xref: /linux-6.15/scripts/mod/file2alias.c (revision 600dbaf1)
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.
4  *
5  * Copyright 2002-2003  Rusty Russell, IBM Corporation
6  *           2003       Kai Germaschewski
7  *
8  *
9  * This software may be used and distributed according to the terms
10  * of the GNU General Public License, incorporated herein by reference.
11  */
12 
13 #include <stdarg.h>
14 #include <stdio.h>
15 
16 #include "list.h"
17 #include "xalloc.h"
18 
19 #include "modpost.h"
20 #include "devicetable-offsets.h"
21 
22 /* We use the ELF typedefs for kernel_ulong_t but bite the bullet and
23  * use either stdint.h or inttypes.h for the rest. */
24 #if KERNEL_ELFCLASS == ELFCLASS32
25 typedef Elf32_Addr	kernel_ulong_t;
26 #define BITS_PER_LONG 32
27 #else
28 typedef Elf64_Addr	kernel_ulong_t;
29 #define BITS_PER_LONG 64
30 #endif
31 #ifdef __sun__
32 #include <inttypes.h>
33 #else
34 #include <stdint.h>
35 #endif
36 
37 #include <ctype.h>
38 #include <stdbool.h>
39 
40 /**
41  * module_alias_printf - add auto-generated MODULE_ALIAS()
42  *
43  * @mod: module
44  * @append_wildcard: append '*' for future extension if not exist yet
45  * @fmt: printf(3)-like format
46  */
47 static void __attribute__((format (printf, 3, 4)))
48 module_alias_printf(struct module *mod, bool append_wildcard,
49 		    const char *fmt, ...)
50 {
51 	struct module_alias *new, *als;
52 	size_t len;
53 	int n;
54 	va_list ap;
55 
56 	/* Determine required size. */
57 	va_start(ap, fmt);
58 	n = vsnprintf(NULL, 0, fmt, ap);
59 	va_end(ap);
60 
61 	if (n < 0) {
62 		error("vsnprintf failed\n");
63 		return;
64 	}
65 
66 	len = n + 1;	/* extra byte for '\0' */
67 
68 	if (append_wildcard)
69 		len++;	/* extra byte for '*' */
70 
71 	new = xmalloc(sizeof(*new) + len);
72 
73 	/* Now, really print it to the allocated buffer */
74 	va_start(ap, fmt);
75 	n = vsnprintf(new->str, len, fmt, ap);
76 	va_end(ap);
77 
78 	if (n < 0) {
79 		error("vsnprintf failed\n");
80 		free(new);
81 		return;
82 	}
83 
84 	if (append_wildcard && (n == 0 || new->str[n - 1] != '*')) {
85 		new->str[n] = '*';
86 		new->str[n + 1] = '\0';
87 	}
88 
89 	/* avoid duplication */
90 	list_for_each_entry(als, &mod->aliases, node) {
91 		if (!strcmp(als->str, new->str)) {
92 			free(new);
93 			return;
94 		}
95 	}
96 
97 	list_add_tail(&new->node, &mod->aliases);
98 }
99 
100 typedef uint32_t	__u32;
101 typedef uint16_t	__u16;
102 typedef unsigned char	__u8;
103 
104 /* UUID types for backward compatibility, don't use in new code */
105 typedef struct {
106 	__u8 b[16];
107 } guid_t;
108 
109 typedef struct {
110 	__u8 b[16];
111 } uuid_t;
112 
113 #define	UUID_STRING_LEN		36
114 
115 /* MEI UUID type, don't use anywhere else */
116 typedef struct {
117 	__u8 b[16];
118 } uuid_le;
119 
120 /* Big exception to the "don't include kernel headers into userspace, which
121  * even potentially has different endianness and word sizes, since
122  * we handle those differences explicitly below */
123 #include "../../include/linux/mod_devicetable.h"
124 
125 /* This array collects all instances that use the generic do_table */
126 struct devtable {
127 	const char *device_id; /* name of table, __mod_<name>__*_device_table. */
128 	unsigned long id_size;
129 	void (*do_entry)(struct module *mod, void *symval);
130 };
131 
132 /* Define a variable f that holds the value of field f of struct devid
133  * based at address m.
134  */
135 #define DEF_FIELD(m, devid, f) \
136 	typeof(((struct devid *)0)->f) f = TO_NATIVE(*(typeof(f) *)((m) + OFF_##devid##_##f))
137 
138 /* Define a variable f that holds the address of field f of struct devid
139  * based at address m.  Due to the way typeof works, for a field of type
140  * T[N] the variable has type T(*)[N], _not_ T*.
141  */
142 #define DEF_FIELD_ADDR(m, devid, f) \
143 	typeof(((struct devid *)0)->f) *f = ((m) + OFF_##devid##_##f)
144 
145 #define ADD(str, sep, cond, field)                              \
146 do {                                                            \
147         strcat(str, sep);                                       \
148         if (cond)                                               \
149                 sprintf(str + strlen(str),                      \
150                         sizeof(field) == 1 ? "%02X" :           \
151                         sizeof(field) == 2 ? "%04X" :           \
152                         sizeof(field) == 4 ? "%08X" : "",       \
153                         field);                                 \
154         else                                                    \
155                 sprintf(str + strlen(str), "*");                \
156 } while(0)
157 
158 static inline void add_uuid(char *str, uuid_le uuid)
159 {
160 	int len = strlen(str);
161 
162 	sprintf(str + len, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
163 		uuid.b[3], uuid.b[2], uuid.b[1], uuid.b[0],
164 		uuid.b[5], uuid.b[4], uuid.b[7], uuid.b[6],
165 		uuid.b[8], uuid.b[9], uuid.b[10], uuid.b[11],
166 		uuid.b[12], uuid.b[13], uuid.b[14], uuid.b[15]);
167 }
168 
169 static inline void add_guid(char *str, guid_t guid)
170 {
171 	int len = strlen(str);
172 
173 	sprintf(str + len, "%02X%02X%02X%02X-%02X%02X-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
174 		guid.b[3], guid.b[2], guid.b[1], guid.b[0],
175 		guid.b[5], guid.b[4], guid.b[7], guid.b[6],
176 		guid.b[8], guid.b[9], guid.b[10], guid.b[11],
177 		guid.b[12], guid.b[13], guid.b[14], guid.b[15]);
178 }
179 
180 /**
181  * Check that sizeof(device_id type) are consistent with size of section
182  * in .o file. If in-consistent then userspace and kernel does not agree
183  * on actual size which is a bug.
184  * Also verify that the final entry in the table is all zeros.
185  * Ignore both checks if build host differ from target host and size differs.
186  **/
187 static void device_id_check(const char *modname, const char *device_id,
188 			    unsigned long size, unsigned long id_size,
189 			    void *symval)
190 {
191 	int i;
192 
193 	if (size % id_size || size < id_size) {
194 		fatal("%s: sizeof(struct %s_device_id)=%lu is not a modulo of the size of section __mod_%s__<identifier>_device_table=%lu.\n"
195 		      "Fix definition of struct %s_device_id in mod_devicetable.h\n",
196 		      modname, device_id, id_size, device_id, size, device_id);
197 	}
198 	/* Verify last one is a terminator */
199 	for (i = 0; i < id_size; i++ ) {
200 		if (*(uint8_t*)(symval+size-id_size+i)) {
201 			fprintf(stderr,
202 				"%s: struct %s_device_id is %lu bytes.  The last of %lu is:\n",
203 				modname, device_id, id_size, size / id_size);
204 			for (i = 0; i < id_size; i++ )
205 				fprintf(stderr,"0x%02x ",
206 					*(uint8_t*)(symval+size-id_size+i) );
207 			fprintf(stderr,"\n");
208 			fatal("%s: struct %s_device_id is not terminated with a NULL entry!\n",
209 			      modname, device_id);
210 		}
211 	}
212 }
213 
214 /* USB is special because the bcdDevice can be matched against a numeric range */
215 /* Looks like "usb:vNpNdNdcNdscNdpNicNiscNipNinN" */
216 static void do_usb_entry(void *symval,
217 			 unsigned int bcdDevice_initial, int bcdDevice_initial_digits,
218 			 unsigned char range_lo, unsigned char range_hi,
219 			 unsigned char max, struct module *mod)
220 {
221 	char alias[500];
222 	DEF_FIELD(symval, usb_device_id, match_flags);
223 	DEF_FIELD(symval, usb_device_id, idVendor);
224 	DEF_FIELD(symval, usb_device_id, idProduct);
225 	DEF_FIELD(symval, usb_device_id, bcdDevice_lo);
226 	DEF_FIELD(symval, usb_device_id, bDeviceClass);
227 	DEF_FIELD(symval, usb_device_id, bDeviceSubClass);
228 	DEF_FIELD(symval, usb_device_id, bDeviceProtocol);
229 	DEF_FIELD(symval, usb_device_id, bInterfaceClass);
230 	DEF_FIELD(symval, usb_device_id, bInterfaceSubClass);
231 	DEF_FIELD(symval, usb_device_id, bInterfaceProtocol);
232 	DEF_FIELD(symval, usb_device_id, bInterfaceNumber);
233 
234 	strcpy(alias, "usb:");
235 	ADD(alias, "v", match_flags&USB_DEVICE_ID_MATCH_VENDOR,
236 	    idVendor);
237 	ADD(alias, "p", match_flags&USB_DEVICE_ID_MATCH_PRODUCT,
238 	    idProduct);
239 
240 	strcat(alias, "d");
241 	if (bcdDevice_initial_digits)
242 		sprintf(alias + strlen(alias), "%0*X",
243 			bcdDevice_initial_digits, bcdDevice_initial);
244 	if (range_lo == range_hi)
245 		sprintf(alias + strlen(alias), "%X", range_lo);
246 	else if (range_lo > 0 || range_hi < max) {
247 		if (range_lo > 0x9 || range_hi < 0xA)
248 			sprintf(alias + strlen(alias),
249 				"[%X-%X]",
250 				range_lo,
251 				range_hi);
252 		else {
253 			sprintf(alias + strlen(alias),
254 				range_lo < 0x9 ? "[%X-9" : "[%X",
255 				range_lo);
256 			sprintf(alias + strlen(alias),
257 				range_hi > 0xA ? "A-%X]" : "%X]",
258 				range_hi);
259 		}
260 	}
261 	if (bcdDevice_initial_digits < (sizeof(bcdDevice_lo) * 2 - 1))
262 		strcat(alias, "*");
263 
264 	ADD(alias, "dc", match_flags&USB_DEVICE_ID_MATCH_DEV_CLASS,
265 	    bDeviceClass);
266 	ADD(alias, "dsc", match_flags&USB_DEVICE_ID_MATCH_DEV_SUBCLASS,
267 	    bDeviceSubClass);
268 	ADD(alias, "dp", match_flags&USB_DEVICE_ID_MATCH_DEV_PROTOCOL,
269 	    bDeviceProtocol);
270 	ADD(alias, "ic", match_flags&USB_DEVICE_ID_MATCH_INT_CLASS,
271 	    bInterfaceClass);
272 	ADD(alias, "isc", match_flags&USB_DEVICE_ID_MATCH_INT_SUBCLASS,
273 	    bInterfaceSubClass);
274 	ADD(alias, "ip", match_flags&USB_DEVICE_ID_MATCH_INT_PROTOCOL,
275 	    bInterfaceProtocol);
276 	ADD(alias, "in", match_flags&USB_DEVICE_ID_MATCH_INT_NUMBER,
277 	    bInterfaceNumber);
278 
279 	module_alias_printf(mod, true, "%s", alias);
280 }
281 
282 /* Handles increment/decrement of BCD formatted integers */
283 /* Returns the previous value, so it works like i++ or i-- */
284 static unsigned int incbcd(unsigned int *bcd,
285 			   int inc,
286 			   unsigned char max,
287 			   size_t chars)
288 {
289 	unsigned int init = *bcd, i, j;
290 	unsigned long long c, dec = 0;
291 
292 	/* If bcd is not in BCD format, just increment */
293 	if (max > 0x9) {
294 		*bcd += inc;
295 		return init;
296 	}
297 
298 	/* Convert BCD to Decimal */
299 	for (i=0 ; i < chars ; i++) {
300 		c = (*bcd >> (i << 2)) & 0xf;
301 		c = c > 9 ? 9 : c; /* force to bcd just in case */
302 		for (j=0 ; j < i ; j++)
303 			c = c * 10;
304 		dec += c;
305 	}
306 
307 	/* Do our increment/decrement */
308 	dec += inc;
309 	*bcd  = 0;
310 
311 	/* Convert back to BCD */
312 	for (i=0 ; i < chars ; i++) {
313 		for (c=1,j=0 ; j < i ; j++)
314 			c = c * 10;
315 		c = (dec / c) % 10;
316 		*bcd += c << (i << 2);
317 	}
318 	return init;
319 }
320 
321 static void do_usb_entry_multi(void *symval, struct module *mod)
322 {
323 	unsigned int devlo, devhi;
324 	unsigned char chi, clo, max;
325 	int ndigits;
326 
327 	DEF_FIELD(symval, usb_device_id, match_flags);
328 	DEF_FIELD(symval, usb_device_id, idVendor);
329 	DEF_FIELD(symval, usb_device_id, idProduct);
330 	DEF_FIELD(symval, usb_device_id, bcdDevice_lo);
331 	DEF_FIELD(symval, usb_device_id, bcdDevice_hi);
332 	DEF_FIELD(symval, usb_device_id, bDeviceClass);
333 	DEF_FIELD(symval, usb_device_id, bInterfaceClass);
334 
335 	devlo = match_flags & USB_DEVICE_ID_MATCH_DEV_LO ?
336 		bcdDevice_lo : 0x0U;
337 	devhi = match_flags & USB_DEVICE_ID_MATCH_DEV_HI ?
338 		bcdDevice_hi : ~0x0U;
339 
340 	/* Figure out if this entry is in bcd or hex format */
341 	max = 0x9; /* Default to decimal format */
342 	for (ndigits = 0 ; ndigits < sizeof(bcdDevice_lo) * 2 ; ndigits++) {
343 		clo = (devlo >> (ndigits << 2)) & 0xf;
344 		chi = ((devhi > 0x9999 ? 0x9999 : devhi) >> (ndigits << 2)) & 0xf;
345 		if (clo > max || chi > max) {
346 			max = 0xf;
347 			break;
348 		}
349 	}
350 
351 	/*
352 	 * Some modules (visor) have empty slots as placeholder for
353 	 * run-time specification that results in catch-all alias
354 	 */
355 	if (!(idVendor | idProduct | bDeviceClass | bInterfaceClass))
356 		return;
357 
358 	/* Convert numeric bcdDevice range into fnmatch-able pattern(s) */
359 	for (ndigits = sizeof(bcdDevice_lo) * 2 - 1; devlo <= devhi; ndigits--) {
360 		clo = devlo & 0xf;
361 		chi = devhi & 0xf;
362 		if (chi > max)	/* If we are in bcd mode, truncate if necessary */
363 			chi = max;
364 		devlo >>= 4;
365 		devhi >>= 4;
366 
367 		if (devlo == devhi || !ndigits) {
368 			do_usb_entry(symval, devlo, ndigits, clo, chi, max, mod);
369 			break;
370 		}
371 
372 		if (clo > 0x0)
373 			do_usb_entry(symval,
374 				     incbcd(&devlo, 1, max,
375 					    sizeof(bcdDevice_lo) * 2),
376 				     ndigits, clo, max, max, mod);
377 
378 		if (chi < max)
379 			do_usb_entry(symval,
380 				     incbcd(&devhi, -1, max,
381 					    sizeof(bcdDevice_lo) * 2),
382 				     ndigits, 0x0, chi, max, mod);
383 	}
384 }
385 
386 static void do_usb_table(void *symval, unsigned long size,
387 			 struct module *mod)
388 {
389 	unsigned int i;
390 	const unsigned long id_size = SIZE_usb_device_id;
391 
392 	device_id_check(mod->name, "usb", size, id_size, symval);
393 
394 	/* Leave last one: it's the terminator. */
395 	size -= id_size;
396 
397 	for (i = 0; i < size; i += id_size)
398 		do_usb_entry_multi(symval + i, mod);
399 }
400 
401 static void do_of_entry_multi(void *symval, struct module *mod)
402 {
403 	char alias[500];
404 	int len;
405 	char *tmp;
406 
407 	DEF_FIELD_ADDR(symval, of_device_id, name);
408 	DEF_FIELD_ADDR(symval, of_device_id, type);
409 	DEF_FIELD_ADDR(symval, of_device_id, compatible);
410 
411 	len = sprintf(alias, "of:N%sT%s", (*name)[0] ? *name : "*",
412 		      (*type)[0] ? *type : "*");
413 
414 	if ((*compatible)[0])
415 		sprintf(&alias[len], "%sC%s", (*type)[0] ? "*" : "",
416 			*compatible);
417 
418 	/* Replace all whitespace with underscores */
419 	for (tmp = alias; tmp && *tmp; tmp++)
420 		if (isspace(*tmp))
421 			*tmp = '_';
422 
423 	module_alias_printf(mod, false, "%s", alias);
424 	module_alias_printf(mod, false, "%sC*", alias);
425 }
426 
427 static void do_of_table(void *symval, unsigned long size,
428 			struct module *mod)
429 {
430 	unsigned int i;
431 	const unsigned long id_size = SIZE_of_device_id;
432 
433 	device_id_check(mod->name, "of", size, id_size, symval);
434 
435 	/* Leave last one: it's the terminator. */
436 	size -= id_size;
437 
438 	for (i = 0; i < size; i += id_size)
439 		do_of_entry_multi(symval + i, mod);
440 }
441 
442 /* Looks like: hid:bNvNpN */
443 static void do_hid_entry(struct module *mod, void *symval)
444 {
445 	char alias[256] = {};
446 
447 	DEF_FIELD(symval, hid_device_id, bus);
448 	DEF_FIELD(symval, hid_device_id, group);
449 	DEF_FIELD(symval, hid_device_id, vendor);
450 	DEF_FIELD(symval, hid_device_id, product);
451 
452 	ADD(alias, "b", bus != HID_BUS_ANY, bus);
453 	ADD(alias, "g", group != HID_GROUP_ANY, group);
454 	ADD(alias, "v", vendor != HID_ANY_ID, vendor);
455 	ADD(alias, "p", product != HID_ANY_ID, product);
456 
457 	module_alias_printf(mod, false, "hid:%s", alias);
458 }
459 
460 /* Looks like: ieee1394:venNmoNspNverN */
461 static void do_ieee1394_entry(struct module *mod, void *symval)
462 {
463 	char alias[256] = {};
464 
465 	DEF_FIELD(symval, ieee1394_device_id, match_flags);
466 	DEF_FIELD(symval, ieee1394_device_id, vendor_id);
467 	DEF_FIELD(symval, ieee1394_device_id, model_id);
468 	DEF_FIELD(symval, ieee1394_device_id, specifier_id);
469 	DEF_FIELD(symval, ieee1394_device_id, version);
470 
471 	ADD(alias, "ven", match_flags & IEEE1394_MATCH_VENDOR_ID,
472 	    vendor_id);
473 	ADD(alias, "mo", match_flags & IEEE1394_MATCH_MODEL_ID,
474 	    model_id);
475 	ADD(alias, "sp", match_flags & IEEE1394_MATCH_SPECIFIER_ID,
476 	    specifier_id);
477 	ADD(alias, "ver", match_flags & IEEE1394_MATCH_VERSION,
478 	    version);
479 
480 	module_alias_printf(mod, true, "ieee1394:%s", alias);
481 }
482 
483 /* Looks like: pci:vNdNsvNsdNbcNscNiN or <prefix>_pci:vNdNsvNsdNbcNscNiN. */
484 static void do_pci_entry(struct module *mod, void *symval)
485 {
486 	char alias[256];
487 	/* Class field can be divided into these three. */
488 	unsigned char baseclass, subclass, interface,
489 		baseclass_mask, subclass_mask, interface_mask;
490 
491 	DEF_FIELD(symval, pci_device_id, vendor);
492 	DEF_FIELD(symval, pci_device_id, device);
493 	DEF_FIELD(symval, pci_device_id, subvendor);
494 	DEF_FIELD(symval, pci_device_id, subdevice);
495 	DEF_FIELD(symval, pci_device_id, class);
496 	DEF_FIELD(symval, pci_device_id, class_mask);
497 	DEF_FIELD(symval, pci_device_id, override_only);
498 
499 	switch (override_only) {
500 	case 0:
501 		strcpy(alias, "pci:");
502 		break;
503 	case PCI_ID_F_VFIO_DRIVER_OVERRIDE:
504 		strcpy(alias, "vfio_pci:");
505 		break;
506 	default:
507 		warn("Unknown PCI driver_override alias %08X\n",
508 		     override_only);
509 	}
510 
511 	ADD(alias, "v", vendor != PCI_ANY_ID, vendor);
512 	ADD(alias, "d", device != PCI_ANY_ID, device);
513 	ADD(alias, "sv", subvendor != PCI_ANY_ID, subvendor);
514 	ADD(alias, "sd", subdevice != PCI_ANY_ID, subdevice);
515 
516 	baseclass = (class) >> 16;
517 	baseclass_mask = (class_mask) >> 16;
518 	subclass = (class) >> 8;
519 	subclass_mask = (class_mask) >> 8;
520 	interface = class;
521 	interface_mask = class_mask;
522 
523 	if ((baseclass_mask != 0 && baseclass_mask != 0xFF)
524 	    || (subclass_mask != 0 && subclass_mask != 0xFF)
525 	    || (interface_mask != 0 && interface_mask != 0xFF)) {
526 		warn("Can't handle masks in %s:%04X\n",
527 		     mod->name, class_mask);
528 		return;
529 	}
530 
531 	ADD(alias, "bc", baseclass_mask == 0xFF, baseclass);
532 	ADD(alias, "sc", subclass_mask == 0xFF, subclass);
533 	ADD(alias, "i", interface_mask == 0xFF, interface);
534 
535 	module_alias_printf(mod, true, "%s", alias);
536 }
537 
538 /* looks like: "ccw:tNmNdtNdmN" */
539 static void do_ccw_entry(struct module *mod, void *symval)
540 {
541 	char alias[256] = {};
542 
543 	DEF_FIELD(symval, ccw_device_id, match_flags);
544 	DEF_FIELD(symval, ccw_device_id, cu_type);
545 	DEF_FIELD(symval, ccw_device_id, cu_model);
546 	DEF_FIELD(symval, ccw_device_id, dev_type);
547 	DEF_FIELD(symval, ccw_device_id, dev_model);
548 
549 	ADD(alias, "t", match_flags&CCW_DEVICE_ID_MATCH_CU_TYPE,
550 	    cu_type);
551 	ADD(alias, "m", match_flags&CCW_DEVICE_ID_MATCH_CU_MODEL,
552 	    cu_model);
553 	ADD(alias, "dt", match_flags&CCW_DEVICE_ID_MATCH_DEVICE_TYPE,
554 	    dev_type);
555 	ADD(alias, "dm", match_flags&CCW_DEVICE_ID_MATCH_DEVICE_MODEL,
556 	    dev_model);
557 
558 	module_alias_printf(mod, true, "ccw:%s", alias);
559 }
560 
561 /* looks like: "ap:tN" */
562 static void do_ap_entry(struct module *mod, void *symval)
563 {
564 	DEF_FIELD(symval, ap_device_id, dev_type);
565 
566 	module_alias_printf(mod, false, "ap:t%02X*", dev_type);
567 }
568 
569 /* looks like: "css:tN" */
570 static void do_css_entry(struct module *mod, void *symval)
571 {
572 	DEF_FIELD(symval, css_device_id, type);
573 
574 	module_alias_printf(mod, false, "css:t%01X", type);
575 }
576 
577 /* Looks like: "serio:tyNprNidNexN" */
578 static void do_serio_entry(struct module *mod, void *symval)
579 {
580 	char alias[256] = {};
581 
582 	DEF_FIELD(symval, serio_device_id, type);
583 	DEF_FIELD(symval, serio_device_id, proto);
584 	DEF_FIELD(symval, serio_device_id, id);
585 	DEF_FIELD(symval, serio_device_id, extra);
586 
587 	ADD(alias, "ty", type != SERIO_ANY, type);
588 	ADD(alias, "pr", proto != SERIO_ANY, proto);
589 	ADD(alias, "id", id != SERIO_ANY, id);
590 	ADD(alias, "ex", extra != SERIO_ANY, extra);
591 
592 	module_alias_printf(mod, true, "serio:%s", alias);
593 }
594 
595 /* looks like: "acpi:ACPI0003" or "acpi:PNP0C0B" or "acpi:LNXVIDEO" or
596  *             "acpi:bbsspp" (bb=base-class, ss=sub-class, pp=prog-if)
597  *
598  * NOTE: Each driver should use one of the following : _HID, _CIDs
599  *       or _CLS. Also, bb, ss, and pp can be substituted with ??
600  *       as don't care byte.
601  */
602 static void do_acpi_entry(struct module *mod, void *symval)
603 {
604 	DEF_FIELD_ADDR(symval, acpi_device_id, id);
605 	DEF_FIELD(symval, acpi_device_id, cls);
606 	DEF_FIELD(symval, acpi_device_id, cls_msk);
607 
608 	if ((*id)[0])
609 		module_alias_printf(mod, false, "acpi*:%s:*", *id);
610 	else {
611 		char alias[256];
612 		int i, byte_shift, cnt = 0;
613 		unsigned int msk;
614 
615 		for (i = 1; i <= 3; i++) {
616 			byte_shift = 8 * (3-i);
617 			msk = (cls_msk >> byte_shift) & 0xFF;
618 			if (msk)
619 				sprintf(&alias[cnt], "%02x",
620 					(cls >> byte_shift) & 0xFF);
621 			else
622 				sprintf(&alias[cnt], "??");
623 			cnt += 2;
624 		}
625 		module_alias_printf(mod, false, "acpi*:%s:*", alias);
626 	}
627 }
628 
629 /* looks like: "pnp:dD" */
630 static void do_pnp_device_entry(struct module *mod, void *symval)
631 {
632 	DEF_FIELD_ADDR(symval, pnp_device_id, id);
633 	char acpi_id[sizeof(*id)];
634 
635 	/* fix broken pnp bus lowercasing */
636 	for (unsigned int i = 0; i < sizeof(acpi_id); i++)
637 		acpi_id[i] = toupper((*id)[i]);
638 	module_alias_printf(mod, false, "pnp:d%s*", *id);
639 	module_alias_printf(mod, false, "acpi*:%s:*", acpi_id);
640 }
641 
642 /* looks like: "pnp:dD" for every device of the card */
643 static void do_pnp_card_entry(struct module *mod, void *symval)
644 {
645 	DEF_FIELD_ADDR(symval, pnp_card_device_id, devs);
646 
647 	for (unsigned int i = 0; i < PNP_MAX_DEVICES; i++) {
648 		const char *id = (char *)(*devs)[i].id;
649 		char acpi_id[PNP_ID_LEN];
650 
651 		if (!id[0])
652 			break;
653 
654 		/* fix broken pnp bus lowercasing */
655 		for (unsigned int j = 0; j < sizeof(acpi_id); j++)
656 			acpi_id[j] = toupper(id[j]);
657 
658 		/* add an individual alias for every device entry */
659 		module_alias_printf(mod, false, "pnp:d%s*", id);
660 		module_alias_printf(mod, false, "acpi*:%s:*", acpi_id);
661 	}
662 }
663 
664 /* Looks like: pcmcia:mNcNfNfnNpfnNvaNvbNvcNvdN. */
665 static void do_pcmcia_entry(struct module *mod, void *symval)
666 {
667 	char alias[256] = {};
668 	unsigned int i;
669 	DEF_FIELD(symval, pcmcia_device_id, match_flags);
670 	DEF_FIELD(symval, pcmcia_device_id, manf_id);
671 	DEF_FIELD(symval, pcmcia_device_id, card_id);
672 	DEF_FIELD(symval, pcmcia_device_id, func_id);
673 	DEF_FIELD(symval, pcmcia_device_id, function);
674 	DEF_FIELD(symval, pcmcia_device_id, device_no);
675 	DEF_FIELD_ADDR(symval, pcmcia_device_id, prod_id_hash);
676 
677 	for (i=0; i<4; i++) {
678 		(*prod_id_hash)[i] = TO_NATIVE((*prod_id_hash)[i]);
679 	}
680 
681 	ADD(alias, "m", match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID,
682 	    manf_id);
683 	ADD(alias, "c", match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID,
684 	    card_id);
685 	ADD(alias, "f", match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID,
686 	    func_id);
687 	ADD(alias, "fn", match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION,
688 	    function);
689 	ADD(alias, "pfn", match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO,
690 	    device_no);
691 	ADD(alias, "pa", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1, (*prod_id_hash)[0]);
692 	ADD(alias, "pb", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2, (*prod_id_hash)[1]);
693 	ADD(alias, "pc", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3, (*prod_id_hash)[2]);
694 	ADD(alias, "pd", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4, (*prod_id_hash)[3]);
695 
696 	module_alias_printf(mod, true, "pcmcia:%s", alias);
697 }
698 
699 static void do_vio_entry(struct module *mod, void *symval)
700 {
701 	char alias[256];
702 	char *tmp;
703 	DEF_FIELD_ADDR(symval, vio_device_id, type);
704 	DEF_FIELD_ADDR(symval, vio_device_id, compat);
705 
706 	sprintf(alias, "vio:T%sS%s", (*type)[0] ? *type : "*",
707 			(*compat)[0] ? *compat : "*");
708 
709 	/* Replace all whitespace with underscores */
710 	for (tmp = alias; tmp && *tmp; tmp++)
711 		if (isspace (*tmp))
712 			*tmp = '_';
713 
714 	module_alias_printf(mod, true, "%s", alias);
715 }
716 
717 static void do_input(char *alias,
718 		     kernel_ulong_t *arr, unsigned int min, unsigned int max)
719 {
720 	unsigned int i;
721 
722 	for (i = min / BITS_PER_LONG; i < max / BITS_PER_LONG + 1; i++)
723 		arr[i] = TO_NATIVE(arr[i]);
724 	for (i = min; i < max; i++)
725 		if (arr[i / BITS_PER_LONG] & (1ULL << (i%BITS_PER_LONG)))
726 			sprintf(alias + strlen(alias), "%X,*", i);
727 }
728 
729 /* input:b0v0p0e0-eXkXrXaXmXlXsXfXwX where X is comma-separated %02X. */
730 static void do_input_entry(struct module *mod, void *symval)
731 {
732 	char alias[256] = {};
733 
734 	DEF_FIELD(symval, input_device_id, flags);
735 	DEF_FIELD(symval, input_device_id, bustype);
736 	DEF_FIELD(symval, input_device_id, vendor);
737 	DEF_FIELD(symval, input_device_id, product);
738 	DEF_FIELD(symval, input_device_id, version);
739 	DEF_FIELD_ADDR(symval, input_device_id, evbit);
740 	DEF_FIELD_ADDR(symval, input_device_id, keybit);
741 	DEF_FIELD_ADDR(symval, input_device_id, relbit);
742 	DEF_FIELD_ADDR(symval, input_device_id, absbit);
743 	DEF_FIELD_ADDR(symval, input_device_id, mscbit);
744 	DEF_FIELD_ADDR(symval, input_device_id, ledbit);
745 	DEF_FIELD_ADDR(symval, input_device_id, sndbit);
746 	DEF_FIELD_ADDR(symval, input_device_id, ffbit);
747 	DEF_FIELD_ADDR(symval, input_device_id, swbit);
748 
749 	ADD(alias, "b", flags & INPUT_DEVICE_ID_MATCH_BUS, bustype);
750 	ADD(alias, "v", flags & INPUT_DEVICE_ID_MATCH_VENDOR, vendor);
751 	ADD(alias, "p", flags & INPUT_DEVICE_ID_MATCH_PRODUCT, product);
752 	ADD(alias, "e", flags & INPUT_DEVICE_ID_MATCH_VERSION, version);
753 
754 	sprintf(alias + strlen(alias), "-e*");
755 	if (flags & INPUT_DEVICE_ID_MATCH_EVBIT)
756 		do_input(alias, *evbit, 0, INPUT_DEVICE_ID_EV_MAX);
757 	sprintf(alias + strlen(alias), "k*");
758 	if (flags & INPUT_DEVICE_ID_MATCH_KEYBIT)
759 		do_input(alias, *keybit,
760 			 INPUT_DEVICE_ID_KEY_MIN_INTERESTING,
761 			 INPUT_DEVICE_ID_KEY_MAX);
762 	sprintf(alias + strlen(alias), "r*");
763 	if (flags & INPUT_DEVICE_ID_MATCH_RELBIT)
764 		do_input(alias, *relbit, 0, INPUT_DEVICE_ID_REL_MAX);
765 	sprintf(alias + strlen(alias), "a*");
766 	if (flags & INPUT_DEVICE_ID_MATCH_ABSBIT)
767 		do_input(alias, *absbit, 0, INPUT_DEVICE_ID_ABS_MAX);
768 	sprintf(alias + strlen(alias), "m*");
769 	if (flags & INPUT_DEVICE_ID_MATCH_MSCIT)
770 		do_input(alias, *mscbit, 0, INPUT_DEVICE_ID_MSC_MAX);
771 	sprintf(alias + strlen(alias), "l*");
772 	if (flags & INPUT_DEVICE_ID_MATCH_LEDBIT)
773 		do_input(alias, *ledbit, 0, INPUT_DEVICE_ID_LED_MAX);
774 	sprintf(alias + strlen(alias), "s*");
775 	if (flags & INPUT_DEVICE_ID_MATCH_SNDBIT)
776 		do_input(alias, *sndbit, 0, INPUT_DEVICE_ID_SND_MAX);
777 	sprintf(alias + strlen(alias), "f*");
778 	if (flags & INPUT_DEVICE_ID_MATCH_FFBIT)
779 		do_input(alias, *ffbit, 0, INPUT_DEVICE_ID_FF_MAX);
780 	sprintf(alias + strlen(alias), "w*");
781 	if (flags & INPUT_DEVICE_ID_MATCH_SWBIT)
782 		do_input(alias, *swbit, 0, INPUT_DEVICE_ID_SW_MAX);
783 
784 	module_alias_printf(mod, false, "input:%s", alias);
785 }
786 
787 static void do_eisa_entry(struct module *mod, void *symval)
788 {
789 	DEF_FIELD_ADDR(symval, eisa_device_id, sig);
790 	module_alias_printf(mod, false, EISA_DEVICE_MODALIAS_FMT "*", *sig);
791 }
792 
793 /* Looks like: parisc:tNhvNrevNsvN */
794 static void do_parisc_entry(struct module *mod, void *symval)
795 {
796 	char alias[256] = {};
797 
798 	DEF_FIELD(symval, parisc_device_id, hw_type);
799 	DEF_FIELD(symval, parisc_device_id, hversion);
800 	DEF_FIELD(symval, parisc_device_id, hversion_rev);
801 	DEF_FIELD(symval, parisc_device_id, sversion);
802 
803 	ADD(alias, "t", hw_type != PA_HWTYPE_ANY_ID, hw_type);
804 	ADD(alias, "hv", hversion != PA_HVERSION_ANY_ID, hversion);
805 	ADD(alias, "rev", hversion_rev != PA_HVERSION_REV_ANY_ID, hversion_rev);
806 	ADD(alias, "sv", sversion != PA_SVERSION_ANY_ID, sversion);
807 
808 	module_alias_printf(mod, true, "parisc:%s", alias);
809 }
810 
811 /* Looks like: sdio:cNvNdN. */
812 static void do_sdio_entry(struct module *mod, void *symval)
813 {
814 	char alias[256] = {};
815 
816 	DEF_FIELD(symval, sdio_device_id, class);
817 	DEF_FIELD(symval, sdio_device_id, vendor);
818 	DEF_FIELD(symval, sdio_device_id, device);
819 
820 	ADD(alias, "c", class != (__u8)SDIO_ANY_ID, class);
821 	ADD(alias, "v", vendor != (__u16)SDIO_ANY_ID, vendor);
822 	ADD(alias, "d", device != (__u16)SDIO_ANY_ID, device);
823 
824 	module_alias_printf(mod, true, "sdio:%s", alias);
825 }
826 
827 /* Looks like: ssb:vNidNrevN. */
828 static void do_ssb_entry(struct module *mod, void *symval)
829 {
830 	char alias[256] = {};
831 
832 	DEF_FIELD(symval, ssb_device_id, vendor);
833 	DEF_FIELD(symval, ssb_device_id, coreid);
834 	DEF_FIELD(symval, ssb_device_id, revision);
835 
836 	ADD(alias, "v", vendor != SSB_ANY_VENDOR, vendor);
837 	ADD(alias, "id", coreid != SSB_ANY_ID, coreid);
838 	ADD(alias, "rev", revision != SSB_ANY_REV, revision);
839 
840 	module_alias_printf(mod, true, "ssb:%s", alias);
841 }
842 
843 /* Looks like: bcma:mNidNrevNclN. */
844 static void do_bcma_entry(struct module *mod, void *symval)
845 {
846 	char alias[256] = {};
847 
848 	DEF_FIELD(symval, bcma_device_id, manuf);
849 	DEF_FIELD(symval, bcma_device_id, id);
850 	DEF_FIELD(symval, bcma_device_id, rev);
851 	DEF_FIELD(symval, bcma_device_id, class);
852 
853 	ADD(alias, "m", manuf != BCMA_ANY_MANUF, manuf);
854 	ADD(alias, "id", id != BCMA_ANY_ID, id);
855 	ADD(alias, "rev", rev != BCMA_ANY_REV, rev);
856 	ADD(alias, "cl", class != BCMA_ANY_CLASS, class);
857 
858 	module_alias_printf(mod, true, "bcma:%s", alias);
859 }
860 
861 /* Looks like: virtio:dNvN */
862 static void do_virtio_entry(struct module *mod, void *symval)
863 {
864 	char alias[256] = {};
865 
866 	DEF_FIELD(symval, virtio_device_id, device);
867 	DEF_FIELD(symval, virtio_device_id, vendor);
868 
869 	ADD(alias, "d", device != VIRTIO_DEV_ANY_ID, device);
870 	ADD(alias, "v", vendor != VIRTIO_DEV_ANY_ID, vendor);
871 
872 	module_alias_printf(mod, true, "virtio:%s", alias);
873 }
874 
875 /*
876  * Looks like: vmbus:guid
877  * Each byte of the guid will be represented by two hex characters
878  * in the name.
879  */
880 
881 static void do_vmbus_entry(struct module *mod, void *symval)
882 {
883 	int i;
884 	DEF_FIELD_ADDR(symval, hv_vmbus_device_id, guid);
885 	char guid_name[(sizeof(*guid) + 1) * 2];
886 
887 	for (i = 0; i < (sizeof(*guid) * 2); i += 2)
888 		sprintf(&guid_name[i], "%02x", TO_NATIVE((guid->b)[i/2]));
889 
890 	module_alias_printf(mod, false, "vmbus:%s", guid_name);
891 }
892 
893 /* Looks like: rpmsg:S */
894 static void do_rpmsg_entry(struct module *mod, void *symval)
895 {
896 	DEF_FIELD_ADDR(symval, rpmsg_device_id, name);
897 
898 	module_alias_printf(mod, false, RPMSG_DEVICE_MODALIAS_FMT, *name);
899 }
900 
901 /* Looks like: i2c:S */
902 static void do_i2c_entry(struct module *mod, void *symval)
903 {
904 	DEF_FIELD_ADDR(symval, i2c_device_id, name);
905 
906 	module_alias_printf(mod, false, I2C_MODULE_PREFIX "%s", *name);
907 }
908 
909 static void do_i3c_entry(struct module *mod, void *symval)
910 {
911 	char alias[256] = {};
912 
913 	DEF_FIELD(symval, i3c_device_id, match_flags);
914 	DEF_FIELD(symval, i3c_device_id, dcr);
915 	DEF_FIELD(symval, i3c_device_id, manuf_id);
916 	DEF_FIELD(symval, i3c_device_id, part_id);
917 	DEF_FIELD(symval, i3c_device_id, extra_info);
918 
919 	ADD(alias, "dcr", match_flags & I3C_MATCH_DCR, dcr);
920 	ADD(alias, "manuf", match_flags & I3C_MATCH_MANUF, manuf_id);
921 	ADD(alias, "part", match_flags & I3C_MATCH_PART, part_id);
922 	ADD(alias, "ext", match_flags & I3C_MATCH_EXTRA_INFO, extra_info);
923 
924 	module_alias_printf(mod, false, "i3c:%s", alias);
925 }
926 
927 static void do_slim_entry(struct module *mod, void *symval)
928 {
929 	DEF_FIELD(symval, slim_device_id, manf_id);
930 	DEF_FIELD(symval, slim_device_id, prod_code);
931 
932 	module_alias_printf(mod, false, "slim:%x:%x:*", manf_id, prod_code);
933 }
934 
935 /* Looks like: spi:S */
936 static void do_spi_entry(struct module *mod, void *symval)
937 {
938 	DEF_FIELD_ADDR(symval, spi_device_id, name);
939 
940 	module_alias_printf(mod, false, SPI_MODULE_PREFIX "%s", *name);
941 }
942 
943 static const struct dmifield {
944 	const char *prefix;
945 	int field;
946 } dmi_fields[] = {
947 	{ "bvn", DMI_BIOS_VENDOR },
948 	{ "bvr", DMI_BIOS_VERSION },
949 	{ "bd",  DMI_BIOS_DATE },
950 	{ "br",  DMI_BIOS_RELEASE },
951 	{ "efr", DMI_EC_FIRMWARE_RELEASE },
952 	{ "svn", DMI_SYS_VENDOR },
953 	{ "pn",  DMI_PRODUCT_NAME },
954 	{ "pvr", DMI_PRODUCT_VERSION },
955 	{ "rvn", DMI_BOARD_VENDOR },
956 	{ "rn",  DMI_BOARD_NAME },
957 	{ "rvr", DMI_BOARD_VERSION },
958 	{ "cvn", DMI_CHASSIS_VENDOR },
959 	{ "ct",  DMI_CHASSIS_TYPE },
960 	{ "cvr", DMI_CHASSIS_VERSION },
961 	{ NULL,  DMI_NONE }
962 };
963 
964 static void dmi_ascii_filter(char *d, const char *s)
965 {
966 	/* Filter out characters we don't want to see in the modalias string */
967 	for (; *s; s++)
968 		if (*s > ' ' && *s < 127 && *s != ':')
969 			*(d++) = *s;
970 
971 	*d = 0;
972 }
973 
974 
975 static void do_dmi_entry(struct module *mod, void *symval)
976 {
977 	char alias[256] = {};
978 	int i, j;
979 	DEF_FIELD_ADDR(symval, dmi_system_id, matches);
980 
981 	for (i = 0; i < ARRAY_SIZE(dmi_fields); i++) {
982 		for (j = 0; j < 4; j++) {
983 			if ((*matches)[j].slot &&
984 			    (*matches)[j].slot == dmi_fields[i].field) {
985 				sprintf(alias + strlen(alias), ":%s*",
986 					dmi_fields[i].prefix);
987 				dmi_ascii_filter(alias + strlen(alias),
988 						 (*matches)[j].substr);
989 				strcat(alias, "*");
990 			}
991 		}
992 	}
993 
994 	module_alias_printf(mod, false, "dmi*%s:", alias);
995 }
996 
997 static void do_platform_entry(struct module *mod, void *symval)
998 {
999 	DEF_FIELD_ADDR(symval, platform_device_id, name);
1000 
1001 	module_alias_printf(mod, false, PLATFORM_MODULE_PREFIX "%s", *name);
1002 }
1003 
1004 static void do_mdio_entry(struct module *mod, void *symval)
1005 {
1006 	char id[33];
1007 	int i;
1008 	DEF_FIELD(symval, mdio_device_id, phy_id);
1009 	DEF_FIELD(symval, mdio_device_id, phy_id_mask);
1010 
1011 	for (i = 0; i < 32; i++) {
1012 		if (!((phy_id_mask >> (31-i)) & 1))
1013 			id[i] = '?';
1014 		else if ((phy_id >> (31-i)) & 1)
1015 			id[i] = '1';
1016 		else
1017 			id[i] = '0';
1018 	}
1019 
1020 	/* Terminate the string */
1021 	id[32] = '\0';
1022 
1023 	module_alias_printf(mod, false, MDIO_MODULE_PREFIX "%s", id);
1024 }
1025 
1026 /* Looks like: zorro:iN. */
1027 static void do_zorro_entry(struct module *mod, void *symval)
1028 {
1029 	char alias[256] = {};
1030 	DEF_FIELD(symval, zorro_device_id, id);
1031 
1032 	ADD(alias, "i", id != ZORRO_WILDCARD, id);
1033 
1034 	module_alias_printf(mod, false, "zorro:%s", alias);
1035 }
1036 
1037 /* looks like: "pnp:dD" */
1038 static void do_isapnp_entry(struct module *mod, void *symval)
1039 {
1040 	DEF_FIELD(symval, isapnp_device_id, vendor);
1041 	DEF_FIELD(symval, isapnp_device_id, function);
1042 	module_alias_printf(mod, false, "pnp:d%c%c%c%x%x%x%x*",
1043 		'A' + ((vendor >> 2) & 0x3f) - 1,
1044 		'A' + (((vendor & 3) << 3) | ((vendor >> 13) & 7)) - 1,
1045 		'A' + ((vendor >> 8) & 0x1f) - 1,
1046 		(function >> 4) & 0x0f, function & 0x0f,
1047 		(function >> 12) & 0x0f, (function >> 8) & 0x0f);
1048 }
1049 
1050 /* Looks like: "ipack:fNvNdN". */
1051 static void do_ipack_entry(struct module *mod, void *symval)
1052 {
1053 	char alias[256] = {};
1054 	DEF_FIELD(symval, ipack_device_id, format);
1055 	DEF_FIELD(symval, ipack_device_id, vendor);
1056 	DEF_FIELD(symval, ipack_device_id, device);
1057 
1058 	ADD(alias, "f", format != IPACK_ANY_FORMAT, format);
1059 	ADD(alias, "v", vendor != IPACK_ANY_ID, vendor);
1060 	ADD(alias, "d", device != IPACK_ANY_ID, device);
1061 
1062 	module_alias_printf(mod, true, "ipack:%s", alias);
1063 }
1064 
1065 /*
1066  * Append a match expression for a single masked hex digit.
1067  * outp points to a pointer to the character at which to append.
1068  *	*outp is updated on return to point just after the appended text,
1069  *	to facilitate further appending.
1070  */
1071 static void append_nibble_mask(char **outp,
1072 			       unsigned int nibble, unsigned int mask)
1073 {
1074 	char *p = *outp;
1075 	unsigned int i;
1076 
1077 	switch (mask) {
1078 	case 0:
1079 		*p++ = '?';
1080 		break;
1081 
1082 	case 0xf:
1083 		p += sprintf(p, "%X",  nibble);
1084 		break;
1085 
1086 	default:
1087 		/*
1088 		 * Dumbly emit a match pattern for all possible matching
1089 		 * digits.  This could be improved in some cases using ranges,
1090 		 * but it has the advantage of being trivially correct, and is
1091 		 * often optimal.
1092 		 */
1093 		*p++ = '[';
1094 		for (i = 0; i < 0x10; i++)
1095 			if ((i & mask) == nibble)
1096 				p += sprintf(p, "%X", i);
1097 		*p++ = ']';
1098 	}
1099 
1100 	/* Ensure that the string remains NUL-terminated: */
1101 	*p = '\0';
1102 
1103 	/* Advance the caller's end-of-string pointer: */
1104 	*outp = p;
1105 }
1106 
1107 /*
1108  * looks like: "amba:dN"
1109  *
1110  * N is exactly 8 digits, where each is an upper-case hex digit, or
1111  *	a ? or [] pattern matching exactly one digit.
1112  */
1113 static void do_amba_entry(struct module *mod, void *symval)
1114 {
1115 	char alias[256];
1116 	unsigned int digit;
1117 	char *p = alias;
1118 	DEF_FIELD(symval, amba_id, id);
1119 	DEF_FIELD(symval, amba_id, mask);
1120 
1121 	if ((id & mask) != id)
1122 		fatal("%s: Masked-off bit(s) of AMBA device ID are non-zero: id=0x%08X, mask=0x%08X.  Please fix this driver.\n",
1123 		      mod->name, id, mask);
1124 
1125 	for (digit = 0; digit < 8; digit++)
1126 		append_nibble_mask(&p,
1127 				   (id >> (4 * (7 - digit))) & 0xf,
1128 				   (mask >> (4 * (7 - digit))) & 0xf);
1129 
1130 	module_alias_printf(mod, false, "amba:d%s", alias);
1131 }
1132 
1133 /*
1134  * looks like: "mipscdmm:tN"
1135  *
1136  * N is exactly 2 digits, where each is an upper-case hex digit, or
1137  *	a ? or [] pattern matching exactly one digit.
1138  */
1139 static void do_mips_cdmm_entry(struct module *mod, void *symval)
1140 {
1141 	DEF_FIELD(symval, mips_cdmm_device_id, type);
1142 
1143 	module_alias_printf(mod, false, "mipscdmm:t%02X*", type);
1144 }
1145 
1146 /* LOOKS like cpu:type:x86,venVVVVfamFFFFmodMMMM:feature:*,FEAT,*
1147  * All fields are numbers. It would be nicer to use strings for vendor
1148  * and feature, but getting those out of the build system here is too
1149  * complicated.
1150  */
1151 
1152 static void do_x86cpu_entry(struct module *mod, void *symval)
1153 {
1154 	char alias[256] = {};
1155 
1156 	DEF_FIELD(symval, x86_cpu_id, feature);
1157 	DEF_FIELD(symval, x86_cpu_id, family);
1158 	DEF_FIELD(symval, x86_cpu_id, model);
1159 	DEF_FIELD(symval, x86_cpu_id, vendor);
1160 
1161 	ADD(alias, "ven", vendor != X86_VENDOR_ANY, vendor);
1162 	ADD(alias, "fam", family != X86_FAMILY_ANY, family);
1163 	ADD(alias, "mod", model  != X86_MODEL_ANY,  model);
1164 	strcat(alias, ":feature:*");
1165 	if (feature != X86_FEATURE_ANY)
1166 		sprintf(alias + strlen(alias), "%04X*", feature);
1167 
1168 	module_alias_printf(mod, false, "cpu:type:x86,%s", alias);
1169 }
1170 
1171 /* LOOKS like cpu:type:*:feature:*FEAT* */
1172 static void do_cpu_entry(struct module *mod, void *symval)
1173 {
1174 	DEF_FIELD(symval, cpu_feature, feature);
1175 
1176 	module_alias_printf(mod, false, "cpu:type:*:feature:*%04X*", feature);
1177 }
1178 
1179 /* Looks like: mei:S:uuid:N:* */
1180 static void do_mei_entry(struct module *mod, void *symval)
1181 {
1182 	char alias[256] = {};
1183 
1184 	DEF_FIELD_ADDR(symval, mei_cl_device_id, name);
1185 	DEF_FIELD_ADDR(symval, mei_cl_device_id, uuid);
1186 	DEF_FIELD(symval, mei_cl_device_id, version);
1187 
1188 	add_uuid(alias, *uuid);
1189 	ADD(alias, ":", version != MEI_CL_VERSION_ANY, version);
1190 
1191 	module_alias_printf(mod, false, MEI_CL_MODULE_PREFIX "%s:%s:*",
1192 			    (*name)[0] ? *name : "*", alias);
1193 }
1194 
1195 /* Looks like: rapidio:vNdNavNadN */
1196 static void do_rio_entry(struct module *mod, void *symval)
1197 {
1198 	char alias[256] = {};
1199 
1200 	DEF_FIELD(symval, rio_device_id, did);
1201 	DEF_FIELD(symval, rio_device_id, vid);
1202 	DEF_FIELD(symval, rio_device_id, asm_did);
1203 	DEF_FIELD(symval, rio_device_id, asm_vid);
1204 
1205 	ADD(alias, "v", vid != RIO_ANY_ID, vid);
1206 	ADD(alias, "d", did != RIO_ANY_ID, did);
1207 	ADD(alias, "av", asm_vid != RIO_ANY_ID, asm_vid);
1208 	ADD(alias, "ad", asm_did != RIO_ANY_ID, asm_did);
1209 
1210 	module_alias_printf(mod, true, "rapidio:%s", alias);
1211 }
1212 
1213 /* Looks like: ulpi:vNpN */
1214 static void do_ulpi_entry(struct module *mod, void *symval)
1215 {
1216 	DEF_FIELD(symval, ulpi_device_id, vendor);
1217 	DEF_FIELD(symval, ulpi_device_id, product);
1218 
1219 	module_alias_printf(mod, false, "ulpi:v%04xp%04x", vendor, product);
1220 }
1221 
1222 /* Looks like: hdaudio:vNrNaN */
1223 static void do_hda_entry(struct module *mod, void *symval)
1224 {
1225 	char alias[256] = {};
1226 
1227 	DEF_FIELD(symval, hda_device_id, vendor_id);
1228 	DEF_FIELD(symval, hda_device_id, rev_id);
1229 	DEF_FIELD(symval, hda_device_id, api_version);
1230 
1231 	ADD(alias, "v", vendor_id != 0, vendor_id);
1232 	ADD(alias, "r", rev_id != 0, rev_id);
1233 	ADD(alias, "a", api_version != 0, api_version);
1234 
1235 	module_alias_printf(mod, true, "hdaudio:%s", alias);
1236 }
1237 
1238 /* Looks like: sdw:mNpNvNcN */
1239 static void do_sdw_entry(struct module *mod, void *symval)
1240 {
1241 	char alias[256] = {};
1242 
1243 	DEF_FIELD(symval, sdw_device_id, mfg_id);
1244 	DEF_FIELD(symval, sdw_device_id, part_id);
1245 	DEF_FIELD(symval, sdw_device_id, sdw_version);
1246 	DEF_FIELD(symval, sdw_device_id, class_id);
1247 
1248 	ADD(alias, "m", mfg_id != 0, mfg_id);
1249 	ADD(alias, "p", part_id != 0, part_id);
1250 	ADD(alias, "v", sdw_version != 0, sdw_version);
1251 	ADD(alias, "c", class_id != 0, class_id);
1252 
1253 	module_alias_printf(mod, true, "sdw:%s", alias);
1254 }
1255 
1256 /* Looks like: fsl-mc:vNdN */
1257 static void do_fsl_mc_entry(struct module *mod, void *symval)
1258 {
1259 	DEF_FIELD(symval, fsl_mc_device_id, vendor);
1260 	DEF_FIELD_ADDR(symval, fsl_mc_device_id, obj_type);
1261 
1262 	module_alias_printf(mod, false, "fsl-mc:v%08Xd%s", vendor, *obj_type);
1263 }
1264 
1265 /* Looks like: tbsvc:kSpNvNrN */
1266 static void do_tbsvc_entry(struct module *mod, void *symval)
1267 {
1268 	char alias[256] = {};
1269 
1270 	DEF_FIELD(symval, tb_service_id, match_flags);
1271 	DEF_FIELD_ADDR(symval, tb_service_id, protocol_key);
1272 	DEF_FIELD(symval, tb_service_id, protocol_id);
1273 	DEF_FIELD(symval, tb_service_id, protocol_version);
1274 	DEF_FIELD(symval, tb_service_id, protocol_revision);
1275 
1276 	if (match_flags & TBSVC_MATCH_PROTOCOL_KEY)
1277 		sprintf(alias + strlen(alias), "k%s", *protocol_key);
1278 	else
1279 		strcat(alias + strlen(alias), "k*");
1280 	ADD(alias, "p", match_flags & TBSVC_MATCH_PROTOCOL_ID, protocol_id);
1281 	ADD(alias, "v", match_flags & TBSVC_MATCH_PROTOCOL_VERSION,
1282 	    protocol_version);
1283 	ADD(alias, "r", match_flags & TBSVC_MATCH_PROTOCOL_REVISION,
1284 	    protocol_revision);
1285 
1286 	module_alias_printf(mod, true, "tbsvc:%s", alias);
1287 }
1288 
1289 /* Looks like: typec:idNmN */
1290 static void do_typec_entry(struct module *mod, void *symval)
1291 {
1292 	char alias[256] = {};
1293 
1294 	DEF_FIELD(symval, typec_device_id, svid);
1295 	DEF_FIELD(symval, typec_device_id, mode);
1296 
1297 	ADD(alias, "m", mode != TYPEC_ANY_MODE, mode);
1298 
1299 	module_alias_printf(mod, false, "typec:id%04X%s", svid, alias);
1300 }
1301 
1302 /* Looks like: tee:uuid */
1303 static void do_tee_entry(struct module *mod, void *symval)
1304 {
1305 	DEF_FIELD_ADDR(symval, tee_client_device_id, uuid);
1306 
1307 	module_alias_printf(mod, true,
1308 			    "tee:%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1309 		uuid->b[0], uuid->b[1], uuid->b[2], uuid->b[3], uuid->b[4],
1310 		uuid->b[5], uuid->b[6], uuid->b[7], uuid->b[8], uuid->b[9],
1311 		uuid->b[10], uuid->b[11], uuid->b[12], uuid->b[13], uuid->b[14],
1312 		uuid->b[15]);
1313 }
1314 
1315 /* Looks like: wmi:guid */
1316 static void do_wmi_entry(struct module *mod, void *symval)
1317 {
1318 	DEF_FIELD_ADDR(symval, wmi_device_id, guid_string);
1319 
1320 	if (strlen(*guid_string) != UUID_STRING_LEN) {
1321 		warn("Invalid WMI device id 'wmi:%s' in '%s'\n",
1322 				*guid_string, mod->name);
1323 		return;
1324 	}
1325 
1326 	module_alias_printf(mod, false, WMI_MODULE_PREFIX "%s", *guid_string);
1327 }
1328 
1329 /* Looks like: mhi:S */
1330 static void do_mhi_entry(struct module *mod, void *symval)
1331 {
1332 	DEF_FIELD_ADDR(symval, mhi_device_id, chan);
1333 	module_alias_printf(mod, false, MHI_DEVICE_MODALIAS_FMT, *chan);
1334 }
1335 
1336 /* Looks like: mhi_ep:S */
1337 static void do_mhi_ep_entry(struct module *mod, void *symval)
1338 {
1339 	DEF_FIELD_ADDR(symval, mhi_device_id, chan);
1340 
1341 	module_alias_printf(mod, false, MHI_EP_DEVICE_MODALIAS_FMT, *chan);
1342 }
1343 
1344 /* Looks like: ishtp:{guid} */
1345 static void do_ishtp_entry(struct module *mod, void *symval)
1346 {
1347 	char alias[256] = {};
1348 	DEF_FIELD_ADDR(symval, ishtp_device_id, guid);
1349 
1350 	add_guid(alias, *guid);
1351 
1352 	module_alias_printf(mod, false, ISHTP_MODULE_PREFIX "{%s}", alias);
1353 }
1354 
1355 static void do_auxiliary_entry(struct module *mod, void *symval)
1356 {
1357 	DEF_FIELD_ADDR(symval, auxiliary_device_id, name);
1358 
1359 	module_alias_printf(mod, false, AUXILIARY_MODULE_PREFIX "%s", *name);
1360 }
1361 
1362 /*
1363  * Looks like: ssam:dNcNtNiNfN
1364  *
1365  * N is exactly 2 digits, where each is an upper-case hex digit.
1366  */
1367 static void do_ssam_entry(struct module *mod, void *symval)
1368 {
1369 	char alias[256] = {};
1370 
1371 	DEF_FIELD(symval, ssam_device_id, match_flags);
1372 	DEF_FIELD(symval, ssam_device_id, domain);
1373 	DEF_FIELD(symval, ssam_device_id, category);
1374 	DEF_FIELD(symval, ssam_device_id, target);
1375 	DEF_FIELD(symval, ssam_device_id, instance);
1376 	DEF_FIELD(symval, ssam_device_id, function);
1377 
1378 	ADD(alias, "t", match_flags & SSAM_MATCH_TARGET, target);
1379 	ADD(alias, "i", match_flags & SSAM_MATCH_INSTANCE, instance);
1380 	ADD(alias, "f", match_flags & SSAM_MATCH_FUNCTION, function);
1381 
1382 	module_alias_printf(mod, false, "ssam:d%02Xc%02X%s",
1383 			    domain, category, alias);
1384 }
1385 
1386 /* Looks like: dfl:tNfN */
1387 static void do_dfl_entry(struct module *mod, void *symval)
1388 {
1389 	DEF_FIELD(symval, dfl_device_id, type);
1390 	DEF_FIELD(symval, dfl_device_id, feature_id);
1391 
1392 	module_alias_printf(mod, true, "dfl:t%04Xf%04X", type, feature_id);
1393 }
1394 
1395 /* Looks like: cdx:vNdN */
1396 static void do_cdx_entry(struct module *mod, void *symval)
1397 {
1398 	char alias[256];
1399 
1400 	DEF_FIELD(symval, cdx_device_id, vendor);
1401 	DEF_FIELD(symval, cdx_device_id, device);
1402 	DEF_FIELD(symval, cdx_device_id, subvendor);
1403 	DEF_FIELD(symval, cdx_device_id, subdevice);
1404 	DEF_FIELD(symval, cdx_device_id, class);
1405 	DEF_FIELD(symval, cdx_device_id, class_mask);
1406 	DEF_FIELD(symval, cdx_device_id, override_only);
1407 
1408 	switch (override_only) {
1409 	case 0:
1410 		strcpy(alias, "cdx:");
1411 		break;
1412 	case CDX_ID_F_VFIO_DRIVER_OVERRIDE:
1413 		strcpy(alias, "vfio_cdx:");
1414 		break;
1415 	default:
1416 		warn("Unknown CDX driver_override alias %08X\n",
1417 		     override_only);
1418 		return;
1419 	}
1420 
1421 	ADD(alias, "v", vendor != CDX_ANY_ID, vendor);
1422 	ADD(alias, "d", device != CDX_ANY_ID, device);
1423 	ADD(alias, "sv", subvendor != CDX_ANY_ID, subvendor);
1424 	ADD(alias, "sd", subdevice != CDX_ANY_ID, subdevice);
1425 	ADD(alias, "c", class_mask == 0xFFFFFF, class);
1426 
1427 	module_alias_printf(mod, false, "%s", alias);
1428 }
1429 
1430 static void do_vchiq_entry(struct module *mod, void *symval)
1431 {
1432 	DEF_FIELD_ADDR(symval, vchiq_device_id, name);
1433 
1434 	module_alias_printf(mod, false, "vchiq:%s", *name);
1435 }
1436 
1437 /* Looks like: coreboot:tN */
1438 static void do_coreboot_entry(struct module *mod, void *symval)
1439 {
1440 	DEF_FIELD(symval, coreboot_device_id, tag);
1441 
1442 	module_alias_printf(mod, false, "coreboot:t%08X", tag);
1443 }
1444 
1445 /* Does namelen bytes of name exactly match the symbol? */
1446 static bool sym_is(const char *name, unsigned namelen, const char *symbol)
1447 {
1448 	if (namelen != strlen(symbol))
1449 		return false;
1450 
1451 	return memcmp(name, symbol, namelen) == 0;
1452 }
1453 
1454 static void do_table(void *symval, unsigned long size,
1455 		     unsigned long id_size,
1456 		     const char *device_id,
1457 		     void (*do_entry)(struct module *mod, void *symval),
1458 		     struct module *mod)
1459 {
1460 	unsigned int i;
1461 
1462 	device_id_check(mod->name, device_id, size, id_size, symval);
1463 	/* Leave last one: it's the terminator. */
1464 	size -= id_size;
1465 
1466 	for (i = 0; i < size; i += id_size)
1467 		do_entry(mod, symval + i);
1468 }
1469 
1470 static const struct devtable devtable[] = {
1471 	{"hid", SIZE_hid_device_id, do_hid_entry},
1472 	{"ieee1394", SIZE_ieee1394_device_id, do_ieee1394_entry},
1473 	{"pci", SIZE_pci_device_id, do_pci_entry},
1474 	{"ccw", SIZE_ccw_device_id, do_ccw_entry},
1475 	{"ap", SIZE_ap_device_id, do_ap_entry},
1476 	{"css", SIZE_css_device_id, do_css_entry},
1477 	{"serio", SIZE_serio_device_id, do_serio_entry},
1478 	{"acpi", SIZE_acpi_device_id, do_acpi_entry},
1479 	{"pcmcia", SIZE_pcmcia_device_id, do_pcmcia_entry},
1480 	{"vio", SIZE_vio_device_id, do_vio_entry},
1481 	{"input", SIZE_input_device_id, do_input_entry},
1482 	{"eisa", SIZE_eisa_device_id, do_eisa_entry},
1483 	{"parisc", SIZE_parisc_device_id, do_parisc_entry},
1484 	{"sdio", SIZE_sdio_device_id, do_sdio_entry},
1485 	{"ssb", SIZE_ssb_device_id, do_ssb_entry},
1486 	{"bcma", SIZE_bcma_device_id, do_bcma_entry},
1487 	{"virtio", SIZE_virtio_device_id, do_virtio_entry},
1488 	{"vmbus", SIZE_hv_vmbus_device_id, do_vmbus_entry},
1489 	{"rpmsg", SIZE_rpmsg_device_id, do_rpmsg_entry},
1490 	{"i2c", SIZE_i2c_device_id, do_i2c_entry},
1491 	{"i3c", SIZE_i3c_device_id, do_i3c_entry},
1492 	{"slim", SIZE_slim_device_id, do_slim_entry},
1493 	{"spi", SIZE_spi_device_id, do_spi_entry},
1494 	{"dmi", SIZE_dmi_system_id, do_dmi_entry},
1495 	{"platform", SIZE_platform_device_id, do_platform_entry},
1496 	{"mdio", SIZE_mdio_device_id, do_mdio_entry},
1497 	{"zorro", SIZE_zorro_device_id, do_zorro_entry},
1498 	{"isapnp", SIZE_isapnp_device_id, do_isapnp_entry},
1499 	{"ipack", SIZE_ipack_device_id, do_ipack_entry},
1500 	{"amba", SIZE_amba_id, do_amba_entry},
1501 	{"mipscdmm", SIZE_mips_cdmm_device_id, do_mips_cdmm_entry},
1502 	{"x86cpu", SIZE_x86_cpu_id, do_x86cpu_entry},
1503 	{"cpu", SIZE_cpu_feature, do_cpu_entry},
1504 	{"mei", SIZE_mei_cl_device_id, do_mei_entry},
1505 	{"rapidio", SIZE_rio_device_id, do_rio_entry},
1506 	{"ulpi", SIZE_ulpi_device_id, do_ulpi_entry},
1507 	{"hdaudio", SIZE_hda_device_id, do_hda_entry},
1508 	{"sdw", SIZE_sdw_device_id, do_sdw_entry},
1509 	{"fslmc", SIZE_fsl_mc_device_id, do_fsl_mc_entry},
1510 	{"tbsvc", SIZE_tb_service_id, do_tbsvc_entry},
1511 	{"typec", SIZE_typec_device_id, do_typec_entry},
1512 	{"tee", SIZE_tee_client_device_id, do_tee_entry},
1513 	{"wmi", SIZE_wmi_device_id, do_wmi_entry},
1514 	{"mhi", SIZE_mhi_device_id, do_mhi_entry},
1515 	{"mhi_ep", SIZE_mhi_device_id, do_mhi_ep_entry},
1516 	{"auxiliary", SIZE_auxiliary_device_id, do_auxiliary_entry},
1517 	{"ssam", SIZE_ssam_device_id, do_ssam_entry},
1518 	{"dfl", SIZE_dfl_device_id, do_dfl_entry},
1519 	{"ishtp", SIZE_ishtp_device_id, do_ishtp_entry},
1520 	{"cdx", SIZE_cdx_device_id, do_cdx_entry},
1521 	{"vchiq", SIZE_vchiq_device_id, do_vchiq_entry},
1522 	{"coreboot", SIZE_coreboot_device_id, do_coreboot_entry},
1523 	{"pnp", SIZE_pnp_device_id, do_pnp_device_entry},
1524 	{"pnp_card", SIZE_pnp_card_device_id, do_pnp_card_entry},
1525 };
1526 
1527 /* Create MODULE_ALIAS() statements.
1528  * At this time, we cannot write the actual output C source yet,
1529  * so we write into the mod->dev_table_buf buffer. */
1530 void handle_moddevtable(struct module *mod, struct elf_info *info,
1531 			Elf_Sym *sym, const char *symname)
1532 {
1533 	void *symval;
1534 	char *zeros = NULL;
1535 	const char *name, *identifier;
1536 	unsigned int namelen;
1537 
1538 	/* We're looking for a section relative symbol */
1539 	if (!sym->st_shndx || get_secindex(info, sym) >= info->num_sections)
1540 		return;
1541 
1542 	/* We're looking for an object */
1543 	if (ELF_ST_TYPE(sym->st_info) != STT_OBJECT)
1544 		return;
1545 
1546 	/* All our symbols are of form __mod_<name>__<identifier>_device_table. */
1547 	if (strncmp(symname, "__mod_", strlen("__mod_")))
1548 		return;
1549 	name = symname + strlen("__mod_");
1550 	namelen = strlen(name);
1551 	if (namelen < strlen("_device_table"))
1552 		return;
1553 	if (strcmp(name + namelen - strlen("_device_table"), "_device_table"))
1554 		return;
1555 	identifier = strstr(name, "__");
1556 	if (!identifier)
1557 		return;
1558 	namelen = identifier - name;
1559 
1560 	/* Handle all-NULL symbols allocated into .bss */
1561 	if (info->sechdrs[get_secindex(info, sym)].sh_type & SHT_NOBITS) {
1562 		zeros = calloc(1, sym->st_size);
1563 		symval = zeros;
1564 	} else {
1565 		symval = sym_get_data(info, sym);
1566 	}
1567 
1568 	/* First handle the "special" cases */
1569 	if (sym_is(name, namelen, "usb"))
1570 		do_usb_table(symval, sym->st_size, mod);
1571 	else if (sym_is(name, namelen, "of"))
1572 		do_of_table(symval, sym->st_size, mod);
1573 	else {
1574 		int i;
1575 
1576 		for (i = 0; i < ARRAY_SIZE(devtable); i++) {
1577 			const struct devtable *p = &devtable[i];
1578 
1579 			if (sym_is(name, namelen, p->device_id)) {
1580 				do_table(symval, sym->st_size, p->id_size,
1581 					 p->device_id, p->do_entry, mod);
1582 				break;
1583 			}
1584 		}
1585 	}
1586 	free(zeros);
1587 }
1588