3  * FPGA Region - Support for FPGA programming under Linux
10 #include <linux/fpga/fpga-region.h>
36  * fpga_region_get - get an exclusive reference to a fpga region
37  * @region: FPGA Region struct
39  * Caller should call fpga_region_put() when done with region.
42  * Return -EBUSY if someone already has a reference to the region.
43  * Return -ENODEV if @np is not a FPGA Region.
45 static struct fpga_region *fpga_region_get(struct fpga_region *region)  in fpga_region_get()  argument
47 	struct device *dev = &region->dev;  in fpga_region_get()
49 	if (!mutex_trylock(&region->mutex)) {  in fpga_region_get()
50 		dev_dbg(dev, "%s: FPGA Region already in use\n", __func__);  in fpga_region_get()
57 		mutex_unlock(&region->mutex);  in fpga_region_get()
63 	return region;  in fpga_region_get()
67  * fpga_region_put - release a reference to a region
69  * @region: FPGA region
71 static void fpga_region_put(struct fpga_region *region)  in fpga_region_put()  argument
73 	struct device *dev = &region->dev;  in fpga_region_put()
79 	mutex_unlock(&region->mutex);  in fpga_region_put()
85  * @region: FPGA region
87  * Program an FPGA using fpga image info (region->info).
88  * If the region has a get_bridges function, the exclusive reference for the
90  * reprogramming the region until the caller considers it safe to do so.
92  * reprogram the region.
96 int fpga_region_program_fpga(struct fpga_region *region)  in fpga_region_program_fpga()  argument
98 	struct device *dev = &region->dev;  in fpga_region_program_fpga()
99 	struct fpga_image_info *info = region->info;  in fpga_region_program_fpga()
102 	region = fpga_region_get(region);  in fpga_region_program_fpga()
103 	if (IS_ERR(region)) {  in fpga_region_program_fpga()
104 		dev_err(dev, "failed to get FPGA region\n");  in fpga_region_program_fpga()
105 		return PTR_ERR(region);  in fpga_region_program_fpga()
108 	ret = fpga_mgr_lock(region->mgr);  in fpga_region_program_fpga()
116 	 * fpga region struct.  Or we don't have any bridges.  in fpga_region_program_fpga()
118 	if (region->get_bridges) {  in fpga_region_program_fpga()
119 		ret = region->get_bridges(region);  in fpga_region_program_fpga()
121 			dev_err(dev, "failed to get fpga region bridges\n");  in fpga_region_program_fpga()
126 	ret = fpga_bridges_disable(&region->bridge_list);  in fpga_region_program_fpga()
132 	ret = fpga_mgr_load(region->mgr, info);  in fpga_region_program_fpga()
138 	ret = fpga_bridges_enable(&region->bridge_list);  in fpga_region_program_fpga()
140 		dev_err(dev, "failed to enable region bridges\n");  in fpga_region_program_fpga()
144 	fpga_mgr_unlock(region->mgr);  in fpga_region_program_fpga()
145 	fpga_region_put(region);  in fpga_region_program_fpga()
150 	if (region->get_bridges)  in fpga_region_program_fpga()
151 		fpga_bridges_put(&region->bridge_list);  in fpga_region_program_fpga()
153 	fpga_mgr_unlock(region->mgr);  in fpga_region_program_fpga()
155 	fpga_region_put(region);  in fpga_region_program_fpga()
164 	struct fpga_region *region = to_fpga_region(dev);  in compat_id_show()  local
166 	if (!region->compat_id)  in compat_id_show()
170 		       (unsigned long long)region->compat_id->id_h,  in compat_id_show()
171 		       (unsigned long long)region->compat_id->id_l);  in compat_id_show()
185  * @mgr: manager that programs this region
188  * The caller of this function is responsible for freeing the resulting region
199 	struct fpga_region *region;  in fpga_region_create()  local
202 	region = kzalloc(sizeof(*region), GFP_KERNEL);  in fpga_region_create()
203 	if (!region)  in fpga_region_create()
210 	region->mgr = mgr;  in fpga_region_create()
211 	region->get_bridges = get_bridges;  in fpga_region_create()
212 	mutex_init(&region->mutex);  in fpga_region_create()
213 	INIT_LIST_HEAD(&region->bridge_list);  in fpga_region_create()
215 	device_initialize(&region->dev);  in fpga_region_create()
216 	region->dev.class = fpga_region_class;  in fpga_region_create()
217 	region->dev.parent = dev;  in fpga_region_create()
218 	region->dev.of_node = dev->of_node;  in fpga_region_create()
219 	region->dev.id = id;  in fpga_region_create()
221 	ret = dev_set_name(&region->dev, "region%d", id);  in fpga_region_create()
225 	return region;  in fpga_region_create()
230 	kfree(region);  in fpga_region_create()
237  * fpga_region_free - free a FPGA region created by fpga_region_create()
238  * @region: FPGA region
240 void fpga_region_free(struct fpga_region *region)  in fpga_region_free()  argument
242 	ida_simple_remove(&fpga_region_ida, region->dev.id);  in fpga_region_free()
243 	kfree(region);  in fpga_region_free()
249 	struct fpga_region *region = *(struct fpga_region **)res;  in devm_fpga_region_release()  local
251 	fpga_region_free(region);  in devm_fpga_region_release()
255  * devm_fpga_region_create - create and initialize a managed FPGA region struct
257  * @mgr: manager that programs this region
260  * This function is intended for use in a FPGA region driver's probe function.
261  * After the region driver creates the region struct with
263  * The region driver's remove function should call fpga_region_unregister().
264  * The region struct allocated with this function will be freed automatically on
275 	struct fpga_region **ptr, *region;  in devm_fpga_region_create()  local
281 	region = fpga_region_create(dev, mgr, get_bridges);  in devm_fpga_region_create()
282 	if (!region) {  in devm_fpga_region_create()
285 		*ptr = region;  in devm_fpga_region_create()
289 	return region;  in devm_fpga_region_create()
294  * fpga_region_register - register a FPGA region
295  * @region: FPGA region
299 int fpga_region_register(struct fpga_region *region)  in fpga_region_register()  argument
301 	return device_add(&region->dev);  in fpga_region_register()
306  * fpga_region_unregister - unregister a FPGA region
307  * @region: FPGA region
309  * This function is intended for use in a FPGA region driver's remove function.
311 void fpga_region_unregister(struct fpga_region *region)  in fpga_region_unregister()  argument
313 	device_unregister(&region->dev);  in fpga_region_unregister()
346 MODULE_DESCRIPTION("FPGA Region");