[mirror_ubuntu-zesty-kernel.git] / include / linux / mod_devicetable.h

/*
 * Device tables which are exported to userspace via
 * scripts/mod/file2alias.c.  You must keep that file in sync with this
 * header.
 */

#ifndef LINUX_MOD_DEVICETABLE_H
#define LINUX_MOD_DEVICETABLE_H

#ifdef __KERNEL__
#include <linux/types.h>
typedef unsigned long kernel_ulong_t;
#endif

#define PCI_ANY_ID (~0)

struct pci_device_id {
	__u32 vendor, device;		/* Vendor and device ID or PCI_ANY_ID*/
	__u32 subvendor, subdevice;	/* Subsystem ID's or PCI_ANY_ID */
	__u32 class, class_mask;	/* (class,subclass,prog-if) triplet */
	kernel_ulong_t driver_data;	/* Data private to the driver */
};


#define IEEE1394_MATCH_VENDOR_ID	0x0001
#define IEEE1394_MATCH_MODEL_ID		0x0002
#define IEEE1394_MATCH_SPECIFIER_ID	0x0004
#define IEEE1394_MATCH_VERSION		0x0008

struct ieee1394_device_id {
	__u32 match_flags;
	__u32 vendor_id;
	__u32 model_id;
	__u32 specifier_id;
	__u32 version;
	kernel_ulong_t driver_data
		__attribute__((aligned(sizeof(kernel_ulong_t))));
};


/*
 * Device table entry for "new style" table-driven USB drivers.
 * User mode code can read these tables to choose which modules to load.
 * Declare the table as a MODULE_DEVICE_TABLE.
 *
 * A probe() parameter will point to a matching entry from this table.
 * Use the driver_info field for each match to hold information tied
 * to that match:  device quirks, etc.
 *
 * Terminate the driver's table with an all-zeroes entry.
 * Use the flag values to control which fields are compared.
 */

/**
 * struct usb_device_id - identifies USB devices for probing and hotplugging
 * @match_flags: Bit mask controlling of the other fields are used to match
 *	against new devices.  Any field except for driver_info may be used,
 *	although some only make sense in conjunction with other fields.
 *	This is usually set by a USB_DEVICE_*() macro, which sets all
 *	other fields in this structure except for driver_info.
 * @idVendor: USB vendor ID for a device; numbers are assigned
 *	by the USB forum to its members.
 * @idProduct: Vendor-assigned product ID.
 * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
 *	This is also used to identify individual product versions, for
 *	a range consisting of a single device.
 * @bcdDevice_hi: High end of version number range.  The range of product
 *	versions is inclusive.
 * @bDeviceClass: Class of device; numbers are assigned
 *	by the USB forum.  Products may choose to implement classes,
 *	or be vendor-specific.  Device classes specify behavior of all
 *	the interfaces on a devices.
 * @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
 * @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
 * @bInterfaceClass: Class of interface; numbers are assigned
 *	by the USB forum.  Products may choose to implement classes,
 *	or be vendor-specific.  Interface classes specify behavior only
 *	of a given interface; other interfaces may support other classes.
 * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
 * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
 * @driver_info: Holds information used by the driver.  Usually it holds
 *	a pointer to a descriptor understood by the driver, or perhaps
 *	device flags.
 *
 * In most cases, drivers will create a table of device IDs by using
 * USB_DEVICE(), or similar macros designed for that purpose.
 * They will then export it to userspace using MODULE_DEVICE_TABLE(),
 * and provide it to the USB core through their usb_driver structure.
 *
 * See the usb_match_id() function for information about how matches are
 * performed.  Briefly, you will normally use one of several macros to help
 * construct these entries.  Each entry you provide will either identify
 * one or more specific products, or will identify a class of products
 * which have agreed to behave the same.  You should put the more specific
 * matches towards the beginning of your table, so that driver_info can
 * record quirks of specific products.
 */
struct usb_device_id {
	/* which fields to match against? */
	__u16		match_flags;

	/* Used for product specific matches; range is inclusive */
	__u16		idVendor;
	__u16		idProduct;
	__u16		bcdDevice_lo;
	__u16		bcdDevice_hi;

	/* Used for device class matches */
	__u8		bDeviceClass;
	__u8		bDeviceSubClass;
	__u8		bDeviceProtocol;

	/* Used for interface class matches */
	__u8		bInterfaceClass;
	__u8		bInterfaceSubClass;
	__u8		bInterfaceProtocol;

	/* not matched against */
	kernel_ulong_t	driver_info;
};

/* Some useful macros to use to create struct usb_device_id */
#define USB_DEVICE_ID_MATCH_VENDOR		0x0001
#define USB_DEVICE_ID_MATCH_PRODUCT		0x0002
#define USB_DEVICE_ID_MATCH_DEV_LO		0x0004
#define USB_DEVICE_ID_MATCH_DEV_HI		0x0008
#define USB_DEVICE_ID_MATCH_DEV_CLASS		0x0010
#define USB_DEVICE_ID_MATCH_DEV_SUBCLASS	0x0020
#define USB_DEVICE_ID_MATCH_DEV_PROTOCOL	0x0040
#define USB_DEVICE_ID_MATCH_INT_CLASS		0x0080
#define USB_DEVICE_ID_MATCH_INT_SUBCLASS	0x0100
#define USB_DEVICE_ID_MATCH_INT_PROTOCOL	0x0200

#define HID_ANY_ID				(~0)
#define HID_GROUP_ANY				0x0000

struct hid_device_id {
	__u16 bus;
	__u16 group;
	__u32 vendor;
	__u32 product;
	kernel_ulong_t driver_data
		__attribute__((aligned(sizeof(kernel_ulong_t))));
};

/* s390 CCW devices */
struct ccw_device_id {
	__u16	match_flags;	/* which fields to match against */

