mod_devicetable.h

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