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