	__u16	cu_type;	/* control unit type     */
	__u16	dev_type;	/* device type           */
	__u8	cu_model;	/* control unit model    */
	__u8	dev_model;	/* device model          */

	kernel_ulong_t driver_info;
};

#define CCW_DEVICE_ID_MATCH_CU_TYPE		0x01
#define CCW_DEVICE_ID_MATCH_CU_MODEL		0x02
#define CCW_DEVICE_ID_MATCH_DEVICE_TYPE		0x04
#define CCW_DEVICE_ID_MATCH_DEVICE_MODEL	0x08

/* s390 AP bus devices */
struct ap_device_id {
	__u16 match_flags;	/* which fields to match against */
	__u8 dev_type;		/* device type */
	__u8 pad1;
	__u32 pad2;
	kernel_ulong_t driver_info;
};

#define AP_DEVICE_ID_MATCH_DEVICE_TYPE		0x01

/* s390 css bus devices (subchannels) */
struct css_device_id {
	__u8 match_flags;
	__u8 type; /* subchannel type */
	__u16 pad2;
	__u32 pad3;
	kernel_ulong_t driver_data;
};

#define ACPI_ID_LEN	16 /* only 9 bytes needed here, 16 bytes are used */
			   /* to workaround crosscompile issues */

struct acpi_device_id {
	__u8 id[ACPI_ID_LEN];
	kernel_ulong_t driver_data;
};

#define PNP_ID_LEN	8
#define PNP_MAX_DEVICES	8

struct pnp_device_id {
	__u8 id[PNP_ID_LEN];
	kernel_ulong_t driver_data;
};

struct pnp_card_device_id {
	__u8 id[PNP_ID_LEN];
	kernel_ulong_t driver_data;
	struct {
		__u8 id[PNP_ID_LEN];
	} devs[PNP_MAX_DEVICES];
};


#define SERIO_ANY	0xff

struct serio_device_id {
	__u8 type;
	__u8 extra;
	__u8 id;
	__u8 proto;
};

/*
 * Struct used for matching a device
 */
struct of_device_id
{
	char	name[32];
	char	type[32];
	char	compatible[128];
#ifdef __KERNEL__
	void	*data;
#else
	kernel_ulong_t data;
#endif
};

/* VIO */
struct vio_device_id {
	char type[32];
	char compat[32];
};

/* PCMCIA */

struct pcmcia_device_id {
	__u16		match_flags;

	__u16		manf_id;
	__u16 		card_id;

	__u8  		func_id;

	/* for real multi-function devices */
	__u8  		function;

	/* for pseudo multi-function devices */
	__u8  		device_no;

	__u32 		prod_id_hash[4]
		__attribute__((aligned(sizeof(__u32))));

	/* not matched against in kernelspace*/
#ifdef __KERNEL__
	const char *	prod_id[4];
#else
	kernel_ulong_t	prod_id[4]
		__attribute__((aligned(sizeof(kernel_ulong_t))));
#endif

	/* not matched against */
	kernel_ulong_t	driver_info;
#ifdef __KERNEL__
	char *		cisfile;
#else
	kernel_ulong_t	cisfile;
#endif
};

#define PCMCIA_DEV_ID_MATCH_MANF_ID	0x0001
#define PCMCIA_DEV_ID_MATCH_CARD_ID	0x0002
#define PCMCIA_DEV_ID_MATCH_FUNC_ID	0x0004
#define PCMCIA_DEV_ID_MATCH_FUNCTION	0x0008
#define PCMCIA_DEV_ID_MATCH_PROD_ID1	0x0010
#define PCMCIA_DEV_ID_MATCH_PROD_ID2	0x0020
#define PCMCIA_DEV_ID_MATCH_PROD_ID3	0x0040
#define PCMCIA_DEV_ID_MATCH_PROD_ID4	0x0080
#define PCMCIA_DEV_ID_MATCH_DEVICE_NO	0x0100
#define PCMCIA_DEV_ID_MATCH_FAKE_CIS	0x0200
#define PCMCIA_DEV_ID_MATCH_ANONYMOUS	0x0400

/* Input */
#define INPUT_DEVICE_ID_EV_MAX		0x1f
#define INPUT_DEVICE_ID_KEY_MIN_INTERESTING	0x71
#define INPUT_DEVICE_ID_KEY_MAX		0x2ff
#define INPUT_DEVICE_ID_REL_MAX		0x0f
#define INPUT_DEVICE_ID_ABS_MAX		0x3f
#define INPUT_DEVICE_ID_MSC_MAX		0x07
#define INPUT_DEVICE_ID_LED_MAX		0x0f
#define INPUT_DEVICE_ID_SND_MAX		0x07
#define INPUT_DEVICE_ID_FF_MAX		0x7f
#define INPUT_DEVICE_ID_SW_MAX		0x0f

#define INPUT_DEVICE_ID_MATCH_BUS	1
#define INPUT_DEVICE_ID_MATCH_VENDOR	2
#define INPUT_DEVICE_ID_MATCH_PRODUCT	4
#define INPUT_DEVICE_ID_MATCH_VERSION	8

#define INPUT_DEVICE_ID_MATCH_EVBIT	0x0010
#define INPUT_DEVICE_ID_MATCH_KEYBIT	0x0020
#define INPUT_DEVICE_ID_MATCH_RELBIT	0x0040
#define INPUT_DEVICE_ID_MATCH_ABSBIT	0x0080
#define INPUT_DEVICE_ID_MATCH_MSCIT	0x0100
#define INPUT_DEVICE_ID_MATCH_LEDBIT	0x0200
#define INPUT_DEVICE_ID_MATCH_SNDBIT	0x0400
#define INPUT_DEVICE_ID_MATCH_FFBIT	0x0800
#define INPUT_DEVICE_ID_MATCH_SWBIT	0x1000

struct input_device_id {

	kernel_ulong_t flags;

