1 /*
2 * UWB Multi-interface Controller support.
3 *
4 * Copyright (C) 2007 Cambridge Silicon Radio Ltd.
5 *
6 * This file is released under the GPLv2
7 *
8 * UMC (UWB Multi-interface Controller) capabilities (e.g., radio
9 * controller, host controller) are presented as devices on the "umc"
10 * bus.
11 *
12 * The radio controller is not strictly a UMC capability but it's
13 * useful to present it as such.
14 *
15 * References:
16 *
17 * [WHCI] Wireless Host Controller Interface Specification for
18 * Certified Wireless Universal Serial Bus, revision 0.95.
19 *
20 * How this works is kind of convoluted but simple. The whci.ko driver
21 * loads when WHCI devices are detected. These WHCI devices expose
22 * many devices in the same PCI function (they couldn't have reused
23 * functions, no), so for each PCI function that exposes these many
24 * devices, whci ceates a umc_dev [whci_probe() -> whci_add_cap()]
25 * with umc_device_create() and adds it to the bus with
26 * umc_device_register().
27 *
28 * umc_device_register() calls device_register() which will push the
29 * bus management code to load your UMC driver's somehting_probe()
30 * that you have registered for that capability code.
31 *
32 * Now when the WHCI device is removed, whci_remove() will go over
33 * each umc_dev assigned to each of the PCI function's capabilities
34 * and through whci_del_cap() call umc_device_unregister() each
35 * created umc_dev. Of course, if you are bound to the device, your
36 * driver's something_remove() will be called.
37 */
38
39 #ifndef _LINUX_UWB_UMC_H_
40 #define _LINUX_UWB_UMC_H_
41
42 #include <linux/device.h>
43 #include <linux/pci.h>
44
45 /*
46 * UMC capability IDs.
47 *
48 * 0x00 is reserved so use it for the radio controller device.
49 *
50 * [WHCI] table 2-8
51 */
52 #define UMC_CAP_ID_WHCI_RC 0x00 /* radio controller */
53 #define UMC_CAP_ID_WHCI_WUSB_HC 0x01 /* WUSB host controller */
54
55 /**
56 * struct umc_dev - UMC capability device
57 *
58 * @version: version of the specification this capability conforms to.
59 * @cap_id: capability ID.
60 * @bar: PCI Bar (64 bit) where the resource lies
61 * @resource: register space resource.
62 * @irq: interrupt line.
63 */
64 struct umc_dev {
65 u16 version;
66 u8 cap_id;
67 u8 bar;
68 struct resource resource;
69 unsigned irq;
70 struct device dev;
71 };
72
73 #define to_umc_dev(d) container_of(d, struct umc_dev, dev)
74
75 /**
76 * struct umc_driver - UMC capability driver
77 * @cap_id: supported capability ID.
78 * @match: driver specific capability matching function.
79 * @match_data: driver specific data for match() (e.g., a
80 * table of pci_device_id's if umc_match_pci_id() is used).
81 */
82 struct umc_driver {
83 char *name;
84 u8 cap_id;
85 int (*match)(struct umc_driver *, struct umc_dev *);
86 const void *match_data;
87
88 int (*probe)(struct umc_dev *);
89 void (*remove)(struct umc_dev *);
90 int (*suspend)(struct umc_dev *, pm_message_t state);
91 int (*resume)(struct umc_dev *);
92 int (*pre_reset)(struct umc_dev *);
93 int (*post_reset)(struct umc_dev *);
94
95 struct device_driver driver;
96 };
97
98 #define to_umc_driver(d) container_of(d, struct umc_driver, driver)
99
100 extern struct bus_type umc_bus_type;
101
102 struct umc_dev *umc_device_create(struct device *parent, int n);
103 int __must_check umc_device_register(struct umc_dev *umc);
104 void umc_device_unregister(struct umc_dev *umc);
105
106 int __must_check __umc_driver_register(struct umc_driver *umc_drv,
107 struct module *mod,
108 const char *mod_name);
109
110 /**
111 * umc_driver_register - register a UMC capabiltity driver.
112 * @umc_drv: pointer to the driver.
113 */
114 #define umc_driver_register(umc_drv) \
115 __umc_driver_register(umc_drv, THIS_MODULE, KBUILD_MODNAME)
116
117 void umc_driver_unregister(struct umc_driver *umc_drv);
118
119 /*
120 * Utility function you can use to match (umc_driver->match) against a
121 * null-terminated array of 'struct pci_device_id' in
122 * umc_driver->match_data.
123 */
124 int umc_match_pci_id(struct umc_driver *umc_drv, struct umc_dev *umc);
125
126 /**
127 * umc_parent_pci_dev - return the UMC's parent PCI device or NULL if none
128 * @umc_dev: UMC device whose parent PCI device we are looking for
129 *
130 * DIRTY!!! DON'T RELY ON THIS
131 *
132 * FIXME: This is as dirty as it gets, but we need some way to check
133 * the correct type of umc_dev->parent (so that for example, we can
134 * cast to pci_dev). Casting to pci_dev is necessary because at some
135 * point we need to request resources from the device. Mapping is
136 * easily over come (ioremap and stuff are bus agnostic), but hooking
137 * up to some error handlers (such as pci error handlers) might need
138 * this.
139 *
140 * THIS might (probably will) be removed in the future, so don't count
141 * on it.
142 */
umc_parent_pci_dev(struct umc_dev * umc_dev)143 static inline struct pci_dev *umc_parent_pci_dev(struct umc_dev *umc_dev)
144 {
145 struct pci_dev *pci_dev = NULL;
146 if (umc_dev->dev.parent->bus == &pci_bus_type)
147 pci_dev = to_pci_dev(umc_dev->dev.parent);
148 return pci_dev;
149 }
150
151 /**
152 * umc_dev_get() - reference a UMC device.
153 * @umc_dev: Pointer to UMC device.
154 *
155 * NOTE: we are assuming in this whole scheme that the parent device
156 * is referenced at _probe() time and unreferenced at _remove()
157 * time by the parent's subsystem.
158 */
umc_dev_get(struct umc_dev * umc_dev)159 static inline struct umc_dev *umc_dev_get(struct umc_dev *umc_dev)
160 {
161 get_device(&umc_dev->dev);
162 return umc_dev;
163 }
164
165 /**
166 * umc_dev_put() - unreference a UMC device.
167 * @umc_dev: Pointer to UMC device.
168 */
umc_dev_put(struct umc_dev * umc_dev)169 static inline void umc_dev_put(struct umc_dev *umc_dev)
170 {
171 put_device(&umc_dev->dev);
172 }
173
174 /**
175 * umc_set_drvdata - set UMC device's driver data.
176 * @umc_dev: Pointer to UMC device.
177 * @data: Data to set.
178 */
umc_set_drvdata(struct umc_dev * umc_dev,void * data)179 static inline void umc_set_drvdata(struct umc_dev *umc_dev, void *data)
180 {
181 dev_set_drvdata(&umc_dev->dev, data);
182 }
183
184 /**
185 * umc_get_drvdata - recover UMC device's driver data.
186 * @umc_dev: Pointer to UMC device.
187 */
umc_get_drvdata(struct umc_dev * umc_dev)188 static inline void *umc_get_drvdata(struct umc_dev *umc_dev)
189 {
190 return dev_get_drvdata(&umc_dev->dev);
191 }
192
193 int umc_controller_reset(struct umc_dev *umc);
194
195 #endif /* #ifndef _LINUX_UWB_UMC_H_ */
196