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 /**
  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         kernel_ulong_t driver_data;
 255 };
 256
 257 /*
 258  * Struct used for matching a device
 259  */
 260 struct of_device_id {
 261         char    name[32];
 262         char    type[32];
 263         char    compatible[128];
 264         const void *data;
 265 };
 266
 267 /* VIO */
 268 struct vio_device_id {
 269         char type[32];
 270         char compat[32];
 271 };
 272
 273 /* PCMCIA */
 274
 275 struct pcmcia_device_id {
 276         __u16           match_flags;
 277
 278         __u16           manf_id;
 279         __u16           card_id;
 280
 281         __u8            func_id;
 282
 283         /* for real multi-function devices */
 284         __u8            function;
 285
 286         /* for pseudo multi-function devices */
 287         __u8            device_no;
 288
 289         __u32           prod_id_hash[4];
 290
 291         /* not matched against in kernelspace */
 292         const char *    prod_id[4];
 293
 294         /* not matched against */
 295         kernel_ulong_t  driver_info;
 296         char *          cisfile;
 297 };
 298
 299 #define PCMCIA_DEV_ID_MATCH_MANF_ID     0x0001
 300 #define PCMCIA_DEV_ID_MATCH_CARD_ID     0x0002
 301 #define PCMCIA_DEV_ID_MATCH_FUNC_ID     0x0004
 302 #define PCMCIA_DEV_ID_MATCH_FUNCTION    0x0008
 303 #define PCMCIA_DEV_ID_MATCH_PROD_ID1    0x0010
 304 #define PCMCIA_DEV_ID_MATCH_PROD_ID2    0x0020
 305 #define PCMCIA_DEV_ID_MATCH_PROD_ID3    0x0040
 306 #define PCMCIA_DEV_ID_MATCH_PROD_ID4    0x0080
 307 #define PCMCIA_DEV_ID_MATCH_DEVICE_NO   0x0100
 308 #define PCMCIA_DEV_ID_MATCH_FAKE_CIS    0x0200
 309 #define PCMCIA_DEV_ID_MATCH_ANONYMOUS   0x0400
 310
 311 /* Input */
 312 #define INPUT_DEVICE_ID_EV_MAX          0x1f
 313 #define INPUT_DEVICE_ID_KEY_MIN_INTERESTING     0x71
 314 #define INPUT_DEVICE_ID_KEY_MAX         0x2ff
 315 #define INPUT_DEVICE_ID_REL_MAX         0x0f
 316 #define INPUT_DEVICE_ID_ABS_MAX         0x3f
 317 #define INPUT_DEVICE_ID_MSC_MAX         0x07
 318 #define INPUT_DEVICE_ID_LED_MAX         0x0f
 319 #define INPUT_DEVICE_ID_SND_MAX         0x07
 320 #define INPUT_DEVICE_ID_FF_MAX          0x7f
 321 #define INPUT_DEVICE_ID_SW_MAX          0x0f
 322 #define INPUT_DEVICE_ID_PROP_MAX        0x1f
 323
 324 #define INPUT_DEVICE_ID_MATCH_BUS       1
 325 #define INPUT_DEVICE_ID_MATCH_VENDOR    2
 326 #define INPUT_DEVICE_ID_MATCH_PRODUCT   4
 327 #define INPUT_DEVICE_ID_MATCH_VERSION   8
 328
 329 #define INPUT_DEVICE_ID_MATCH_EVBIT     0x0010
 330 #define INPUT_DEVICE_ID_MATCH_KEYBIT    0x0020
 331 #define INPUT_DEVICE_ID_MATCH_RELBIT    0x0040
 332 #define INPUT_DEVICE_ID_MATCH_ABSBIT    0x0080
 333 #define INPUT_DEVICE_ID_MATCH_MSCIT     0x0100
 334 #define INPUT_DEVICE_ID_MATCH_LEDBIT    0x0200
 335 #define INPUT_DEVICE_ID_MATCH_SNDBIT    0x0400
 336 #define INPUT_DEVICE_ID_MATCH_FFBIT     0x0800
 337 #define INPUT_DEVICE_ID_MATCH_SWBIT     0x1000
 338 #define INPUT_DEVICE_ID_MATCH_PROPBIT   0x2000
 339
 340 struct input_device_id {
 341
 342         kernel_ulong_t flags;
 343
 344         __u16 bustype;
 345         __u16 vendor;
 346         __u16 product;
 347         __u16 version;
 348
 349         kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
 350         kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
 351         kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
 352         kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
 353         kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
 354         kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
 355         kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
 356         kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
 357         kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];
 358         kernel_ulong_t propbit[INPUT_DEVICE_ID_PROP_MAX / BITS_PER_LONG + 1];
 359
 360         kernel_ulong_t driver_info;
 361 };
 362
 363 /* EISA */
 364
 365 #define EISA_SIG_LEN   8
 366
 367 /* The EISA signature, in ASCII form, null terminated */
 368 struct eisa_device_id {
 369         char          sig[EISA_SIG_LEN];
 370         kernel_ulong_t driver_data;
 371 };
 372
 373 #define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"
 374
 375 struct parisc_device_id {
 376         __u8    hw_type;        /* 5 bits used */
 377         __u8    hversion_rev;   /* 4 bits */
 378         __u16   hversion;       /* 12 bits */
 379         __u32   sversion;       /* 20 bits */
 380 };
 381
 382 #define PA_HWTYPE_ANY_ID        0xff
 383 #define PA_HVERSION_REV_ANY_ID  0xff
 384 #define PA_HVERSION_ANY_ID      0xffff
 385 #define PA_SVERSION_ANY_ID      0xffffffff
 386
 387 /* SDIO */
 388
 389 #define SDIO_ANY_ID (~0)
 390
 391 struct sdio_device_id {
 392         __u8    class;                  /* Standard interface or SDIO_ANY_ID */
 393         __u16   vendor;                 /* Vendor or SDIO_ANY_ID */
 394         __u16   device;                 /* Device ID or SDIO_ANY_ID */
 395         kernel_ulong_t driver_data;     /* Data private to the driver */
 396 };
 397
 398 /* SSB core, see drivers/ssb/ */
 399 struct ssb_device_id {
 400         __u16   vendor;
 401         __u16   coreid;
 402         __u8    revision;
 403         __u8    __pad;
 404 } __attribute__((packed, aligned(2)));
 405 #define SSB_DEVICE(_vendor, _coreid, _revision)  \
 406         { .vendor = _vendor, .coreid = _coreid, .revision = _revision, }
 407
 408 #define SSB_ANY_VENDOR          0xFFFF
 409 #define SSB_ANY_ID              0xFFFF
 410 #define SSB_ANY_REV             0xFF
 411
 412 /* Broadcom's specific AMBA core, see drivers/bcma/ */
 413 struct bcma_device_id {
 414         __u16   manuf;
 415         __u16   id;
 416         __u8    rev;
 417         __u8    class;
 418 } __attribute__((packed,aligned(2)));
 419 #define BCMA_CORE(_manuf, _id, _rev, _class)  \
 420         { .manuf = _manuf, .id = _id, .rev = _rev, .class = _class, }
 421
 422 #define BCMA_ANY_MANUF          0xFFFF
 423 #define BCMA_ANY_ID             0xFFFF
 424 #define BCMA_ANY_REV            0xFF
 425 #define BCMA_ANY_CLASS          0xFF
 426
 427 struct virtio_device_id {
 428         __u32 device;
 429         __u32 vendor;
 430 };
 431 #define VIRTIO_DEV_ANY_ID       0xffffffff
 432
 433 /*
 434  * For Hyper-V devices we use the device guid as the id.
 435  */
 436 struct hv_vmbus_device_id {
 437         guid_t guid;
 438         kernel_ulong_t driver_data;     /* Data private to the driver */
 439 };
 440
 441 /* rpmsg */
 442
 443 #define RPMSG_NAME_SIZE                 32
 444 #define RPMSG_DEVICE_MODALIAS_FMT       "rpmsg:%s"
 445
 446 struct rpmsg_device_id {
 447         char name[RPMSG_NAME_SIZE];
 448 };
 449
 450 /* i2c */
 451
 452 #define I2C_NAME_SIZE   20
 453 #define I2C_MODULE_PREFIX "i2c:"
 454
 455 struct i2c_device_id {
 456         char name[I2C_NAME_SIZE];
 457         kernel_ulong_t driver_data;     /* Data private to the driver */
 458 };
 459
 460 /* pci_epf */
 461
 462 #define PCI_EPF_NAME_SIZE       20
 463 #define PCI_EPF_MODULE_PREFIX   "pci_epf:"
 464
 465 struct pci_epf_device_id {
 466         char name[PCI_EPF_NAME_SIZE];
 467         kernel_ulong_t driver_data;
 468 };
 469
 470 /* i3c */
 471
 472 #define I3C_MATCH_DCR                   0x1
 473 #define I3C_MATCH_MANUF                 0x2
 474 #define I3C_MATCH_PART                  0x4
 475 #define I3C_MATCH_EXTRA_INFO            0x8
 476
 477 struct i3c_device_id {
 478         __u8 match_flags;
 479         __u8 dcr;
 480         __u16 manuf_id;
 481         __u16 part_id;
 482         __u16 extra_info;
 483
 484         const void *data;
 485 };
 486
 487 /* spi */
 488
 489 #define SPI_NAME_SIZE   32
 490 #define SPI_MODULE_PREFIX "spi:"
 491
 492 struct spi_device_id {
 493         char name[SPI_NAME_SIZE];
 494         kernel_ulong_t driver_data;     /* Data private to the driver */
 495 };
 496
 497 /* SLIMbus */
 498
 499 #define SLIMBUS_NAME_SIZE       32
 500 #define SLIMBUS_MODULE_PREFIX   "slim:"
 501
 502 struct slim_device_id {
 503         __u16 manf_id, prod_code;
 504         __u16 dev_index, instance;
 505
 506         /* Data private to the driver */
 507         kernel_ulong_t driver_data;
 508 };
 509
 510 #define APR_NAME_SIZE   32
 511 #define APR_MODULE_PREFIX "apr:"
 512
 513 struct apr_device_id {
 514         char name[APR_NAME_SIZE];
 515         __u32 domain_id;
 516         __u32 svc_id;
 517         __u32 svc_version;
 518         kernel_ulong_t driver_data;     /* Data private to the driver */
 519 };
 520
 521 #define SPMI_NAME_SIZE  32
 522 #define SPMI_MODULE_PREFIX "spmi:"
 523
 524 struct spmi_device_id {
 525         char name[SPMI_NAME_SIZE];
 526         kernel_ulong_t driver_data;     /* Data private to the driver */
 527 };
 528
 529 /* dmi */
 530 enum dmi_field {
 531         DMI_NONE,
 532         DMI_BIOS_VENDOR,
 533         DMI_BIOS_VERSION,
 534         DMI_BIOS_DATE,
 535         DMI_BIOS_RELEASE,
 536         DMI_EC_FIRMWARE_RELEASE,
 537         DMI_SYS_VENDOR,
 538         DMI_PRODUCT_NAME,
 539         DMI_PRODUCT_VERSION,
 540         DMI_PRODUCT_SERIAL,
 541         DMI_PRODUCT_UUID,
 542         DMI_PRODUCT_SKU,
 543         DMI_PRODUCT_FAMILY,
 544         DMI_BOARD_VENDOR,
 545         DMI_BOARD_NAME,
 546         DMI_BOARD_VERSION,
 547         DMI_BOARD_SERIAL,
 548         DMI_BOARD_ASSET_TAG,
 549         DMI_CHASSIS_VENDOR,
 550         DMI_CHASSIS_TYPE,
 551         DMI_CHASSIS_VERSION,
 552         DMI_CHASSIS_SERIAL,
 553         DMI_CHASSIS_ASSET_TAG,
 554         DMI_STRING_MAX,
 555         DMI_OEM_STRING, /* special case - will not be in dmi_ident */
 556 };
 557
 558 struct dmi_strmatch {
 559         unsigned char slot:7;
 560         unsigned char exact_match:1;
 561         char substr[79];
 562 };
 563
 564 struct dmi_system_id {
 565         int (*callback)(const struct dmi_system_id *);
 566         const char *ident;
 567         struct dmi_strmatch matches[4];
 568         void *driver_data;
 569 };
 570 /*
 571  * struct dmi_device_id appears during expansion of
 572  * "MODULE_DEVICE_TABLE(dmi, x)". Compiler doesn't look inside it
 573  * but this is enough for gcc 3.4.6 to error out:
 574  *      error: storage size of '__mod_dmi_device_table' isn't known
 575  */
 576 #define dmi_device_id dmi_system_id
 577
 578 #define DMI_MATCH(a, b) { .slot = a, .substr = b }
 579 #define DMI_EXACT_MATCH(a, b)   { .slot = a, .substr = b, .exact_match = 1 }
 580
 581 #define PLATFORM_NAME_SIZE      20
 582 #define PLATFORM_MODULE_PREFIX  "platform:"
 583
 584 struct platform_device_id {
 585         char name[PLATFORM_NAME_SIZE];
 586         kernel_ulong_t driver_data;
 587 };
 588
 589 #define MDIO_NAME_SIZE          32
 590 #define MDIO_MODULE_PREFIX      "mdio:"
 591
 592 #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"
 593 #define MDIO_ID_ARGS(_id) \
 594         ((_id)>>31) & 1, ((_id)>>30) & 1, ((_id)>>29) & 1, ((_id)>>28) & 1, \
 595         ((_id)>>27) & 1, ((_id)>>26) & 1, ((_id)>>25) & 1, ((_id)>>24) & 1, \
 596         ((_id)>>23) & 1, ((_id)>>22) & 1, ((_id)>>21) & 1, ((_id)>>20) & 1, \
 597         ((_id)>>19) & 1, ((_id)>>18) & 1, ((_id)>>17) & 1, ((_id)>>16) & 1, \
 598         ((_id)>>15) & 1, ((_id)>>14) & 1, ((_id)>>13) & 1, ((_id)>>12) & 1, \
 599         ((_id)>>11) & 1, ((_id)>>10) & 1, ((_id)>>9) & 1, ((_id)>>8) & 1, \
 600         ((_id)>>7) & 1, ((_id)>>6) & 1, ((_id)>>5) & 1, ((_id)>>4) & 1, \
 601         ((_id)>>3) & 1, ((_id)>>2) & 1, ((_id)>>1) & 1, (_id) & 1
 602
 603 /**
 604  * struct mdio_device_id - identifies PHY devices on an MDIO/MII bus
 605  * @phy_id: The result of
 606  *     (mdio_read(&MII_PHYSID1) << 16 | mdio_read(&MII_PHYSID2)) & @phy_id_mask
 607  *     for this PHY type
 608  * @phy_id_mask: Defines the significant bits of @phy_id.  A value of 0
 609  *     is used to terminate an array of struct mdio_device_id.
 610  */
 611 struct mdio_device_id {
 612         __u32 phy_id;
 613         __u32 phy_id_mask;
 614 };
 615
 616 struct zorro_device_id {
 617         __u32 id;                       /* Device ID or ZORRO_WILDCARD */
 618         kernel_ulong_t driver_data;     /* Data private to the driver */
 619 };
 620
 621 #define ZORRO_WILDCARD                  (0xffffffff)    /* not official */
 622
 623 #define ZORRO_DEVICE_MODALIAS_FMT       "zorro:i%08X"
 624
 625 #define ISAPNP_ANY_ID           0xffff
 626 struct isapnp_device_id {
 627         unsigned short card_vendor, card_device;
 628         unsigned short vendor, function;
 629         kernel_ulong_t driver_data;     /* data private to the driver */
 630 };
 631
 632 /**
 633  * struct amba_id - identifies a device on an AMBA bus
 634  * @id: The significant bits if the hardware device ID
 635  * @mask: Bitmask specifying which bits of the id field are significant when
 636  *      matching.  A driver binds to a device when ((hardware device ID) & mask)
 637  *      == id.
 638  * @data: Private data used by the driver.
 639  */
 640 struct amba_id {
 641         unsigned int            id;
 642         unsigned int            mask;
 643         void                    *data;
 644 };
 645
 646 /**
 647  * struct mips_cdmm_device_id - identifies devices in MIPS CDMM bus
 648  * @type:       Device type identifier.
 649  */
 650 struct mips_cdmm_device_id {
 651         __u8    type;
 652 };
 653
 654 /*
 655  * Match x86 CPUs for CPU specific drivers.
 656  * See documentation of "x86_match_cpu" for details.
 657  */
 658
 659 /*
 660  * MODULE_DEVICE_TABLE expects this struct to be called x86cpu_device_id.
 661  * Although gcc seems to ignore this error, clang fails without this define.
 662  */
 663 #define x86cpu_device_id x86_cpu_id
 664 struct x86_cpu_id {
 665         __u16 vendor;
 666         __u16 family;
 667         __u16 model;
 668         __u16 steppings;
 669         __u16 feature;  /* bit index */
 670         kernel_ulong_t driver_data;
 671 };
 672
 673 /* Wild cards for x86_cpu_id::vendor, family, model and feature */
 674 #define X86_VENDOR_ANY 0xffff
 675 #define X86_FAMILY_ANY 0
 676 #define X86_MODEL_ANY  0
 677 #define X86_STEPPING_ANY 0
 678 #define X86_FEATURE_ANY 0       /* Same as FPU, you can't test for that */
 679
 680 /*
 681  * Generic table type for matching CPU features.
 682  * @feature:    the bit number of the feature (0 - 65535)
 683  */
 684
 685 struct cpu_feature {
 686         __u16   feature;
 687 };
 688
 689 #define IPACK_ANY_FORMAT 0xff
 690 #define IPACK_ANY_ID (~0)
 691 struct ipack_device_id {
 692         __u8  format;                   /* Format version or IPACK_ANY_ID */
 693         __u32 vendor;                   /* Vendor ID or IPACK_ANY_ID */
 694         __u32 device;                   /* Device ID or IPACK_ANY_ID */
 695 };
 696
 697 #define MEI_CL_MODULE_PREFIX "mei:"
 698 #define MEI_CL_NAME_SIZE 32
 699 #define MEI_CL_VERSION_ANY 0xff
 700
 701 /**
 702  * struct mei_cl_device_id - MEI client device identifier
 703  * @name: helper name
 704  * @uuid: client uuid
 705  * @version: client protocol version
 706  * @driver_info: information used by the driver.
 707  *
 708  * identifies mei client device by uuid and name
 709  */
 710 struct mei_cl_device_id {
 711         char name[MEI_CL_NAME_SIZE];
 712         uuid_le uuid;
 713         __u8    version;
 714         kernel_ulong_t driver_info;
 715 };
 716
 717 /* RapidIO */
 718
 719 #define RIO_ANY_ID      0xffff
 720
 721 /**
 722  * struct rio_device_id - RIO device identifier
 723  * @did: RapidIO device ID
 724  * @vid: RapidIO vendor ID
 725  * @asm_did: RapidIO assembly device ID
 726  * @asm_vid: RapidIO assembly vendor ID
 727  *
 728  * Identifies a RapidIO device based on both the device/vendor IDs and
 729  * the assembly device/vendor IDs.
 730  */
 731 struct rio_device_id {
 732         __u16 did, vid;
 733         __u16 asm_did, asm_vid;
 734 };
 735
 736 struct mcb_device_id {
 737         __u16 device;
 738         kernel_ulong_t driver_data;
 739 };
 740
 741 struct ulpi_device_id {
 742         __u16 vendor;
 743         __u16 product;
 744         kernel_ulong_t driver_data;
 745 };
 746
 747 /**
 748  * struct fsl_mc_device_id - MC object device identifier
 749  * @vendor: vendor ID
 750  * @obj_type: MC object type
 751  *
 752  * Type of entries in the "device Id" table for MC object devices supported by
 753  * a MC object device driver. The last entry of the table has vendor set to 0x0
 754  */
 755 struct fsl_mc_device_id {
 756         __u16 vendor;
 757         const char obj_type[16];
 758 };
 759
 760 /**
 761  * struct tb_service_id - Thunderbolt service identifiers
 762  * @match_flags: Flags used to match the structure
 763  * @protocol_key: Protocol key the service supports
 764  * @protocol_id: Protocol id the service supports
 765  * @protocol_version: Version of the protocol
 766  * @protocol_revision: Revision of the protocol software
 767  * @driver_data: Driver specific data
 768  *
 769  * Thunderbolt XDomain services are exposed as devices where each device
 770  * carries the protocol information the service supports. Thunderbolt
 771  * XDomain service drivers match against that information.
 772  */
 773 struct tb_service_id {
 774         __u32 match_flags;
 775         char protocol_key[8 + 1];
 776         __u32 protocol_id;
 777         __u32 protocol_version;
 778         __u32 protocol_revision;
 779         kernel_ulong_t driver_data;
 780 };
 781
 782 #define TBSVC_MATCH_PROTOCOL_KEY        0x0001
 783 #define TBSVC_MATCH_PROTOCOL_ID         0x0002
 784 #define TBSVC_MATCH_PROTOCOL_VERSION    0x0004
 785 #define TBSVC_MATCH_PROTOCOL_REVISION   0x0008
 786
 787 /* USB Type-C Alternate Modes */
 788
 789 #define TYPEC_ANY_MODE  0x7
 790
 791 /**
 792  * struct typec_device_id - USB Type-C alternate mode identifiers
 793  * @svid: Standard or Vendor ID
 794  * @mode: Mode index
 795  * @driver_data: Driver specific data
 796  */
 797 struct typec_device_id {
 798         __u16 svid;
 799         __u8 mode;
 800         kernel_ulong_t driver_data;
 801 };
 802
 803 /**
 804  * struct tee_client_device_id - tee based device identifier
 805  * @uuid: For TEE based client devices we use the device uuid as
 806  *        the identifier.
 807  */
 808 struct tee_client_device_id {
 809         uuid_t uuid;
 810 };
 811
 812 /* WMI */
 813
 814 #define WMI_MODULE_PREFIX       "wmi:"
 815
 816 /**
 817  * struct wmi_device_id - WMI device identifier
 818  * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
 819  * @context: pointer to driver specific data
 820  */
 821 struct wmi_device_id {
 822         const char guid_string[UUID_STRING_LEN+1];
 823         const void *context;
 824 };
 825
 826 #define MHI_DEVICE_MODALIAS_FMT "mhi:%s"
 827 #define MHI_NAME_SIZE 32
 828
 829 /**
 830  * struct mhi_device_id - MHI device identification
 831  * @chan: MHI channel name
 832  * @driver_data: driver data;
 833  */
 834 struct mhi_device_id {
 835         const char chan[MHI_NAME_SIZE];
 836         kernel_ulong_t driver_data;
 837 };
 838
 839 #endif /* LINUX_MOD_DEVICETABLE_H */