	__u16 bustype;
	__u16 vendor;
	__u16 product;
	__u16 version;

	kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
	kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];

	kernel_ulong_t driver_info;
};

/* EISA */

#define EISA_SIG_LEN   8

/* The EISA signature, in ASCII form, null terminated */
struct eisa_device_id {
	char          sig[EISA_SIG_LEN];
	kernel_ulong_t driver_data;
};

#define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"

struct parisc_device_id {
	__u8	hw_type;	/* 5 bits used */
	__u8	hversion_rev;	/* 4 bits */
	__u16	hversion;	/* 12 bits */
	__u32	sversion;	/* 20 bits */
};

#define PA_HWTYPE_ANY_ID	0xff
#define PA_HVERSION_REV_ANY_ID	0xff
#define PA_HVERSION_ANY_ID	0xffff
#define PA_SVERSION_ANY_ID	0xffffffff

/* SDIO */

#define SDIO_ANY_ID (~0)

struct sdio_device_id {
	__u8	class;			/* Standard interface or SDIO_ANY_ID */
	__u16	vendor;			/* Vendor or SDIO_ANY_ID */
	__u16	device;			/* Device ID or SDIO_ANY_ID */
	kernel_ulong_t driver_data	/* Data private to the driver */
		__attribute__((aligned(sizeof(kernel_ulong_t))));
};

/* SSB core, see drivers/ssb/ */
struct ssb_device_id {
	__u16	vendor;
	__u16	coreid;
	__u8	revision;
};
#define SSB_DEVICE(_vendor, _coreid, _revision)  \
	{ .vendor = _vendor, .coreid = _coreid, .revision = _revision, }
#define SSB_DEVTABLE_END  \
	{ 0, },

#define SSB_ANY_VENDOR		0xFFFF
#define SSB_ANY_ID		0xFFFF
#define SSB_ANY_REV		0xFF

/* Broadcom's specific AMBA core, see drivers/bcma/ */
struct bcma_device_id {
	__u16	manuf;
	__u16	id;
	__u8	rev;
	__u8	class;
};
#define BCMA_CORE(_manuf, _id, _rev, _class)  \
	{ .manuf = _manuf, .id = _id, .rev = _rev, .class = _class, }
#define BCMA_CORETABLE_END  \
	{ 0, },

#define BCMA_ANY_MANUF		0xFFFF
#define BCMA_ANY_ID		0xFFFF
#define BCMA_ANY_REV		0xFF
#define BCMA_ANY_CLASS		0xFF

struct virtio_device_id {
	__u32 device;
	__u32 vendor;
};
#define VIRTIO_DEV_ANY_ID	0xffffffff

/*
 * For Hyper-V devices we use the device guid as the id.
 */
struct hv_vmbus_device_id {
	__u8 guid[16];
	kernel_ulong_t driver_data	/* Data private to the driver */
			__attribute__((aligned(sizeof(kernel_ulong_t))));
};

/* rpmsg */

#define RPMSG_NAME_SIZE			32
#define RPMSG_DEVICE_MODALIAS_FMT	"rpmsg:%s"

struct rpmsg_device_id {
	char name[RPMSG_NAME_SIZE];
};

/* i2c */

#define I2C_NAME_SIZE	20
#define I2C_MODULE_PREFIX "i2c:"

struct i2c_device_id {
	char name[I2C_NAME_SIZE];
	kernel_ulong_t driver_data	/* Data private to the driver */
			__attribute__((aligned(sizeof(kernel_ulong_t))));
};

/* spi */

#define SPI_NAME_SIZE	32
#define SPI_MODULE_PREFIX "spi:"

struct spi_device_id {
	char name[SPI_NAME_SIZE];
	kernel_ulong_t driver_data	/* Data private to the driver */
			__attribute__((aligned(sizeof(kernel_ulong_t))));
};

/* dmi */
enum dmi_field {
	DMI_NONE,
	DMI_BIOS_VENDOR,
	DMI_BIOS_VERSION,
	DMI_BIOS_DATE,
	DMI_SYS_VENDOR,
	DMI_PRODUCT_NAME,
	DMI_PRODUCT_VERSION,
	DMI_PRODUCT_SERIAL,
	DMI_PRODUCT_UUID,
	DMI_BOARD_VENDOR,
	DMI_BOARD_NAME,
	DMI_BOARD_VERSION,
	DMI_BOARD_SERIAL,
	DMI_BOARD_ASSET_TAG,
	DMI_CHASSIS_VENDOR,
	DMI_CHASSIS_TYPE,
	DMI_CHASSIS_VERSION,
	DMI_CHASSIS_SERIAL,
	DMI_CHASSIS_ASSET_TAG,
	DMI_STRING_MAX,
};

struct dmi_strmatch {
	unsigned char slot;
	char substr[79];
};

#ifndef __KERNEL__
struct dmi_system_id {
	kernel_ulong_t callback;
	kernel_ulong_t ident;
	struct dmi_strmatch matches[4];
	kernel_ulong_t driver_data
			__attribute__((aligned(sizeof(kernel_ulong_t))));
};
#else
struct dmi_system_id {
	int (*callback)(const struct dmi_system_id *);
	const char *ident;
	struct dmi_strmatch matches[4];
	void *driver_data;
};
/*
 * struct dmi_device_id appears during expansion of
 * "MODULE_DEVICE_TABLE(dmi, x)". Compiler doesn't look inside it
 * but this is enough for gcc 3.4.6 to error out:
 *	error: storage size of '__mod_dmi_device_table' isn't known
 */
#define dmi_device_id dmi_system_id
#endif

#define DMI_MATCH(a, b)	{ a, b }

#define PLATFORM_NAME_SIZE	20
#define PLATFORM_MODULE_PREFIX	"platform:"

struct platform_device_id {
	char name[PLATFORM_NAME_SIZE];
	kernel_ulong_t driver_data
			__attribute__((aligned(sizeof(kernel_ulong_t))));
};

