UPSTREAM: USB: option: add ZTE MF821D
[cascardo/linux.git] / 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  * @bInterfaceNumber: Number of interface; composite devices may use
82  *      fixed interface numbers to differentiate between vendor-specific
83  *      interfaces.
84  * @driver_info: Holds information used by the driver.  Usually it holds
85  *      a pointer to a descriptor understood by the driver, or perhaps
86  *      device flags.
87  *
88  * In most cases, drivers will create a table of device IDs by using
89  * USB_DEVICE(), or similar macros designed for that purpose.
90  * They will then export it to userspace using MODULE_DEVICE_TABLE(),
91  * and provide it to the USB core through their usb_driver structure.
92  *
93  * See the usb_match_id() function for information about how matches are
94  * performed.  Briefly, you will normally use one of several macros to help
95  * construct these entries.  Each entry you provide will either identify
96  * one or more specific products, or will identify a class of products
97  * which have agreed to behave the same.  You should put the more specific
98  * matches towards the beginning of your table, so that driver_info can
99  * record quirks of specific products.
100  */
101 struct usb_device_id {
102         /* which fields to match against? */
103         __u16           match_flags;
104
105         /* Used for product specific matches; range is inclusive */
106         __u16           idVendor;
107         __u16           idProduct;
108         __u16           bcdDevice_lo;
109         __u16           bcdDevice_hi;
110
111         /* Used for device class matches */
112         __u8            bDeviceClass;
113         __u8            bDeviceSubClass;
114         __u8            bDeviceProtocol;
115
116         /* Used for interface class matches */
117         __u8            bInterfaceClass;
118         __u8            bInterfaceSubClass;
119         __u8            bInterfaceProtocol;
120
121         /* Used for vendor-specific interface matches */
122         __u8            bInterfaceNumber;
123
124         /* not matched against */
125         kernel_ulong_t  driver_info;
126 };
127
128 /* Some useful macros to use to create struct usb_device_id */
129 #define USB_DEVICE_ID_MATCH_VENDOR              0x0001
130 #define USB_DEVICE_ID_MATCH_PRODUCT             0x0002
131 #define USB_DEVICE_ID_MATCH_DEV_LO              0x0004
132 #define USB_DEVICE_ID_MATCH_DEV_HI              0x0008
133 #define USB_DEVICE_ID_MATCH_DEV_CLASS           0x0010
134 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS        0x0020
135 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL        0x0040
136 #define USB_DEVICE_ID_MATCH_INT_CLASS           0x0080
137 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS        0x0100
138 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL        0x0200
139 #define USB_DEVICE_ID_MATCH_INT_NUMBER          0x0400
140
141 #define HID_ANY_ID                              (~0)
142
143 struct hid_device_id {
144         __u16 bus;
145         __u16 pad1;
146         __u32 vendor;
147         __u32 product;
148         kernel_ulong_t driver_data
149                 __attribute__((aligned(sizeof(kernel_ulong_t))));
150 };
151
152 /* s390 CCW devices */
153 struct ccw_device_id {
154         __u16   match_flags;    /* which fields to match against */
155
156         __u16   cu_type;        /* control unit type     */
157         __u16   dev_type;       /* device type           */
158         __u8    cu_model;       /* control unit model    */
159         __u8    dev_model;      /* device model          */
160
161         kernel_ulong_t driver_info;
162 };
163
164 #define CCW_DEVICE_ID_MATCH_CU_TYPE             0x01
165 #define CCW_DEVICE_ID_MATCH_CU_MODEL            0x02
166 #define CCW_DEVICE_ID_MATCH_DEVICE_TYPE         0x04
167 #define CCW_DEVICE_ID_MATCH_DEVICE_MODEL        0x08
168
169 /* s390 AP bus devices */
170 struct ap_device_id {
171         __u16 match_flags;      /* which fields to match against */
172         __u8 dev_type;          /* device type */
173         __u8 pad1;
174         __u32 pad2;
175         kernel_ulong_t driver_info;
176 };
177
178 #define AP_DEVICE_ID_MATCH_DEVICE_TYPE          0x01
179
180 /* s390 css bus devices (subchannels) */
181 struct css_device_id {
182         __u8 match_flags;
183         __u8 type; /* subchannel type */
184         __u16 pad2;
185         __u32 pad3;
186         kernel_ulong_t driver_data;
187 };
188
189 #define ACPI_ID_LEN     16 /* only 9 bytes needed here, 16 bytes are used */
190                            /* to workaround crosscompile issues */
191
192 struct acpi_device_id {
193         __u8 id[ACPI_ID_LEN];
194         kernel_ulong_t driver_data;
195 };
196
197 #define PNP_ID_LEN      8
198 #define PNP_MAX_DEVICES 8
199
200 struct pnp_device_id {
201         __u8 id[PNP_ID_LEN];
202         kernel_ulong_t driver_data;
203 };
204
205 struct pnp_card_device_id {
206         __u8 id[PNP_ID_LEN];
207         kernel_ulong_t driver_data;
208         struct {
209                 __u8 id[PNP_ID_LEN];
210         } devs[PNP_MAX_DEVICES];
211 };
212
213
214 #define SERIO_ANY       0xff
215
216 struct serio_device_id {
217         __u8 type;
218         __u8 extra;
219         __u8 id;
220         __u8 proto;
221 };
222
223 /*
224  * Struct used for matching a device
225  */
226 struct of_device_id
227 {
228         char    name[32];
229         char    type[32];
230         char    compatible[128];
231 #ifdef __KERNEL__
232         void    *data;
233 #else
234         kernel_ulong_t data;
235 #endif
236 };
237
238 /* VIO */
239 struct vio_device_id {
240         char type[32];
241         char compat[32];
242 };
243
244 /* PCMCIA */
245
246 struct pcmcia_device_id {
247         __u16           match_flags;
248
249         __u16           manf_id;
250         __u16           card_id;
251
252         __u8            func_id;
253
254         /* for real multi-function devices */
255         __u8            function;
256
257         /* for pseudo multi-function devices */
258         __u8            device_no;
259
260         __u32           prod_id_hash[4]
261                 __attribute__((aligned(sizeof(__u32))));
262
263         /* not matched against in kernelspace*/
264 #ifdef __KERNEL__
265         const char *    prod_id[4];
266 #else
267         kernel_ulong_t  prod_id[4]
268                 __attribute__((aligned(sizeof(kernel_ulong_t))));
269 #endif
270
271         /* not matched against */
272         kernel_ulong_t  driver_info;
273 #ifdef __KERNEL__
274         char *          cisfile;
275 #else
276         kernel_ulong_t  cisfile;
277 #endif
278 };
279
280 #define PCMCIA_DEV_ID_MATCH_MANF_ID     0x0001
281 #define PCMCIA_DEV_ID_MATCH_CARD_ID     0x0002
282 #define PCMCIA_DEV_ID_MATCH_FUNC_ID     0x0004
283 #define PCMCIA_DEV_ID_MATCH_FUNCTION    0x0008
284 #define PCMCIA_DEV_ID_MATCH_PROD_ID1    0x0010
285 #define PCMCIA_DEV_ID_MATCH_PROD_ID2    0x0020
286 #define PCMCIA_DEV_ID_MATCH_PROD_ID3    0x0040
287 #define PCMCIA_DEV_ID_MATCH_PROD_ID4    0x0080
288 #define PCMCIA_DEV_ID_MATCH_DEVICE_NO   0x0100
289 #define PCMCIA_DEV_ID_MATCH_FAKE_CIS    0x0200
290 #define PCMCIA_DEV_ID_MATCH_ANONYMOUS   0x0400
291
292 /* Input */
293 #define INPUT_DEVICE_ID_EV_MAX          0x1f
294 #define INPUT_DEVICE_ID_KEY_MIN_INTERESTING     0x71
295 #define INPUT_DEVICE_ID_KEY_MAX         0x2ff
296 #define INPUT_DEVICE_ID_REL_MAX         0x0f
297 #define INPUT_DEVICE_ID_ABS_MAX         0x3f
298 #define INPUT_DEVICE_ID_MSC_MAX         0x07
299 #define INPUT_DEVICE_ID_LED_MAX         0x0f
300 #define INPUT_DEVICE_ID_SND_MAX         0x07
301 #define INPUT_DEVICE_ID_FF_MAX          0x7f
302 #define INPUT_DEVICE_ID_SW_MAX          0x0f
303
304 #define INPUT_DEVICE_ID_MATCH_BUS       1
305 #define INPUT_DEVICE_ID_MATCH_VENDOR    2
306 #define INPUT_DEVICE_ID_MATCH_PRODUCT   4
307 #define INPUT_DEVICE_ID_MATCH_VERSION   8
308
309 #define INPUT_DEVICE_ID_MATCH_EVBIT     0x0010
310 #define INPUT_DEVICE_ID_MATCH_KEYBIT    0x0020
311 #define INPUT_DEVICE_ID_MATCH_RELBIT    0x0040
312 #define INPUT_DEVICE_ID_MATCH_ABSBIT    0x0080
313 #define INPUT_DEVICE_ID_MATCH_MSCIT     0x0100
314 #define INPUT_DEVICE_ID_MATCH_LEDBIT    0x0200
315 #define INPUT_DEVICE_ID_MATCH_SNDBIT    0x0400
316 #define INPUT_DEVICE_ID_MATCH_FFBIT     0x0800
317 #define INPUT_DEVICE_ID_MATCH_SWBIT     0x1000
318
319 struct input_device_id {
320
321         kernel_ulong_t flags;
322
323         __u16 bustype;
324         __u16 vendor;
325         __u16 product;
326         __u16 version;
327
328         kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
329         kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
330         kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
331         kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
332         kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
333         kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
334         kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
335         kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
336         kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];
337
338         kernel_ulong_t driver_info;
339 };
340
341 /* EISA */
342
343 #define EISA_SIG_LEN   8
344
345 /* The EISA signature, in ASCII form, null terminated */
346 struct eisa_device_id {
347         char          sig[EISA_SIG_LEN];
348         kernel_ulong_t driver_data;
349 };
350
351 #define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"
352
353 struct parisc_device_id {
354         __u8    hw_type;        /* 5 bits used */
355         __u8    hversion_rev;   /* 4 bits */
356         __u16   hversion;       /* 12 bits */
357         __u32   sversion;       /* 20 bits */
358 };
359
360 #define PA_HWTYPE_ANY_ID        0xff
361 #define PA_HVERSION_REV_ANY_ID  0xff
362 #define PA_HVERSION_ANY_ID      0xffff
363 #define PA_SVERSION_ANY_ID      0xffffffff
364
365 /* SDIO */
366
367 #define SDIO_ANY_ID (~0)
368
369 struct sdio_device_id {
370         __u8    class;                  /* Standard interface or SDIO_ANY_ID */
371         __u16   vendor;                 /* Vendor or SDIO_ANY_ID */
372         __u16   device;                 /* Device ID or SDIO_ANY_ID */
373         kernel_ulong_t driver_data      /* Data private to the driver */
374                 __attribute__((aligned(sizeof(kernel_ulong_t))));
375 };
376
377 /* SSB core, see drivers/ssb/ */
378 struct ssb_device_id {
379         __u16   vendor;
380         __u16   coreid;
381         __u8    revision;
382 };
383 #define SSB_DEVICE(_vendor, _coreid, _revision)  \
384         { .vendor = _vendor, .coreid = _coreid, .revision = _revision, }
385 #define SSB_DEVTABLE_END  \
386         { 0, },
387
388 #define SSB_ANY_VENDOR          0xFFFF
389 #define SSB_ANY_ID              0xFFFF
390 #define SSB_ANY_REV             0xFF
391
392 /* Broadcom's specific AMBA core, see drivers/bcma/ */
393 struct bcma_device_id {
394         __u16   manuf;
395         __u16   id;
396         __u8    rev;
397         __u8    class;
398 };
399 #define BCMA_CORE(_manuf, _id, _rev, _class)  \
400         { .manuf = _manuf, .id = _id, .rev = _rev, .class = _class, }
401 #define BCMA_CORETABLE_END  \
402         { 0, },
403
404 #define BCMA_ANY_MANUF          0xFFFF
405 #define BCMA_ANY_ID             0xFFFF
406 #define BCMA_ANY_REV            0xFF
407 #define BCMA_ANY_CLASS          0xFF
408
409 struct virtio_device_id {
410         __u32 device;
411         __u32 vendor;
412 };
413 #define VIRTIO_DEV_ANY_ID       0xffffffff
414
415 /*
416  * For Hyper-V devices we use the device guid as the id.
417  */
418 struct hv_vmbus_device_id {
419         __u8 guid[16];
420         kernel_ulong_t driver_data      /* Data private to the driver */
421                         __attribute__((aligned(sizeof(kernel_ulong_t))));
422 };
423
424 /* rpmsg */
425
426 #define RPMSG_NAME_SIZE                 32
427 #define RPMSG_DEVICE_MODALIAS_FMT       "rpmsg:%s"
428
429 struct rpmsg_device_id {
430         char name[RPMSG_NAME_SIZE];
431 };
432
433 /* i2c */
434
435 #define I2C_NAME_SIZE   20
436 #define I2C_MODULE_PREFIX "i2c:"
437
438 struct i2c_device_id {
439         char name[I2C_NAME_SIZE];
440         kernel_ulong_t driver_data      /* Data private to the driver */
441                         __attribute__((aligned(sizeof(kernel_ulong_t))));
442 };
443
444 /* spi */
445
446 #define SPI_NAME_SIZE   32
447 #define SPI_MODULE_PREFIX "spi:"
448
449 struct spi_device_id {
450         char name[SPI_NAME_SIZE];
451         kernel_ulong_t driver_data      /* Data private to the driver */
452                         __attribute__((aligned(sizeof(kernel_ulong_t))));
453 };
454
455 /* dmi */
456 enum dmi_field {
457         DMI_NONE,
458         DMI_BIOS_VENDOR,
459         DMI_BIOS_VERSION,
460         DMI_BIOS_DATE,
461         DMI_SYS_VENDOR,
462         DMI_PRODUCT_NAME,
463         DMI_PRODUCT_VERSION,
464         DMI_PRODUCT_SERIAL,
465         DMI_PRODUCT_UUID,
466         DMI_BOARD_VENDOR,
467         DMI_BOARD_NAME,
468         DMI_BOARD_VERSION,
469         DMI_BOARD_SERIAL,
470         DMI_BOARD_ASSET_TAG,
471         DMI_CHASSIS_VENDOR,
472         DMI_CHASSIS_TYPE,
473         DMI_CHASSIS_VERSION,
474         DMI_CHASSIS_SERIAL,
475         DMI_CHASSIS_ASSET_TAG,
476         DMI_STRING_MAX,
477 };
478
479 struct dmi_strmatch {
480         unsigned char slot;
481         char substr[79];
482 };
483
484 #ifndef __KERNEL__
485 struct dmi_system_id {
486         kernel_ulong_t callback;
487         kernel_ulong_t ident;
488         struct dmi_strmatch matches[4];
489         kernel_ulong_t driver_data
490                         __attribute__((aligned(sizeof(kernel_ulong_t))));
491 };
492 #else
493 struct dmi_system_id {
494         int (*callback)(const struct dmi_system_id *);
495         const char *ident;
496         struct dmi_strmatch matches[4];
497         void *driver_data;
498 };
499 /*
500  * struct dmi_device_id appears during expansion of
501  * "MODULE_DEVICE_TABLE(dmi, x)". Compiler doesn't look inside it
502  * but this is enough for gcc 3.4.6 to error out:
503  *      error: storage size of '__mod_dmi_device_table' isn't known
504  */
505 #define dmi_device_id dmi_system_id
506 #endif
507
508 #define DMI_MATCH(a, b) { a, b }
509
510 #define PLATFORM_NAME_SIZE      20
511 #define PLATFORM_MODULE_PREFIX  "platform:"
512
513 struct platform_device_id {
514         char name[PLATFORM_NAME_SIZE];
515         kernel_ulong_t driver_data
516                         __attribute__((aligned(sizeof(kernel_ulong_t))));
517 };
518
519 #define MDIO_MODULE_PREFIX      "mdio:"
520
521 #define MDIO_ID_FMT "%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d%d"
522 #define MDIO_ID_ARGS(_id) \
523         (_id)>>31, ((_id)>>30) & 1, ((_id)>>29) & 1, ((_id)>>28) & 1,   \
524         ((_id)>>27) & 1, ((_id)>>26) & 1, ((_id)>>25) & 1, ((_id)>>24) & 1, \
525         ((_id)>>23) & 1, ((_id)>>22) & 1, ((_id)>>21) & 1, ((_id)>>20) & 1, \
526         ((_id)>>19) & 1, ((_id)>>18) & 1, ((_id)>>17) & 1, ((_id)>>16) & 1, \
527         ((_id)>>15) & 1, ((_id)>>14) & 1, ((_id)>>13) & 1, ((_id)>>12) & 1, \
528         ((_id)>>11) & 1, ((_id)>>10) & 1, ((_id)>>9) & 1, ((_id)>>8) & 1, \
529         ((_id)>>7) & 1, ((_id)>>6) & 1, ((_id)>>5) & 1, ((_id)>>4) & 1, \
530         ((_id)>>3) & 1, ((_id)>>2) & 1, ((_id)>>1) & 1, (_id) & 1
531
532 /**
533  * struct mdio_device_id - identifies PHY devices on an MDIO/MII bus
534  * @phy_id: The result of
535  *     (mdio_read(&MII_PHYSID1) << 16 | mdio_read(&PHYSID2)) & @phy_id_mask
536  *     for this PHY type
537  * @phy_id_mask: Defines the significant bits of @phy_id.  A value of 0
538  *     is used to terminate an array of struct mdio_device_id.
539  */
540 struct mdio_device_id {
541         __u32 phy_id;
542         __u32 phy_id_mask;
543 };
544
545 struct zorro_device_id {
546         __u32 id;                       /* Device ID or ZORRO_WILDCARD */
547         kernel_ulong_t driver_data;     /* Data private to the driver */
548 };
549
550 #define ZORRO_WILDCARD                  (0xffffffff)    /* not official */
551
552 #define ZORRO_DEVICE_MODALIAS_FMT       "zorro:i%08X"
553
554 #define ISAPNP_ANY_ID           0xffff
555 struct isapnp_device_id {
556         unsigned short card_vendor, card_device;
557         unsigned short vendor, function;
558         kernel_ulong_t driver_data;     /* data private to the driver */
559 };
560
561 /**
562  * struct amba_id - identifies a device on an AMBA bus
563  * @id: The significant bits if the hardware device ID
564  * @mask: Bitmask specifying which bits of the id field are significant when
565  *      matching.  A driver binds to a device when ((hardware device ID) & mask)
566  *      == id.
567  * @data: Private data used by the driver.
568  */
569 struct amba_id {
570         unsigned int            id;
571         unsigned int            mask;
572 #ifndef __KERNEL__
573         kernel_ulong_t          data;
574 #else
575         void                    *data;
576 #endif
577 };
578
579 /*
580  * Match x86 CPUs for CPU specific drivers.
581  * See documentation of "x86_match_cpu" for details.
582  */
583
584 struct x86_cpu_id {
585         __u16 vendor;
586         __u16 family;
587         __u16 model;
588         __u16 feature;  /* bit index */
589         kernel_ulong_t driver_data;
590 };
591
592 #define X86_FEATURE_MATCH(x) \
593         { X86_VENDOR_ANY, X86_FAMILY_ANY, X86_MODEL_ANY, x }
594
595 #define X86_VENDOR_ANY 0xffff
596 #define X86_FAMILY_ANY 0
597 #define X86_MODEL_ANY  0
598 #define X86_FEATURE_ANY 0       /* Same as FPU, you can't test for that */
599
600 #endif /* LINUX_MOD_DEVICETABLE_H */