nlm: Ensure callback code also checks that the files match
[GitHub/mt8127/android_kernel_alcatel_ttab.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 #include <linux/uuid.h>
13 typedef unsigned long kernel_ulong_t;
14 #endif
15
16 #define PCI_ANY_ID (~0)
17
18 struct pci_device_id {
19 __u32 vendor, device; /* Vendor and device ID or PCI_ANY_ID*/
20 __u32 subvendor, subdevice; /* Subsystem ID's or PCI_ANY_ID */
21 __u32 class, class_mask; /* (class,subclass,prog-if) triplet */
22 kernel_ulong_t driver_data; /* Data private to the driver */
23 };
24
25
26 #define IEEE1394_MATCH_VENDOR_ID 0x0001
27 #define IEEE1394_MATCH_MODEL_ID 0x0002
28 #define IEEE1394_MATCH_SPECIFIER_ID 0x0004
29 #define IEEE1394_MATCH_VERSION 0x0008
30
31 struct ieee1394_device_id {
32 __u32 match_flags;
33 __u32 vendor_id;
34 __u32 model_id;
35 __u32 specifier_id;
36 __u32 version;
37 kernel_ulong_t driver_data;
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 __attribute__((aligned(sizeof(kernel_ulong_t))));
127 };
128
129 /* Some useful macros to use to create struct usb_device_id */
130 #define USB_DEVICE_ID_MATCH_VENDOR 0x0001
131 #define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
132 #define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
133 #define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
134 #define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
135 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
136 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
137 #define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
138 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
139 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
140 #define USB_DEVICE_ID_MATCH_INT_NUMBER 0x0400
141
142 #define HID_ANY_ID (~0)
143 #define HID_BUS_ANY 0xffff
144 #define HID_GROUP_ANY 0x0000
145
146 struct hid_device_id {
147 __u16 bus;
148 __u16 group;
149 __u32 vendor;
150 __u32 product;
151 kernel_ulong_t driver_data;
152 };
153
154 /* s390 CCW devices */
155 struct ccw_device_id {
156 __u16 match_flags; /* which fields to match against */
157
158 __u16 cu_type; /* control unit type */
159 __u16 dev_type; /* device type */
160 __u8 cu_model; /* control unit model */
161 __u8 dev_model; /* device model */
162
163 kernel_ulong_t driver_info;
164 };
165
166 #define CCW_DEVICE_ID_MATCH_CU_TYPE 0x01
167 #define CCW_DEVICE_ID_MATCH_CU_MODEL 0x02
168 #define CCW_DEVICE_ID_MATCH_DEVICE_TYPE 0x04
169 #define CCW_DEVICE_ID_MATCH_DEVICE_MODEL 0x08
170
171 /* s390 AP bus devices */
172 struct ap_device_id {
173 __u16 match_flags; /* which fields to match against */
174 __u8 dev_type; /* device type */
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 kernel_ulong_t driver_data;
185 };
186
187 #define ACPI_ID_LEN 9
188
189 struct acpi_device_id {
190 __u8 id[ACPI_ID_LEN];
191 kernel_ulong_t driver_data;
192 };
193
194 #define PNP_ID_LEN 8
195 #define PNP_MAX_DEVICES 8
196
197 struct pnp_device_id {
198 __u8 id[PNP_ID_LEN];
199 kernel_ulong_t driver_data;
200 };
201
202 struct pnp_card_device_id {
203 __u8 id[PNP_ID_LEN];
204 kernel_ulong_t driver_data;
205 struct {
206 __u8 id[PNP_ID_LEN];
207 } devs[PNP_MAX_DEVICES];
208 };
209
210
211 #define SERIO_ANY 0xff
212
213 struct serio_device_id {
214 __u8 type;
215 __u8 extra;
216 __u8 id;
217 __u8 proto;
218 };
219
220 /*
221 * Struct used for matching a device
222 */
223 struct of_device_id
224 {
225 char name[32];
226 char type[32];
227 char compatible[128];
228 const void *data;
229 };
230
231 /* VIO */
232 struct vio_device_id {
233 char type[32];
234 char compat[32];
235 };
236
237 /* PCMCIA */
238
239 struct pcmcia_device_id {
240 __u16 match_flags;
241
242 __u16 manf_id;
243 __u16 card_id;
244
245 __u8 func_id;
246
247 /* for real multi-function devices */
248 __u8 function;
249
250 /* for pseudo multi-function devices */
251 __u8 device_no;
252
253 __u32 prod_id_hash[4];
254
255 /* not matched against in kernelspace*/
256 const char * prod_id[4];
257
258 /* not matched against */
259 kernel_ulong_t driver_info;
260 char * cisfile;
261 };
262
263 #define PCMCIA_DEV_ID_MATCH_MANF_ID 0x0001
264 #define PCMCIA_DEV_ID_MATCH_CARD_ID 0x0002
265 #define PCMCIA_DEV_ID_MATCH_FUNC_ID 0x0004
266 #define PCMCIA_DEV_ID_MATCH_FUNCTION 0x0008
267 #define PCMCIA_DEV_ID_MATCH_PROD_ID1 0x0010
268 #define PCMCIA_DEV_ID_MATCH_PROD_ID2 0x0020
269 #define PCMCIA_DEV_ID_MATCH_PROD_ID3 0x0040
270 #define PCMCIA_DEV_ID_MATCH_PROD_ID4 0x0080
271 #define PCMCIA_DEV_ID_MATCH_DEVICE_NO 0x0100
272 #define PCMCIA_DEV_ID_MATCH_FAKE_CIS 0x0200
273 #define PCMCIA_DEV_ID_MATCH_ANONYMOUS 0x0400
274
275 /* Input */
276 #define INPUT_DEVICE_ID_EV_MAX 0x1f
277 #define INPUT_DEVICE_ID_KEY_MIN_INTERESTING 0x71
278 #define INPUT_DEVICE_ID_KEY_MAX 0x2ff
279 #define INPUT_DEVICE_ID_REL_MAX 0x0f
280 #define INPUT_DEVICE_ID_ABS_MAX 0x3f
281 #define INPUT_DEVICE_ID_MSC_MAX 0x07
282 #define INPUT_DEVICE_ID_LED_MAX 0x0f
283 #define INPUT_DEVICE_ID_SND_MAX 0x07
284 #define INPUT_DEVICE_ID_FF_MAX 0x7f
285 #define INPUT_DEVICE_ID_SW_MAX 0x0f
286
287 #define INPUT_DEVICE_ID_MATCH_BUS 1
288 #define INPUT_DEVICE_ID_MATCH_VENDOR 2
289 #define INPUT_DEVICE_ID_MATCH_PRODUCT 4
290 #define INPUT_DEVICE_ID_MATCH_VERSION 8
291
292 #define INPUT_DEVICE_ID_MATCH_EVBIT 0x0010
293 #define INPUT_DEVICE_ID_MATCH_KEYBIT 0x0020
294 #define INPUT_DEVICE_ID_MATCH_RELBIT 0x0040
295 #define INPUT_DEVICE_ID_MATCH_ABSBIT 0x0080
296 #define INPUT_DEVICE_ID_MATCH_MSCIT 0x0100
297 #define INPUT_DEVICE_ID_MATCH_LEDBIT 0x0200
298 #define INPUT_DEVICE_ID_MATCH_SNDBIT 0x0400
299 #define INPUT_DEVICE_ID_MATCH_FFBIT 0x0800
300 #define INPUT_DEVICE_ID_MATCH_SWBIT 0x1000
301
302 struct input_device_id {
303
304 kernel_ulong_t flags;
305
306 __u16 bustype;
307 __u16 vendor;
308 __u16 product;
309 __u16 version;
310
311 kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
312 kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
313 kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
314 kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
315 kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
316 kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
317 kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
318 kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
319 kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];
320
321 kernel_ulong_t driver_info;
322 };
323
324 /* EISA */
325
326 #define EISA_SIG_LEN 8
327
328 /* The EISA signature, in ASCII form, null terminated */
329 struct eisa_device_id {
330 char sig[EISA_SIG_LEN];
331 kernel_ulong_t driver_data;
332 };
333
334 #define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"
335
336 struct parisc_device_id {
337 __u8 hw_type; /* 5 bits used */
338 __u8 hversion_rev; /* 4 bits */
339 __u16 hversion; /* 12 bits */
340 __u32 sversion; /* 20 bits */
341 };
342
343 #define PA_HWTYPE_ANY_ID 0xff
344 #define PA_HVERSION_REV_ANY_ID 0xff
345 #define PA_HVERSION_ANY_ID 0xffff
346 #define PA_SVERSION_ANY_ID 0xffffffff
347
348 /* SDIO */
349
350 #define SDIO_ANY_ID (~0)
351
352 struct sdio_device_id {
353 __u8 class; /* Standard interface or SDIO_ANY_ID */
354 __u16 vendor; /* Vendor or SDIO_ANY_ID */
355 __u16 device; /* Device ID or SDIO_ANY_ID */
356 kernel_ulong_t driver_data; /* Data private to the driver */
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 /* Broadcom's specific AMBA core, see drivers/bcma/ */
375 struct bcma_device_id {
376 __u16 manuf;
377 __u16 id;
378 __u8 rev;
379 __u8 class;
380 };
381 #define BCMA_CORE(_manuf, _id, _rev, _class) \
382 { .manuf = _manuf, .id = _id, .rev = _rev, .class = _class, }
383 #define BCMA_CORETABLE_END \
384 { 0, },
385
386 #define BCMA_ANY_MANUF 0xFFFF
387 #define BCMA_ANY_ID 0xFFFF
388 #define BCMA_ANY_REV 0xFF
389 #define BCMA_ANY_CLASS 0xFF
390
391 struct virtio_device_id {
392 __u32 device;
393 __u32 vendor;
394 };
395 #define VIRTIO_DEV_ANY_ID 0xffffffff
396
397 /*
398 * For Hyper-V devices we use the device guid as the id.
399 */
400 #define vmbus_device_id hv_vmbus_device_id
401 struct hv_vmbus_device_id {
402 __u8 guid[16];
403 kernel_ulong_t driver_data; /* Data private to the driver */
404 };
405
406 /* rpmsg */
407
408 #define RPMSG_NAME_SIZE 32
409 #define RPMSG_DEVICE_MODALIAS_FMT "rpmsg:%s"
410
411 struct rpmsg_device_id {
412 char name[RPMSG_NAME_SIZE];
413 };
414
415 /* i2c */
416
417 #define I2C_NAME_SIZE 20
418 #define I2C_MODULE_PREFIX "i2c:"
419
420 struct i2c_device_id {
421 char name[I2C_NAME_SIZE];
422 kernel_ulong_t driver_data; /* Data private to the driver */
423 };
424
425 /* spi */
426
427 #define SPI_NAME_SIZE 32
428 #define SPI_MODULE_PREFIX "spi:"
429
430 struct spi_device_id {
431 char name[SPI_NAME_SIZE];
432 kernel_ulong_t driver_data; /* Data private to the driver */
433 };
434
435 /* dmi */
436 enum dmi_field {
437 DMI_NONE,
438 DMI_BIOS_VENDOR,
439 DMI_BIOS_VERSION,
440 DMI_BIOS_DATE,
441 DMI_SYS_VENDOR,
442 DMI_PRODUCT_NAME,
443 DMI_PRODUCT_VERSION,
444 DMI_PRODUCT_SERIAL,
445 DMI_PRODUCT_UUID,
446 DMI_BOARD_VENDOR,
447 DMI_BOARD_NAME,
448 DMI_BOARD_VERSION,
449 DMI_BOARD_SERIAL,
450 DMI_BOARD_ASSET_TAG,
451 DMI_CHASSIS_VENDOR,
452 DMI_CHASSIS_TYPE,
453 DMI_CHASSIS_VERSION,
454 DMI_CHASSIS_SERIAL,
455 DMI_CHASSIS_ASSET_TAG,
456 DMI_STRING_MAX,
457 };
458
459 struct dmi_strmatch {
460 unsigned char slot:7;
461 unsigned char exact_match:1;
462 char substr[79];
463 };
464
465 struct dmi_system_id {
466 int (*callback)(const struct dmi_system_id *);
467 const char *ident;
468 struct dmi_strmatch matches[4];
469 void *driver_data;
470 };
471 /*
472 * struct dmi_device_id appears during expansion of
473 * "MODULE_DEVICE_TABLE(dmi, x)". Compiler doesn't look inside it
474 * but this is enough for gcc 3.4.6 to error out:
475 * error: storage size of '__mod_dmi_device_table' isn't known
476 */
477 #define dmi_device_id dmi_system_id
478
479 #define DMI_MATCH(a, b) { .slot = a, .substr = b }
480 #define DMI_EXACT_MATCH(a, b) { .slot = a, .substr = b, .exact_match = 1 }
481
482 #define PLATFORM_NAME_SIZE 20
483 #define PLATFORM_MODULE_PREFIX "platform:"
484
485 struct platform_device_id {
486 char name[PLATFORM_NAME_SIZE];
487 kernel_ulong_t driver_data;
488 };
489
490 #define MDIO_MODULE_PREFIX "mdio:"
491
492 #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"
493 #define MDIO_ID_ARGS(_id) \
494 (_id)>>31, ((_id)>>30) & 1, ((_id)>>29) & 1, ((_id)>>28) & 1, \
495 ((_id)>>27) & 1, ((_id)>>26) & 1, ((_id)>>25) & 1, ((_id)>>24) & 1, \
496 ((_id)>>23) & 1, ((_id)>>22) & 1, ((_id)>>21) & 1, ((_id)>>20) & 1, \
497 ((_id)>>19) & 1, ((_id)>>18) & 1, ((_id)>>17) & 1, ((_id)>>16) & 1, \
498 ((_id)>>15) & 1, ((_id)>>14) & 1, ((_id)>>13) & 1, ((_id)>>12) & 1, \
499 ((_id)>>11) & 1, ((_id)>>10) & 1, ((_id)>>9) & 1, ((_id)>>8) & 1, \
500 ((_id)>>7) & 1, ((_id)>>6) & 1, ((_id)>>5) & 1, ((_id)>>4) & 1, \
501 ((_id)>>3) & 1, ((_id)>>2) & 1, ((_id)>>1) & 1, (_id) & 1
502
503 /**
504 * struct mdio_device_id - identifies PHY devices on an MDIO/MII bus
505 * @phy_id: The result of
506 * (mdio_read(&MII_PHYSID1) << 16 | mdio_read(&PHYSID2)) & @phy_id_mask
507 * for this PHY type
508 * @phy_id_mask: Defines the significant bits of @phy_id. A value of 0
509 * is used to terminate an array of struct mdio_device_id.
510 */
511 struct mdio_device_id {
512 __u32 phy_id;
513 __u32 phy_id_mask;
514 };
515
516 struct zorro_device_id {
517 __u32 id; /* Device ID or ZORRO_WILDCARD */
518 kernel_ulong_t driver_data; /* Data private to the driver */
519 };
520
521 #define ZORRO_WILDCARD (0xffffffff) /* not official */
522
523 #define ZORRO_DEVICE_MODALIAS_FMT "zorro:i%08X"
524
525 #define ISAPNP_ANY_ID 0xffff
526 struct isapnp_device_id {
527 unsigned short card_vendor, card_device;
528 unsigned short vendor, function;
529 kernel_ulong_t driver_data; /* data private to the driver */
530 };
531
532 /**
533 * struct amba_id - identifies a device on an AMBA bus
534 * @id: The significant bits if the hardware device ID
535 * @mask: Bitmask specifying which bits of the id field are significant when
536 * matching. A driver binds to a device when ((hardware device ID) & mask)
537 * == id.
538 * @data: Private data used by the driver.
539 */
540 struct amba_id {
541 unsigned int id;
542 unsigned int mask;
543 void *data;
544 };
545
546 /*
547 * Match x86 CPUs for CPU specific drivers.
548 * See documentation of "x86_match_cpu" for details.
549 */
550
551 /*
552 * MODULE_DEVICE_TABLE expects this struct to be called x86cpu_device_id.
553 * Although gcc seems to ignore this error, clang fails without this define.
554 */
555 #define x86cpu_device_id x86_cpu_id
556 struct x86_cpu_id {
557 __u16 vendor;
558 __u16 family;
559 __u16 model;
560 __u16 feature; /* bit index */
561 kernel_ulong_t driver_data;
562 };
563
564 #define X86_FEATURE_MATCH(x) \
565 { X86_VENDOR_ANY, X86_FAMILY_ANY, X86_MODEL_ANY, x }
566
567 #define X86_VENDOR_ANY 0xffff
568 #define X86_FAMILY_ANY 0
569 #define X86_MODEL_ANY 0
570 #define X86_FEATURE_ANY 0 /* Same as FPU, you can't test for that */
571
572 #define IPACK_ANY_FORMAT 0xff
573 #define IPACK_ANY_ID (~0)
574 struct ipack_device_id {
575 __u8 format; /* Format version or IPACK_ANY_ID */
576 __u32 vendor; /* Vendor ID or IPACK_ANY_ID */
577 __u32 device; /* Device ID or IPACK_ANY_ID */
578 };
579
580 #define MEI_CL_MODULE_PREFIX "mei:"
581 #define MEI_CL_NAME_SIZE 32
582
583 #define mei_device_id mei_cl_device_id
584 struct mei_cl_device_id {
585 char name[MEI_CL_NAME_SIZE];
586 kernel_ulong_t driver_info;
587 };
588
589 #endif /* LINUX_MOD_DEVICETABLE_H */