#define MDIO_MODULE_PREFIX	"mdio:"

#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"
#define MDIO_ID_ARGS(_id) \
	(_id)>>31, ((_id)>>30) & 1, ((_id)>>29) & 1, ((_id)>>28) & 1,	\
	((_id)>>27) & 1, ((_id)>>26) & 1, ((_id)>>25) & 1, ((_id)>>24) & 1, \
	((_id)>>23) & 1, ((_id)>>22) & 1, ((_id)>>21) & 1, ((_id)>>20) & 1, \
	((_id)>>19) & 1, ((_id)>>18) & 1, ((_id)>>17) & 1, ((_id)>>16) & 1, \
	((_id)>>15) & 1, ((_id)>>14) & 1, ((_id)>>13) & 1, ((_id)>>12) & 1, \
	((_id)>>11) & 1, ((_id)>>10) & 1, ((_id)>>9) & 1, ((_id)>>8) & 1, \
	((_id)>>7) & 1, ((_id)>>6) & 1, ((_id)>>5) & 1, ((_id)>>4) & 1, \
	((_id)>>3) & 1, ((_id)>>2) & 1, ((_id)>>1) & 1, (_id) & 1

/**
 * struct mdio_device_id - identifies PHY devices on an MDIO/MII bus
 * @phy_id: The result of
 *     (mdio_read(&MII_PHYSID1) << 16 | mdio_read(&PHYSID2)) & @phy_id_mask
 *     for this PHY type
 * @phy_id_mask: Defines the significant bits of @phy_id.  A value of 0
 *     is used to terminate an array of struct mdio_device_id.
 */
struct mdio_device_id {
	__u32 phy_id;
	__u32 phy_id_mask;
};

struct zorro_device_id {
	__u32 id;			/* Device ID or ZORRO_WILDCARD */
	kernel_ulong_t driver_data;	/* Data private to the driver */
};

#define ZORRO_WILDCARD			(0xffffffff)	/* not official */

#define ZORRO_DEVICE_MODALIAS_FMT	"zorro:i%08X"

#define ISAPNP_ANY_ID		0xffff
struct isapnp_device_id {
	unsigned short card_vendor, card_device;
	unsigned short vendor, function;
	kernel_ulong_t driver_data;	/* data private to the driver */
};

/**
 * struct amba_id - identifies a device on an AMBA bus
 * @id: The significant bits if the hardware device ID
 * @mask: Bitmask specifying which bits of the id field are significant when
 *	matching.  A driver binds to a device when ((hardware device ID) & mask)
 *	== id.
 * @data: Private data used by the driver.
 */
struct amba_id {
	unsigned int		id;
	unsigned int		mask;
#ifndef __KERNEL__
	kernel_ulong_t		data;
#else
	void			*data;
#endif
};

/*
 * Match x86 CPUs for CPU specific drivers.
 * See documentation of "x86_match_cpu" for details.
 */

struct x86_cpu_id {
	__u16 vendor;
	__u16 family;
	__u16 model;
	__u16 feature;	/* bit index */
	kernel_ulong_t driver_data;
};

#define X86_FEATURE_MATCH(x) \
	{ X86_VENDOR_ANY, X86_FAMILY_ANY, X86_MODEL_ANY, x }

#define X86_VENDOR_ANY 0xffff
#define X86_FAMILY_ANY 0
#define X86_MODEL_ANY  0
#define X86_FEATURE_ANY 0	/* Same as FPU, you can't test for that */

