Back to home page

OSCL-LXR

 
 

    


0001 /* Simple code to turn various tables in an ELF file into alias definitions.
0002  * This deals with kernel datastructures where they should be
0003  * dealt with: in the kernel source.
0004  *
0005  * Copyright 2002-2003  Rusty Russell, IBM Corporation
0006  *           2003       Kai Germaschewski
0007  *
0008  *
0009  * This software may be used and distributed according to the terms
0010  * of the GNU General Public License, incorporated herein by reference.
0011  */
0012 
0013 #include "modpost.h"
0014 #include "devicetable-offsets.h"
0015 
0016 /* We use the ELF typedefs for kernel_ulong_t but bite the bullet and
0017  * use either stdint.h or inttypes.h for the rest. */
0018 #if KERNEL_ELFCLASS == ELFCLASS32
0019 typedef Elf32_Addr  kernel_ulong_t;
0020 #define BITS_PER_LONG 32
0021 #else
0022 typedef Elf64_Addr  kernel_ulong_t;
0023 #define BITS_PER_LONG 64
0024 #endif
0025 #ifdef __sun__
0026 #include <inttypes.h>
0027 #else
0028 #include <stdint.h>
0029 #endif
0030 
0031 #include <ctype.h>
0032 #include <stdbool.h>
0033 
0034 typedef uint32_t    __u32;
0035 typedef uint16_t    __u16;
0036 typedef unsigned char   __u8;
0037 typedef struct {
0038     __u8 b[16];
0039 } guid_t;
0040 
0041 /* backwards compatibility, don't use in new code */
0042 typedef struct {
0043     __u8 b[16];
0044 } uuid_le;
0045 typedef struct {
0046     __u8 b[16];
0047 } uuid_t;
0048 #define UUID_STRING_LEN     36
0049 
0050 /* Big exception to the "don't include kernel headers into userspace, which
0051  * even potentially has different endianness and word sizes, since
0052  * we handle those differences explicitly below */
0053 #include "../../include/linux/mod_devicetable.h"
0054 
0055 /* This array collects all instances that use the generic do_table */
0056 struct devtable {
0057     const char *device_id; /* name of table, __mod_<name>__*_device_table. */
0058     unsigned long id_size;
0059     int (*do_entry)(const char *filename, void *symval, char *alias);
0060 };
0061 
0062 /* Size of alias provided to do_entry functions */
0063 #define ALIAS_SIZE 500
0064 
0065 /* Define a variable f that holds the value of field f of struct devid
0066  * based at address m.
0067  */
0068 #define DEF_FIELD(m, devid, f) \
0069     typeof(((struct devid *)0)->f) f = TO_NATIVE(*(typeof(f) *)((m) + OFF_##devid##_##f))
0070 
0071 /* Define a variable v that holds the address of field f of struct devid
0072  * based at address m.  Due to the way typeof works, for a field of type
0073  * T[N] the variable has type T(*)[N], _not_ T*.
0074  */
0075 #define DEF_FIELD_ADDR_VAR(m, devid, f, v) \
0076     typeof(((struct devid *)0)->f) *v = ((m) + OFF_##devid##_##f)
0077 
0078 /* Define a variable f that holds the address of field f of struct devid
0079  * based at address m.  Due to the way typeof works, for a field of type
0080  * T[N] the variable has type T(*)[N], _not_ T*.
0081  */
0082 #define DEF_FIELD_ADDR(m, devid, f) \
0083     DEF_FIELD_ADDR_VAR(m, devid, f, f)
0084 
0085 #define ADD(str, sep, cond, field)                              \
0086 do {                                                            \
0087         strcat(str, sep);                                       \
0088         if (cond)                                               \
0089                 sprintf(str + strlen(str),                      \
0090                         sizeof(field) == 1 ? "%02X" :           \
0091                         sizeof(field) == 2 ? "%04X" :           \
0092                         sizeof(field) == 4 ? "%08X" : "",       \
0093                         field);                                 \
0094         else                                                    \
0095                 sprintf(str + strlen(str), "*");                \
0096 } while(0)
0097 
0098 /* End in a wildcard, for future extension */
0099 static inline void add_wildcard(char *str)
0100 {
0101     int len = strlen(str);
0102 
0103     if (str[len - 1] != '*')
0104         strcat(str + len, "*");
0105 }
0106 
0107 static inline void add_uuid(char *str, uuid_le uuid)
0108 {
0109     int len = strlen(str);
0110 
0111     sprintf(str + len, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
0112         uuid.b[3], uuid.b[2], uuid.b[1], uuid.b[0],
0113         uuid.b[5], uuid.b[4], uuid.b[7], uuid.b[6],
0114         uuid.b[8], uuid.b[9], uuid.b[10], uuid.b[11],
0115         uuid.b[12], uuid.b[13], uuid.b[14], uuid.b[15]);
0116 }
0117 
0118 static inline void add_guid(char *str, guid_t guid)
0119 {
0120     int len = strlen(str);
0121 
0122     sprintf(str + len, "%02X%02X%02X%02X-%02X%02X-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
0123         guid.b[3], guid.b[2], guid.b[1], guid.b[0],
0124         guid.b[5], guid.b[4], guid.b[7], guid.b[6],
0125         guid.b[8], guid.b[9], guid.b[10], guid.b[11],
0126         guid.b[12], guid.b[13], guid.b[14], guid.b[15]);
0127 }
0128 
0129 /**
0130  * Check that sizeof(device_id type) are consistent with size of section
0131  * in .o file. If in-consistent then userspace and kernel does not agree
0132  * on actual size which is a bug.
0133  * Also verify that the final entry in the table is all zeros.
0134  * Ignore both checks if build host differ from target host and size differs.
0135  **/
0136 static void device_id_check(const char *modname, const char *device_id,
0137                 unsigned long size, unsigned long id_size,
0138                 void *symval)
0139 {
0140     int i;
0141 
0142     if (size % id_size || size < id_size) {
0143         fatal("%s: sizeof(struct %s_device_id)=%lu is not a modulo "
0144               "of the size of "
0145               "section __mod_%s__<identifier>_device_table=%lu.\n"
0146               "Fix definition of struct %s_device_id "
0147               "in mod_devicetable.h\n",
0148               modname, device_id, id_size, device_id, size, device_id);
0149     }
0150     /* Verify last one is a terminator */
0151     for (i = 0; i < id_size; i++ ) {
0152         if (*(uint8_t*)(symval+size-id_size+i)) {
0153             fprintf(stderr,"%s: struct %s_device_id is %lu bytes.  "
0154                 "The last of %lu is:\n",
0155                 modname, device_id, id_size, size / id_size);
0156             for (i = 0; i < id_size; i++ )
0157                 fprintf(stderr,"0x%02x ",
0158                     *(uint8_t*)(symval+size-id_size+i) );
0159             fprintf(stderr,"\n");
0160             fatal("%s: struct %s_device_id is not terminated "
0161                 "with a NULL entry!\n", modname, device_id);
0162         }
0163     }
0164 }
0165 
0166 /* USB is special because the bcdDevice can be matched against a numeric range */
0167 /* Looks like "usb:vNpNdNdcNdscNdpNicNiscNipNinN" */
0168 static void do_usb_entry(void *symval,
0169              unsigned int bcdDevice_initial, int bcdDevice_initial_digits,
0170              unsigned char range_lo, unsigned char range_hi,
0171              unsigned char max, struct module *mod)
0172 {
0173     char alias[500];
0174     DEF_FIELD(symval, usb_device_id, match_flags);
0175     DEF_FIELD(symval, usb_device_id, idVendor);
0176     DEF_FIELD(symval, usb_device_id, idProduct);
0177     DEF_FIELD(symval, usb_device_id, bcdDevice_lo);
0178     DEF_FIELD(symval, usb_device_id, bDeviceClass);
0179     DEF_FIELD(symval, usb_device_id, bDeviceSubClass);
0180     DEF_FIELD(symval, usb_device_id, bDeviceProtocol);
0181     DEF_FIELD(symval, usb_device_id, bInterfaceClass);
0182     DEF_FIELD(symval, usb_device_id, bInterfaceSubClass);
0183     DEF_FIELD(symval, usb_device_id, bInterfaceProtocol);
0184     DEF_FIELD(symval, usb_device_id, bInterfaceNumber);
0185 
0186     strcpy(alias, "usb:");
0187     ADD(alias, "v", match_flags&USB_DEVICE_ID_MATCH_VENDOR,
0188         idVendor);
0189     ADD(alias, "p", match_flags&USB_DEVICE_ID_MATCH_PRODUCT,
0190         idProduct);
0191 
0192     strcat(alias, "d");
0193     if (bcdDevice_initial_digits)
0194         sprintf(alias + strlen(alias), "%0*X",
0195             bcdDevice_initial_digits, bcdDevice_initial);
0196     if (range_lo == range_hi)
0197         sprintf(alias + strlen(alias), "%X", range_lo);
0198     else if (range_lo > 0 || range_hi < max) {
0199         if (range_lo > 0x9 || range_hi < 0xA)
0200             sprintf(alias + strlen(alias),
0201                 "[%X-%X]",
0202                 range_lo,
0203                 range_hi);
0204         else {
0205             sprintf(alias + strlen(alias),
0206                 range_lo < 0x9 ? "[%X-9" : "[%X",
0207                 range_lo);
0208             sprintf(alias + strlen(alias),
0209                 range_hi > 0xA ? "A-%X]" : "%X]",
0210                 range_hi);
0211         }
0212     }
0213     if (bcdDevice_initial_digits < (sizeof(bcdDevice_lo) * 2 - 1))
0214         strcat(alias, "*");
0215 
0216     ADD(alias, "dc", match_flags&USB_DEVICE_ID_MATCH_DEV_CLASS,
0217         bDeviceClass);
0218     ADD(alias, "dsc", match_flags&USB_DEVICE_ID_MATCH_DEV_SUBCLASS,
0219         bDeviceSubClass);
0220     ADD(alias, "dp", match_flags&USB_DEVICE_ID_MATCH_DEV_PROTOCOL,
0221         bDeviceProtocol);
0222     ADD(alias, "ic", match_flags&USB_DEVICE_ID_MATCH_INT_CLASS,
0223         bInterfaceClass);
0224     ADD(alias, "isc", match_flags&USB_DEVICE_ID_MATCH_INT_SUBCLASS,
0225         bInterfaceSubClass);
0226     ADD(alias, "ip", match_flags&USB_DEVICE_ID_MATCH_INT_PROTOCOL,
0227         bInterfaceProtocol);
0228     ADD(alias, "in", match_flags&USB_DEVICE_ID_MATCH_INT_NUMBER,
0229         bInterfaceNumber);
0230 
0231     add_wildcard(alias);
0232     buf_printf(&mod->dev_table_buf,
0233            "MODULE_ALIAS(\"%s\");\n", alias);
0234 }
0235 
0236 /* Handles increment/decrement of BCD formatted integers */
0237 /* Returns the previous value, so it works like i++ or i-- */
0238 static unsigned int incbcd(unsigned int *bcd,
0239                int inc,
0240                unsigned char max,
0241                size_t chars)
0242 {
0243     unsigned int init = *bcd, i, j;
0244     unsigned long long c, dec = 0;
0245 
0246     /* If bcd is not in BCD format, just increment */
0247     if (max > 0x9) {
0248         *bcd += inc;
0249         return init;
0250     }
0251 
0252     /* Convert BCD to Decimal */
0253     for (i=0 ; i < chars ; i++) {
0254         c = (*bcd >> (i << 2)) & 0xf;
0255         c = c > 9 ? 9 : c; /* force to bcd just in case */
0256         for (j=0 ; j < i ; j++)
0257             c = c * 10;
0258         dec += c;
0259     }
0260 
0261     /* Do our increment/decrement */
0262     dec += inc;
0263     *bcd  = 0;
0264 
0265     /* Convert back to BCD */
0266     for (i=0 ; i < chars ; i++) {
0267         for (c=1,j=0 ; j < i ; j++)
0268             c = c * 10;
0269         c = (dec / c) % 10;
0270         *bcd += c << (i << 2);
0271     }
0272     return init;
0273 }
0274 
0275 static void do_usb_entry_multi(void *symval, struct module *mod)
0276 {
0277     unsigned int devlo, devhi;
0278     unsigned char chi, clo, max;
0279     int ndigits;
0280 
0281     DEF_FIELD(symval, usb_device_id, match_flags);
0282     DEF_FIELD(symval, usb_device_id, idVendor);
0283     DEF_FIELD(symval, usb_device_id, idProduct);
0284     DEF_FIELD(symval, usb_device_id, bcdDevice_lo);
0285     DEF_FIELD(symval, usb_device_id, bcdDevice_hi);
0286     DEF_FIELD(symval, usb_device_id, bDeviceClass);
0287     DEF_FIELD(symval, usb_device_id, bInterfaceClass);
0288 
0289     devlo = match_flags & USB_DEVICE_ID_MATCH_DEV_LO ?
0290         bcdDevice_lo : 0x0U;
0291     devhi = match_flags & USB_DEVICE_ID_MATCH_DEV_HI ?
0292         bcdDevice_hi : ~0x0U;
0293 
0294     /* Figure out if this entry is in bcd or hex format */
0295     max = 0x9; /* Default to decimal format */
0296     for (ndigits = 0 ; ndigits < sizeof(bcdDevice_lo) * 2 ; ndigits++) {
0297         clo = (devlo >> (ndigits << 2)) & 0xf;
0298         chi = ((devhi > 0x9999 ? 0x9999 : devhi) >> (ndigits << 2)) & 0xf;
0299         if (clo > max || chi > max) {
0300             max = 0xf;
0301             break;
0302         }
0303     }
0304 
0305     /*
0306      * Some modules (visor) have empty slots as placeholder for
0307      * run-time specification that results in catch-all alias
0308      */
0309     if (!(idVendor | idProduct | bDeviceClass | bInterfaceClass))
0310         return;
0311 
0312     /* Convert numeric bcdDevice range into fnmatch-able pattern(s) */
0313     for (ndigits = sizeof(bcdDevice_lo) * 2 - 1; devlo <= devhi; ndigits--) {
0314         clo = devlo & 0xf;
0315         chi = devhi & 0xf;
0316         if (chi > max)  /* If we are in bcd mode, truncate if necessary */
0317             chi = max;
0318         devlo >>= 4;
0319         devhi >>= 4;
0320 
0321         if (devlo == devhi || !ndigits) {
0322             do_usb_entry(symval, devlo, ndigits, clo, chi, max, mod);
0323             break;
0324         }
0325 
0326         if (clo > 0x0)
0327             do_usb_entry(symval,
0328                      incbcd(&devlo, 1, max,
0329                         sizeof(bcdDevice_lo) * 2),
0330                      ndigits, clo, max, max, mod);
0331 
0332         if (chi < max)
0333             do_usb_entry(symval,
0334                      incbcd(&devhi, -1, max,
0335                         sizeof(bcdDevice_lo) * 2),
0336                      ndigits, 0x0, chi, max, mod);
0337     }
0338 }
0339 
0340 static void do_usb_table(void *symval, unsigned long size,
0341              struct module *mod)
0342 {
0343     unsigned int i;
0344     const unsigned long id_size = SIZE_usb_device_id;
0345 
0346     device_id_check(mod->name, "usb", size, id_size, symval);
0347 
0348     /* Leave last one: it's the terminator. */
0349     size -= id_size;
0350 
0351     for (i = 0; i < size; i += id_size)
0352         do_usb_entry_multi(symval + i, mod);
0353 }
0354 
0355 static void do_of_entry_multi(void *symval, struct module *mod)
0356 {
0357     char alias[500];
0358     int len;
0359     char *tmp;
0360 
0361     DEF_FIELD_ADDR(symval, of_device_id, name);
0362     DEF_FIELD_ADDR(symval, of_device_id, type);
0363     DEF_FIELD_ADDR(symval, of_device_id, compatible);
0364 
0365     len = sprintf(alias, "of:N%sT%s", (*name)[0] ? *name : "*",
0366               (*type)[0] ? *type : "*");
0367 
0368     if ((*compatible)[0])
0369         sprintf(&alias[len], "%sC%s", (*type)[0] ? "*" : "",
0370             *compatible);
0371 
0372     /* Replace all whitespace with underscores */
0373     for (tmp = alias; tmp && *tmp; tmp++)
0374         if (isspace(*tmp))
0375             *tmp = '_';
0376 
0377     buf_printf(&mod->dev_table_buf, "MODULE_ALIAS(\"%s\");\n", alias);
0378     strcat(alias, "C");
0379     add_wildcard(alias);
0380     buf_printf(&mod->dev_table_buf, "MODULE_ALIAS(\"%s\");\n", alias);
0381 }
0382 
0383 static void do_of_table(void *symval, unsigned long size,
0384             struct module *mod)
0385 {
0386     unsigned int i;
0387     const unsigned long id_size = SIZE_of_device_id;
0388 
0389     device_id_check(mod->name, "of", size, id_size, symval);
0390 
0391     /* Leave last one: it's the terminator. */
0392     size -= id_size;
0393 
0394     for (i = 0; i < size; i += id_size)
0395         do_of_entry_multi(symval + i, mod);
0396 }
0397 
0398 /* Looks like: hid:bNvNpN */
0399 static int do_hid_entry(const char *filename,
0400                  void *symval, char *alias)
0401 {
0402     DEF_FIELD(symval, hid_device_id, bus);
0403     DEF_FIELD(symval, hid_device_id, group);
0404     DEF_FIELD(symval, hid_device_id, vendor);
0405     DEF_FIELD(symval, hid_device_id, product);
0406 
0407     sprintf(alias, "hid:");
0408     ADD(alias, "b", bus != HID_BUS_ANY, bus);
0409     ADD(alias, "g", group != HID_GROUP_ANY, group);
0410     ADD(alias, "v", vendor != HID_ANY_ID, vendor);
0411     ADD(alias, "p", product != HID_ANY_ID, product);
0412 
0413     return 1;
0414 }
0415 
0416 /* Looks like: ieee1394:venNmoNspNverN */
0417 static int do_ieee1394_entry(const char *filename,
0418                  void *symval, char *alias)
0419 {
0420     DEF_FIELD(symval, ieee1394_device_id, match_flags);
0421     DEF_FIELD(symval, ieee1394_device_id, vendor_id);
0422     DEF_FIELD(symval, ieee1394_device_id, model_id);
0423     DEF_FIELD(symval, ieee1394_device_id, specifier_id);
0424     DEF_FIELD(symval, ieee1394_device_id, version);
0425 
0426     strcpy(alias, "ieee1394:");
0427     ADD(alias, "ven", match_flags & IEEE1394_MATCH_VENDOR_ID,
0428         vendor_id);
0429     ADD(alias, "mo", match_flags & IEEE1394_MATCH_MODEL_ID,
0430         model_id);
0431     ADD(alias, "sp", match_flags & IEEE1394_MATCH_SPECIFIER_ID,
0432         specifier_id);
0433     ADD(alias, "ver", match_flags & IEEE1394_MATCH_VERSION,
0434         version);
0435 
0436     add_wildcard(alias);
0437     return 1;
0438 }
0439 
0440 /* Looks like: pci:vNdNsvNsdNbcNscNiN or <prefix>_pci:vNdNsvNsdNbcNscNiN. */
0441 static int do_pci_entry(const char *filename,
0442             void *symval, char *alias)
0443 {
0444     /* Class field can be divided into these three. */
0445     unsigned char baseclass, subclass, interface,
0446         baseclass_mask, subclass_mask, interface_mask;
0447 
0448     DEF_FIELD(symval, pci_device_id, vendor);
0449     DEF_FIELD(symval, pci_device_id, device);
0450     DEF_FIELD(symval, pci_device_id, subvendor);
0451     DEF_FIELD(symval, pci_device_id, subdevice);
0452     DEF_FIELD(symval, pci_device_id, class);
0453     DEF_FIELD(symval, pci_device_id, class_mask);
0454     DEF_FIELD(symval, pci_device_id, override_only);
0455 
0456     switch (override_only) {
0457     case 0:
0458         strcpy(alias, "pci:");
0459         break;
0460     case PCI_ID_F_VFIO_DRIVER_OVERRIDE:
0461         strcpy(alias, "vfio_pci:");
0462         break;
0463     default:
0464         warn("Unknown PCI driver_override alias %08X\n",
0465              override_only);
0466         return 0;
0467     }
0468 
0469     ADD(alias, "v", vendor != PCI_ANY_ID, vendor);
0470     ADD(alias, "d", device != PCI_ANY_ID, device);
0471     ADD(alias, "sv", subvendor != PCI_ANY_ID, subvendor);
0472     ADD(alias, "sd", subdevice != PCI_ANY_ID, subdevice);
0473 
0474     baseclass = (class) >> 16;
0475     baseclass_mask = (class_mask) >> 16;
0476     subclass = (class) >> 8;
0477     subclass_mask = (class_mask) >> 8;
0478     interface = class;
0479     interface_mask = class_mask;
0480 
0481     if ((baseclass_mask != 0 && baseclass_mask != 0xFF)
0482         || (subclass_mask != 0 && subclass_mask != 0xFF)
0483         || (interface_mask != 0 && interface_mask != 0xFF)) {
0484         warn("Can't handle masks in %s:%04X\n",
0485              filename, class_mask);
0486         return 0;
0487     }
0488 
0489     ADD(alias, "bc", baseclass_mask == 0xFF, baseclass);
0490     ADD(alias, "sc", subclass_mask == 0xFF, subclass);
0491     ADD(alias, "i", interface_mask == 0xFF, interface);
0492     add_wildcard(alias);
0493     return 1;
0494 }
0495 
0496 /* looks like: "ccw:tNmNdtNdmN" */
0497 static int do_ccw_entry(const char *filename,
0498             void *symval, char *alias)
0499 {
0500     DEF_FIELD(symval, ccw_device_id, match_flags);
0501     DEF_FIELD(symval, ccw_device_id, cu_type);
0502     DEF_FIELD(symval, ccw_device_id, cu_model);
0503     DEF_FIELD(symval, ccw_device_id, dev_type);
0504     DEF_FIELD(symval, ccw_device_id, dev_model);
0505 
0506     strcpy(alias, "ccw:");
0507     ADD(alias, "t", match_flags&CCW_DEVICE_ID_MATCH_CU_TYPE,
0508         cu_type);
0509     ADD(alias, "m", match_flags&CCW_DEVICE_ID_MATCH_CU_MODEL,
0510         cu_model);
0511     ADD(alias, "dt", match_flags&CCW_DEVICE_ID_MATCH_DEVICE_TYPE,
0512         dev_type);
0513     ADD(alias, "dm", match_flags&CCW_DEVICE_ID_MATCH_DEVICE_MODEL,
0514         dev_model);
0515     add_wildcard(alias);
0516     return 1;
0517 }
0518 
0519 /* looks like: "ap:tN" */
0520 static int do_ap_entry(const char *filename,
0521                void *symval, char *alias)
0522 {
0523     DEF_FIELD(symval, ap_device_id, dev_type);
0524 
0525     sprintf(alias, "ap:t%02X*", dev_type);
0526     return 1;
0527 }
0528 
0529 /* looks like: "css:tN" */
0530 static int do_css_entry(const char *filename,
0531             void *symval, char *alias)
0532 {
0533     DEF_FIELD(symval, css_device_id, type);
0534 
0535     sprintf(alias, "css:t%01X", type);
0536     return 1;
0537 }
0538 
0539 /* Looks like: "serio:tyNprNidNexN" */
0540 static int do_serio_entry(const char *filename,
0541               void *symval, char *alias)
0542 {
0543     DEF_FIELD(symval, serio_device_id, type);
0544     DEF_FIELD(symval, serio_device_id, proto);
0545     DEF_FIELD(symval, serio_device_id, id);
0546     DEF_FIELD(symval, serio_device_id, extra);
0547 
0548     strcpy(alias, "serio:");
0549     ADD(alias, "ty", type != SERIO_ANY, type);
0550     ADD(alias, "pr", proto != SERIO_ANY, proto);
0551     ADD(alias, "id", id != SERIO_ANY, id);
0552     ADD(alias, "ex", extra != SERIO_ANY, extra);
0553 
0554     add_wildcard(alias);
0555     return 1;
0556 }
0557 
0558 /* looks like: "acpi:ACPI0003" or "acpi:PNP0C0B" or "acpi:LNXVIDEO" or
0559  *             "acpi:bbsspp" (bb=base-class, ss=sub-class, pp=prog-if)
0560  *
0561  * NOTE: Each driver should use one of the following : _HID, _CIDs
0562  *       or _CLS. Also, bb, ss, and pp can be substituted with ??
0563  *       as don't care byte.
0564  */
0565 static int do_acpi_entry(const char *filename,
0566             void *symval, char *alias)
0567 {
0568     DEF_FIELD_ADDR(symval, acpi_device_id, id);
0569     DEF_FIELD_ADDR(symval, acpi_device_id, cls);
0570     DEF_FIELD_ADDR(symval, acpi_device_id, cls_msk);
0571 
0572     if (id && strlen((const char *)*id))
0573         sprintf(alias, "acpi*:%s:*", *id);
0574     else if (cls) {
0575         int i, byte_shift, cnt = 0;
0576         unsigned int msk;
0577 
0578         sprintf(&alias[cnt], "acpi*:");
0579         cnt = 6;
0580         for (i = 1; i <= 3; i++) {
0581             byte_shift = 8 * (3-i);
0582             msk = (*cls_msk >> byte_shift) & 0xFF;
0583             if (msk)
0584                 sprintf(&alias[cnt], "%02x",
0585                     (*cls >> byte_shift) & 0xFF);
0586             else
0587                 sprintf(&alias[cnt], "??");
0588             cnt += 2;
0589         }
0590         sprintf(&alias[cnt], ":*");
0591     }
0592     return 1;
0593 }
0594 
0595 /* looks like: "pnp:dD" */
0596 static void do_pnp_device_entry(void *symval, unsigned long size,
0597                 struct module *mod)
0598 {
0599     const unsigned long id_size = SIZE_pnp_device_id;
0600     const unsigned int count = (size / id_size)-1;
0601     unsigned int i;
0602 
0603     device_id_check(mod->name, "pnp", size, id_size, symval);
0604 
0605     for (i = 0; i < count; i++) {
0606         DEF_FIELD_ADDR(symval + i*id_size, pnp_device_id, id);
0607         char acpi_id[sizeof(*id)];
0608         int j;
0609 
0610         buf_printf(&mod->dev_table_buf,
0611                "MODULE_ALIAS(\"pnp:d%s*\");\n", *id);
0612 
0613         /* fix broken pnp bus lowercasing */
0614         for (j = 0; j < sizeof(acpi_id); j++)
0615             acpi_id[j] = toupper((*id)[j]);
0616         buf_printf(&mod->dev_table_buf,
0617                "MODULE_ALIAS(\"acpi*:%s:*\");\n", acpi_id);
0618     }
0619 }
0620 
0621 /* looks like: "pnp:dD" for every device of the card */
0622 static void do_pnp_card_entries(void *symval, unsigned long size,
0623                 struct module *mod)
0624 {
0625     const unsigned long id_size = SIZE_pnp_card_device_id;
0626     const unsigned int count = (size / id_size)-1;
0627     unsigned int i;
0628 
0629     device_id_check(mod->name, "pnp", size, id_size, symval);
0630 
0631     for (i = 0; i < count; i++) {
0632         unsigned int j;
0633         DEF_FIELD_ADDR(symval + i * id_size, pnp_card_device_id, devs);
0634 
0635         for (j = 0; j < PNP_MAX_DEVICES; j++) {
0636             const char *id = (char *)(*devs)[j].id;
0637             int i2, j2;
0638             int dup = 0;
0639 
0640             if (!id[0])
0641                 break;
0642 
0643             /* find duplicate, already added value */
0644             for (i2 = 0; i2 < i && !dup; i2++) {
0645                 DEF_FIELD_ADDR_VAR(symval + i2 * id_size,
0646                            pnp_card_device_id,
0647                            devs, devs_dup);
0648 
0649                 for (j2 = 0; j2 < PNP_MAX_DEVICES; j2++) {
0650                     const char *id2 =
0651                         (char *)(*devs_dup)[j2].id;
0652 
0653                     if (!id2[0])
0654                         break;
0655 
0656                     if (!strcmp(id, id2)) {
0657                         dup = 1;
0658                         break;
0659                     }
0660                 }
0661             }
0662 
0663             /* add an individual alias for every device entry */
0664             if (!dup) {
0665                 char acpi_id[PNP_ID_LEN];
0666                 int k;
0667 
0668                 buf_printf(&mod->dev_table_buf,
0669                        "MODULE_ALIAS(\"pnp:d%s*\");\n", id);
0670 
0671                 /* fix broken pnp bus lowercasing */
0672                 for (k = 0; k < sizeof(acpi_id); k++)
0673                     acpi_id[k] = toupper(id[k]);
0674                 buf_printf(&mod->dev_table_buf,
0675                        "MODULE_ALIAS(\"acpi*:%s:*\");\n", acpi_id);
0676             }
0677         }
0678     }
0679 }
0680 
0681 /* Looks like: pcmcia:mNcNfNfnNpfnNvaNvbNvcNvdN. */
0682 static int do_pcmcia_entry(const char *filename,
0683                void *symval, char *alias)
0684 {
0685     unsigned int i;
0686     DEF_FIELD(symval, pcmcia_device_id, match_flags);
0687     DEF_FIELD(symval, pcmcia_device_id, manf_id);
0688     DEF_FIELD(symval, pcmcia_device_id, card_id);
0689     DEF_FIELD(symval, pcmcia_device_id, func_id);
0690     DEF_FIELD(symval, pcmcia_device_id, function);
0691     DEF_FIELD(symval, pcmcia_device_id, device_no);
0692     DEF_FIELD_ADDR(symval, pcmcia_device_id, prod_id_hash);
0693 
0694     for (i=0; i<4; i++) {
0695         (*prod_id_hash)[i] = TO_NATIVE((*prod_id_hash)[i]);
0696     }
0697 
0698     strcpy(alias, "pcmcia:");
0699     ADD(alias, "m", match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID,
0700         manf_id);
0701     ADD(alias, "c", match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID,
0702         card_id);
0703     ADD(alias, "f", match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID,
0704         func_id);
0705     ADD(alias, "fn", match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION,
0706         function);
0707     ADD(alias, "pfn", match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO,
0708         device_no);
0709     ADD(alias, "pa", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1, (*prod_id_hash)[0]);
0710     ADD(alias, "pb", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2, (*prod_id_hash)[1]);
0711     ADD(alias, "pc", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3, (*prod_id_hash)[2]);
0712     ADD(alias, "pd", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4, (*prod_id_hash)[3]);
0713 
0714     add_wildcard(alias);
0715     return 1;
0716 }
0717 
0718 static int do_vio_entry(const char *filename, void *symval,
0719         char *alias)
0720 {
0721     char *tmp;
0722     DEF_FIELD_ADDR(symval, vio_device_id, type);
0723     DEF_FIELD_ADDR(symval, vio_device_id, compat);
0724 
0725     sprintf(alias, "vio:T%sS%s", (*type)[0] ? *type : "*",
0726             (*compat)[0] ? *compat : "*");
0727 
0728     /* Replace all whitespace with underscores */
0729     for (tmp = alias; tmp && *tmp; tmp++)
0730         if (isspace (*tmp))
0731             *tmp = '_';
0732 
0733     add_wildcard(alias);
0734     return 1;
0735 }
0736 
0737 static void do_input(char *alias,
0738              kernel_ulong_t *arr, unsigned int min, unsigned int max)
0739 {
0740     unsigned int i;
0741 
0742     for (i = min / BITS_PER_LONG; i < max / BITS_PER_LONG + 1; i++)
0743         arr[i] = TO_NATIVE(arr[i]);
0744     for (i = min; i < max; i++)
0745         if (arr[i / BITS_PER_LONG] & (1L << (i%BITS_PER_LONG)))
0746             sprintf(alias + strlen(alias), "%X,*", i);
0747 }
0748 
0749 /* input:b0v0p0e0-eXkXrXaXmXlXsXfXwX where X is comma-separated %02X. */
0750 static int do_input_entry(const char *filename, void *symval,
0751               char *alias)
0752 {
0753     DEF_FIELD(symval, input_device_id, flags);
0754     DEF_FIELD(symval, input_device_id, bustype);
0755     DEF_FIELD(symval, input_device_id, vendor);
0756     DEF_FIELD(symval, input_device_id, product);
0757     DEF_FIELD(symval, input_device_id, version);
0758     DEF_FIELD_ADDR(symval, input_device_id, evbit);
0759     DEF_FIELD_ADDR(symval, input_device_id, keybit);
0760     DEF_FIELD_ADDR(symval, input_device_id, relbit);
0761     DEF_FIELD_ADDR(symval, input_device_id, absbit);
0762     DEF_FIELD_ADDR(symval, input_device_id, mscbit);
0763     DEF_FIELD_ADDR(symval, input_device_id, ledbit);
0764     DEF_FIELD_ADDR(symval, input_device_id, sndbit);
0765     DEF_FIELD_ADDR(symval, input_device_id, ffbit);
0766     DEF_FIELD_ADDR(symval, input_device_id, swbit);
0767 
0768     sprintf(alias, "input:");
0769 
0770     ADD(alias, "b", flags & INPUT_DEVICE_ID_MATCH_BUS, bustype);
0771     ADD(alias, "v", flags & INPUT_DEVICE_ID_MATCH_VENDOR, vendor);
0772     ADD(alias, "p", flags & INPUT_DEVICE_ID_MATCH_PRODUCT, product);
0773     ADD(alias, "e", flags & INPUT_DEVICE_ID_MATCH_VERSION, version);
0774 
0775     sprintf(alias + strlen(alias), "-e*");
0776     if (flags & INPUT_DEVICE_ID_MATCH_EVBIT)
0777         do_input(alias, *evbit, 0, INPUT_DEVICE_ID_EV_MAX);
0778     sprintf(alias + strlen(alias), "k*");
0779     if (flags & INPUT_DEVICE_ID_MATCH_KEYBIT)
0780         do_input(alias, *keybit,
0781              INPUT_DEVICE_ID_KEY_MIN_INTERESTING,
0782              INPUT_DEVICE_ID_KEY_MAX);
0783     sprintf(alias + strlen(alias), "r*");
0784     if (flags & INPUT_DEVICE_ID_MATCH_RELBIT)
0785         do_input(alias, *relbit, 0, INPUT_DEVICE_ID_REL_MAX);
0786     sprintf(alias + strlen(alias), "a*");
0787     if (flags & INPUT_DEVICE_ID_MATCH_ABSBIT)
0788         do_input(alias, *absbit, 0, INPUT_DEVICE_ID_ABS_MAX);
0789     sprintf(alias + strlen(alias), "m*");
0790     if (flags & INPUT_DEVICE_ID_MATCH_MSCIT)
0791         do_input(alias, *mscbit, 0, INPUT_DEVICE_ID_MSC_MAX);
0792     sprintf(alias + strlen(alias), "l*");
0793     if (flags & INPUT_DEVICE_ID_MATCH_LEDBIT)
0794         do_input(alias, *ledbit, 0, INPUT_DEVICE_ID_LED_MAX);
0795     sprintf(alias + strlen(alias), "s*");
0796     if (flags & INPUT_DEVICE_ID_MATCH_SNDBIT)
0797         do_input(alias, *sndbit, 0, INPUT_DEVICE_ID_SND_MAX);
0798     sprintf(alias + strlen(alias), "f*");
0799     if (flags & INPUT_DEVICE_ID_MATCH_FFBIT)
0800         do_input(alias, *ffbit, 0, INPUT_DEVICE_ID_FF_MAX);
0801     sprintf(alias + strlen(alias), "w*");
0802     if (flags & INPUT_DEVICE_ID_MATCH_SWBIT)
0803         do_input(alias, *swbit, 0, INPUT_DEVICE_ID_SW_MAX);
0804     return 1;
0805 }
0806 
0807 static int do_eisa_entry(const char *filename, void *symval,
0808         char *alias)
0809 {
0810     DEF_FIELD_ADDR(symval, eisa_device_id, sig);
0811     if (sig[0])
0812         sprintf(alias, EISA_DEVICE_MODALIAS_FMT "*", *sig);
0813     else
0814         strcat(alias, "*");
0815     return 1;
0816 }
0817 
0818 /* Looks like: parisc:tNhvNrevNsvN */
0819 static int do_parisc_entry(const char *filename, void *symval,
0820         char *alias)
0821 {
0822     DEF_FIELD(symval, parisc_device_id, hw_type);
0823     DEF_FIELD(symval, parisc_device_id, hversion);
0824     DEF_FIELD(symval, parisc_device_id, hversion_rev);
0825     DEF_FIELD(symval, parisc_device_id, sversion);
0826 
0827     strcpy(alias, "parisc:");
0828     ADD(alias, "t", hw_type != PA_HWTYPE_ANY_ID, hw_type);
0829     ADD(alias, "hv", hversion != PA_HVERSION_ANY_ID, hversion);
0830     ADD(alias, "rev", hversion_rev != PA_HVERSION_REV_ANY_ID, hversion_rev);
0831     ADD(alias, "sv", sversion != PA_SVERSION_ANY_ID, sversion);
0832 
0833     add_wildcard(alias);
0834     return 1;
0835 }
0836 
0837 /* Looks like: sdio:cNvNdN. */
0838 static int do_sdio_entry(const char *filename,
0839             void *symval, char *alias)
0840 {
0841     DEF_FIELD(symval, sdio_device_id, class);
0842     DEF_FIELD(symval, sdio_device_id, vendor);
0843     DEF_FIELD(symval, sdio_device_id, device);
0844 
0845     strcpy(alias, "sdio:");
0846     ADD(alias, "c", class != (__u8)SDIO_ANY_ID, class);
0847     ADD(alias, "v", vendor != (__u16)SDIO_ANY_ID, vendor);
0848     ADD(alias, "d", device != (__u16)SDIO_ANY_ID, device);
0849     add_wildcard(alias);
0850     return 1;
0851 }
0852 
0853 /* Looks like: ssb:vNidNrevN. */
0854 static int do_ssb_entry(const char *filename,
0855             void *symval, char *alias)
0856 {
0857     DEF_FIELD(symval, ssb_device_id, vendor);
0858     DEF_FIELD(symval, ssb_device_id, coreid);
0859     DEF_FIELD(symval, ssb_device_id, revision);
0860 
0861     strcpy(alias, "ssb:");
0862     ADD(alias, "v", vendor != SSB_ANY_VENDOR, vendor);
0863     ADD(alias, "id", coreid != SSB_ANY_ID, coreid);
0864     ADD(alias, "rev", revision != SSB_ANY_REV, revision);
0865     add_wildcard(alias);
0866     return 1;
0867 }
0868 
0869 /* Looks like: bcma:mNidNrevNclN. */
0870 static int do_bcma_entry(const char *filename,
0871              void *symval, char *alias)
0872 {
0873     DEF_FIELD(symval, bcma_device_id, manuf);
0874     DEF_FIELD(symval, bcma_device_id, id);
0875     DEF_FIELD(symval, bcma_device_id, rev);
0876     DEF_FIELD(symval, bcma_device_id, class);
0877 
0878     strcpy(alias, "bcma:");
0879     ADD(alias, "m", manuf != BCMA_ANY_MANUF, manuf);
0880     ADD(alias, "id", id != BCMA_ANY_ID, id);
0881     ADD(alias, "rev", rev != BCMA_ANY_REV, rev);
0882     ADD(alias, "cl", class != BCMA_ANY_CLASS, class);
0883     add_wildcard(alias);
0884     return 1;
0885 }
0886 
0887 /* Looks like: virtio:dNvN */
0888 static int do_virtio_entry(const char *filename, void *symval,
0889                char *alias)
0890 {
0891     DEF_FIELD(symval, virtio_device_id, device);
0892     DEF_FIELD(symval, virtio_device_id, vendor);
0893 
0894     strcpy(alias, "virtio:");
0895     ADD(alias, "d", device != VIRTIO_DEV_ANY_ID, device);
0896     ADD(alias, "v", vendor != VIRTIO_DEV_ANY_ID, vendor);
0897 
0898     add_wildcard(alias);
0899     return 1;
0900 }
0901 
0902 /*
0903  * Looks like: vmbus:guid
0904  * Each byte of the guid will be represented by two hex characters
0905  * in the name.
0906  */
0907 
0908 static int do_vmbus_entry(const char *filename, void *symval,
0909               char *alias)
0910 {
0911     int i;
0912     DEF_FIELD_ADDR(symval, hv_vmbus_device_id, guid);
0913     char guid_name[(sizeof(*guid) + 1) * 2];
0914 
0915     for (i = 0; i < (sizeof(*guid) * 2); i += 2)
0916         sprintf(&guid_name[i], "%02x", TO_NATIVE((guid->b)[i/2]));
0917 
0918     strcpy(alias, "vmbus:");
0919     strcat(alias, guid_name);
0920 
0921     return 1;
0922 }
0923 
0924 /* Looks like: rpmsg:S */
0925 static int do_rpmsg_entry(const char *filename, void *symval,
0926               char *alias)
0927 {
0928     DEF_FIELD_ADDR(symval, rpmsg_device_id, name);
0929     sprintf(alias, RPMSG_DEVICE_MODALIAS_FMT, *name);
0930 
0931     return 1;
0932 }
0933 
0934 /* Looks like: i2c:S */
0935 static int do_i2c_entry(const char *filename, void *symval,
0936             char *alias)
0937 {
0938     DEF_FIELD_ADDR(symval, i2c_device_id, name);
0939     sprintf(alias, I2C_MODULE_PREFIX "%s", *name);
0940 
0941     return 1;
0942 }
0943 
0944 static int do_i3c_entry(const char *filename, void *symval,
0945             char *alias)
0946 {
0947     DEF_FIELD(symval, i3c_device_id, match_flags);
0948     DEF_FIELD(symval, i3c_device_id, dcr);
0949     DEF_FIELD(symval, i3c_device_id, manuf_id);
0950     DEF_FIELD(symval, i3c_device_id, part_id);
0951     DEF_FIELD(symval, i3c_device_id, extra_info);
0952 
0953     strcpy(alias, "i3c:");
0954     ADD(alias, "dcr", match_flags & I3C_MATCH_DCR, dcr);
0955     ADD(alias, "manuf", match_flags & I3C_MATCH_MANUF, manuf_id);
0956     ADD(alias, "part", match_flags & I3C_MATCH_PART, part_id);
0957     ADD(alias, "ext", match_flags & I3C_MATCH_EXTRA_INFO, extra_info);
0958 
0959     return 1;
0960 }
0961 
0962 /* Looks like: spi:S */
0963 static int do_spi_entry(const char *filename, void *symval,
0964             char *alias)
0965 {
0966     DEF_FIELD_ADDR(symval, spi_device_id, name);
0967     sprintf(alias, SPI_MODULE_PREFIX "%s", *name);
0968 
0969     return 1;
0970 }
0971 
0972 static const struct dmifield {
0973     const char *prefix;
0974     int field;
0975 } dmi_fields[] = {
0976     { "bvn", DMI_BIOS_VENDOR },
0977     { "bvr", DMI_BIOS_VERSION },
0978     { "bd",  DMI_BIOS_DATE },
0979     { "br",  DMI_BIOS_RELEASE },
0980     { "efr", DMI_EC_FIRMWARE_RELEASE },
0981     { "svn", DMI_SYS_VENDOR },
0982     { "pn",  DMI_PRODUCT_NAME },
0983     { "pvr", DMI_PRODUCT_VERSION },
0984     { "rvn", DMI_BOARD_VENDOR },
0985     { "rn",  DMI_BOARD_NAME },
0986     { "rvr", DMI_BOARD_VERSION },
0987     { "cvn", DMI_CHASSIS_VENDOR },
0988     { "ct",  DMI_CHASSIS_TYPE },
0989     { "cvr", DMI_CHASSIS_VERSION },
0990     { NULL,  DMI_NONE }
0991 };
0992 
0993 static void dmi_ascii_filter(char *d, const char *s)
0994 {
0995     /* Filter out characters we don't want to see in the modalias string */
0996     for (; *s; s++)
0997         if (*s > ' ' && *s < 127 && *s != ':')
0998             *(d++) = *s;
0999 
1000     *d = 0;
1001 }
1002 
1003 
1004 static int do_dmi_entry(const char *filename, void *symval,
1005             char *alias)
1006 {
1007     int i, j;
1008     DEF_FIELD_ADDR(symval, dmi_system_id, matches);
1009     sprintf(alias, "dmi*");
1010 
1011     for (i = 0; i < ARRAY_SIZE(dmi_fields); i++) {
1012         for (j = 0; j < 4; j++) {
1013             if ((*matches)[j].slot &&
1014                 (*matches)[j].slot == dmi_fields[i].field) {
1015                 sprintf(alias + strlen(alias), ":%s*",
1016                     dmi_fields[i].prefix);
1017                 dmi_ascii_filter(alias + strlen(alias),
1018                          (*matches)[j].substr);
1019                 strcat(alias, "*");
1020             }
1021         }
1022     }
1023 
1024     strcat(alias, ":");
1025     return 1;
1026 }
1027 
1028 static int do_platform_entry(const char *filename,
1029                  void *symval, char *alias)
1030 {
1031     DEF_FIELD_ADDR(symval, platform_device_id, name);
1032     sprintf(alias, PLATFORM_MODULE_PREFIX "%s", *name);
1033     return 1;
1034 }
1035 
1036 static int do_mdio_entry(const char *filename,
1037              void *symval, char *alias)
1038 {
1039     int i;
1040     DEF_FIELD(symval, mdio_device_id, phy_id);
1041     DEF_FIELD(symval, mdio_device_id, phy_id_mask);
1042 
1043     alias += sprintf(alias, MDIO_MODULE_PREFIX);
1044 
1045     for (i = 0; i < 32; i++) {
1046         if (!((phy_id_mask >> (31-i)) & 1))
1047             *(alias++) = '?';
1048         else if ((phy_id >> (31-i)) & 1)
1049             *(alias++) = '1';
1050         else
1051             *(alias++) = '0';
1052     }
1053 
1054     /* Terminate the string */
1055     *alias = 0;
1056 
1057     return 1;
1058 }
1059 
1060 /* Looks like: zorro:iN. */
1061 static int do_zorro_entry(const char *filename, void *symval,
1062               char *alias)
1063 {
1064     DEF_FIELD(symval, zorro_device_id, id);
1065     strcpy(alias, "zorro:");
1066     ADD(alias, "i", id != ZORRO_WILDCARD, id);
1067     return 1;
1068 }
1069 
1070 /* looks like: "pnp:dD" */
1071 static int do_isapnp_entry(const char *filename,
1072                void *symval, char *alias)
1073 {
1074     DEF_FIELD(symval, isapnp_device_id, vendor);
1075     DEF_FIELD(symval, isapnp_device_id, function);
1076     sprintf(alias, "pnp:d%c%c%c%x%x%x%x*",
1077         'A' + ((vendor >> 2) & 0x3f) - 1,
1078         'A' + (((vendor & 3) << 3) | ((vendor >> 13) & 7)) - 1,
1079         'A' + ((vendor >> 8) & 0x1f) - 1,
1080         (function >> 4) & 0x0f, function & 0x0f,
1081         (function >> 12) & 0x0f, (function >> 8) & 0x0f);
1082     return 1;
1083 }
1084 
1085 /* Looks like: "ipack:fNvNdN". */
1086 static int do_ipack_entry(const char *filename,
1087               void *symval, char *alias)
1088 {
1089     DEF_FIELD(symval, ipack_device_id, format);
1090     DEF_FIELD(symval, ipack_device_id, vendor);
1091     DEF_FIELD(symval, ipack_device_id, device);
1092     strcpy(alias, "ipack:");
1093     ADD(alias, "f", format != IPACK_ANY_FORMAT, format);
1094     ADD(alias, "v", vendor != IPACK_ANY_ID, vendor);
1095     ADD(alias, "d", device != IPACK_ANY_ID, device);
1096     add_wildcard(alias);
1097     return 1;
1098 }
1099 
1100 /*
1101  * Append a match expression for a single masked hex digit.
1102  * outp points to a pointer to the character at which to append.
1103  *  *outp is updated on return to point just after the appended text,
1104  *  to facilitate further appending.
1105  */
1106 static void append_nibble_mask(char **outp,
1107                    unsigned int nibble, unsigned int mask)
1108 {
1109     char *p = *outp;
1110     unsigned int i;
1111 
1112     switch (mask) {
1113     case 0:
1114         *p++ = '?';
1115         break;
1116 
1117     case 0xf:
1118         p += sprintf(p, "%X",  nibble);
1119         break;
1120 
1121     default:
1122         /*
1123          * Dumbly emit a match pattern for all possible matching
1124          * digits.  This could be improved in some cases using ranges,
1125          * but it has the advantage of being trivially correct, and is
1126          * often optimal.
1127          */
1128         *p++ = '[';
1129         for (i = 0; i < 0x10; i++)
1130             if ((i & mask) == nibble)
1131                 p += sprintf(p, "%X", i);
1132         *p++ = ']';
1133     }
1134 
1135     /* Ensure that the string remains NUL-terminated: */
1136     *p = '\0';
1137 
1138     /* Advance the caller's end-of-string pointer: */
1139     *outp = p;
1140 }
1141 
1142 /*
1143  * looks like: "amba:dN"
1144  *
1145  * N is exactly 8 digits, where each is an upper-case hex digit, or
1146  *  a ? or [] pattern matching exactly one digit.
1147  */
1148 static int do_amba_entry(const char *filename,
1149              void *symval, char *alias)
1150 {
1151     unsigned int digit;
1152     char *p = alias;
1153     DEF_FIELD(symval, amba_id, id);
1154     DEF_FIELD(symval, amba_id, mask);
1155 
1156     if ((id & mask) != id)
1157         fatal("%s: Masked-off bit(s) of AMBA device ID are non-zero: "
1158               "id=0x%08X, mask=0x%08X.  Please fix this driver.\n",
1159               filename, id, mask);
1160 
1161     p += sprintf(alias, "amba:d");
1162     for (digit = 0; digit < 8; digit++)
1163         append_nibble_mask(&p,
1164                    (id >> (4 * (7 - digit))) & 0xf,
1165                    (mask >> (4 * (7 - digit))) & 0xf);
1166 
1167     return 1;
1168 }
1169 
1170 /*
1171  * looks like: "mipscdmm:tN"
1172  *
1173  * N is exactly 2 digits, where each is an upper-case hex digit, or
1174  *  a ? or [] pattern matching exactly one digit.
1175  */
1176 static int do_mips_cdmm_entry(const char *filename,
1177                   void *symval, char *alias)
1178 {
1179     DEF_FIELD(symval, mips_cdmm_device_id, type);
1180 
1181     sprintf(alias, "mipscdmm:t%02X*", type);
1182     return 1;
1183 }
1184 
1185 /* LOOKS like cpu:type:x86,venVVVVfamFFFFmodMMMM:feature:*,FEAT,*
1186  * All fields are numbers. It would be nicer to use strings for vendor
1187  * and feature, but getting those out of the build system here is too
1188  * complicated.
1189  */
1190 
1191 static int do_x86cpu_entry(const char *filename, void *symval,
1192                char *alias)
1193 {
1194     DEF_FIELD(symval, x86_cpu_id, feature);
1195     DEF_FIELD(symval, x86_cpu_id, family);
1196     DEF_FIELD(symval, x86_cpu_id, model);
1197     DEF_FIELD(symval, x86_cpu_id, vendor);
1198 
1199     strcpy(alias, "cpu:type:x86,");
1200     ADD(alias, "ven", vendor != X86_VENDOR_ANY, vendor);
1201     ADD(alias, "fam", family != X86_FAMILY_ANY, family);
1202     ADD(alias, "mod", model  != X86_MODEL_ANY,  model);
1203     strcat(alias, ":feature:*");
1204     if (feature != X86_FEATURE_ANY)
1205         sprintf(alias + strlen(alias), "%04X*", feature);
1206     return 1;
1207 }
1208 
1209 /* LOOKS like cpu:type:*:feature:*FEAT* */
1210 static int do_cpu_entry(const char *filename, void *symval, char *alias)
1211 {
1212     DEF_FIELD(symval, cpu_feature, feature);
1213 
1214     sprintf(alias, "cpu:type:*:feature:*%04X*", feature);
1215     return 1;
1216 }
1217 
1218 /* Looks like: mei:S:uuid:N:* */
1219 static int do_mei_entry(const char *filename, void *symval,
1220             char *alias)
1221 {
1222     DEF_FIELD_ADDR(symval, mei_cl_device_id, name);
1223     DEF_FIELD_ADDR(symval, mei_cl_device_id, uuid);
1224     DEF_FIELD(symval, mei_cl_device_id, version);
1225 
1226     sprintf(alias, MEI_CL_MODULE_PREFIX);
1227     sprintf(alias + strlen(alias), "%s:",  (*name)[0]  ? *name : "*");
1228     add_uuid(alias, *uuid);
1229     ADD(alias, ":", version != MEI_CL_VERSION_ANY, version);
1230 
1231     strcat(alias, ":*");
1232 
1233     return 1;
1234 }
1235 
1236 /* Looks like: rapidio:vNdNavNadN */
1237 static int do_rio_entry(const char *filename,
1238             void *symval, char *alias)
1239 {
1240     DEF_FIELD(symval, rio_device_id, did);
1241     DEF_FIELD(symval, rio_device_id, vid);
1242     DEF_FIELD(symval, rio_device_id, asm_did);
1243     DEF_FIELD(symval, rio_device_id, asm_vid);
1244 
1245     strcpy(alias, "rapidio:");
1246     ADD(alias, "v", vid != RIO_ANY_ID, vid);
1247     ADD(alias, "d", did != RIO_ANY_ID, did);
1248     ADD(alias, "av", asm_vid != RIO_ANY_ID, asm_vid);
1249     ADD(alias, "ad", asm_did != RIO_ANY_ID, asm_did);
1250 
1251     add_wildcard(alias);
1252     return 1;
1253 }
1254 
1255 /* Looks like: ulpi:vNpN */
1256 static int do_ulpi_entry(const char *filename, void *symval,
1257              char *alias)
1258 {
1259     DEF_FIELD(symval, ulpi_device_id, vendor);
1260     DEF_FIELD(symval, ulpi_device_id, product);
1261 
1262     sprintf(alias, "ulpi:v%04xp%04x", vendor, product);
1263 
1264     return 1;
1265 }
1266 
1267 /* Looks like: hdaudio:vNrNaN */
1268 static int do_hda_entry(const char *filename, void *symval, char *alias)
1269 {
1270     DEF_FIELD(symval, hda_device_id, vendor_id);
1271     DEF_FIELD(symval, hda_device_id, rev_id);
1272     DEF_FIELD(symval, hda_device_id, api_version);
1273 
1274     strcpy(alias, "hdaudio:");
1275     ADD(alias, "v", vendor_id != 0, vendor_id);
1276     ADD(alias, "r", rev_id != 0, rev_id);
1277     ADD(alias, "a", api_version != 0, api_version);
1278 
1279     add_wildcard(alias);
1280     return 1;
1281 }
1282 
1283 /* Looks like: sdw:mNpNvNcN */
1284 static int do_sdw_entry(const char *filename, void *symval, char *alias)
1285 {
1286     DEF_FIELD(symval, sdw_device_id, mfg_id);
1287     DEF_FIELD(symval, sdw_device_id, part_id);
1288     DEF_FIELD(symval, sdw_device_id, sdw_version);
1289     DEF_FIELD(symval, sdw_device_id, class_id);
1290 
1291     strcpy(alias, "sdw:");
1292     ADD(alias, "m", mfg_id != 0, mfg_id);
1293     ADD(alias, "p", part_id != 0, part_id);
1294     ADD(alias, "v", sdw_version != 0, sdw_version);
1295     ADD(alias, "c", class_id != 0, class_id);
1296 
1297     add_wildcard(alias);
1298     return 1;
1299 }
1300 
1301 /* Looks like: fsl-mc:vNdN */
1302 static int do_fsl_mc_entry(const char *filename, void *symval,
1303                char *alias)
1304 {
1305     DEF_FIELD(symval, fsl_mc_device_id, vendor);
1306     DEF_FIELD_ADDR(symval, fsl_mc_device_id, obj_type);
1307 
1308     sprintf(alias, "fsl-mc:v%08Xd%s", vendor, *obj_type);
1309     return 1;
1310 }
1311 
1312 /* Looks like: tbsvc:kSpNvNrN */
1313 static int do_tbsvc_entry(const char *filename, void *symval, char *alias)
1314 {
1315     DEF_FIELD(symval, tb_service_id, match_flags);
1316     DEF_FIELD_ADDR(symval, tb_service_id, protocol_key);
1317     DEF_FIELD(symval, tb_service_id, protocol_id);
1318     DEF_FIELD(symval, tb_service_id, protocol_version);
1319     DEF_FIELD(symval, tb_service_id, protocol_revision);
1320 
1321     strcpy(alias, "tbsvc:");
1322     if (match_flags & TBSVC_MATCH_PROTOCOL_KEY)
1323         sprintf(alias + strlen(alias), "k%s", *protocol_key);
1324     else
1325         strcat(alias + strlen(alias), "k*");
1326     ADD(alias, "p", match_flags & TBSVC_MATCH_PROTOCOL_ID, protocol_id);
1327     ADD(alias, "v", match_flags & TBSVC_MATCH_PROTOCOL_VERSION,
1328         protocol_version);
1329     ADD(alias, "r", match_flags & TBSVC_MATCH_PROTOCOL_REVISION,
1330         protocol_revision);
1331 
1332     add_wildcard(alias);
1333     return 1;
1334 }
1335 
1336 /* Looks like: typec:idNmN */
1337 static int do_typec_entry(const char *filename, void *symval, char *alias)
1338 {
1339     DEF_FIELD(symval, typec_device_id, svid);
1340     DEF_FIELD(symval, typec_device_id, mode);
1341 
1342     sprintf(alias, "typec:id%04X", svid);
1343     ADD(alias, "m", mode != TYPEC_ANY_MODE, mode);
1344 
1345     return 1;
1346 }
1347 
1348 /* Looks like: tee:uuid */
1349 static int do_tee_entry(const char *filename, void *symval, char *alias)
1350 {
1351     DEF_FIELD(symval, tee_client_device_id, uuid);
1352 
1353     sprintf(alias, "tee:%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1354         uuid.b[0], uuid.b[1], uuid.b[2], uuid.b[3], uuid.b[4],
1355         uuid.b[5], uuid.b[6], uuid.b[7], uuid.b[8], uuid.b[9],
1356         uuid.b[10], uuid.b[11], uuid.b[12], uuid.b[13], uuid.b[14],
1357         uuid.b[15]);
1358 
1359     add_wildcard(alias);
1360     return 1;
1361 }
1362 
1363 /* Looks like: wmi:guid */
1364 static int do_wmi_entry(const char *filename, void *symval, char *alias)
1365 {
1366     int len;
1367     DEF_FIELD_ADDR(symval, wmi_device_id, guid_string);
1368 
1369     if (strlen(*guid_string) != UUID_STRING_LEN) {
1370         warn("Invalid WMI device id 'wmi:%s' in '%s'\n",
1371                 *guid_string, filename);
1372         return 0;
1373     }
1374 
1375     len = snprintf(alias, ALIAS_SIZE, WMI_MODULE_PREFIX "%s", *guid_string);
1376     if (len < 0 || len >= ALIAS_SIZE) {
1377         warn("Could not generate all MODULE_ALIAS's in '%s'\n",
1378                 filename);
1379         return 0;
1380     }
1381     return 1;
1382 }
1383 
1384 /* Looks like: mhi:S */
1385 static int do_mhi_entry(const char *filename, void *symval, char *alias)
1386 {
1387     DEF_FIELD_ADDR(symval, mhi_device_id, chan);
1388     sprintf(alias, MHI_DEVICE_MODALIAS_FMT, *chan);
1389     return 1;
1390 }
1391 
1392 /* Looks like: mhi_ep:S */
1393 static int do_mhi_ep_entry(const char *filename, void *symval, char *alias)
1394 {
1395     DEF_FIELD_ADDR(symval, mhi_device_id, chan);
1396     sprintf(alias, MHI_EP_DEVICE_MODALIAS_FMT, *chan);
1397 
1398     return 1;
1399 }
1400 
1401 /* Looks like: ishtp:{guid} */
1402 static int do_ishtp_entry(const char *filename, void *symval, char *alias)
1403 {
1404     DEF_FIELD(symval, ishtp_device_id, guid);
1405 
1406     strcpy(alias, ISHTP_MODULE_PREFIX "{");
1407     add_guid(alias, guid);
1408     strcat(alias, "}");
1409 
1410     return 1;
1411 }
1412 
1413 static int do_auxiliary_entry(const char *filename, void *symval, char *alias)
1414 {
1415     DEF_FIELD_ADDR(symval, auxiliary_device_id, name);
1416     sprintf(alias, AUXILIARY_MODULE_PREFIX "%s", *name);
1417 
1418     return 1;
1419 }
1420 
1421 /*
1422  * Looks like: ssam:dNcNtNiNfN
1423  *
1424  * N is exactly 2 digits, where each is an upper-case hex digit.
1425  */
1426 static int do_ssam_entry(const char *filename, void *symval, char *alias)
1427 {
1428     DEF_FIELD(symval, ssam_device_id, match_flags);
1429     DEF_FIELD(symval, ssam_device_id, domain);
1430     DEF_FIELD(symval, ssam_device_id, category);
1431     DEF_FIELD(symval, ssam_device_id, target);
1432     DEF_FIELD(symval, ssam_device_id, instance);
1433     DEF_FIELD(symval, ssam_device_id, function);
1434 
1435     sprintf(alias, "ssam:d%02Xc%02X", domain, category);
1436     ADD(alias, "t", match_flags & SSAM_MATCH_TARGET, target);
1437     ADD(alias, "i", match_flags & SSAM_MATCH_INSTANCE, instance);
1438     ADD(alias, "f", match_flags & SSAM_MATCH_FUNCTION, function);
1439 
1440     return 1;
1441 }
1442 
1443 /* Looks like: dfl:tNfN */
1444 static int do_dfl_entry(const char *filename, void *symval, char *alias)
1445 {
1446     DEF_FIELD(symval, dfl_device_id, type);
1447     DEF_FIELD(symval, dfl_device_id, feature_id);
1448 
1449     sprintf(alias, "dfl:t%04Xf%04X", type, feature_id);
1450 
1451     add_wildcard(alias);
1452     return 1;
1453 }
1454 
1455 /* Does namelen bytes of name exactly match the symbol? */
1456 static bool sym_is(const char *name, unsigned namelen, const char *symbol)
1457 {
1458     if (namelen != strlen(symbol))
1459         return false;
1460 
1461     return memcmp(name, symbol, namelen) == 0;
1462 }
1463 
1464 static void do_table(void *symval, unsigned long size,
1465              unsigned long id_size,
1466              const char *device_id,
1467              int (*do_entry)(const char *filename, void *symval, char *alias),
1468              struct module *mod)
1469 {
1470     unsigned int i;
1471     char alias[ALIAS_SIZE];
1472 
1473     device_id_check(mod->name, device_id, size, id_size, symval);
1474     /* Leave last one: it's the terminator. */
1475     size -= id_size;
1476 
1477     for (i = 0; i < size; i += id_size) {
1478         if (do_entry(mod->name, symval+i, alias)) {
1479             buf_printf(&mod->dev_table_buf,
1480                    "MODULE_ALIAS(\"%s\");\n", alias);
1481         }
1482     }
1483 }
1484 
1485 static const struct devtable devtable[] = {
1486     {"hid", SIZE_hid_device_id, do_hid_entry},
1487     {"ieee1394", SIZE_ieee1394_device_id, do_ieee1394_entry},
1488     {"pci", SIZE_pci_device_id, do_pci_entry},
1489     {"ccw", SIZE_ccw_device_id, do_ccw_entry},
1490     {"ap", SIZE_ap_device_id, do_ap_entry},
1491     {"css", SIZE_css_device_id, do_css_entry},
1492     {"serio", SIZE_serio_device_id, do_serio_entry},
1493     {"acpi", SIZE_acpi_device_id, do_acpi_entry},
1494     {"pcmcia", SIZE_pcmcia_device_id, do_pcmcia_entry},
1495     {"vio", SIZE_vio_device_id, do_vio_entry},
1496     {"input", SIZE_input_device_id, do_input_entry},
1497     {"eisa", SIZE_eisa_device_id, do_eisa_entry},
1498     {"parisc", SIZE_parisc_device_id, do_parisc_entry},
1499     {"sdio", SIZE_sdio_device_id, do_sdio_entry},
1500     {"ssb", SIZE_ssb_device_id, do_ssb_entry},
1501     {"bcma", SIZE_bcma_device_id, do_bcma_entry},
1502     {"virtio", SIZE_virtio_device_id, do_virtio_entry},
1503     {"vmbus", SIZE_hv_vmbus_device_id, do_vmbus_entry},
1504     {"rpmsg", SIZE_rpmsg_device_id, do_rpmsg_entry},
1505     {"i2c", SIZE_i2c_device_id, do_i2c_entry},
1506     {"i3c", SIZE_i3c_device_id, do_i3c_entry},
1507     {"spi", SIZE_spi_device_id, do_spi_entry},
1508     {"dmi", SIZE_dmi_system_id, do_dmi_entry},
1509     {"platform", SIZE_platform_device_id, do_platform_entry},
1510     {"mdio", SIZE_mdio_device_id, do_mdio_entry},
1511     {"zorro", SIZE_zorro_device_id, do_zorro_entry},
1512     {"isapnp", SIZE_isapnp_device_id, do_isapnp_entry},
1513     {"ipack", SIZE_ipack_device_id, do_ipack_entry},
1514     {"amba", SIZE_amba_id, do_amba_entry},
1515     {"mipscdmm", SIZE_mips_cdmm_device_id, do_mips_cdmm_entry},
1516     {"x86cpu", SIZE_x86_cpu_id, do_x86cpu_entry},
1517     {"cpu", SIZE_cpu_feature, do_cpu_entry},
1518     {"mei", SIZE_mei_cl_device_id, do_mei_entry},
1519     {"rapidio", SIZE_rio_device_id, do_rio_entry},
1520     {"ulpi", SIZE_ulpi_device_id, do_ulpi_entry},
1521     {"hdaudio", SIZE_hda_device_id, do_hda_entry},
1522     {"sdw", SIZE_sdw_device_id, do_sdw_entry},
1523     {"fslmc", SIZE_fsl_mc_device_id, do_fsl_mc_entry},
1524     {"tbsvc", SIZE_tb_service_id, do_tbsvc_entry},
1525     {"typec", SIZE_typec_device_id, do_typec_entry},
1526     {"tee", SIZE_tee_client_device_id, do_tee_entry},
1527     {"wmi", SIZE_wmi_device_id, do_wmi_entry},
1528     {"mhi", SIZE_mhi_device_id, do_mhi_entry},
1529     {"mhi_ep", SIZE_mhi_device_id, do_mhi_ep_entry},
1530     {"auxiliary", SIZE_auxiliary_device_id, do_auxiliary_entry},
1531     {"ssam", SIZE_ssam_device_id, do_ssam_entry},
1532     {"dfl", SIZE_dfl_device_id, do_dfl_entry},
1533     {"ishtp", SIZE_ishtp_device_id, do_ishtp_entry},
1534 };
1535 
1536 /* Create MODULE_ALIAS() statements.
1537  * At this time, we cannot write the actual output C source yet,
1538  * so we write into the mod->dev_table_buf buffer. */
1539 void handle_moddevtable(struct module *mod, struct elf_info *info,
1540             Elf_Sym *sym, const char *symname)
1541 {
1542     void *symval;
1543     char *zeros = NULL;
1544     const char *name, *identifier;
1545     unsigned int namelen;
1546 
1547     /* We're looking for a section relative symbol */
1548     if (!sym->st_shndx || get_secindex(info, sym) >= info->num_sections)
1549         return;
1550 
1551     /* We're looking for an object */
1552     if (ELF_ST_TYPE(sym->st_info) != STT_OBJECT)
1553         return;
1554 
1555     /* All our symbols are of form __mod_<name>__<identifier>_device_table. */
1556     if (strncmp(symname, "__mod_", strlen("__mod_")))
1557         return;
1558     name = symname + strlen("__mod_");
1559     namelen = strlen(name);
1560     if (namelen < strlen("_device_table"))
1561         return;
1562     if (strcmp(name + namelen - strlen("_device_table"), "_device_table"))
1563         return;
1564     identifier = strstr(name, "__");
1565     if (!identifier)
1566         return;
1567     namelen = identifier - name;
1568 
1569     /* Handle all-NULL symbols allocated into .bss */
1570     if (info->sechdrs[get_secindex(info, sym)].sh_type & SHT_NOBITS) {
1571         zeros = calloc(1, sym->st_size);
1572         symval = zeros;
1573     } else {
1574         symval = sym_get_data(info, sym);
1575     }
1576 
1577     /* First handle the "special" cases */
1578     if (sym_is(name, namelen, "usb"))
1579         do_usb_table(symval, sym->st_size, mod);
1580     if (sym_is(name, namelen, "of"))
1581         do_of_table(symval, sym->st_size, mod);
1582     else if (sym_is(name, namelen, "pnp"))
1583         do_pnp_device_entry(symval, sym->st_size, mod);
1584     else if (sym_is(name, namelen, "pnp_card"))
1585         do_pnp_card_entries(symval, sym->st_size, mod);
1586     else {
1587         int i;
1588 
1589         for (i = 0; i < ARRAY_SIZE(devtable); i++) {
1590             const struct devtable *p = &devtable[i];
1591 
1592             if (sym_is(name, namelen, p->device_id)) {
1593                 do_table(symval, sym->st_size, p->id_size,
1594                      p->device_id, p->do_entry, mod);
1595                 break;
1596             }
1597         }
1598     }
1599     free(zeros);
1600 }
1601 
1602 /* Now add out buffered information to the generated C source */
1603 void add_moddevtable(struct buffer *buf, struct module *mod)
1604 {
1605     buf_printf(buf, "\n");
1606     buf_write(buf, mod->dev_table_buf.p, mod->dev_table_buf.pos);
1607     free(mod->dev_table_buf.p);
1608 }