Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6] / include / linux / mod_devicetable.h
1 /*
2  * Device tables which are exported to userspace via
3  * scripts/mod/file2alias.c.  You must keep that file in sync with this
4  * header.
5  */
6
7 #ifndef LINUX_MOD_DEVICETABLE_H
8 #define LINUX_MOD_DEVICETABLE_H
9
10 #ifdef __KERNEL__
11 #include <linux/types.h>
12 typedef unsigned long kernel_ulong_t;
13 #endif
14
15 #define PCI_ANY_ID (~0)
16
17 struct pci_device_id {
18         __u32 vendor, device;           /* Vendor and device ID or PCI_ANY_ID*/
19         __u32 subvendor, subdevice;     /* Subsystem ID's or PCI_ANY_ID */
20         __u32 class, class_mask;        /* (class,subclass,prog-if) triplet */
21         kernel_ulong_t driver_data;     /* Data private to the driver */
22 };
23
24
25 #define IEEE1394_MATCH_VENDOR_ID        0x0001
26 #define IEEE1394_MATCH_MODEL_ID         0x0002
27 #define IEEE1394_MATCH_SPECIFIER_ID     0x0004
28 #define IEEE1394_MATCH_VERSION          0x0008
29
30 struct ieee1394_device_id {
31         __u32 match_flags;
32         __u32 vendor_id;
33         __u32 model_id;
34         __u32 specifier_id;
35         __u32 version;
36         kernel_ulong_t driver_data
37                 __attribute__((aligned(sizeof(kernel_ulong_t))));
38 };
39
40
41 /*
42  * Device table entry for "new style" table-driven USB drivers.
43  * User mode code can read these tables to choose which modules to load.
44  * Declare the table as a MODULE_DEVICE_TABLE.
45  *
46  * A probe() parameter will point to a matching entry from this table.
47  * Use the driver_info field for each match to hold information tied
48  * to that match:  device quirks, etc.
49  *
50  * Terminate the driver's table with an all-zeroes entry.
51  * Use the flag values to control which fields are compared.
52  */
53
54 /**
55  * struct usb_device_id - identifies USB devices for probing and hotplugging
56  * @match_flags: Bit mask controlling of the other fields are used to match
57  *      against new devices.  Any field except for driver_info may be used,
58  *      although some only make sense in conjunction with other fields.
59  *      This is usually set by a USB_DEVICE_*() macro, which sets all
60  *      other fields in this structure except for driver_info.
61  * @idVendor: USB vendor ID for a device; numbers are assigned
62  *      by the USB forum to its members.
63  * @idProduct: Vendor-assigned product ID.
64  * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
65  *      This is also used to identify individual product versions, for
66  *      a range consisting of a single device.
67  * @bcdDevice_hi: High end of version number range.  The range of product
68  *      versions is inclusive.
69  * @bDeviceClass: Class of device; numbers are assigned
70  *      by the USB forum.  Products may choose to implement classes,
71  *      or be vendor-specific.  Device classes specify behavior of all
72  *      the interfaces on a devices.
73  * @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
74  * @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
75  * @bInterfaceClass: Class of interface; numbers are assigned
76  *      by the USB forum.  Products may choose to implement classes,
77  *      or be vendor-specific.  Interface classes specify behavior only
78  *      of a given interface; other interfaces may support other classes.
79  * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
80  * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
81  * @driver_info: Holds information used by the driver.  Usually it holds
82  *      a pointer to a descriptor understood by the driver, or perhaps
83  *      device flags.
84  *
85  * In most cases, drivers will create a table of device IDs by using
86  * USB_DEVICE(), or similar macros designed for that purpose.
87  * They will then export it to userspace using MODULE_DEVICE_TABLE(),
88  * and provide it to the USB core through their usb_driver structure.
89  *
90  * See the usb_match_id() function for information about how matches are
91  * performed.  Briefly, you will normally use one of several macros to help
92  * construct these entries.  Each entry you provide will either identify
93  * one or more specific products, or will identify a class of products
94  * which have agreed to behave the same.  You should put the more specific
95  * matches towards the beginning of your table, so that driver_info can
96  * record quirks of specific products.
97  */
98 struct usb_device_id {
99         /* which fields to match against? */
100         __u16           match_flags;
101
102         /* Used for product specific matches; range is inclusive */
103         __u16           idVendor;
104         __u16           idProduct;
105         __u16           bcdDevice_lo;
106         __u16           bcdDevice_hi;
107
108         /* Used for device class matches */
109         __u8            bDeviceClass;
110         __u8            bDeviceSubClass;
111         __u8            bDeviceProtocol;
112
113         /* Used for interface class matches */
114         __u8            bInterfaceClass;
115         __u8            bInterfaceSubClass;
116         __u8            bInterfaceProtocol;
117
118         /* not matched against */
119         kernel_ulong_t  driver_info;
120 };
121
122 /* Some useful macros to use to create struct usb_device_id */
123 #define USB_DEVICE_ID_MATCH_VENDOR              0x0001
124 #define USB_DEVICE_ID_MATCH_PRODUCT             0x0002
125 #define USB_DEVICE_ID_MATCH_DEV_LO              0x0004
126 #define USB_DEVICE_ID_MATCH_DEV_HI              0x0008
127 #define USB_DEVICE_ID_MATCH_DEV_CLASS           0x0010
128 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS        0x0020
129 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL        0x0040
130 #define USB_DEVICE_ID_MATCH_INT_CLASS           0x0080
131 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS        0x0100
132 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL        0x0200
133
134 /* s390 CCW devices */
135 struct ccw_device_id {
136         __u16   match_flags;    /* which fields to match against */
137
138         __u16   cu_type;        /* control unit type     */
139         __u16   dev_type;       /* device type           */
140         __u8    cu_model;       /* control unit model    */
141         __u8    dev_model;      /* device model          */
142
143         kernel_ulong_t driver_info;
144 };
145
146 #define CCW_DEVICE_ID_MATCH_CU_TYPE             0x01
147 #define CCW_DEVICE_ID_MATCH_CU_MODEL            0x02
148 #define CCW_DEVICE_ID_MATCH_DEVICE_TYPE         0x04
149 #define CCW_DEVICE_ID_MATCH_DEVICE_MODEL        0x08
150
151 /* s390 AP bus devices */
152 struct ap_device_id {
153         __u16 match_flags;      /* which fields to match against */
154         __u8 dev_type;          /* device type */
155         __u8 pad1;
156         __u32 pad2;
157         kernel_ulong_t driver_info;
158 };
159
160 #define AP_DEVICE_ID_MATCH_DEVICE_TYPE          0x01
161
162 /* s390 css bus devices (subchannels) */
163 struct css_device_id {
164         __u8 match_flags;
165         __u8 type; /* subchannel type */
166         __u16 pad2;
167         __u32 pad3;
168         kernel_ulong_t driver_data;
169 };
170
171 #define ACPI_ID_LEN     16 /* only 9 bytes needed here, 16 bytes are used */
172                            /* to workaround crosscompile issues */
173
174 struct acpi_device_id {
175         __u8 id[ACPI_ID_LEN];
176         kernel_ulong_t driver_data;
177 };
178
179 #define PNP_ID_LEN      8
180 #define PNP_MAX_DEVICES 8
181
182 struct pnp_device_id {
183         __u8 id[PNP_ID_LEN];
184         kernel_ulong_t driver_data;
185 };
186
187 struct pnp_card_device_id {
188         __u8 id[PNP_ID_LEN];
189         kernel_ulong_t driver_data;
190         struct {
191                 __u8 id[PNP_ID_LEN];
192         } devs[PNP_MAX_DEVICES];
193 };
194
195
196 #define SERIO_ANY       0xff
197
198 struct serio_device_id {
199         __u8 type;
200         __u8 extra;
201         __u8 id;
202         __u8 proto;
203 };
204
205 /*
206  * Struct used for matching a device
207  */
208 struct of_device_id
209 {
210         char    name[32];
211         char    type[32];
212         char    compatible[128];
213 #ifdef __KERNEL__
214         void    *data;
215 #else
216         kernel_ulong_t data;
217 #endif
218 };
219
220 /* VIO */
221 struct vio_device_id {
222         char type[32];
223         char compat[32];
224 };
225
226 /* PCMCIA */
227
228 struct pcmcia_device_id {
229         __u16           match_flags;
230
231         __u16           manf_id;
232         __u16           card_id;
233
234         __u8            func_id;
235
236         /* for real multi-function devices */
237         __u8            function;
238
239         /* for pseudo multi-function devices */
240         __u8            device_no;
241
242         __u32           prod_id_hash[4]
243                 __attribute__((aligned(sizeof(__u32))));
244
245         /* not matched against in kernelspace*/
246 #ifdef __KERNEL__
247         const char *    prod_id[4];
248 #else
249         kernel_ulong_t  prod_id[4]
250                 __attribute__((aligned(sizeof(kernel_ulong_t))));
251 #endif
252
253         /* not matched against */
254         kernel_ulong_t  driver_info;
255 #ifdef __KERNEL__
256         char *          cisfile;
257 #else
258         kernel_ulong_t  cisfile;
259 #endif
260 };
261
262 #define PCMCIA_DEV_ID_MATCH_MANF_ID     0x0001
263 #define PCMCIA_DEV_ID_MATCH_CARD_ID     0x0002
264 #define PCMCIA_DEV_ID_MATCH_FUNC_ID     0x0004
265 #define PCMCIA_DEV_ID_MATCH_FUNCTION    0x0008
266 #define PCMCIA_DEV_ID_MATCH_PROD_ID1    0x0010
267 #define PCMCIA_DEV_ID_MATCH_PROD_ID2    0x0020
268 #define PCMCIA_DEV_ID_MATCH_PROD_ID3    0x0040
269 #define PCMCIA_DEV_ID_MATCH_PROD_ID4    0x0080
270 #define PCMCIA_DEV_ID_MATCH_DEVICE_NO   0x0100
271 #define PCMCIA_DEV_ID_MATCH_FAKE_CIS    0x0200
272 #define PCMCIA_DEV_ID_MATCH_ANONYMOUS   0x0400
273
274 /* Input */
275 #define INPUT_DEVICE_ID_EV_MAX          0x1f
276 #define INPUT_DEVICE_ID_KEY_MIN_INTERESTING     0x71
277 #define INPUT_DEVICE_ID_KEY_MAX         0x1ff
278 #define INPUT_DEVICE_ID_REL_MAX         0x0f
279 #define INPUT_DEVICE_ID_ABS_MAX         0x3f
280 #define INPUT_DEVICE_ID_MSC_MAX         0x07
281 #define INPUT_DEVICE_ID_LED_MAX         0x0f
282 #define INPUT_DEVICE_ID_SND_MAX         0x07
283 #define INPUT_DEVICE_ID_FF_MAX          0x7f
284 #define INPUT_DEVICE_ID_SW_MAX          0x0f
285
286 #define INPUT_DEVICE_ID_MATCH_BUS       1
287 #define INPUT_DEVICE_ID_MATCH_VENDOR    2
288 #define INPUT_DEVICE_ID_MATCH_PRODUCT   4
289 #define INPUT_DEVICE_ID_MATCH_VERSION   8
290
291 #define INPUT_DEVICE_ID_MATCH_EVBIT     0x0010
292 #define INPUT_DEVICE_ID_MATCH_KEYBIT    0x0020
293 #define INPUT_DEVICE_ID_MATCH_RELBIT    0x0040
294 #define INPUT_DEVICE_ID_MATCH_ABSBIT    0x0080
295 #define INPUT_DEVICE_ID_MATCH_MSCIT     0x0100
296 #define INPUT_DEVICE_ID_MATCH_LEDBIT    0x0200
297 #define INPUT_DEVICE_ID_MATCH_SNDBIT    0x0400
298 #define INPUT_DEVICE_ID_MATCH_FFBIT     0x0800
299 #define INPUT_DEVICE_ID_MATCH_SWBIT     0x1000
300
301 struct input_device_id {
302
303         kernel_ulong_t flags;
304
305         __u16 bustype;
306         __u16 vendor;
307         __u16 product;
308         __u16 version;
309
310         kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
311         kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
312         kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
313         kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
314         kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
315         kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
316         kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
317         kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
318         kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];
319
320         kernel_ulong_t driver_info;
321 };
322
323 /* EISA */
324
325 #define EISA_SIG_LEN   8
326
327 /* The EISA signature, in ASCII form, null terminated */
328 struct eisa_device_id {
329         char          sig[EISA_SIG_LEN];
330         kernel_ulong_t driver_data;
331 };
332
333 #define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"
334
335 struct parisc_device_id {
336         __u8    hw_type;        /* 5 bits used */
337         __u8    hversion_rev;   /* 4 bits */
338         __u16   hversion;       /* 12 bits */
339         __u32   sversion;       /* 20 bits */
340 };
341
342 #define PA_HWTYPE_ANY_ID        0xff
343 #define PA_HVERSION_REV_ANY_ID  0xff
344 #define PA_HVERSION_ANY_ID      0xffff
345 #define PA_SVERSION_ANY_ID      0xffffffff
346
347 /* SDIO */
348
349 #define SDIO_ANY_ID (~0)
350
351 struct sdio_device_id {
352         __u8    class;                  /* Standard interface or SDIO_ANY_ID */
353         __u16   vendor;                 /* Vendor or SDIO_ANY_ID */
354         __u16   device;                 /* Device ID or SDIO_ANY_ID */
355         kernel_ulong_t driver_data      /* Data private to the driver */
356                 __attribute__((aligned(sizeof(kernel_ulong_t))));
357 };
358
359 /* SSB core, see drivers/ssb/ */
360 struct ssb_device_id {
361         __u16   vendor;
362         __u16   coreid;
363         __u8    revision;
364 };
365 #define SSB_DEVICE(_vendor, _coreid, _revision)  \
366         { .vendor = _vendor, .coreid = _coreid, .revision = _revision, }
367 #define SSB_DEVTABLE_END  \
368         { 0, },
369
370 #define SSB_ANY_VENDOR          0xFFFF
371 #define SSB_ANY_ID              0xFFFF
372 #define SSB_ANY_REV             0xFF
373
374 struct virtio_device_id {
375         __u32 device;
376         __u32 vendor;
377 };
378 #define VIRTIO_DEV_ANY_ID       0xffffffff
379
380 /* i2c */
381
382 #define I2C_NAME_SIZE   20
383 #define I2C_MODULE_PREFIX "i2c:"
384
385 struct i2c_device_id {
386         char name[I2C_NAME_SIZE];
387         kernel_ulong_t driver_data      /* Data private to the driver */
388                         __attribute__((aligned(sizeof(kernel_ulong_t))));
389 };
390
391
392 #endif /* LINUX_MOD_DEVICETABLE_H */