#endif /* LINUX_MOD_DEVICETABLE_H */
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* Device tables which are exported to userspace via
fb120da6	3	* scripts/mod/file2alias.c. You must keep that file in sync with this
1da177e4 LT	4	* header.
	5	*/
	6
	7	#ifndef LINUX_MOD_DEVICETABLE_H
	8	#define LINUX_MOD_DEVICETABLE_H
	9
	10	#ifdef __KERNEL__
	11	#include <linux/types.h>
	12	typedef unsigned long kernel_ulong_t;
	13	#endif
	14
	15	#define PCI_ANY_ID (~0)
	16
	17	struct pci_device_id {
	18	__u32 vendor, device; /* Vendor and device ID or PCI_ANY_ID*/
	19	__u32 subvendor, subdevice; /* Subsystem ID's or PCI_ANY_ID */
	20	__u32 class, class_mask; /* (class,subclass,prog-if) triplet */
	21	kernel_ulong_t driver_data; /* Data private to the driver */
	22	};
	23
	24
	25	#define IEEE1394_MATCH_VENDOR_ID 0x0001
	26	#define IEEE1394_MATCH_MODEL_ID 0x0002
	27	#define IEEE1394_MATCH_SPECIFIER_ID 0x0004
	28	#define IEEE1394_MATCH_VERSION 0x0008
	29
	30	struct ieee1394_device_id {
	31	__u32 match_flags;
	32	__u32 vendor_id;
	33	__u32 model_id;
	34	__u32 specifier_id;
	35	__u32 version;
9e2d3cd3 AV	36	kernel_ulong_t driver_data
9e2d3cd3 AV	37	__attribute__((aligned(sizeof(kernel_ulong_t))));
1da177e4 LT	38	};
	39
	40
	41	/*
	42	* Device table entry for "new style" table-driven USB drivers.
	43	* User mode code can read these tables to choose which modules to load.
	44	* Declare the table as a MODULE_DEVICE_TABLE.
	45	*
	46	* A probe() parameter will point to a matching entry from this table.
	47	* Use the driver_info field for each match to hold information tied
	48	* to that match: device quirks, etc.
	49	*
	50	* Terminate the driver's table with an all-zeroes entry.
	51	* Use the flag values to control which fields are compared.
	52	*/
	53
	54	/**
	55	* struct usb_device_id - identifies USB devices for probing and hotplugging
	56	* @match_flags: Bit mask controlling of the other fields are used to match
	57	* against new devices. Any field except for driver_info may be used,
	58	* although some only make sense in conjunction with other fields.
	59	* This is usually set by a USB_DEVICE_*() macro, which sets all
	60	* other fields in this structure except for driver_info.
	61	* @idVendor: USB vendor ID for a device; numbers are assigned
	62	* by the USB forum to its members.
	63	* @idProduct: Vendor-assigned product ID.
	64	* @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
	65	* This is also used to identify individual product versions, for
	66	* a range consisting of a single device.
	67	* @bcdDevice_hi: High end of version number range. The range of product
	68	* versions is inclusive.
	69	* @bDeviceClass: Class of device; numbers are assigned
	70	* by the USB forum. Products may choose to implement classes,
	71	* or be vendor-specific. Device classes specify behavior of all
	72	* the interfaces on a devices.
	73	* @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
	74	* @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
	75	* @bInterfaceClass: Class of interface; numbers are assigned
	76	* by the USB forum. Products may choose to implement classes,
	77	* or be vendor-specific. Interface classes specify behavior only
	78	* of a given interface; other interfaces may support other classes.
	79	* @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
	80	* @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
	81	* @driver_info: Holds information used by the driver. Usually it holds
	82	* a pointer to a descriptor understood by the driver, or perhaps
	83	* device flags.
	84	*
	85	* In most cases, drivers will create a table of device IDs by using
	86	* USB_DEVICE(), or similar macros designed for that purpose.
	87	* They will then export it to userspace using MODULE_DEVICE_TABLE(),
	88	* and provide it to the USB core through their usb_driver structure.
	89	*
	90	* See the usb_match_id() function for information about how matches are
	91	* performed. Briefly, you will normally use one of several macros to help
	92	* construct these entries. Each entry you provide will either identify
	93	* one or more specific products, or will identify a class of products
	94	* which have agreed to behave the same. You should put the more specific
	95	* matches towards the beginning of your table, so that driver_info can
	96	* record quirks of specific products.
	97	*/
	98	struct usb_device_id {
	99	/* which fields to match against? */
	100	__u16 match_flags;
	101
102	/* Used for product specific matches; range is inclusive */
103	__u16 idVendor;
104	__u16 idProduct;
105	__u16 bcdDevice_lo;
106	__u16 bcdDevice_hi;
107
108	/* Used for device class matches */
109	__u8 bDeviceClass;
110	__u8 bDeviceSubClass;
111	__u8 bDeviceProtocol;
112
113	/* Used for interface class matches */
114	__u8 bInterfaceClass;
115	__u8 bInterfaceSubClass;
116	__u8 bInterfaceProtocol;
117
118	/* not matched against */
119	kernel_ulong_t driver_info;
120	};
121
122	/* Some useful macros to use to create struct usb_device_id */
123	#define USB_DEVICE_ID_MATCH_VENDOR 0x0001
124	#define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
125	#define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
126	#define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
127	#define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
128	#define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
129	#define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
130	#define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
131	#define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
132	#define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
133
e8c84f9a	134	#define HID_ANY_ID (~0)
4d53b801	135	#define HID_GROUP_ANY 0x0000
e8c84f9a JS	136
	137	struct hid_device_id {
	138	__u16 bus;
4d53b801	139	__u16 group;
e8c84f9a JS	140	__u32 vendor;
	141	__u32 product;
	142	kernel_ulong_t driver_data
	143	__attribute__((aligned(sizeof(kernel_ulong_t))));
	144	};
	145
1da177e4 LT	146	/* s390 CCW devices */
	147	struct ccw_device_id {
	148	__u16 match_flags; /* which fields to match against */
	149
	150	__u16 cu_type; /* control unit type */
	151	__u16 dev_type; /* device type */
	152	__u8 cu_model; /* control unit model */
	153	__u8 dev_model; /* device model */
	154
	155	kernel_ulong_t driver_info;
	156	};
	157
	158	#define CCW_DEVICE_ID_MATCH_CU_TYPE 0x01
	159	#define CCW_DEVICE_ID_MATCH_CU_MODEL 0x02
	160	#define CCW_DEVICE_ID_MATCH_DEVICE_TYPE 0x04
	161	#define CCW_DEVICE_ID_MATCH_DEVICE_MODEL 0x08
	162
1534c382 MS	163	/* s390 AP bus devices */
	164	struct ap_device_id {
	165	__u16 match_flags; /* which fields to match against */
	166	__u8 dev_type; /* device type */
	167	__u8 pad1;
	168	__u32 pad2;
	169	kernel_ulong_t driver_info;
	170	};
	171
	172	#define AP_DEVICE_ID_MATCH_DEVICE_TYPE 0x01
	173
7e9db9ea CH	174	/* s390 css bus devices (subchannels) */
7e9db9ea CH	175	struct css_device_id {
f08adc00	176	__u8 match_flags;
7e9db9ea	177	__u8 type; /* subchannel type */
7e9db9ea CH	178	__u16 pad2;
	179	__u32 pad3;
	180	kernel_ulong_t driver_data;
	181	};
	182
11814208 TR	183	#define ACPI_ID_LEN 16 /* only 9 bytes needed here, 16 bytes are used */
11814208 TR	184	/* to workaround crosscompile issues */
29b71a1c TR	185
	186	struct acpi_device_id {
	187	__u8 id[ACPI_ID_LEN];
	188	kernel_ulong_t driver_data;
	189	};
