1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
2 | /* |
3 | * MEN Chameleon Bus. |
4 | * |
5 | * Copyright (C) 2014 MEN Mikroelektronik GmbH (www.men.de) |
6 | * Author: Johannes Thumshirn <johannes.thumshirn@men.de> |
7 | */ |
8 | #ifndef _LINUX_MCB_H |
9 | #define _LINUX_MCB_H |
10 | |
11 | #include <linux/mod_devicetable.h> |
12 | #include <linux/device.h> |
13 | #include <linux/irqreturn.h> |
14 | |
15 | #define CHAMELEON_FILENAME_LEN 12 |
16 | |
17 | struct mcb_driver; |
18 | struct mcb_device; |
19 | |
20 | /** |
21 | * struct mcb_bus - MEN Chameleon Bus |
22 | * |
23 | * @dev: bus device |
24 | * @carrier: pointer to carrier device |
25 | * @bus_nr: mcb bus number |
26 | * @get_irq: callback to get IRQ number |
27 | * @revision: the FPGA's revision number |
28 | * @model: the FPGA's model number |
29 | * @filename: the FPGA's name |
30 | */ |
31 | struct mcb_bus { |
32 | struct device dev; |
33 | struct device *carrier; |
34 | int bus_nr; |
35 | u8 revision; |
36 | char model; |
37 | u8 minor; |
38 | char name[CHAMELEON_FILENAME_LEN + 1]; |
39 | int (*get_irq)(struct mcb_device *dev); |
40 | }; |
41 | |
42 | static inline struct mcb_bus *to_mcb_bus(struct device *dev) |
43 | { |
44 | return container_of(dev, struct mcb_bus, dev); |
45 | } |
46 | |
47 | /** |
48 | * struct mcb_device - MEN Chameleon Bus device |
49 | * |
50 | * @dev: device in kernel representation |
51 | * @bus: mcb bus the device is plugged to |
52 | * @is_added: flag to check if device is added to bus |
53 | * @driver: associated mcb_driver |
54 | * @id: mcb device id |
55 | * @inst: instance in Chameleon table |
56 | * @group: group in Chameleon table |
57 | * @var: variant in Chameleon table |
58 | * @bar: BAR in Chameleon table |
59 | * @rev: revision in Chameleon table |
60 | * @irq: IRQ resource |
61 | * @memory: memory resource |
62 | */ |
63 | struct mcb_device { |
64 | struct device dev; |
65 | struct mcb_bus *bus; |
66 | struct mcb_driver *driver; |
67 | u16 id; |
68 | int inst; |
69 | int group; |
70 | int var; |
71 | int bar; |
72 | int rev; |
73 | struct resource irq; |
74 | struct resource mem; |
75 | struct device *dma_dev; |
76 | }; |
77 | |
78 | #define to_mcb_device(__dev) container_of_const(__dev, struct mcb_device, dev) |
79 | |
80 | /** |
81 | * struct mcb_driver - MEN Chameleon Bus device driver |
82 | * |
83 | * @driver: device_driver |
84 | * @id_table: mcb id table |
85 | * @probe: probe callback |
86 | * @remove: remove callback |
87 | * @shutdown: shutdown callback |
88 | */ |
89 | struct mcb_driver { |
90 | struct device_driver driver; |
91 | const struct mcb_device_id *id_table; |
92 | int (*probe)(struct mcb_device *mdev, const struct mcb_device_id *id); |
93 | void (*remove)(struct mcb_device *mdev); |
94 | void (*shutdown)(struct mcb_device *mdev); |
95 | }; |
96 | |
97 | static inline struct mcb_driver *to_mcb_driver(struct device_driver *drv) |
98 | { |
99 | return container_of(drv, struct mcb_driver, driver); |
100 | } |
101 | |
102 | static inline void *mcb_get_drvdata(struct mcb_device *dev) |
103 | { |
104 | return dev_get_drvdata(dev: &dev->dev); |
105 | } |
106 | |
107 | static inline void mcb_set_drvdata(struct mcb_device *dev, void *data) |
108 | { |
109 | dev_set_drvdata(dev: &dev->dev, data); |
110 | } |
111 | |
112 | extern int __must_check __mcb_register_driver(struct mcb_driver *drv, |
113 | struct module *owner, |
114 | const char *mod_name); |
115 | #define mcb_register_driver(driver) \ |
116 | __mcb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) |
117 | extern void mcb_unregister_driver(struct mcb_driver *driver); |
118 | #define module_mcb_driver(__mcb_driver) \ |
119 | module_driver(__mcb_driver, mcb_register_driver, mcb_unregister_driver) |
120 | extern void mcb_bus_add_devices(const struct mcb_bus *bus); |
121 | extern int mcb_device_register(struct mcb_bus *bus, struct mcb_device *dev); |
122 | extern struct mcb_bus *mcb_alloc_bus(struct device *carrier); |
123 | extern struct mcb_bus *mcb_bus_get(struct mcb_bus *bus); |
124 | extern void mcb_bus_put(struct mcb_bus *bus); |
125 | extern struct mcb_device *mcb_alloc_dev(struct mcb_bus *bus); |
126 | extern void mcb_free_dev(struct mcb_device *dev); |
127 | extern void mcb_release_bus(struct mcb_bus *bus); |
128 | extern struct resource *mcb_request_mem(struct mcb_device *dev, |
129 | const char *name); |
130 | extern void mcb_release_mem(struct resource *mem); |
131 | extern int mcb_get_irq(struct mcb_device *dev); |
132 | extern struct resource *mcb_get_resource(struct mcb_device *dev, |
133 | unsigned int type); |
134 | |
135 | #endif /* _LINUX_MCB_H */ |
136 | |