xref: /linux-6.15/include/linux/fpga/fpga-bridge.h (revision 564f7dfd)
1 #include <linux/device.h>
2 #include <linux/fpga/fpga-mgr.h>
3 
4 #ifndef _LINUX_FPGA_BRIDGE_H
5 #define _LINUX_FPGA_BRIDGE_H
6 
7 struct fpga_bridge;
8 
9 /**
10  * struct fpga_bridge_ops - ops for low level FPGA bridge drivers
11  * @enable_show: returns the FPGA bridge's status
12  * @enable_set: set a FPGA bridge as enabled or disabled
13  * @fpga_bridge_remove: set FPGA into a specific state during driver remove
14  */
15 struct fpga_bridge_ops {
16 	int (*enable_show)(struct fpga_bridge *bridge);
17 	int (*enable_set)(struct fpga_bridge *bridge, bool enable);
18 	void (*fpga_bridge_remove)(struct fpga_bridge *bridge);
19 };
20 
21 /**
22  * struct fpga_bridge - FPGA bridge structure
23  * @name: name of low level FPGA bridge
24  * @dev: FPGA bridge device
25  * @mutex: enforces exclusive reference to bridge
26  * @br_ops: pointer to struct of FPGA bridge ops
27  * @info: fpga image specific information
28  * @node: FPGA bridge list node
29  * @priv: low level driver private date
30  */
31 struct fpga_bridge {
32 	const char *name;
33 	struct device dev;
34 	struct mutex mutex; /* for exclusive reference to bridge */
35 	const struct fpga_bridge_ops *br_ops;
36 	struct fpga_image_info *info;
37 	struct list_head node;
38 	void *priv;
39 };
40 
41 #define to_fpga_bridge(d) container_of(d, struct fpga_bridge, dev)
42 
43 struct fpga_bridge *of_fpga_bridge_get(struct device_node *node,
44 				       struct fpga_image_info *info);
45 void fpga_bridge_put(struct fpga_bridge *bridge);
46 int fpga_bridge_enable(struct fpga_bridge *bridge);
47 int fpga_bridge_disable(struct fpga_bridge *bridge);
48 
49 int fpga_bridges_enable(struct list_head *bridge_list);
50 int fpga_bridges_disable(struct list_head *bridge_list);
51 void fpga_bridges_put(struct list_head *bridge_list);
52 int fpga_bridge_get_to_list(struct device_node *np,
53 			    struct fpga_image_info *info,
54 			    struct list_head *bridge_list);
55 
56 int fpga_bridge_register(struct device *dev, const char *name,
57 			 const struct fpga_bridge_ops *br_ops, void *priv);
58 void fpga_bridge_unregister(struct device *dev);
59 
60 #endif /* _LINUX_FPGA_BRIDGE_H */
61