1da177e4 LT	190
	191	#define PNP_ID_LEN 8
	192	#define PNP_MAX_DEVICES 8
	193
	194	struct pnp_device_id {
	195	__u8 id[PNP_ID_LEN];
	196	kernel_ulong_t driver_data;
	197	};
	198
	199	struct pnp_card_device_id {
	200	__u8 id[PNP_ID_LEN];
	201	kernel_ulong_t driver_data;
	202	struct {
	203	__u8 id[PNP_ID_LEN];
	204	} devs[PNP_MAX_DEVICES];
	205	};
	206
	207
	208	#define SERIO_ANY 0xff
	209
	210	struct serio_device_id {
	211	__u8 type;
	212	__u8 extra;
	213	__u8 id;
	214	__u8 proto;
	215	};
	216
5e655772 JM	217	/*
	218	* Struct used for matching a device
	219	*/
	220	struct of_device_id
	221	{
	222	char name[32];
	223	char type[32];
	224	char compatible[128];
fd2e54b3	225	#ifdef __KERNEL__
5e655772	226	void *data;
9e2d3cd3 AV	227	#else
	228	kernel_ulong_t data;
	229	#endif
5e655772 JM	230	};
5e655772 JM	231
fb120da6 SR	232	/* VIO */
	233	struct vio_device_id {
	234	char type[32];
	235	char compat[32];
	236	};
1da177e4	237
1ad275e3 DB	238	/* PCMCIA */
	239
	240	struct pcmcia_device_id {
	241	__u16 match_flags;
	242
	243	__u16 manf_id;
	244	__u16 card_id;
	245
	246	__u8 func_id;
	247
	248	/* for real multi-function devices */
	249	__u8 function;
	250
4fb7edce	251	/* for pseudo multi-function devices */
1ad275e3 DB	252	__u8 device_no;
1ad275e3 DB	253
4fb7edce KJ	254	__u32 prod_id_hash[4]
4fb7edce KJ	255	__attribute__((aligned(sizeof(__u32))));
1ad275e3	256
aecab27a DB	257	/* not matched against in kernelspace*/
	258	#ifdef __KERNEL__
	259	const char * prod_id[4];
	260	#else
9e2d3cd3 AV	261	kernel_ulong_t prod_id[4]
9e2d3cd3 AV	262	__attribute__((aligned(sizeof(kernel_ulong_t))));
aecab27a DB	263	#endif
aecab27a DB	264
1ad275e3 DB	265	/* not matched against */
1ad275e3 DB	266	kernel_ulong_t driver_info;
aecab27a	267	#ifdef __KERNEL__
ea7b3882	268	char * cisfile;
aecab27a DB	269	#else
	270	kernel_ulong_t cisfile;
	271	#endif
1ad275e3 DB	272	};
	273
	274	#define PCMCIA_DEV_ID_MATCH_MANF_ID 0x0001
	275	#define PCMCIA_DEV_ID_MATCH_CARD_ID 0x0002
	276	#define PCMCIA_DEV_ID_MATCH_FUNC_ID 0x0004
	277	#define PCMCIA_DEV_ID_MATCH_FUNCTION 0x0008
	278	#define PCMCIA_DEV_ID_MATCH_PROD_ID1 0x0010
	279	#define PCMCIA_DEV_ID_MATCH_PROD_ID2 0x0020
	280	#define PCMCIA_DEV_ID_MATCH_PROD_ID3 0x0040
	281	#define PCMCIA_DEV_ID_MATCH_PROD_ID4 0x0080
	282	#define PCMCIA_DEV_ID_MATCH_DEVICE_NO 0x0100
ea7b3882	283	#define PCMCIA_DEV_ID_MATCH_FAKE_CIS 0x0200
f602ff7e	284	#define PCMCIA_DEV_ID_MATCH_ANONYMOUS 0x0400
1ad275e3	285
ddc5d341 DT	286	/* Input */
ddc5d341 DT	287	#define INPUT_DEVICE_ID_EV_MAX 0x1f
dc24f0e7	288	#define INPUT_DEVICE_ID_KEY_MIN_INTERESTING 0x71
03bac96f	289	#define INPUT_DEVICE_ID_KEY_MAX 0x2ff
ddc5d341 DT	290	#define INPUT_DEVICE_ID_REL_MAX 0x0f
	291	#define INPUT_DEVICE_ID_ABS_MAX 0x3f
	292	#define INPUT_DEVICE_ID_MSC_MAX 0x07
	293	#define INPUT_DEVICE_ID_LED_MAX 0x0f
	294	#define INPUT_DEVICE_ID_SND_MAX 0x07
	295	#define INPUT_DEVICE_ID_FF_MAX 0x7f
	296	#define INPUT_DEVICE_ID_SW_MAX 0x0f
	297
	298	#define INPUT_DEVICE_ID_MATCH_BUS 1
	299	#define INPUT_DEVICE_ID_MATCH_VENDOR 2
	300	#define INPUT_DEVICE_ID_MATCH_PRODUCT 4
	301	#define INPUT_DEVICE_ID_MATCH_VERSION 8
	302
	303	#define INPUT_DEVICE_ID_MATCH_EVBIT 0x0010
	304	#define INPUT_DEVICE_ID_MATCH_KEYBIT 0x0020
	305	#define INPUT_DEVICE_ID_MATCH_RELBIT 0x0040
	306	#define INPUT_DEVICE_ID_MATCH_ABSBIT 0x0080
	307	#define INPUT_DEVICE_ID_MATCH_MSCIT 0x0100
	308	#define INPUT_DEVICE_ID_MATCH_LEDBIT 0x0200
	309	#define INPUT_DEVICE_ID_MATCH_SNDBIT 0x0400
	310	#define INPUT_DEVICE_ID_MATCH_FFBIT 0x0800
	311	#define INPUT_DEVICE_ID_MATCH_SWBIT 0x1000
	312
	313	struct input_device_id {
	314
	315	kernel_ulong_t flags;
	316
	317	__u16 bustype;
	318	__u16 vendor;
	319	__u16 product;
	320	__u16 version;
	321
	322	kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
	323	kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
	324	kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
	325	kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
	326	kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
	327	kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
	328	kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
	329	kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
	330	kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];
	331
	332	kernel_ulong_t driver_info;
	333	};
	334
