1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Device tables which are exported to userspace via
4  * scripts/mod/file2alias.c.  You must keep that file in sync with this
5  * header.
6  */
7 
8 #ifndef LINUX_MOD_DEVICETABLE_H
9 #define LINUX_MOD_DEVICETABLE_H
10 
11 #ifdef __KERNEL__
12 #include <linux/types.h>
13 #include <linux/uuid.h>
14 typedef unsigned long kernel_ulong_t;
15 #endif
16 
17 #define PCI_ANY_ID (~0)
18 
19 /**
20  * struct pci_device_id - PCI device ID structure
21  * @vendor:		Vendor ID to match (or PCI_ANY_ID)
22  * @device:		Device ID to match (or PCI_ANY_ID)
23  * @subvendor:		Subsystem vendor ID to match (or PCI_ANY_ID)
24  * @subdevice:		Subsystem device ID to match (or PCI_ANY_ID)
25  * @class:		Device class, subclass, and "interface" to match.
26  *			See Appendix D of the PCI Local Bus Spec or
27  *			include/linux/pci_ids.h for a full list of classes.
28  *			Most drivers do not need to specify class/class_mask
29  *			as vendor/device is normally sufficient.
30  * @class_mask:		Limit which sub-fields of the class field are compared.
31  *			See drivers/scsi/sym53c8xx_2/ for example of usage.
32  * @driver_data:	Data private to the driver.
33  *			Most drivers don't need to use driver_data field.
34  *			Best practice is to use driver_data as an index
35  *			into a static list of equivalent device types,
36  *			instead of using it as a pointer.
37  */
38 struct pci_device_id {
39 	__u32 vendor, device;		/* Vendor and device ID or PCI_ANY_ID*/
40 	__u32 subvendor, subdevice;	/* Subsystem ID's or PCI_ANY_ID */
41 	__u32 class, class_mask;	/* (class,subclass,prog-if) triplet */
42 	kernel_ulong_t driver_data;	/* Data private to the driver */
43 };
44 
45 
46 #define IEEE1394_MATCH_VENDOR_ID	0x0001
47 #define IEEE1394_MATCH_MODEL_ID		0x0002
48 #define IEEE1394_MATCH_SPECIFIER_ID	0x0004
49 #define IEEE1394_MATCH_VERSION		0x0008
50 
51 struct ieee1394_device_id {
52 	__u32 match_flags;
53 	__u32 vendor_id;
54 	__u32 model_id;
55 	__u32 specifier_id;
56 	__u32 version;
57 	kernel_ulong_t driver_data;
58 };
59 
60 
61 /*
62  * Device table entry for "new style" table-driven USB drivers.
63  * User mode code can read these tables to choose which modules to load.
64  * Declare the table as a MODULE_DEVICE_TABLE.
65  *
66  * A probe() parameter will point to a matching entry from this table.
67  * Use the driver_info field for each match to hold information tied
68  * to that match:  device quirks, etc.
69  *
70  * Terminate the driver's table with an all-zeroes entry.
71  * Use the flag values to control which fields are compared.
72  */
73 
74 /**
75  * struct usb_device_id - identifies USB devices for probing and hotplugging
76  * @match_flags: Bit mask controlling which of the other fields are used to
77  *	match against new devices. Any field except for driver_info may be
78  *	used, although some only make sense in conjunction with other fields.
79  *	This is usually set by a USB_DEVICE_*() macro, which sets all
80  *	other fields in this structure except for driver_info.
81  * @idVendor: USB vendor ID for a device; numbers are assigned
82  *	by the USB forum to its members.
83  * @idProduct: Vendor-assigned product ID.
84  * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
85  *	This is also used to identify individual product versions, for
86  *	a range consisting of a single device.
87  * @bcdDevice_hi: High end of version number range.  The range of product
88  *	versions is inclusive.
89  * @bDeviceClass: Class of device; numbers are assigned
90  *	by the USB forum.  Products may choose to implement classes,
91  *	or be vendor-specific.  Device classes specify behavior of all
92  *	the interfaces on a device.
93  * @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
94  * @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
95  * @bInterfaceClass: Class of interface; numbers are assigned
96  *	by the USB forum.  Products may choose to implement classes,
97  *	or be vendor-specific.  Interface classes specify behavior only
98  *	of a given interface; other interfaces may support other classes.
99  * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
100  * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
101  * @bInterfaceNumber: Number of interface; composite devices may use
102  *	fixed interface numbers to differentiate between vendor-specific
103  *	interfaces.
104  * @driver_info: Holds information used by the driver.  Usually it holds
105  *	a pointer to a descriptor understood by the driver, or perhaps
106  *	device flags.
107  *
108  * In most cases, drivers will create a table of device IDs by using
109  * USB_DEVICE(), or similar macros designed for that purpose.
110  * They will then export it to userspace using MODULE_DEVICE_TABLE(),
111  * and provide it to the USB core through their usb_driver structure.
112  *
113  * See the usb_match_id() function for information about how matches are
114  * performed.  Briefly, you will normally use one of several macros to help
115  * construct these entries.  Each entry you provide will either identify
116  * one or more specific products, or will identify a class of products
117  * which have agreed to behave the same.  You should put the more specific
118  * matches towards the beginning of your table, so that driver_info can
119  * record quirks of specific products.
120  */
121 struct usb_device_id {
122 	/* which fields to match against? */
123 	__u16		match_flags;
124 
125 	/* Used for product specific matches; range is inclusive */
126 	__u16		idVendor;
127 	__u16		idProduct;
128 	__u16		bcdDevice_lo;
129 	__u16		bcdDevice_hi;
130 
131 	/* Used for device class matches */
132 	__u8		bDeviceClass;
133 	__u8		bDeviceSubClass;
134 	__u8		bDeviceProtocol;
135 
136 	/* Used for interface class matches */
137 	__u8		bInterfaceClass;
138 	__u8		bInterfaceSubClass;
139 	__u8		bInterfaceProtocol;
140 
141 	/* Used for vendor-specific interface matches */
142 	__u8		bInterfaceNumber;
143 
144 	/* not matched against */
145 	kernel_ulong_t	driver_info
146 		__attribute__((aligned(sizeof(kernel_ulong_t))));
147 };
148 
149 /* Some useful macros to use to create struct usb_device_id */
150 #define USB_DEVICE_ID_MATCH_VENDOR		0x0001
151 #define USB_DEVICE_ID_MATCH_PRODUCT		0x0002
152 #define USB_DEVICE_ID_MATCH_DEV_LO		0x0004
153 #define USB_DEVICE_ID_MATCH_DEV_HI		0x0008
154 #define USB_DEVICE_ID_MATCH_DEV_CLASS		0x0010
155 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS	0x0020
156 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL	0x0040
157 #define USB_DEVICE_ID_MATCH_INT_CLASS		0x0080
158 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS	0x0100
159 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL	0x0200
160 #define USB_DEVICE_ID_MATCH_INT_NUMBER		0x0400
161 
162 #define HID_ANY_ID				(~0)
163 #define HID_BUS_ANY				0xffff
164 #define HID_GROUP_ANY				0x0000
165 
166 struct hid_device_id {
167 	__u16 bus;
168 	__u16 group;
169 	__u32 vendor;
170 	__u32 product;
171 	kernel_ulong_t driver_data;
172 };
173 
174 /* s390 CCW devices */
175 struct ccw_device_id {
176 	__u16	match_flags;	/* which fields to match against */
177 
178 	__u16	cu_type;	/* control unit type     */
179 	__u16	dev_type;	/* device type           */
180 	__u8	cu_model;	/* control unit model    */
181 	__u8	dev_model;	/* device model          */
182 
183 	kernel_ulong_t driver_info;
184 };
185 
186 #define CCW_DEVICE_ID_MATCH_CU_TYPE		0x01
187 #define CCW_DEVICE_ID_MATCH_CU_MODEL		0x02
188 #define CCW_DEVICE_ID_MATCH_DEVICE_TYPE		0x04
189 #define CCW_DEVICE_ID_MATCH_DEVICE_MODEL	0x08
190 
191 /* s390 AP bus devices */
192 struct ap_device_id {
193 	__u16 match_flags;	/* which fields to match against */
194 	__u8 dev_type;		/* device type */
195 	kernel_ulong_t driver_info;
196 };
197 
198 #define AP_DEVICE_ID_MATCH_CARD_TYPE		0x01
199 #define AP_DEVICE_ID_MATCH_QUEUE_TYPE		0x02
200 
201 /* s390 css bus devices (subchannels) */
202 struct css_device_id {
203 	__u8 match_flags;
204 	__u8 type; /* subchannel type */
205 	kernel_ulong_t driver_data;
206 };
207 
208 #define ACPI_ID_LEN	9
209 
210 struct acpi_device_id {
211 	__u8 id[ACPI_ID_LEN];
212 	kernel_ulong_t driver_data;
213 	__u32 cls;
214 	__u32 cls_msk;
215 };
216 
217 #define PNP_ID_LEN	8
218 #define PNP_MAX_DEVICES	8
219 
220 struct pnp_device_id {
221 	__u8 id[PNP_ID_LEN];
222 	kernel_ulong_t driver_data;
223 };
224 
225 struct pnp_card_device_id {
226 	__u8 id[PNP_ID_LEN];
227 	kernel_ulong_t driver_data;
228 	struct {
229 		__u8 id[PNP_ID_LEN];
230 	} devs[PNP_MAX_DEVICES];
231 };
232 
233 
234 #define SERIO_ANY	0xff
235 
236 struct serio_device_id {
237 	__u8 type;
238 	__u8 extra;
239 	__u8 id;
240 	__u8 proto;
241 };
242 
243 struct hda_device_id {
244 	__u32 vendor_id;
245 	__u32 rev_id;
246 	__u8 api_version;
247 	const char *name;
248 	unsigned long driver_data;
249 };
250 
251 struct sdw_device_id {
252 	__u16 mfg_id;
253 	__u16 part_id;
254 	__u8  sdw_version;
255 	__u8  class_id;
256 	kernel_ulong_t driver_data;
257 };
258 
259 /*
260  * Struct used for matching a device
261  */
262 struct of_device_id {
263 	char	name[32];
264 	char	type[32];
265 	char	compatible[128];
266 	const void *data;
267 };
268 
269 /* VIO */
270 struct vio_device_id {
271 	char type[32];
272 	char compat[32];
273 };
274 
275 /* PCMCIA */
276 
277 struct pcmcia_device_id {
278 	__u16		match_flags;
279 
280 	__u16		manf_id;
281 	__u16		card_id;
282 
283 	__u8		func_id;
284 
285 	/* for real multi-function devices */
286 	__u8		function;
287 
288 	/* for pseudo multi-function devices */
289 	__u8		device_no;
290 
291 	__u32		prod_id_hash[4];
292 
293 	/* not matched against in kernelspace */
294 	const char *	prod_id[4];
295 
296 	/* not matched against */
297 	kernel_ulong_t	driver_info;
298 	char *		cisfile;
299 };
300 
301 #define PCMCIA_DEV_ID_MATCH_MANF_ID	0x0001
302 #define PCMCIA_DEV_ID_MATCH_CARD_ID	0x0002
303 #define PCMCIA_DEV_ID_MATCH_FUNC_ID	0x0004
304 #define PCMCIA_DEV_ID_MATCH_FUNCTION	0x0008
305 #define PCMCIA_DEV_ID_MATCH_PROD_ID1	0x0010
306 #define PCMCIA_DEV_ID_MATCH_PROD_ID2	0x0020
307 #define PCMCIA_DEV_ID_MATCH_PROD_ID3	0x0040
308 #define PCMCIA_DEV_ID_MATCH_PROD_ID4	0x0080
309 #define PCMCIA_DEV_ID_MATCH_DEVICE_NO	0x0100
310 #define PCMCIA_DEV_ID_MATCH_FAKE_CIS	0x0200
311 #define PCMCIA_DEV_ID_MATCH_ANONYMOUS	0x0400
312 
313 /* Input */
314 #define INPUT_DEVICE_ID_EV_MAX		0x1f
315 #define INPUT_DEVICE_ID_KEY_MIN_INTERESTING	0x71
316 #define INPUT_DEVICE_ID_KEY_MAX		0x2ff
317 #define INPUT_DEVICE_ID_REL_MAX		0x0f
318 #define INPUT_DEVICE_ID_ABS_MAX		0x3f
319 #define INPUT_DEVICE_ID_MSC_MAX		0x07
320 #define INPUT_DEVICE_ID_LED_MAX		0x0f
321 #define INPUT_DEVICE_ID_SND_MAX		0x07
322 #define INPUT_DEVICE_ID_FF_MAX		0x7f
323 #define INPUT_DEVICE_ID_SW_MAX		0x10
324 #define INPUT_DEVICE_ID_PROP_MAX	0x1f
325 
326 #define INPUT_DEVICE_ID_MATCH_BUS	1
327 #define INPUT_DEVICE_ID_MATCH_VENDOR	2
328 #define INPUT_DEVICE_ID_MATCH_PRODUCT	4
329 #define INPUT_DEVICE_ID_MATCH_VERSION	8
330 
331 #define INPUT_DEVICE_ID_MATCH_EVBIT	0x0010
332 #define INPUT_DEVICE_ID_MATCH_KEYBIT	0x0020
333 #define INPUT_DEVICE_ID_MATCH_RELBIT	0x0040
334 #define INPUT_DEVICE_ID_MATCH_ABSBIT	0x0080
335 #define INPUT_DEVICE_ID_MATCH_MSCIT	0x0100
336 #define INPUT_DEVICE_ID_MATCH_LEDBIT	0x0200
337 #define INPUT_DEVICE_ID_MATCH_SNDBIT	0x0400
338 #define INPUT_DEVICE_ID_MATCH_FFBIT	0x0800
339 #define INPUT_DEVICE_ID_MATCH_SWBIT	0x1000
340 #define INPUT_DEVICE_ID_MATCH_PROPBIT	0x2000
341 
342 struct input_device_id {
343 
344 	kernel_ulong_t flags;
345 
346 	__u16 bustype;
347 	__u16 vendor;
348 	__u16 product;
349 	__u16 version;
350 
351 	kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
352 	kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
353 	kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
354 	kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
355 	kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
356 	kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
357 	kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
358 	kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
359 	kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];
360 	kernel_ulong_t propbit[INPUT_DEVICE_ID_PROP_MAX / BITS_PER_LONG + 1];
361 
362 	kernel_ulong_t driver_info;
363 };
364 
365 /* EISA */
366 
367 #define EISA_SIG_LEN   8
368 
369 /* The EISA signature, in ASCII form, null terminated */
370 struct eisa_device_id {
371 	char          sig[EISA_SIG_LEN];
372 	kernel_ulong_t driver_data;
373 };
374 
375 #define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"
376 
377 struct parisc_device_id {
378 	__u8	hw_type;	/* 5 bits used */
379 	__u8	hversion_rev;	/* 4 bits */
380 	__u16	hversion;	/* 12 bits */
381 	__u32	sversion;	/* 20 bits */
382 };
383 
384 #define PA_HWTYPE_ANY_ID	0xff
385 #define PA_HVERSION_REV_ANY_ID	0xff
386 #define PA_HVERSION_ANY_ID	0xffff
387 #define PA_SVERSION_ANY_ID	0xffffffff
388 
389 /* SDIO */
390 
391 #define SDIO_ANY_ID (~0)
392 
393 struct sdio_device_id {
394 	__u8	class;			/* Standard interface or SDIO_ANY_ID */
395 	__u16	vendor;			/* Vendor or SDIO_ANY_ID */
396 	__u16	device;			/* Device ID or SDIO_ANY_ID */
397 	kernel_ulong_t driver_data;	/* Data private to the driver */
398 };
399 
400 /* SSB core, see drivers/ssb/ */
401 struct ssb_device_id {
402 	__u16	vendor;
403 	__u16	coreid;
404 	__u8	revision;
405 	__u8	__pad;
406 } __attribute__((packed, aligned(2)));
407 #define SSB_DEVICE(_vendor, _coreid, _revision)  \
408 	{ .vendor = _vendor, .coreid = _coreid, .revision = _revision, }
409 
410 #define SSB_ANY_VENDOR		0xFFFF
411 #define SSB_ANY_ID		0xFFFF
412 #define SSB_ANY_REV		0xFF
413 
414 /* Broadcom's specific AMBA core, see drivers/bcma/ */
415 struct bcma_device_id {
416 	__u16	manuf;
417 	__u16	id;
418 	__u8	rev;
419 	__u8	class;
420 } __attribute__((packed,aligned(2)));
421 #define BCMA_CORE(_manuf, _id, _rev, _class)  \
422 	{ .manuf = _manuf, .id = _id, .rev = _rev, .class = _class, }
423 
424 #define BCMA_ANY_MANUF		0xFFFF
425 #define BCMA_ANY_ID		0xFFFF
426 #define BCMA_ANY_REV		0xFF
427 #define BCMA_ANY_CLASS		0xFF
428 
429 struct virtio_device_id {
430 	__u32 device;
431 	__u32 vendor;
432 };
433 #define VIRTIO_DEV_ANY_ID	0xffffffff
434 
435 /*
436  * For Hyper-V devices we use the device guid as the id.
437  */
438 struct hv_vmbus_device_id {
439 	guid_t guid;
440 	kernel_ulong_t driver_data;	/* Data private to the driver */
441 };
442 
443 /* rpmsg */
444 
445 #define RPMSG_NAME_SIZE			32
446 #define RPMSG_DEVICE_MODALIAS_FMT	"rpmsg:%s"
447 
448 struct rpmsg_device_id {
449 	char name[RPMSG_NAME_SIZE];
450 	kernel_ulong_t driver_data;
451 };
452 
453 /* i2c */
454 
455 #define I2C_NAME_SIZE	20
456 #define I2C_MODULE_PREFIX "i2c:"
457 
458 struct i2c_device_id {
459 	char name[I2C_NAME_SIZE];
460 	kernel_ulong_t driver_data;	/* Data private to the driver */
461 };
462 
463 /* pci_epf */
464 
465 #define PCI_EPF_NAME_SIZE	20
466 #define PCI_EPF_MODULE_PREFIX	"pci_epf:"
467 
468 struct pci_epf_device_id {
469 	char name[PCI_EPF_NAME_SIZE];
470 	kernel_ulong_t driver_data;
471 };
472 
473 /* i3c */
474 
475 #define I3C_MATCH_DCR			0x1
476 #define I3C_MATCH_MANUF			0x2
477 #define I3C_MATCH_PART			0x4
478 #define I3C_MATCH_EXTRA_INFO		0x8
479 
480 struct i3c_device_id {
481 	__u8 match_flags;
482 	__u8 dcr;
483 	__u16 manuf_id;
484 	__u16 part_id;
485 	__u16 extra_info;
486 
487 	const void *data;
488 };
489 
490 /* spi */
491 
492 #define SPI_NAME_SIZE	32
493 #define SPI_MODULE_PREFIX "spi:"
494 
495 struct spi_device_id {
496 	char name[SPI_NAME_SIZE];
497 	kernel_ulong_t driver_data;	/* Data private to the driver */
498 };
499 
500 /* SLIMbus */
501 
502 #define SLIMBUS_NAME_SIZE	32
503 #define SLIMBUS_MODULE_PREFIX	"slim:"
504 
505 struct slim_device_id {
506 	__u16 manf_id, prod_code;
507 	__u16 dev_index, instance;
508 
509 	/* Data private to the driver */
510 	kernel_ulong_t driver_data;
511 };
512 
513 #define APR_NAME_SIZE	32
514 #define APR_MODULE_PREFIX "apr:"
515 
516 struct apr_device_id {
517 	char name[APR_NAME_SIZE];
518 	__u32 domain_id;
519 	__u32 svc_id;
520 	__u32 svc_version;
521 	kernel_ulong_t driver_data;	/* Data private to the driver */
522 };
523 
524 #define SPMI_NAME_SIZE	32
525 #define SPMI_MODULE_PREFIX "spmi:"
526 
527 struct spmi_device_id {
528 	char name[SPMI_NAME_SIZE];
529 	kernel_ulong_t driver_data;	/* Data private to the driver */
530 };
531 
532 /* dmi */
533 enum dmi_field {
534 	DMI_NONE,
535 	DMI_BIOS_VENDOR,
536 	DMI_BIOS_VERSION,
537 	DMI_BIOS_DATE,
538 	DMI_BIOS_RELEASE,
539 	DMI_EC_FIRMWARE_RELEASE,
540 	DMI_SYS_VENDOR,
541 	DMI_PRODUCT_NAME,
542 	DMI_PRODUCT_VERSION,
543 	DMI_PRODUCT_SERIAL,
544 	DMI_PRODUCT_UUID,
545 	DMI_PRODUCT_SKU,
546 	DMI_PRODUCT_FAMILY,
547 	DMI_BOARD_VENDOR,
548 	DMI_BOARD_NAME,
549 	DMI_BOARD_VERSION,
550 	DMI_BOARD_SERIAL,
551 	DMI_BOARD_ASSET_TAG,
552 	DMI_CHASSIS_VENDOR,
553 	DMI_CHASSIS_TYPE,
554 	DMI_CHASSIS_VERSION,
555 	DMI_CHASSIS_SERIAL,
556 	DMI_CHASSIS_ASSET_TAG,
557 	DMI_STRING_MAX,
558 	DMI_OEM_STRING,	/* special case - will not be in dmi_ident */
559 };
560 
561 struct dmi_strmatch {
562 	unsigned char slot:7;
563 	unsigned char exact_match:1;
564 	char substr[79];
565 };
566 
567 struct dmi_system_id {
568 	int (*callback)(const struct dmi_system_id *);
569 	const char *ident;
570 	struct dmi_strmatch matches[4];
571 	void *driver_data;
572 };
573 /*
574  * struct dmi_device_id appears during expansion of
575  * "MODULE_DEVICE_TABLE(dmi, x)". Compiler doesn't look inside it
576  * but this is enough for gcc 3.4.6 to error out:
577  *	error: storage size of '__mod_dmi_device_table' isn't known
578  */
579 #define dmi_device_id dmi_system_id
580 
581 #define DMI_MATCH(a, b)	{ .slot = a, .substr = b }
582 #define DMI_EXACT_MATCH(a, b)	{ .slot = a, .substr = b, .exact_match = 1 }
583 
584 #define PLATFORM_NAME_SIZE	20
585 #define PLATFORM_MODULE_PREFIX	"platform:"
586 
587 struct platform_device_id {
588 	char name[PLATFORM_NAME_SIZE];
589 	kernel_ulong_t driver_data;
590 };
591 
592 #define MDIO_NAME_SIZE		32
593 #define MDIO_MODULE_PREFIX	"mdio:"
594 
595 #define MDIO_ID_FMT "%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u%u"
596 #define MDIO_ID_ARGS(_id) \
597 	((_id)>>31) & 1, ((_id)>>30) & 1, ((_id)>>29) & 1, ((_id)>>28) & 1, \
598 	((_id)>>27) & 1, ((_id)>>26) & 1, ((_id)>>25) & 1, ((_id)>>24) & 1, \
599 	((_id)>>23) & 1, ((_id)>>22) & 1, ((_id)>>21) & 1, ((_id)>>20) & 1, \
600 	((_id)>>19) & 1, ((_id)>>18) & 1, ((_id)>>17) & 1, ((_id)>>16) & 1, \
601 	((_id)>>15) & 1, ((_id)>>14) & 1, ((_id)>>13) & 1, ((_id)>>12) & 1, \
602 	((_id)>>11) & 1, ((_id)>>10) & 1, ((_id)>>9) & 1, ((_id)>>8) & 1, \
603 	((_id)>>7) & 1, ((_id)>>6) & 1, ((_id)>>5) & 1, ((_id)>>4) & 1, \
604 	((_id)>>3) & 1, ((_id)>>2) & 1, ((_id)>>1) & 1, (_id) & 1
605 
606 /**
607  * struct mdio_device_id - identifies PHY devices on an MDIO/MII bus
608  * @phy_id: The result of
609  *     (mdio_read(&MII_PHYSID1) << 16 | mdio_read(&MII_PHYSID2)) & @phy_id_mask
610  *     for this PHY type
611  * @phy_id_mask: Defines the significant bits of @phy_id.  A value of 0
612  *     is used to terminate an array of struct mdio_device_id.
613  */
614 struct mdio_device_id {
615 	__u32 phy_id;
616 	__u32 phy_id_mask;
617 };
618 
619 struct zorro_device_id {
620 	__u32 id;			/* Device ID or ZORRO_WILDCARD */
621 	kernel_ulong_t driver_data;	/* Data private to the driver */
622 };
623 
624 #define ZORRO_WILDCARD			(0xffffffff)	/* not official */
625 
626 #define ZORRO_DEVICE_MODALIAS_FMT	"zorro:i%08X"
627 
628 #define ISAPNP_ANY_ID		0xffff
629 struct isapnp_device_id {
630 	unsigned short card_vendor, card_device;
631 	unsigned short vendor, function;
632 	kernel_ulong_t driver_data;	/* data private to the driver */
633 };
634 
635 /**
636  * struct amba_id - identifies a device on an AMBA bus
637  * @id: The significant bits if the hardware device ID
638  * @mask: Bitmask specifying which bits of the id field are significant when
639  *	matching.  A driver binds to a device when ((hardware device ID) & mask)
640  *	== id.
641  * @data: Private data used by the driver.
642  */
643 struct amba_id {
644 	unsigned int		id;
645 	unsigned int		mask;
646 	void			*data;
647 };
648 
649 /**
650  * struct mips_cdmm_device_id - identifies devices in MIPS CDMM bus
651  * @type:	Device type identifier.
652  */
653 struct mips_cdmm_device_id {
654 	__u8	type;
655 };
656 
657 /*
658  * Match x86 CPUs for CPU specific drivers.
659  * See documentation of "x86_match_cpu" for details.
660  */
661 
662 /*
663  * MODULE_DEVICE_TABLE expects this struct to be called x86cpu_device_id.
664  * Although gcc seems to ignore this error, clang fails without this define.
665  */
666 #define x86cpu_device_id x86_cpu_id
667 struct x86_cpu_id {
668 	__u16 vendor;
669 	__u16 family;
670 	__u16 model;
671 	__u16 steppings;
672 	__u16 feature;	/* bit index */
673 	kernel_ulong_t driver_data;
674 };
675 
676 /* Wild cards for x86_cpu_id::vendor, family, model and feature */
677 #define X86_VENDOR_ANY 0xffff
678 #define X86_FAMILY_ANY 0
679 #define X86_MODEL_ANY  0
680 #define X86_STEPPING_ANY 0
681 #define X86_FEATURE_ANY 0	/* Same as FPU, you can't test for that */
682 
683 /*
684  * Generic table type for matching CPU features.
685  * @feature:	the bit number of the feature (0 - 65535)
686  */
687 
688 struct cpu_feature {
689 	__u16	feature;
690 };
691 
692 #define IPACK_ANY_FORMAT 0xff
693 #define IPACK_ANY_ID (~0)
694 struct ipack_device_id {
695 	__u8  format;			/* Format version or IPACK_ANY_ID */
696 	__u32 vendor;			/* Vendor ID or IPACK_ANY_ID */
697 	__u32 device;			/* Device ID or IPACK_ANY_ID */
698 };
699 
700 #define MEI_CL_MODULE_PREFIX "mei:"
701 #define MEI_CL_NAME_SIZE 32
702 #define MEI_CL_VERSION_ANY 0xff
703 
704 /**
705  * struct mei_cl_device_id - MEI client device identifier
706  * @name: helper name
707  * @uuid: client uuid
708  * @version: client protocol version
709  * @driver_info: information used by the driver.
710  *
711  * identifies mei client device by uuid and name
712  */
713 struct mei_cl_device_id {
714 	char name[MEI_CL_NAME_SIZE];
715 	uuid_le uuid;
716 	__u8    version;
717 	kernel_ulong_t driver_info;
718 };
719 
720 /* RapidIO */
721 
722 #define RIO_ANY_ID	0xffff
723 
724 /**
725  * struct rio_device_id - RIO device identifier
726  * @did: RapidIO device ID
727  * @vid: RapidIO vendor ID
728  * @asm_did: RapidIO assembly device ID
729  * @asm_vid: RapidIO assembly vendor ID
730  *
731  * Identifies a RapidIO device based on both the device/vendor IDs and
732  * the assembly device/vendor IDs.
733  */
734 struct rio_device_id {
735 	__u16 did, vid;
736 	__u16 asm_did, asm_vid;
737 };
738 
739 struct mcb_device_id {
740 	__u16 device;
741 	kernel_ulong_t driver_data;
742 };
743 
744 struct ulpi_device_id {
745 	__u16 vendor;
746 	__u16 product;
747 	kernel_ulong_t driver_data;
748 };
749 
750 /**
751  * struct fsl_mc_device_id - MC object device identifier
752  * @vendor: vendor ID
753  * @obj_type: MC object type
754  *
755  * Type of entries in the "device Id" table for MC object devices supported by
756  * a MC object device driver. The last entry of the table has vendor set to 0x0
757  */
758 struct fsl_mc_device_id {
759 	__u16 vendor;
760 	const char obj_type[16];
761 };
762 
763 /**
764  * struct tb_service_id - Thunderbolt service identifiers
765  * @match_flags: Flags used to match the structure
766  * @protocol_key: Protocol key the service supports
767  * @protocol_id: Protocol id the service supports
768  * @protocol_version: Version of the protocol
769  * @protocol_revision: Revision of the protocol software
770  * @driver_data: Driver specific data
771  *
772  * Thunderbolt XDomain services are exposed as devices where each device
773  * carries the protocol information the service supports. Thunderbolt
774  * XDomain service drivers match against that information.
775  */
776 struct tb_service_id {
777 	__u32 match_flags;
778 	char protocol_key[8 + 1];
779 	__u32 protocol_id;
780 	__u32 protocol_version;
781 	__u32 protocol_revision;
782 	kernel_ulong_t driver_data;
783 };
784 
785 #define TBSVC_MATCH_PROTOCOL_KEY	0x0001
786 #define TBSVC_MATCH_PROTOCOL_ID		0x0002
787 #define TBSVC_MATCH_PROTOCOL_VERSION	0x0004
788 #define TBSVC_MATCH_PROTOCOL_REVISION	0x0008
789 
790 /* USB Type-C Alternate Modes */
791 
792 #define TYPEC_ANY_MODE	0x7
793 
794 /**
795  * struct typec_device_id - USB Type-C alternate mode identifiers
796  * @svid: Standard or Vendor ID
797  * @mode: Mode index
798  * @driver_data: Driver specific data
799  */
800 struct typec_device_id {
801 	__u16 svid;
802 	__u8 mode;
803 	kernel_ulong_t driver_data;
804 };
805 
806 /**
807  * struct tee_client_device_id - tee based device identifier
808  * @uuid: For TEE based client devices we use the device uuid as
809  *        the identifier.
810  */
811 struct tee_client_device_id {
812 	uuid_t uuid;
813 };
814 
815 /* WMI */
816 
817 #define WMI_MODULE_PREFIX	"wmi:"
818 
819 /**
820  * struct wmi_device_id - WMI device identifier
821  * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
822  * @context: pointer to driver specific data
823  */
824 struct wmi_device_id {
825 	const char guid_string[UUID_STRING_LEN+1];
826 	const void *context;
827 };
828 
829 #define MHI_DEVICE_MODALIAS_FMT "mhi:%s"
830 #define MHI_NAME_SIZE 32
831 
832 /**
833  * struct mhi_device_id - MHI device identification
834  * @chan: MHI channel name
835  * @driver_data: driver data;
836  */
837 struct mhi_device_id {
838 	const char chan[MHI_NAME_SIZE];
839 	kernel_ulong_t driver_data;
840 };
841 
842 #define AUXILIARY_NAME_SIZE 32
843 #define AUXILIARY_MODULE_PREFIX "auxiliary:"
844 
845 struct auxiliary_device_id {
846 	char name[AUXILIARY_NAME_SIZE];
847 	kernel_ulong_t driver_data;
848 };
849 
850 /* Surface System Aggregator Module */
851 
852 #define SSAM_MATCH_TARGET	0x1
853 #define SSAM_MATCH_INSTANCE	0x2
854 #define SSAM_MATCH_FUNCTION	0x4
855 
856 struct ssam_device_id {
857 	__u8 match_flags;
858 
859 	__u8 domain;
860 	__u8 category;
861 	__u8 target;
862 	__u8 instance;
863 	__u8 function;
864 
865 	kernel_ulong_t driver_data;
866 };
867 
868 /*
869  * DFL (Device Feature List)
870  *
871  * DFL defines a linked list of feature headers within the device MMIO space to
872  * provide an extensible way of adding features. Software can walk through these
873  * predefined data structures to enumerate features. It is now used in the FPGA.
874  * See Documentation/fpga/dfl.rst for more information.
875  *
876  * The dfl bus type is introduced to match the individual feature devices (dfl
877  * devices) for specific dfl drivers.
878  */
879 
880 /**
881  * struct dfl_device_id -  dfl device identifier
882  * @type: DFL FIU type of the device. See enum dfl_id_type.
883  * @feature_id: feature identifier local to its DFL FIU type.
884  * @driver_data: driver specific data.
885  */
886 struct dfl_device_id {
887 	__u16 type;
888 	__u16 feature_id;
889 	kernel_ulong_t driver_data;
890 };
891 
892 #endif /* LINUX_MOD_DEVICETABLE_H */
893