]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/mod_devicetable.h
kbuild: whitelist logo references from .text to .init.data
[mirror_ubuntu-bionic-kernel.git] / include / linux / mod_devicetable.h
CommitLineData
1da177e4
LT
1/*
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>
12typedef unsigned long kernel_ulong_t;
13#endif
14
15#define PCI_ANY_ID (~0)
16
17struct 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
30struct 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
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 */
98struct 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
134/* s390 CCW devices */
135struct ccw_device_id {
136 __u16 match_flags; /* which fields to match against */
137
138 __u16 cu_type; /* control unit type */
139 __u16 dev_type; /* device type */
140 __u8 cu_model; /* control unit model */
141 __u8 dev_model; /* device model */
142
143 kernel_ulong_t driver_info;
144};
145
146#define CCW_DEVICE_ID_MATCH_CU_TYPE 0x01
147#define CCW_DEVICE_ID_MATCH_CU_MODEL 0x02
148#define CCW_DEVICE_ID_MATCH_DEVICE_TYPE 0x04
149#define CCW_DEVICE_ID_MATCH_DEVICE_MODEL 0x08
150
1534c382
MS
151/* s390 AP bus devices */
152struct ap_device_id {
153 __u16 match_flags; /* which fields to match against */
154 __u8 dev_type; /* device type */
155 __u8 pad1;
156 __u32 pad2;
157 kernel_ulong_t driver_info;
158};
159
160#define AP_DEVICE_ID_MATCH_DEVICE_TYPE 0x01
161
1da177e4
LT
162
163#define PNP_ID_LEN 8
164#define PNP_MAX_DEVICES 8
165
166struct pnp_device_id {
167 __u8 id[PNP_ID_LEN];
168 kernel_ulong_t driver_data;
169};
170
171struct pnp_card_device_id {
172 __u8 id[PNP_ID_LEN];
173 kernel_ulong_t driver_data;
174 struct {
175 __u8 id[PNP_ID_LEN];
176 } devs[PNP_MAX_DEVICES];
177};
178
179
180#define SERIO_ANY 0xff
181
182struct serio_device_id {
183 __u8 type;
184 __u8 extra;
185 __u8 id;
186 __u8 proto;
187};
188
5e655772
JM
189/*
190 * Struct used for matching a device
191 */
192struct of_device_id
193{
194 char name[32];
195 char type[32];
196 char compatible[128];
fd2e54b3 197#ifdef __KERNEL__
5e655772 198 void *data;
9e2d3cd3
AV
199#else
200 kernel_ulong_t data;
201#endif
5e655772
JM
202};
203
fb120da6
SR
204/* VIO */
205struct vio_device_id {
206 char type[32];
207 char compat[32];
208};
1da177e4 209
1ad275e3
DB
210/* PCMCIA */
211
212struct pcmcia_device_id {
213 __u16 match_flags;
214
215 __u16 manf_id;
216 __u16 card_id;
217
218 __u8 func_id;
219
220 /* for real multi-function devices */
221 __u8 function;
222
4fb7edce 223 /* for pseudo multi-function devices */
1ad275e3
DB
224 __u8 device_no;
225
4fb7edce
KJ
226 __u32 prod_id_hash[4]
227 __attribute__((aligned(sizeof(__u32))));
1ad275e3 228
aecab27a
DB
229 /* not matched against in kernelspace*/
230#ifdef __KERNEL__
231 const char * prod_id[4];
232#else
9e2d3cd3
AV
233 kernel_ulong_t prod_id[4]
234 __attribute__((aligned(sizeof(kernel_ulong_t))));
aecab27a
DB
235#endif
236
1ad275e3
DB
237 /* not matched against */
238 kernel_ulong_t driver_info;
aecab27a 239#ifdef __KERNEL__
ea7b3882 240 char * cisfile;
aecab27a
DB
241#else
242 kernel_ulong_t cisfile;
243#endif
1ad275e3
DB
244};
245
246#define PCMCIA_DEV_ID_MATCH_MANF_ID 0x0001
247#define PCMCIA_DEV_ID_MATCH_CARD_ID 0x0002
248#define PCMCIA_DEV_ID_MATCH_FUNC_ID 0x0004
249#define PCMCIA_DEV_ID_MATCH_FUNCTION 0x0008
250#define PCMCIA_DEV_ID_MATCH_PROD_ID1 0x0010
251#define PCMCIA_DEV_ID_MATCH_PROD_ID2 0x0020
252#define PCMCIA_DEV_ID_MATCH_PROD_ID3 0x0040
253#define PCMCIA_DEV_ID_MATCH_PROD_ID4 0x0080
254#define PCMCIA_DEV_ID_MATCH_DEVICE_NO 0x0100
ea7b3882 255#define PCMCIA_DEV_ID_MATCH_FAKE_CIS 0x0200
f602ff7e 256#define PCMCIA_DEV_ID_MATCH_ANONYMOUS 0x0400
1ad275e3 257
a9d1b24d
GKH
258/* I2C */
259struct i2c_device_id {
260 __u16 id;
261};
262
ddc5d341
DT
263/* Input */
264#define INPUT_DEVICE_ID_EV_MAX 0x1f
265#define INPUT_DEVICE_ID_KEY_MAX 0x1ff
266#define INPUT_DEVICE_ID_REL_MAX 0x0f
267#define INPUT_DEVICE_ID_ABS_MAX 0x3f
268#define INPUT_DEVICE_ID_MSC_MAX 0x07
269#define INPUT_DEVICE_ID_LED_MAX 0x0f
270#define INPUT_DEVICE_ID_SND_MAX 0x07
271#define INPUT_DEVICE_ID_FF_MAX 0x7f
272#define INPUT_DEVICE_ID_SW_MAX 0x0f
273
274#define INPUT_DEVICE_ID_MATCH_BUS 1
275#define INPUT_DEVICE_ID_MATCH_VENDOR 2
276#define INPUT_DEVICE_ID_MATCH_PRODUCT 4
277#define INPUT_DEVICE_ID_MATCH_VERSION 8
278
279#define INPUT_DEVICE_ID_MATCH_EVBIT 0x0010
280#define INPUT_DEVICE_ID_MATCH_KEYBIT 0x0020
281#define INPUT_DEVICE_ID_MATCH_RELBIT 0x0040
282#define INPUT_DEVICE_ID_MATCH_ABSBIT 0x0080
283#define INPUT_DEVICE_ID_MATCH_MSCIT 0x0100
284#define INPUT_DEVICE_ID_MATCH_LEDBIT 0x0200
285#define INPUT_DEVICE_ID_MATCH_SNDBIT 0x0400
286#define INPUT_DEVICE_ID_MATCH_FFBIT 0x0800
287#define INPUT_DEVICE_ID_MATCH_SWBIT 0x1000
288
289struct input_device_id {
290
291 kernel_ulong_t flags;
292
293 __u16 bustype;
294 __u16 vendor;
295 __u16 product;
296 __u16 version;
297
298 kernel_ulong_t evbit[INPUT_DEVICE_ID_EV_MAX / BITS_PER_LONG + 1];
299 kernel_ulong_t keybit[INPUT_DEVICE_ID_KEY_MAX / BITS_PER_LONG + 1];
300 kernel_ulong_t relbit[INPUT_DEVICE_ID_REL_MAX / BITS_PER_LONG + 1];
301 kernel_ulong_t absbit[INPUT_DEVICE_ID_ABS_MAX / BITS_PER_LONG + 1];
302 kernel_ulong_t mscbit[INPUT_DEVICE_ID_MSC_MAX / BITS_PER_LONG + 1];
303 kernel_ulong_t ledbit[INPUT_DEVICE_ID_LED_MAX / BITS_PER_LONG + 1];
304 kernel_ulong_t sndbit[INPUT_DEVICE_ID_SND_MAX / BITS_PER_LONG + 1];
305 kernel_ulong_t ffbit[INPUT_DEVICE_ID_FF_MAX / BITS_PER_LONG + 1];
306 kernel_ulong_t swbit[INPUT_DEVICE_ID_SW_MAX / BITS_PER_LONG + 1];
307
308 kernel_ulong_t driver_info;
309};
310
07563c71
MT
311/* EISA */
312
313#define EISA_SIG_LEN 8
314
315/* The EISA signature, in ASCII form, null terminated */
316struct eisa_device_id {
317 char sig[EISA_SIG_LEN];
318 kernel_ulong_t driver_data;
319};
320
321#define EISA_DEVICE_MODALIAS_FMT "eisa:s%s"
322
f2439b26
KM
323struct parisc_device_id {
324 __u8 hw_type; /* 5 bits used */
325 __u8 hversion_rev; /* 4 bits */
326 __u16 hversion; /* 12 bits */
327 __u32 sversion; /* 20 bits */
328};
329
f354ef8a
KM
330#define PA_HWTYPE_ANY_ID 0xff
331#define PA_HVERSION_REV_ANY_ID 0xff
332#define PA_HVERSION_ANY_ID 0xffff
333#define PA_SVERSION_ANY_ID 0xffffffff
f2439b26 334
1da177e4 335#endif /* LINUX_MOD_DEVICETABLE_H */