07563c71 MT	335	/* EISA */
	336
	337	#define EISA_SIG_LEN 8
	338
	339	/* The EISA signature, in ASCII form, null terminated */
	340	struct eisa_device_id {
	341	char sig[EISA_SIG_LEN];
	342	kernel_ulong_t driver_data;
	343	};
	344
	345	#define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"
	346
f2439b26 KM	347	struct parisc_device_id {
	348	__u8 hw_type; /* 5 bits used */
	349	__u8 hversion_rev; /* 4 bits */
	350	__u16 hversion; /* 12 bits */
	351	__u32 sversion; /* 20 bits */
	352	};
	353
f354ef8a KM	354	#define PA_HWTYPE_ANY_ID 0xff
	355	#define PA_HVERSION_REV_ANY_ID 0xff
	356	#define PA_HVERSION_ANY_ID 0xffff
	357	#define PA_SVERSION_ANY_ID 0xffffffff
f2439b26	358
3b38bea0 PO	359	/* SDIO */
	360
	361	#define SDIO_ANY_ID (~0)
	362
	363	struct sdio_device_id {
	364	__u8 class; /* Standard interface or SDIO_ANY_ID */
	365	__u16 vendor; /* Vendor or SDIO_ANY_ID */
	366	__u16 device; /* Device ID or SDIO_ANY_ID */
7492d4a4 AV	367	kernel_ulong_t driver_data /* Data private to the driver */
7492d4a4 AV	368	__attribute__((aligned(sizeof(kernel_ulong_t))));
3b38bea0 PO	369	};
3b38bea0 PO	370
61e115a5 MB	371	/* SSB core, see drivers/ssb/ */
	372	struct ssb_device_id {
	373	__u16 vendor;
	374	__u16 coreid;
	375	__u8 revision;
	376	};
	377	#define SSB_DEVICE(_vendor, _coreid, _revision) \
	378	{ .vendor = _vendor, .coreid = _coreid, .revision = _revision, }
	379	#define SSB_DEVTABLE_END \
	380	{ 0, },
	381
	382	#define SSB_ANY_VENDOR 0xFFFF
	383	#define SSB_ANY_ID 0xFFFF
	384	#define SSB_ANY_REV 0xFF
	385
8369ae33 RM	386	/* Broadcom's specific AMBA core, see drivers/bcma/ */
	387	struct bcma_device_id {
	388	__u16 manuf;
	389	__u16 id;
	390	__u8 rev;
	391	__u8 class;
	392	};
	393	#define BCMA_CORE(_manuf, _id, _rev, _class) \
	394	{ .manuf = _manuf, .id = _id, .rev = _rev, .class = _class, }
	395	#define BCMA_CORETABLE_END \
	396	{ 0, },
	397
	398	#define BCMA_ANY_MANUF 0xFFFF
	399	#define BCMA_ANY_ID 0xFFFF
	400	#define BCMA_ANY_REV 0xFF
	401	#define BCMA_ANY_CLASS 0xFF
	402
ec3d41c4 RR	403	struct virtio_device_id {
	404	__u32 device;
	405	__u32 vendor;
	406	};
	407	#define VIRTIO_DEV_ANY_ID 0xffffffff
	408
17be18c2 S	409	/*
	410	* For Hyper-V devices we use the device guid as the id.
	411	*/
	412	struct hv_vmbus_device_id {
	413	__u8 guid[16];
a91befc1 GKH	414	kernel_ulong_t driver_data /* Data private to the driver */
a91befc1 GKH	415	__attribute__((aligned(sizeof(kernel_ulong_t))));
17be18c2 S	416	};
17be18c2 S	417
bcabbcca OBC	418	/* rpmsg */
	419
	420	#define RPMSG_NAME_SIZE 32
	421	#define RPMSG_DEVICE_MODALIAS_FMT "rpmsg:%s"
	422
	423	struct rpmsg_device_id {
	424	char name[RPMSG_NAME_SIZE];
	425	};
	426
d2653e92 JD	427	/* i2c */
	428
	429	#define I2C_NAME_SIZE 20
	430	#define I2C_MODULE_PREFIX "i2c:"
	431
	432	struct i2c_device_id {
	433	char name[I2C_NAME_SIZE];
2548baa0 JS	434	kernel_ulong_t driver_data /* Data private to the driver */
2548baa0 JS	435	__attribute__((aligned(sizeof(kernel_ulong_t))));
d2653e92 JD	436	};
d2653e92 JD	437
75368bf6 AV	438	/* spi */
	439
	440	#define SPI_NAME_SIZE 32
e0626e38	441	#define SPI_MODULE_PREFIX "spi:"
75368bf6 AV	442
	443	struct spi_device_id {
	444	char name[SPI_NAME_SIZE];
	445	kernel_ulong_t driver_data /* Data private to the driver */
	446	__attribute__((aligned(sizeof(kernel_ulong_t))));
	447	};
	448
