1 /* Simple code to turn various tables in an ELF file into alias definitions.
2 * This deals with kernel datastructures where they should be
3 * dealt with: in the kernel source.
5 * Copyright 2002-2003 Rusty Russell, IBM Corporation
6 * 2003 Kai Germaschewski
9 * This software may be used and distributed according to the terms
10 * of the GNU General Public License, incorporated herein by reference.
15 /* We use the ELF typedefs for kernel_ulong_t but bite the bullet and
16 * use either stdint.h or inttypes.h for the rest. */
17 #if KERNEL_ELFCLASS == ELFCLASS32
18 typedef Elf32_Addr kernel_ulong_t;
19 #define BITS_PER_LONG 32
21 typedef Elf64_Addr kernel_ulong_t;
22 #define BITS_PER_LONG 64
32 typedef uint32_t __u32;
33 typedef uint16_t __u16;
34 typedef unsigned char __u8;
36 /* Big exception to the "don't include kernel headers into userspace, which
37 * even potentially has different endianness and word sizes, since
38 * we handle those differences explicitly below */
39 #include "../../include/linux/mod_devicetable.h"
41 #define ADD(str, sep, cond, field) \
45 sprintf(str + strlen(str), \
46 sizeof(field) == 1 ? "%02X" : \
47 sizeof(field) == 2 ? "%04X" : \
48 sizeof(field) == 4 ? "%08X" : "", \
51 sprintf(str + strlen(str), "*"); \
55 * Check that sizeof(device_id type) are consistent with size of section
56 * in .o file. If in-consistent then userspace and kernel does not agree
57 * on actual size which is a bug.
59 static void device_id_size_check(const char *modname, const char *device_id,
60 unsigned long size, unsigned long id_size)
62 if (size % id_size || size < id_size) {
63 fatal("%s: sizeof(struct %s_device_id)=%lu is not a modulo "
64 "of the size of section __mod_%s_device_table=%lu.\n"
65 "Fix definition of struct %s_device_id "
66 "in mod_devicetable.h\n",
67 modname, device_id, id_size, device_id, size, device_id);
71 /* USB is special because the bcdDevice can be matched against a numeric range */
72 /* Looks like "usb:vNpNdNdcNdscNdpNicNiscNipN" */
73 static void do_usb_entry(struct usb_device_id *id,
74 unsigned int bcdDevice_initial, int bcdDevice_initial_digits,
75 unsigned char range_lo, unsigned char range_hi,
79 strcpy(alias, "usb:");
80 ADD(alias, "v", id->match_flags&USB_DEVICE_ID_MATCH_VENDOR,
82 ADD(alias, "p", id->match_flags&USB_DEVICE_ID_MATCH_PRODUCT,
86 if (bcdDevice_initial_digits)
87 sprintf(alias + strlen(alias), "%0*X",
88 bcdDevice_initial_digits, bcdDevice_initial);
89 if (range_lo == range_hi)
90 sprintf(alias + strlen(alias), "%u", range_lo);
91 else if (range_lo > 0 || range_hi < 9)
92 sprintf(alias + strlen(alias), "[%u-%u]", range_lo, range_hi);
93 if (bcdDevice_initial_digits < (sizeof(id->bcdDevice_lo) * 2 - 1))
96 ADD(alias, "dc", id->match_flags&USB_DEVICE_ID_MATCH_DEV_CLASS,
99 id->match_flags&USB_DEVICE_ID_MATCH_DEV_SUBCLASS,
100 id->bDeviceSubClass);
102 id->match_flags&USB_DEVICE_ID_MATCH_DEV_PROTOCOL,
103 id->bDeviceProtocol);
105 id->match_flags&USB_DEVICE_ID_MATCH_INT_CLASS,
106 id->bInterfaceClass);
108 id->match_flags&USB_DEVICE_ID_MATCH_INT_SUBCLASS,
109 id->bInterfaceSubClass);
111 id->match_flags&USB_DEVICE_ID_MATCH_INT_PROTOCOL,
112 id->bInterfaceProtocol);
114 /* Always end in a wildcard, for future extension */
115 if (alias[strlen(alias)-1] != '*')
117 buf_printf(&mod->dev_table_buf,
118 "MODULE_ALIAS(\"%s\");\n", alias);
121 static void do_usb_entry_multi(struct usb_device_id *id, struct module *mod)
123 unsigned int devlo, devhi;
124 unsigned char chi, clo;
127 id->match_flags = TO_NATIVE(id->match_flags);
128 id->idVendor = TO_NATIVE(id->idVendor);
129 id->idProduct = TO_NATIVE(id->idProduct);
131 devlo = id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO ?
132 TO_NATIVE(id->bcdDevice_lo) : 0x0U;
133 devhi = id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI ?
134 TO_NATIVE(id->bcdDevice_hi) : ~0x0U;
137 * Some modules (visor) have empty slots as placeholder for
138 * run-time specification that results in catch-all alias
140 if (!(id->idVendor | id->bDeviceClass | id->bInterfaceClass))
143 /* Convert numeric bcdDevice range into fnmatch-able pattern(s) */
144 for (ndigits = sizeof(id->bcdDevice_lo) * 2 - 1; devlo <= devhi; ndigits--) {
147 if (chi > 9) /* it's bcd not hex */
152 if (devlo == devhi || !ndigits) {
153 do_usb_entry(id, devlo, ndigits, clo, chi, mod);
158 do_usb_entry(id, devlo++, ndigits, clo, 9, mod);
161 do_usb_entry(id, devhi--, ndigits, 0, chi, mod);
165 static void do_usb_table(void *symval, unsigned long size,
169 const unsigned long id_size = sizeof(struct usb_device_id);
171 device_id_size_check(mod->name, "usb", size, id_size);
173 /* Leave last one: it's the terminator. */
176 for (i = 0; i < size; i += id_size)
177 do_usb_entry_multi(symval + i, mod);
180 /* Looks like: ieee1394:venNmoNspNverN */
181 static int do_ieee1394_entry(const char *filename,
182 struct ieee1394_device_id *id, char *alias)
184 id->match_flags = TO_NATIVE(id->match_flags);
185 id->vendor_id = TO_NATIVE(id->vendor_id);
186 id->model_id = TO_NATIVE(id->model_id);
187 id->specifier_id = TO_NATIVE(id->specifier_id);
188 id->version = TO_NATIVE(id->version);
190 strcpy(alias, "ieee1394:");
191 ADD(alias, "ven", id->match_flags & IEEE1394_MATCH_VENDOR_ID,
193 ADD(alias, "mo", id->match_flags & IEEE1394_MATCH_MODEL_ID,
195 ADD(alias, "sp", id->match_flags & IEEE1394_MATCH_SPECIFIER_ID,
197 ADD(alias, "ver", id->match_flags & IEEE1394_MATCH_VERSION,
203 /* Looks like: pci:vNdNsvNsdNbcNscNiN. */
204 static int do_pci_entry(const char *filename,
205 struct pci_device_id *id, char *alias)
207 /* Class field can be divided into these three. */
208 unsigned char baseclass, subclass, interface,
209 baseclass_mask, subclass_mask, interface_mask;
211 id->vendor = TO_NATIVE(id->vendor);
212 id->device = TO_NATIVE(id->device);
213 id->subvendor = TO_NATIVE(id->subvendor);
214 id->subdevice = TO_NATIVE(id->subdevice);
215 id->class = TO_NATIVE(id->class);
216 id->class_mask = TO_NATIVE(id->class_mask);
218 strcpy(alias, "pci:");
219 ADD(alias, "v", id->vendor != PCI_ANY_ID, id->vendor);
220 ADD(alias, "d", id->device != PCI_ANY_ID, id->device);
221 ADD(alias, "sv", id->subvendor != PCI_ANY_ID, id->subvendor);
222 ADD(alias, "sd", id->subdevice != PCI_ANY_ID, id->subdevice);
224 baseclass = (id->class) >> 16;
225 baseclass_mask = (id->class_mask) >> 16;
226 subclass = (id->class) >> 8;
227 subclass_mask = (id->class_mask) >> 8;
228 interface = id->class;
229 interface_mask = id->class_mask;
231 if ((baseclass_mask != 0 && baseclass_mask != 0xFF)
232 || (subclass_mask != 0 && subclass_mask != 0xFF)
233 || (interface_mask != 0 && interface_mask != 0xFF)) {
234 warn("Can't handle masks in %s:%04X\n",
235 filename, id->class_mask);
239 ADD(alias, "bc", baseclass_mask == 0xFF, baseclass);
240 ADD(alias, "sc", subclass_mask == 0xFF, subclass);
241 ADD(alias, "i", interface_mask == 0xFF, interface);
245 /* looks like: "ccw:tNmNdtNdmN" */
246 static int do_ccw_entry(const char *filename,
247 struct ccw_device_id *id, char *alias)
249 id->match_flags = TO_NATIVE(id->match_flags);
250 id->cu_type = TO_NATIVE(id->cu_type);
251 id->cu_model = TO_NATIVE(id->cu_model);
252 id->dev_type = TO_NATIVE(id->dev_type);
253 id->dev_model = TO_NATIVE(id->dev_model);
255 strcpy(alias, "ccw:");
256 ADD(alias, "t", id->match_flags&CCW_DEVICE_ID_MATCH_CU_TYPE,
258 ADD(alias, "m", id->match_flags&CCW_DEVICE_ID_MATCH_CU_MODEL,
260 ADD(alias, "dt", id->match_flags&CCW_DEVICE_ID_MATCH_DEVICE_TYPE,
262 ADD(alias, "dm", id->match_flags&CCW_DEVICE_ID_MATCH_DEVICE_MODEL,
267 /* looks like: "ap:tN" */
268 static int do_ap_entry(const char *filename,
269 struct ap_device_id *id, char *alias)
271 sprintf(alias, "ap:t%02X", id->dev_type);
275 /* Looks like: "serio:tyNprNidNexN" */
276 static int do_serio_entry(const char *filename,
277 struct serio_device_id *id, char *alias)
279 id->type = TO_NATIVE(id->type);
280 id->proto = TO_NATIVE(id->proto);
281 id->id = TO_NATIVE(id->id);
282 id->extra = TO_NATIVE(id->extra);
284 strcpy(alias, "serio:");
285 ADD(alias, "ty", id->type != SERIO_ANY, id->type);
286 ADD(alias, "pr", id->proto != SERIO_ANY, id->proto);
287 ADD(alias, "id", id->id != SERIO_ANY, id->id);
288 ADD(alias, "ex", id->extra != SERIO_ANY, id->extra);
293 /* looks like: "pnp:dD" */
294 static int do_pnp_entry(const char *filename,
295 struct pnp_device_id *id, char *alias)
297 sprintf(alias, "pnp:d%s", id->id);
301 /* looks like: "pnp:cCdD..." */
302 static int do_pnp_card_entry(const char *filename,
303 struct pnp_card_device_id *id, char *alias)
307 sprintf(alias, "pnp:c%s", id->id);
308 for (i = 0; i < PNP_MAX_DEVICES; i++) {
309 if (! *id->devs[i].id)
311 sprintf(alias + strlen(alias), "d%s", id->devs[i].id);
316 /* Looks like: pcmcia:mNcNfNfnNpfnNvaNvbNvcNvdN. */
317 static int do_pcmcia_entry(const char *filename,
318 struct pcmcia_device_id *id, char *alias)
322 id->match_flags = TO_NATIVE(id->match_flags);
323 id->manf_id = TO_NATIVE(id->manf_id);
324 id->card_id = TO_NATIVE(id->card_id);
325 id->func_id = TO_NATIVE(id->func_id);
326 id->function = TO_NATIVE(id->function);
327 id->device_no = TO_NATIVE(id->device_no);
329 for (i=0; i<4; i++) {
330 id->prod_id_hash[i] = TO_NATIVE(id->prod_id_hash[i]);
333 strcpy(alias, "pcmcia:");
334 ADD(alias, "m", id->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID,
336 ADD(alias, "c", id->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID,
338 ADD(alias, "f", id->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID,
340 ADD(alias, "fn", id->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION,
342 ADD(alias, "pfn", id->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO,
344 ADD(alias, "pa", id->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1, id->prod_id_hash[0]);
345 ADD(alias, "pb", id->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2, id->prod_id_hash[1]);
346 ADD(alias, "pc", id->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3, id->prod_id_hash[2]);
347 ADD(alias, "pd", id->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4, id->prod_id_hash[3]);
354 static int do_of_entry (const char *filename, struct of_device_id *of, char *alias)
358 len = sprintf (alias, "of:N%sT%s",
359 of->name[0] ? of->name : "*",
360 of->type[0] ? of->type : "*");
362 if (of->compatible[0])
363 sprintf (&alias[len], "%sC%s",
364 of->type[0] ? "*" : "",
367 /* Replace all whitespace with underscores */
368 for (tmp = alias; tmp && *tmp; tmp++)
375 static int do_vio_entry(const char *filename, struct vio_device_id *vio,
380 sprintf(alias, "vio:T%sS%s", vio->type[0] ? vio->type : "*",
381 vio->compat[0] ? vio->compat : "*");
383 /* Replace all whitespace with underscores */
384 for (tmp = alias; tmp && *tmp; tmp++)
391 static int do_i2c_entry(const char *filename, struct i2c_device_id *i2c, char *alias)
393 strcpy(alias, "i2c:");
394 ADD(alias, "id", 1, i2c->id);
398 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
400 static void do_input(char *alias,
401 kernel_ulong_t *arr, unsigned int min, unsigned int max)
405 for (i = min; i < max; i++)
406 if (arr[i / BITS_PER_LONG] & (1L << (i%BITS_PER_LONG)))
407 sprintf(alias + strlen(alias), "%X,*", i);
410 /* input:b0v0p0e0-eXkXrXaXmXlXsXfXwX where X is comma-separated %02X. */
411 static int do_input_entry(const char *filename, struct input_device_id *id,
414 sprintf(alias, "input:");
416 ADD(alias, "b", id->flags & INPUT_DEVICE_ID_MATCH_BUS, id->bustype);
417 ADD(alias, "v", id->flags & INPUT_DEVICE_ID_MATCH_VENDOR, id->vendor);
418 ADD(alias, "p", id->flags & INPUT_DEVICE_ID_MATCH_PRODUCT, id->product);
419 ADD(alias, "e", id->flags & INPUT_DEVICE_ID_MATCH_VERSION, id->version);
421 sprintf(alias + strlen(alias), "-e*");
422 if (id->flags & INPUT_DEVICE_ID_MATCH_EVBIT)
423 do_input(alias, id->evbit, 0, INPUT_DEVICE_ID_EV_MAX);
424 sprintf(alias + strlen(alias), "k*");
425 if (id->flags & INPUT_DEVICE_ID_MATCH_KEYBIT)
426 do_input(alias, id->keybit,
427 INPUT_DEVICE_ID_KEY_MIN_INTERESTING,
428 INPUT_DEVICE_ID_KEY_MAX);
429 sprintf(alias + strlen(alias), "r*");
430 if (id->flags & INPUT_DEVICE_ID_MATCH_RELBIT)
431 do_input(alias, id->relbit, 0, INPUT_DEVICE_ID_REL_MAX);
432 sprintf(alias + strlen(alias), "a*");
433 if (id->flags & INPUT_DEVICE_ID_MATCH_ABSBIT)
434 do_input(alias, id->absbit, 0, INPUT_DEVICE_ID_ABS_MAX);
435 sprintf(alias + strlen(alias), "m*");
436 if (id->flags & INPUT_DEVICE_ID_MATCH_MSCIT)
437 do_input(alias, id->mscbit, 0, INPUT_DEVICE_ID_MSC_MAX);
438 sprintf(alias + strlen(alias), "l*");
439 if (id->flags & INPUT_DEVICE_ID_MATCH_LEDBIT)
440 do_input(alias, id->ledbit, 0, INPUT_DEVICE_ID_LED_MAX);
441 sprintf(alias + strlen(alias), "s*");
442 if (id->flags & INPUT_DEVICE_ID_MATCH_SNDBIT)
443 do_input(alias, id->sndbit, 0, INPUT_DEVICE_ID_SND_MAX);
444 sprintf(alias + strlen(alias), "f*");
445 if (id->flags & INPUT_DEVICE_ID_MATCH_FFBIT)
446 do_input(alias, id->ffbit, 0, INPUT_DEVICE_ID_FF_MAX);
447 sprintf(alias + strlen(alias), "w*");
448 if (id->flags & INPUT_DEVICE_ID_MATCH_SWBIT)
449 do_input(alias, id->swbit, 0, INPUT_DEVICE_ID_SW_MAX);
453 static int do_eisa_entry(const char *filename, struct eisa_device_id *eisa,
457 sprintf(alias, EISA_DEVICE_MODALIAS_FMT "*", eisa->sig);
461 /* Looks like: parisc:tNhvNrevNsvN */
462 static int do_parisc_entry(const char *filename, struct parisc_device_id *id,
465 id->hw_type = TO_NATIVE(id->hw_type);
466 id->hversion = TO_NATIVE(id->hversion);
467 id->hversion_rev = TO_NATIVE(id->hversion_rev);
468 id->sversion = TO_NATIVE(id->sversion);
470 strcpy(alias, "parisc:");
471 ADD(alias, "t", id->hw_type != PA_HWTYPE_ANY_ID, id->hw_type);
472 ADD(alias, "hv", id->hversion != PA_HVERSION_ANY_ID, id->hversion);
473 ADD(alias, "rev", id->hversion_rev != PA_HVERSION_REV_ANY_ID, id->hversion_rev);
474 ADD(alias, "sv", id->sversion != PA_SVERSION_ANY_ID, id->sversion);
479 /* Ignore any prefix, eg. v850 prepends _ */
480 static inline int sym_is(const char *symbol, const char *name)
484 match = strstr(symbol, name);
487 return match[strlen(symbol)] == '\0';
490 static void do_table(void *symval, unsigned long size,
491 unsigned long id_size,
492 const char *device_id,
498 int (*do_entry)(const char *, void *entry, char *alias) = function;
500 device_id_size_check(mod->name, device_id, size, id_size);
501 /* Leave last one: it's the terminator. */
504 for (i = 0; i < size; i += id_size) {
505 if (do_entry(mod->name, symval+i, alias)) {
506 /* Always end in a wildcard, for future extension */
507 if (alias[strlen(alias)-1] != '*')
509 buf_printf(&mod->dev_table_buf,
510 "MODULE_ALIAS(\"%s\");\n", alias);
515 /* Create MODULE_ALIAS() statements.
516 * At this time, we cannot write the actual output C source yet,
517 * so we write into the mod->dev_table_buf buffer. */
518 void handle_moddevtable(struct module *mod, struct elf_info *info,
519 Elf_Sym *sym, const char *symname)
523 /* We're looking for a section relative symbol */
524 if (!sym->st_shndx || sym->st_shndx >= info->hdr->e_shnum)
527 symval = (void *)info->hdr
528 + info->sechdrs[sym->st_shndx].sh_offset
531 if (sym_is(symname, "__mod_pci_device_table"))
532 do_table(symval, sym->st_size,
533 sizeof(struct pci_device_id), "pci",
535 else if (sym_is(symname, "__mod_usb_device_table"))
536 /* special case to handle bcdDevice ranges */
537 do_usb_table(symval, sym->st_size, mod);
538 else if (sym_is(symname, "__mod_ieee1394_device_table"))
539 do_table(symval, sym->st_size,
540 sizeof(struct ieee1394_device_id), "ieee1394",
541 do_ieee1394_entry, mod);
542 else if (sym_is(symname, "__mod_ccw_device_table"))
543 do_table(symval, sym->st_size,
544 sizeof(struct ccw_device_id), "ccw",
546 else if (sym_is(symname, "__mod_ap_device_table"))
547 do_table(symval, sym->st_size,
548 sizeof(struct ap_device_id), "ap",
550 else if (sym_is(symname, "__mod_serio_device_table"))
551 do_table(symval, sym->st_size,
552 sizeof(struct serio_device_id), "serio",
553 do_serio_entry, mod);
554 else if (sym_is(symname, "__mod_pnp_device_table"))
555 do_table(symval, sym->st_size,
556 sizeof(struct pnp_device_id), "pnp",
558 else if (sym_is(symname, "__mod_pnp_card_device_table"))
559 do_table(symval, sym->st_size,
560 sizeof(struct pnp_card_device_id), "pnp_card",
561 do_pnp_card_entry, mod);
562 else if (sym_is(symname, "__mod_pcmcia_device_table"))
563 do_table(symval, sym->st_size,
564 sizeof(struct pcmcia_device_id), "pcmcia",
565 do_pcmcia_entry, mod);
566 else if (sym_is(symname, "__mod_of_device_table"))
567 do_table(symval, sym->st_size,
568 sizeof(struct of_device_id), "of",
570 else if (sym_is(symname, "__mod_vio_device_table"))
571 do_table(symval, sym->st_size,
572 sizeof(struct vio_device_id), "vio",
574 else if (sym_is(symname, "__mod_i2c_device_table"))
575 do_table(symval, sym->st_size,
576 sizeof(struct i2c_device_id), "i2c",
578 else if (sym_is(symname, "__mod_input_device_table"))
579 do_table(symval, sym->st_size,
580 sizeof(struct input_device_id), "input",
581 do_input_entry, mod);
582 else if (sym_is(symname, "__mod_eisa_device_table"))
583 do_table(symval, sym->st_size,
584 sizeof(struct eisa_device_id), "eisa",
586 else if (sym_is(symname, "__mod_parisc_device_table"))
587 do_table(symval, sym->st_size,
588 sizeof(struct parisc_device_id), "parisc",
589 do_parisc_entry, mod);
592 /* Now add out buffered information to the generated C source */
593 void add_moddevtable(struct buffer *buf, struct module *mod)
595 buf_printf(buf, "\n");
596 buf_write(buf, mod->dev_table_buf.p, mod->dev_table_buf.pos);
597 free(mod->dev_table_buf.p);