d945b697 DW	449	/* dmi */
	450	enum dmi_field {
	451	DMI_NONE,
	452	DMI_BIOS_VENDOR,
	453	DMI_BIOS_VERSION,
	454	DMI_BIOS_DATE,
	455	DMI_SYS_VENDOR,
	456	DMI_PRODUCT_NAME,
	457	DMI_PRODUCT_VERSION,
	458	DMI_PRODUCT_SERIAL,
	459	DMI_PRODUCT_UUID,
	460	DMI_BOARD_VENDOR,
	461	DMI_BOARD_NAME,
	462	DMI_BOARD_VERSION,
	463	DMI_BOARD_SERIAL,
	464	DMI_BOARD_ASSET_TAG,
	465	DMI_CHASSIS_VENDOR,
	466	DMI_CHASSIS_TYPE,
	467	DMI_CHASSIS_VERSION,
	468	DMI_CHASSIS_SERIAL,
	469	DMI_CHASSIS_ASSET_TAG,
	470	DMI_STRING_MAX,
	471	};
	472
	473	struct dmi_strmatch {
	474	unsigned char slot;
	475	char substr[79];
	476	};
	477
	478	#ifndef __KERNEL__
	479	struct dmi_system_id {
	480	kernel_ulong_t callback;
	481	kernel_ulong_t ident;
	482	struct dmi_strmatch matches[4];
	483	kernel_ulong_t driver_data
	484	__attribute__((aligned(sizeof(kernel_ulong_t))));
	485	};
	486	#else
	487	struct dmi_system_id {
	488	int (callback)(const struct dmi_system_id );
	489	const char *ident;
	490	struct dmi_strmatch matches[4];
	491	void *driver_data;
	492	};
40413dcb AD	493	/*
	494	* struct dmi_device_id appears during expansion of
	495	* "MODULE_DEVICE_TABLE(dmi, x)". Compiler doesn't look inside it
	496	* but this is enough for gcc 3.4.6 to error out:
	497	* error: storage size of '__mod_dmi_device_table' isn't known
	498	*/
	499	#define dmi_device_id dmi_system_id
d945b697 DW	500	#endif
	501
	502	#define DMI_MATCH(a, b) { a, b }
d2653e92	503
57fee4a5 EM	504	#define PLATFORM_NAME_SIZE 20
	505	#define PLATFORM_MODULE_PREFIX "platform:"
	506
	507	struct platform_device_id {
	508	char name[PLATFORM_NAME_SIZE];
	509	kernel_ulong_t driver_data
	510	__attribute__((aligned(sizeof(kernel_ulong_t))));
	511	};
	512
8626d3b4 DW	513	#define MDIO_MODULE_PREFIX "mdio:"
	514
	515	#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"
	516	#define MDIO_ID_ARGS(_id) \
	517	(_id)>>31, ((_id)>>30) & 1, ((_id)>>29) & 1, ((_id)>>28) & 1, \
	518	((_id)>>27) & 1, ((_id)>>26) & 1, ((_id)>>25) & 1, ((_id)>>24) & 1, \
	519	((_id)>>23) & 1, ((_id)>>22) & 1, ((_id)>>21) & 1, ((_id)>>20) & 1, \
	520	((_id)>>19) & 1, ((_id)>>18) & 1, ((_id)>>17) & 1, ((_id)>>16) & 1, \
	521	((_id)>>15) & 1, ((_id)>>14) & 1, ((_id)>>13) & 1, ((_id)>>12) & 1, \
	522	((_id)>>11) & 1, ((_id)>>10) & 1, ((_id)>>9) & 1, ((_id)>>8) & 1, \
	523	((_id)>>7) & 1, ((_id)>>6) & 1, ((_id)>>5) & 1, ((_id)>>4) & 1, \
	524	((_id)>>3) & 1, ((_id)>>2) & 1, ((_id)>>1) & 1, (_id) & 1
	525
	526	/**
	527	* struct mdio_device_id - identifies PHY devices on an MDIO/MII bus
	528	* @phy_id: The result of
	529	* (mdio_read(&MII_PHYSID1) << 16 \| mdio_read(&PHYSID2)) & @phy_id_mask
	530	* for this PHY type
	531	* @phy_id_mask: Defines the significant bits of @phy_id. A value of 0
	532	* is used to terminate an array of struct mdio_device_id.
	533	*/
	534	struct mdio_device_id {
	535	__u32 phy_id;
	536	__u32 phy_id_mask;
	537	};
	538
bf54a2b3 GU	539	struct zorro_device_id {
	540	__u32 id; /* Device ID or ZORRO_WILDCARD */
	541	kernel_ulong_t driver_data; /* Data private to the driver */
	542	};
	543
	544	#define ZORRO_WILDCARD (0xffffffff) /* not official */
	545
	546	#define ZORRO_DEVICE_MODALIAS_FMT "zorro:i%08X"
	547
90def62d RR	548	#define ISAPNP_ANY_ID 0xffff
	549	struct isapnp_device_id {
	550	unsigned short card_vendor, card_device;
	551	unsigned short vendor, function;
	552	kernel_ulong_t driver_data; /* data private to the driver */
	553	};
	554
1e5f9a23 DM	555	/**
	556	* struct amba_id - identifies a device on an AMBA bus
	557	* @id: The significant bits if the hardware device ID
	558	* @mask: Bitmask specifying which bits of the id field are significant when
	559	* matching. A driver binds to a device when ((hardware device ID) & mask)
	560	* == id.
	561	* @data: Private data used by the driver.
	562	*/
	563	struct amba_id {
	564	unsigned int id;
	565	unsigned int mask;
	566	#ifndef __KERNEL__
	567	kernel_ulong_t data;
	568	#else
	569	void *data;
	570	#endif
	571	};
	572
644e9cbb AK	573	/*
	574	* Match x86 CPUs for CPU specific drivers.
	575	* See documentation of "x86_match_cpu" for details.
	576	*/
	577
	578	struct x86_cpu_id {
	579	__u16 vendor;
	580	__u16 family;
	581	__u16 model;
	582	__u16 feature; /* bit index */
	583	kernel_ulong_t driver_data;
	584	};
	585
	586	#define X86_FEATURE_MATCH(x) \
	587	{ X86_VENDOR_ANY, X86_FAMILY_ANY, X86_MODEL_ANY, x }
	588
	589	#define X86_VENDOR_ANY 0xffff
	590	#define X86_FAMILY_ANY 0
	591	#define X86_MODEL_ANY 0
	592	#define X86_FEATURE_ANY 0 /* Same as FPU, you can't test for that */
	593
1da177e4	594	#endif /* LINUX_MOD_DEVICETABLE_H */