xref: /linux-6.15/scripts/mod/file2alias.c (revision c58854c8)
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(struct module *mod, void *symval)
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 /* Looks like: hid:bNvNpN */
428 static void do_hid_entry(struct module *mod, void *symval)
429 {
430 	char alias[256] = {};
431 
432 	DEF_FIELD(symval, hid_device_id, bus);
433 	DEF_FIELD(symval, hid_device_id, group);
434 	DEF_FIELD(symval, hid_device_id, vendor);
435 	DEF_FIELD(symval, hid_device_id, product);
436 
437 	ADD(alias, "b", bus != HID_BUS_ANY, bus);
438 	ADD(alias, "g", group != HID_GROUP_ANY, group);
439 	ADD(alias, "v", vendor != HID_ANY_ID, vendor);
440 	ADD(alias, "p", product != HID_ANY_ID, product);
441 
442 	module_alias_printf(mod, false, "hid:%s", alias);
443 }
444 
445 /* Looks like: ieee1394:venNmoNspNverN */
446 static void do_ieee1394_entry(struct module *mod, void *symval)
447 {
448 	char alias[256] = {};
449 
450 	DEF_FIELD(symval, ieee1394_device_id, match_flags);
451 	DEF_FIELD(symval, ieee1394_device_id, vendor_id);
452 	DEF_FIELD(symval, ieee1394_device_id, model_id);
453 	DEF_FIELD(symval, ieee1394_device_id, specifier_id);
454 	DEF_FIELD(symval, ieee1394_device_id, version);
455 
456 	ADD(alias, "ven", match_flags & IEEE1394_MATCH_VENDOR_ID,
457 	    vendor_id);
458 	ADD(alias, "mo", match_flags & IEEE1394_MATCH_MODEL_ID,
459 	    model_id);
460 	ADD(alias, "sp", match_flags & IEEE1394_MATCH_SPECIFIER_ID,
461 	    specifier_id);
462 	ADD(alias, "ver", match_flags & IEEE1394_MATCH_VERSION,
463 	    version);
464 
465 	module_alias_printf(mod, true, "ieee1394:%s", alias);
466 }
467 
468 /* Looks like: pci:vNdNsvNsdNbcNscNiN or <prefix>_pci:vNdNsvNsdNbcNscNiN. */
469 static void do_pci_entry(struct module *mod, void *symval)
470 {
471 	char alias[256];
472 	/* Class field can be divided into these three. */
473 	unsigned char baseclass, subclass, interface,
474 		baseclass_mask, subclass_mask, interface_mask;
475 
476 	DEF_FIELD(symval, pci_device_id, vendor);
477 	DEF_FIELD(symval, pci_device_id, device);
478 	DEF_FIELD(symval, pci_device_id, subvendor);
479 	DEF_FIELD(symval, pci_device_id, subdevice);
480 	DEF_FIELD(symval, pci_device_id, class);
481 	DEF_FIELD(symval, pci_device_id, class_mask);
482 	DEF_FIELD(symval, pci_device_id, override_only);
483 
484 	switch (override_only) {
485 	case 0:
486 		strcpy(alias, "pci:");
487 		break;
488 	case PCI_ID_F_VFIO_DRIVER_OVERRIDE:
489 		strcpy(alias, "vfio_pci:");
490 		break;
491 	default:
492 		warn("Unknown PCI driver_override alias %08X\n",
493 		     override_only);
494 	}
495 
496 	ADD(alias, "v", vendor != PCI_ANY_ID, vendor);
497 	ADD(alias, "d", device != PCI_ANY_ID, device);
498 	ADD(alias, "sv", subvendor != PCI_ANY_ID, subvendor);
499 	ADD(alias, "sd", subdevice != PCI_ANY_ID, subdevice);
500 
501 	baseclass = (class) >> 16;
502 	baseclass_mask = (class_mask) >> 16;
503 	subclass = (class) >> 8;
504 	subclass_mask = (class_mask) >> 8;
505 	interface = class;
506 	interface_mask = class_mask;
507 
508 	if ((baseclass_mask != 0 && baseclass_mask != 0xFF)
509 	    || (subclass_mask != 0 && subclass_mask != 0xFF)
510 	    || (interface_mask != 0 && interface_mask != 0xFF)) {
511 		warn("Can't handle masks in %s:%04X\n",
512 		     mod->name, class_mask);
513 		return;
514 	}
515 
516 	ADD(alias, "bc", baseclass_mask == 0xFF, baseclass);
517 	ADD(alias, "sc", subclass_mask == 0xFF, subclass);
518 	ADD(alias, "i", interface_mask == 0xFF, interface);
519 
520 	module_alias_printf(mod, true, "%s", alias);
521 }
522 
523 /* looks like: "ccw:tNmNdtNdmN" */
524 static void do_ccw_entry(struct module *mod, void *symval)
525 {
526 	char alias[256] = {};
527 
528 	DEF_FIELD(symval, ccw_device_id, match_flags);
529 	DEF_FIELD(symval, ccw_device_id, cu_type);
530 	DEF_FIELD(symval, ccw_device_id, cu_model);
531 	DEF_FIELD(symval, ccw_device_id, dev_type);
532 	DEF_FIELD(symval, ccw_device_id, dev_model);
533 
534 	ADD(alias, "t", match_flags&CCW_DEVICE_ID_MATCH_CU_TYPE,
535 	    cu_type);
536 	ADD(alias, "m", match_flags&CCW_DEVICE_ID_MATCH_CU_MODEL,
537 	    cu_model);
538 	ADD(alias, "dt", match_flags&CCW_DEVICE_ID_MATCH_DEVICE_TYPE,
539 	    dev_type);
540 	ADD(alias, "dm", match_flags&CCW_DEVICE_ID_MATCH_DEVICE_MODEL,
541 	    dev_model);
542 
543 	module_alias_printf(mod, true, "ccw:%s", alias);
544 }
545 
546 /* looks like: "ap:tN" */
547 static void do_ap_entry(struct module *mod, void *symval)
548 {
549 	DEF_FIELD(symval, ap_device_id, dev_type);
550 
551 	module_alias_printf(mod, false, "ap:t%02X*", dev_type);
552 }
553 
554 /* looks like: "css:tN" */
555 static void do_css_entry(struct module *mod, void *symval)
556 {
557 	DEF_FIELD(symval, css_device_id, type);
558 
559 	module_alias_printf(mod, false, "css:t%01X", type);
560 }
561 
562 /* Looks like: "serio:tyNprNidNexN" */
563 static void do_serio_entry(struct module *mod, void *symval)
564 {
565 	char alias[256] = {};
566 
567 	DEF_FIELD(symval, serio_device_id, type);
568 	DEF_FIELD(symval, serio_device_id, proto);
569 	DEF_FIELD(symval, serio_device_id, id);
570 	DEF_FIELD(symval, serio_device_id, extra);
571 
572 	ADD(alias, "ty", type != SERIO_ANY, type);
573 	ADD(alias, "pr", proto != SERIO_ANY, proto);
574 	ADD(alias, "id", id != SERIO_ANY, id);
575 	ADD(alias, "ex", extra != SERIO_ANY, extra);
576 
577 	module_alias_printf(mod, true, "serio:%s", alias);
578 }
579 
580 /* looks like: "acpi:ACPI0003" or "acpi:PNP0C0B" or "acpi:LNXVIDEO" or
581  *             "acpi:bbsspp" (bb=base-class, ss=sub-class, pp=prog-if)
582  *
583  * NOTE: Each driver should use one of the following : _HID, _CIDs
584  *       or _CLS. Also, bb, ss, and pp can be substituted with ??
585  *       as don't care byte.
586  */
587 static void do_acpi_entry(struct module *mod, void *symval)
588 {
589 	DEF_FIELD_ADDR(symval, acpi_device_id, id);
590 	DEF_FIELD(symval, acpi_device_id, cls);
591 	DEF_FIELD(symval, acpi_device_id, cls_msk);
592 
593 	if ((*id)[0])
594 		module_alias_printf(mod, false, "acpi*:%s:*", *id);
595 	else {
596 		char alias[256];
597 		int i, byte_shift, cnt = 0;
598 		unsigned int msk;
599 
600 		for (i = 1; i <= 3; i++) {
601 			byte_shift = 8 * (3-i);
602 			msk = (cls_msk >> byte_shift) & 0xFF;
603 			if (msk)
604 				sprintf(&alias[cnt], "%02x",
605 					(cls >> byte_shift) & 0xFF);
606 			else
607 				sprintf(&alias[cnt], "??");
608 			cnt += 2;
609 		}
610 		module_alias_printf(mod, false, "acpi*:%s:*", alias);
611 	}
612 }
613 
614 /* looks like: "pnp:dD" */
615 static void do_pnp_device_entry(struct module *mod, void *symval)
616 {
617 	DEF_FIELD_ADDR(symval, pnp_device_id, id);
618 	char acpi_id[sizeof(*id)];
619 
620 	/* fix broken pnp bus lowercasing */
621 	for (unsigned int i = 0; i < sizeof(acpi_id); i++)
622 		acpi_id[i] = toupper((*id)[i]);
623 	module_alias_printf(mod, false, "pnp:d%s*", *id);
624 	module_alias_printf(mod, false, "acpi*:%s:*", acpi_id);
625 }
626 
627 /* looks like: "pnp:dD" for every device of the card */
628 static void do_pnp_card_entry(struct module *mod, void *symval)
629 {
630 	DEF_FIELD_ADDR(symval, pnp_card_device_id, devs);
631 
632 	for (unsigned int i = 0; i < PNP_MAX_DEVICES; i++) {
633 		const char *id = (char *)(*devs)[i].id;
634 		char acpi_id[PNP_ID_LEN];
635 
636 		if (!id[0])
637 			break;
638 
639 		/* fix broken pnp bus lowercasing */
640 		for (unsigned int j = 0; j < sizeof(acpi_id); j++)
641 			acpi_id[j] = toupper(id[j]);
642 
643 		/* add an individual alias for every device entry */
644 		module_alias_printf(mod, false, "pnp:d%s*", id);
645 		module_alias_printf(mod, false, "acpi*:%s:*", acpi_id);
646 	}
647 }
648 
649 /* Looks like: pcmcia:mNcNfNfnNpfnNvaNvbNvcNvdN. */
650 static void do_pcmcia_entry(struct module *mod, void *symval)
651 {
652 	char alias[256] = {};
653 	unsigned int i;
654 	DEF_FIELD(symval, pcmcia_device_id, match_flags);
655 	DEF_FIELD(symval, pcmcia_device_id, manf_id);
656 	DEF_FIELD(symval, pcmcia_device_id, card_id);
657 	DEF_FIELD(symval, pcmcia_device_id, func_id);
658 	DEF_FIELD(symval, pcmcia_device_id, function);
659 	DEF_FIELD(symval, pcmcia_device_id, device_no);
660 	DEF_FIELD_ADDR(symval, pcmcia_device_id, prod_id_hash);
661 
662 	for (i=0; i<4; i++) {
663 		(*prod_id_hash)[i] = TO_NATIVE((*prod_id_hash)[i]);
664 	}
665 
666 	ADD(alias, "m", match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID,
667 	    manf_id);
668 	ADD(alias, "c", match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID,
669 	    card_id);
670 	ADD(alias, "f", match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID,
671 	    func_id);
672 	ADD(alias, "fn", match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION,
673 	    function);
674 	ADD(alias, "pfn", match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO,
675 	    device_no);
676 	ADD(alias, "pa", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1, (*prod_id_hash)[0]);
677 	ADD(alias, "pb", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2, (*prod_id_hash)[1]);
678 	ADD(alias, "pc", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3, (*prod_id_hash)[2]);
679 	ADD(alias, "pd", match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4, (*prod_id_hash)[3]);
680 
681 	module_alias_printf(mod, true, "pcmcia:%s", alias);
682 }
683 
684 static void do_vio_entry(struct module *mod, void *symval)
685 {
686 	char alias[256];
687 	char *tmp;
688 	DEF_FIELD_ADDR(symval, vio_device_id, type);
689 	DEF_FIELD_ADDR(symval, vio_device_id, compat);
690 
691 	sprintf(alias, "vio:T%sS%s", (*type)[0] ? *type : "*",
692 			(*compat)[0] ? *compat : "*");
693 
694 	/* Replace all whitespace with underscores */
695 	for (tmp = alias; tmp && *tmp; tmp++)
696 		if (isspace (*tmp))
697 			*tmp = '_';
698 
699 	module_alias_printf(mod, true, "%s", alias);
700 }
701 
702 static void do_input(char *alias,
703 		     kernel_ulong_t *arr, unsigned int min, unsigned int max)
704 {
705 	unsigned int i;
706 
707 	for (i = min / BITS_PER_LONG; i < max / BITS_PER_LONG + 1; i++)
708 		arr[i] = TO_NATIVE(arr[i]);
709 	for (i = min; i < max; i++)
710 		if (arr[i / BITS_PER_LONG] & (1ULL << (i%BITS_PER_LONG)))
711 			sprintf(alias + strlen(alias), "%X,*", i);
712 }
713 
714 /* input:b0v0p0e0-eXkXrXaXmXlXsXfXwX where X is comma-separated %02X. */
715 static void do_input_entry(struct module *mod, void *symval)
716 {
717 	char alias[256] = {};
718 
719 	DEF_FIELD(symval, input_device_id, flags);
720 	DEF_FIELD(symval, input_device_id, bustype);
721 	DEF_FIELD(symval, input_device_id, vendor);
722 	DEF_FIELD(symval, input_device_id, product);
723 	DEF_FIELD(symval, input_device_id, version);
724 	DEF_FIELD_ADDR(symval, input_device_id, evbit);
725 	DEF_FIELD_ADDR(symval, input_device_id, keybit);
726 	DEF_FIELD_ADDR(symval, input_device_id, relbit);
727 	DEF_FIELD_ADDR(symval, input_device_id, absbit);
728 	DEF_FIELD_ADDR(symval, input_device_id, mscbit);
729 	DEF_FIELD_ADDR(symval, input_device_id, ledbit);
730 	DEF_FIELD_ADDR(symval, input_device_id, sndbit);
731 	DEF_FIELD_ADDR(symval, input_device_id, ffbit);
732 	DEF_FIELD_ADDR(symval, input_device_id, swbit);
733 
734 	ADD(alias, "b", flags & INPUT_DEVICE_ID_MATCH_BUS, bustype);
735 	ADD(alias, "v", flags & INPUT_DEVICE_ID_MATCH_VENDOR, vendor);
736 	ADD(alias, "p", flags & INPUT_DEVICE_ID_MATCH_PRODUCT, product);
737 	ADD(alias, "e", flags & INPUT_DEVICE_ID_MATCH_VERSION, version);
738 
739 	sprintf(alias + strlen(alias), "-e*");
740 	if (flags & INPUT_DEVICE_ID_MATCH_EVBIT)
741 		do_input(alias, *evbit, 0, INPUT_DEVICE_ID_EV_MAX);
742 	sprintf(alias + strlen(alias), "k*");
743 	if (flags & INPUT_DEVICE_ID_MATCH_KEYBIT)
744 		do_input(alias, *keybit,
745 			 INPUT_DEVICE_ID_KEY_MIN_INTERESTING,
746 			 INPUT_DEVICE_ID_KEY_MAX);
747 	sprintf(alias + strlen(alias), "r*");
748 	if (flags & INPUT_DEVICE_ID_MATCH_RELBIT)
749 		do_input(alias, *relbit, 0, INPUT_DEVICE_ID_REL_MAX);
750 	sprintf(alias + strlen(alias), "a*");
751 	if (flags & INPUT_DEVICE_ID_MATCH_ABSBIT)
752 		do_input(alias, *absbit, 0, INPUT_DEVICE_ID_ABS_MAX);
753 	sprintf(alias + strlen(alias), "m*");
754 	if (flags & INPUT_DEVICE_ID_MATCH_MSCIT)
755 		do_input(alias, *mscbit, 0, INPUT_DEVICE_ID_MSC_MAX);
756 	sprintf(alias + strlen(alias), "l*");
757 	if (flags & INPUT_DEVICE_ID_MATCH_LEDBIT)
758 		do_input(alias, *ledbit, 0, INPUT_DEVICE_ID_LED_MAX);
759 	sprintf(alias + strlen(alias), "s*");
760 	if (flags & INPUT_DEVICE_ID_MATCH_SNDBIT)
761 		do_input(alias, *sndbit, 0, INPUT_DEVICE_ID_SND_MAX);
762 	sprintf(alias + strlen(alias), "f*");
763 	if (flags & INPUT_DEVICE_ID_MATCH_FFBIT)
764 		do_input(alias, *ffbit, 0, INPUT_DEVICE_ID_FF_MAX);
765 	sprintf(alias + strlen(alias), "w*");
766 	if (flags & INPUT_DEVICE_ID_MATCH_SWBIT)
767 		do_input(alias, *swbit, 0, INPUT_DEVICE_ID_SW_MAX);
768 
769 	module_alias_printf(mod, false, "input:%s", alias);
770 }
771 
772 static void do_eisa_entry(struct module *mod, void *symval)
773 {
774 	DEF_FIELD_ADDR(symval, eisa_device_id, sig);
775 	module_alias_printf(mod, false, EISA_DEVICE_MODALIAS_FMT "*", *sig);
776 }
777 
778 /* Looks like: parisc:tNhvNrevNsvN */
779 static void do_parisc_entry(struct module *mod, void *symval)
780 {
781 	char alias[256] = {};
782 
783 	DEF_FIELD(symval, parisc_device_id, hw_type);
784 	DEF_FIELD(symval, parisc_device_id, hversion);
785 	DEF_FIELD(symval, parisc_device_id, hversion_rev);
786 	DEF_FIELD(symval, parisc_device_id, sversion);
787 
788 	ADD(alias, "t", hw_type != PA_HWTYPE_ANY_ID, hw_type);
789 	ADD(alias, "hv", hversion != PA_HVERSION_ANY_ID, hversion);
790 	ADD(alias, "rev", hversion_rev != PA_HVERSION_REV_ANY_ID, hversion_rev);
791 	ADD(alias, "sv", sversion != PA_SVERSION_ANY_ID, sversion);
792 
793 	module_alias_printf(mod, true, "parisc:%s", alias);
794 }
795 
796 /* Looks like: sdio:cNvNdN. */
797 static void do_sdio_entry(struct module *mod, void *symval)
798 {
799 	char alias[256] = {};
800 
801 	DEF_FIELD(symval, sdio_device_id, class);
802 	DEF_FIELD(symval, sdio_device_id, vendor);
803 	DEF_FIELD(symval, sdio_device_id, device);
804 
805 	ADD(alias, "c", class != (__u8)SDIO_ANY_ID, class);
806 	ADD(alias, "v", vendor != (__u16)SDIO_ANY_ID, vendor);
807 	ADD(alias, "d", device != (__u16)SDIO_ANY_ID, device);
808 
809 	module_alias_printf(mod, true, "sdio:%s", alias);
810 }
811 
812 /* Looks like: ssb:vNidNrevN. */
813 static void do_ssb_entry(struct module *mod, void *symval)
814 {
815 	char alias[256] = {};
816 
817 	DEF_FIELD(symval, ssb_device_id, vendor);
818 	DEF_FIELD(symval, ssb_device_id, coreid);
819 	DEF_FIELD(symval, ssb_device_id, revision);
820 
821 	ADD(alias, "v", vendor != SSB_ANY_VENDOR, vendor);
822 	ADD(alias, "id", coreid != SSB_ANY_ID, coreid);
823 	ADD(alias, "rev", revision != SSB_ANY_REV, revision);
824 
825 	module_alias_printf(mod, true, "ssb:%s", alias);
826 }
827 
828 /* Looks like: bcma:mNidNrevNclN. */
829 static void do_bcma_entry(struct module *mod, void *symval)
830 {
831 	char alias[256] = {};
832 
833 	DEF_FIELD(symval, bcma_device_id, manuf);
834 	DEF_FIELD(symval, bcma_device_id, id);
835 	DEF_FIELD(symval, bcma_device_id, rev);
836 	DEF_FIELD(symval, bcma_device_id, class);
837 
838 	ADD(alias, "m", manuf != BCMA_ANY_MANUF, manuf);
839 	ADD(alias, "id", id != BCMA_ANY_ID, id);
840 	ADD(alias, "rev", rev != BCMA_ANY_REV, rev);
841 	ADD(alias, "cl", class != BCMA_ANY_CLASS, class);
842 
843 	module_alias_printf(mod, true, "bcma:%s", alias);
844 }
845 
846 /* Looks like: virtio:dNvN */
847 static void do_virtio_entry(struct module *mod, void *symval)
848 {
849 	char alias[256] = {};
850 
851 	DEF_FIELD(symval, virtio_device_id, device);
852 	DEF_FIELD(symval, virtio_device_id, vendor);
853 
854 	ADD(alias, "d", device != VIRTIO_DEV_ANY_ID, device);
855 	ADD(alias, "v", vendor != VIRTIO_DEV_ANY_ID, vendor);
856 
857 	module_alias_printf(mod, true, "virtio:%s", alias);
858 }
859 
860 /*
861  * Looks like: vmbus:guid
862  * Each byte of the guid will be represented by two hex characters
863  * in the name.
864  */
865 
866 static void do_vmbus_entry(struct module *mod, void *symval)
867 {
868 	int i;
869 	DEF_FIELD_ADDR(symval, hv_vmbus_device_id, guid);
870 	char guid_name[(sizeof(*guid) + 1) * 2];
871 
872 	for (i = 0; i < (sizeof(*guid) * 2); i += 2)
873 		sprintf(&guid_name[i], "%02x", TO_NATIVE((guid->b)[i/2]));
874 
875 	module_alias_printf(mod, false, "vmbus:%s", guid_name);
876 }
877 
878 /* Looks like: rpmsg:S */
879 static void do_rpmsg_entry(struct module *mod, void *symval)
880 {
881 	DEF_FIELD_ADDR(symval, rpmsg_device_id, name);
882 
883 	module_alias_printf(mod, false, RPMSG_DEVICE_MODALIAS_FMT, *name);
884 }
885 
886 /* Looks like: i2c:S */
887 static void do_i2c_entry(struct module *mod, void *symval)
888 {
889 	DEF_FIELD_ADDR(symval, i2c_device_id, name);
890 
891 	module_alias_printf(mod, false, I2C_MODULE_PREFIX "%s", *name);
892 }
893 
894 static void do_i3c_entry(struct module *mod, void *symval)
895 {
896 	char alias[256] = {};
897 
898 	DEF_FIELD(symval, i3c_device_id, match_flags);
899 	DEF_FIELD(symval, i3c_device_id, dcr);
900 	DEF_FIELD(symval, i3c_device_id, manuf_id);
901 	DEF_FIELD(symval, i3c_device_id, part_id);
902 	DEF_FIELD(symval, i3c_device_id, extra_info);
903 
904 	ADD(alias, "dcr", match_flags & I3C_MATCH_DCR, dcr);
905 	ADD(alias, "manuf", match_flags & I3C_MATCH_MANUF, manuf_id);
906 	ADD(alias, "part", match_flags & I3C_MATCH_PART, part_id);
907 	ADD(alias, "ext", match_flags & I3C_MATCH_EXTRA_INFO, extra_info);
908 
909 	module_alias_printf(mod, false, "i3c:%s", alias);
910 }
911 
912 static void do_slim_entry(struct module *mod, void *symval)
913 {
914 	DEF_FIELD(symval, slim_device_id, manf_id);
915 	DEF_FIELD(symval, slim_device_id, prod_code);
916 
917 	module_alias_printf(mod, false, "slim:%x:%x:*", manf_id, prod_code);
918 }
919 
920 /* Looks like: spi:S */
921 static void do_spi_entry(struct module *mod, void *symval)
922 {
923 	DEF_FIELD_ADDR(symval, spi_device_id, name);
924 
925 	module_alias_printf(mod, false, SPI_MODULE_PREFIX "%s", *name);
926 }
927 
928 static const struct dmifield {
929 	const char *prefix;
930 	int field;
931 } dmi_fields[] = {
932 	{ "bvn", DMI_BIOS_VENDOR },
933 	{ "bvr", DMI_BIOS_VERSION },
934 	{ "bd",  DMI_BIOS_DATE },
935 	{ "br",  DMI_BIOS_RELEASE },
936 	{ "efr", DMI_EC_FIRMWARE_RELEASE },
937 	{ "svn", DMI_SYS_VENDOR },
938 	{ "pn",  DMI_PRODUCT_NAME },
939 	{ "pvr", DMI_PRODUCT_VERSION },
940 	{ "rvn", DMI_BOARD_VENDOR },
941 	{ "rn",  DMI_BOARD_NAME },
942 	{ "rvr", DMI_BOARD_VERSION },
943 	{ "cvn", DMI_CHASSIS_VENDOR },
944 	{ "ct",  DMI_CHASSIS_TYPE },
945 	{ "cvr", DMI_CHASSIS_VERSION },
946 	{ NULL,  DMI_NONE }
947 };
948 
949 static void dmi_ascii_filter(char *d, const char *s)
950 {
951 	/* Filter out characters we don't want to see in the modalias string */
952 	for (; *s; s++)
953 		if (*s > ' ' && *s < 127 && *s != ':')
954 			*(d++) = *s;
955 
956 	*d = 0;
957 }
958 
959 
960 static void do_dmi_entry(struct module *mod, void *symval)
961 {
962 	char alias[256] = {};
963 	int i, j;
964 	DEF_FIELD_ADDR(symval, dmi_system_id, matches);
965 
966 	for (i = 0; i < ARRAY_SIZE(dmi_fields); i++) {
967 		for (j = 0; j < 4; j++) {
968 			if ((*matches)[j].slot &&
969 			    (*matches)[j].slot == dmi_fields[i].field) {
970 				sprintf(alias + strlen(alias), ":%s*",
971 					dmi_fields[i].prefix);
972 				dmi_ascii_filter(alias + strlen(alias),
973 						 (*matches)[j].substr);
974 				strcat(alias, "*");
975 			}
976 		}
977 	}
978 
979 	module_alias_printf(mod, false, "dmi*%s:", alias);
980 }
981 
982 static void do_platform_entry(struct module *mod, void *symval)
983 {
984 	DEF_FIELD_ADDR(symval, platform_device_id, name);
985 
986 	module_alias_printf(mod, false, PLATFORM_MODULE_PREFIX "%s", *name);
987 }
988 
989 static void do_mdio_entry(struct module *mod, void *symval)
990 {
991 	char id[33];
992 	int i;
993 	DEF_FIELD(symval, mdio_device_id, phy_id);
994 	DEF_FIELD(symval, mdio_device_id, phy_id_mask);
995 
996 	for (i = 0; i < 32; i++) {
997 		if (!((phy_id_mask >> (31-i)) & 1))
998 			id[i] = '?';
999 		else if ((phy_id >> (31-i)) & 1)
1000 			id[i] = '1';
1001 		else
1002 			id[i] = '0';
1003 	}
1004 
1005 	/* Terminate the string */
1006 	id[32] = '\0';
1007 
1008 	module_alias_printf(mod, false, MDIO_MODULE_PREFIX "%s", id);
1009 }
1010 
1011 /* Looks like: zorro:iN. */
1012 static void do_zorro_entry(struct module *mod, void *symval)
1013 {
1014 	char alias[256] = {};
1015 	DEF_FIELD(symval, zorro_device_id, id);
1016 
1017 	ADD(alias, "i", id != ZORRO_WILDCARD, id);
1018 
1019 	module_alias_printf(mod, false, "zorro:%s", alias);
1020 }
1021 
1022 /* looks like: "pnp:dD" */
1023 static void do_isapnp_entry(struct module *mod, void *symval)
1024 {
1025 	DEF_FIELD(symval, isapnp_device_id, vendor);
1026 	DEF_FIELD(symval, isapnp_device_id, function);
1027 	module_alias_printf(mod, false, "pnp:d%c%c%c%x%x%x%x*",
1028 		'A' + ((vendor >> 2) & 0x3f) - 1,
1029 		'A' + (((vendor & 3) << 3) | ((vendor >> 13) & 7)) - 1,
1030 		'A' + ((vendor >> 8) & 0x1f) - 1,
1031 		(function >> 4) & 0x0f, function & 0x0f,
1032 		(function >> 12) & 0x0f, (function >> 8) & 0x0f);
1033 }
1034 
1035 /* Looks like: "ipack:fNvNdN". */
1036 static void do_ipack_entry(struct module *mod, void *symval)
1037 {
1038 	char alias[256] = {};
1039 	DEF_FIELD(symval, ipack_device_id, format);
1040 	DEF_FIELD(symval, ipack_device_id, vendor);
1041 	DEF_FIELD(symval, ipack_device_id, device);
1042 
1043 	ADD(alias, "f", format != IPACK_ANY_FORMAT, format);
1044 	ADD(alias, "v", vendor != IPACK_ANY_ID, vendor);
1045 	ADD(alias, "d", device != IPACK_ANY_ID, device);
1046 
1047 	module_alias_printf(mod, true, "ipack:%s", alias);
1048 }
1049 
1050 /*
1051  * Append a match expression for a single masked hex digit.
1052  * outp points to a pointer to the character at which to append.
1053  *	*outp is updated on return to point just after the appended text,
1054  *	to facilitate further appending.
1055  */
1056 static void append_nibble_mask(char **outp,
1057 			       unsigned int nibble, unsigned int mask)
1058 {
1059 	char *p = *outp;
1060 	unsigned int i;
1061 
1062 	switch (mask) {
1063 	case 0:
1064 		*p++ = '?';
1065 		break;
1066 
1067 	case 0xf:
1068 		p += sprintf(p, "%X",  nibble);
1069 		break;
1070 
1071 	default:
1072 		/*
1073 		 * Dumbly emit a match pattern for all possible matching
1074 		 * digits.  This could be improved in some cases using ranges,
1075 		 * but it has the advantage of being trivially correct, and is
1076 		 * often optimal.
1077 		 */
1078 		*p++ = '[';
1079 		for (i = 0; i < 0x10; i++)
1080 			if ((i & mask) == nibble)
1081 				p += sprintf(p, "%X", i);
1082 		*p++ = ']';
1083 	}
1084 
1085 	/* Ensure that the string remains NUL-terminated: */
1086 	*p = '\0';
1087 
1088 	/* Advance the caller's end-of-string pointer: */
1089 	*outp = p;
1090 }
1091 
1092 /*
1093  * looks like: "amba:dN"
1094  *
1095  * N is exactly 8 digits, where each is an upper-case hex digit, or
1096  *	a ? or [] pattern matching exactly one digit.
1097  */
1098 static void do_amba_entry(struct module *mod, void *symval)
1099 {
1100 	char alias[256];
1101 	unsigned int digit;
1102 	char *p = alias;
1103 	DEF_FIELD(symval, amba_id, id);
1104 	DEF_FIELD(symval, amba_id, mask);
1105 
1106 	if ((id & mask) != id)
1107 		fatal("%s: Masked-off bit(s) of AMBA device ID are non-zero: id=0x%08X, mask=0x%08X.  Please fix this driver.\n",
1108 		      mod->name, id, mask);
1109 
1110 	for (digit = 0; digit < 8; digit++)
1111 		append_nibble_mask(&p,
1112 				   (id >> (4 * (7 - digit))) & 0xf,
1113 				   (mask >> (4 * (7 - digit))) & 0xf);
1114 
1115 	module_alias_printf(mod, false, "amba:d%s", alias);
1116 }
1117 
1118 /*
1119  * looks like: "mipscdmm:tN"
1120  *
1121  * N is exactly 2 digits, where each is an upper-case hex digit, or
1122  *	a ? or [] pattern matching exactly one digit.
1123  */
1124 static void do_mips_cdmm_entry(struct module *mod, void *symval)
1125 {
1126 	DEF_FIELD(symval, mips_cdmm_device_id, type);
1127 
1128 	module_alias_printf(mod, false, "mipscdmm:t%02X*", type);
1129 }
1130 
1131 /* LOOKS like cpu:type:x86,venVVVVfamFFFFmodMMMM:feature:*,FEAT,*
1132  * All fields are numbers. It would be nicer to use strings for vendor
1133  * and feature, but getting those out of the build system here is too
1134  * complicated.
1135  */
1136 
1137 static void do_x86cpu_entry(struct module *mod, void *symval)
1138 {
1139 	char alias[256] = {};
1140 
1141 	DEF_FIELD(symval, x86_cpu_id, feature);
1142 	DEF_FIELD(symval, x86_cpu_id, family);
1143 	DEF_FIELD(symval, x86_cpu_id, model);
1144 	DEF_FIELD(symval, x86_cpu_id, vendor);
1145 
1146 	ADD(alias, "ven", vendor != X86_VENDOR_ANY, vendor);
1147 	ADD(alias, "fam", family != X86_FAMILY_ANY, family);
1148 	ADD(alias, "mod", model  != X86_MODEL_ANY,  model);
1149 	strcat(alias, ":feature:*");
1150 	if (feature != X86_FEATURE_ANY)
1151 		sprintf(alias + strlen(alias), "%04X*", feature);
1152 
1153 	module_alias_printf(mod, false, "cpu:type:x86,%s", alias);
1154 }
1155 
1156 /* LOOKS like cpu:type:*:feature:*FEAT* */
1157 static void do_cpu_entry(struct module *mod, void *symval)
1158 {
1159 	DEF_FIELD(symval, cpu_feature, feature);
1160 
1161 	module_alias_printf(mod, false, "cpu:type:*:feature:*%04X*", feature);
1162 }
1163 
1164 /* Looks like: mei:S:uuid:N:* */
1165 static void do_mei_entry(struct module *mod, void *symval)
1166 {
1167 	char alias[256] = {};
1168 
1169 	DEF_FIELD_ADDR(symval, mei_cl_device_id, name);
1170 	DEF_FIELD_ADDR(symval, mei_cl_device_id, uuid);
1171 	DEF_FIELD(symval, mei_cl_device_id, version);
1172 
1173 	add_uuid(alias, *uuid);
1174 	ADD(alias, ":", version != MEI_CL_VERSION_ANY, version);
1175 
1176 	module_alias_printf(mod, false, MEI_CL_MODULE_PREFIX "%s:%s:*",
1177 			    (*name)[0] ? *name : "*", alias);
1178 }
1179 
1180 /* Looks like: rapidio:vNdNavNadN */
1181 static void do_rio_entry(struct module *mod, void *symval)
1182 {
1183 	char alias[256] = {};
1184 
1185 	DEF_FIELD(symval, rio_device_id, did);
1186 	DEF_FIELD(symval, rio_device_id, vid);
1187 	DEF_FIELD(symval, rio_device_id, asm_did);
1188 	DEF_FIELD(symval, rio_device_id, asm_vid);
1189 
1190 	ADD(alias, "v", vid != RIO_ANY_ID, vid);
1191 	ADD(alias, "d", did != RIO_ANY_ID, did);
1192 	ADD(alias, "av", asm_vid != RIO_ANY_ID, asm_vid);
1193 	ADD(alias, "ad", asm_did != RIO_ANY_ID, asm_did);
1194 
1195 	module_alias_printf(mod, true, "rapidio:%s", alias);
1196 }
1197 
1198 /* Looks like: ulpi:vNpN */
1199 static void do_ulpi_entry(struct module *mod, void *symval)
1200 {
1201 	DEF_FIELD(symval, ulpi_device_id, vendor);
1202 	DEF_FIELD(symval, ulpi_device_id, product);
1203 
1204 	module_alias_printf(mod, false, "ulpi:v%04xp%04x", vendor, product);
1205 }
1206 
1207 /* Looks like: hdaudio:vNrNaN */
1208 static void do_hda_entry(struct module *mod, void *symval)
1209 {
1210 	char alias[256] = {};
1211 
1212 	DEF_FIELD(symval, hda_device_id, vendor_id);
1213 	DEF_FIELD(symval, hda_device_id, rev_id);
1214 	DEF_FIELD(symval, hda_device_id, api_version);
1215 
1216 	ADD(alias, "v", vendor_id != 0, vendor_id);
1217 	ADD(alias, "r", rev_id != 0, rev_id);
1218 	ADD(alias, "a", api_version != 0, api_version);
1219 
1220 	module_alias_printf(mod, true, "hdaudio:%s", alias);
1221 }
1222 
1223 /* Looks like: sdw:mNpNvNcN */
1224 static void do_sdw_entry(struct module *mod, void *symval)
1225 {
1226 	char alias[256] = {};
1227 
1228 	DEF_FIELD(symval, sdw_device_id, mfg_id);
1229 	DEF_FIELD(symval, sdw_device_id, part_id);
1230 	DEF_FIELD(symval, sdw_device_id, sdw_version);
1231 	DEF_FIELD(symval, sdw_device_id, class_id);
1232 
1233 	ADD(alias, "m", mfg_id != 0, mfg_id);
1234 	ADD(alias, "p", part_id != 0, part_id);
1235 	ADD(alias, "v", sdw_version != 0, sdw_version);
1236 	ADD(alias, "c", class_id != 0, class_id);
1237 
1238 	module_alias_printf(mod, true, "sdw:%s", alias);
1239 }
1240 
1241 /* Looks like: fsl-mc:vNdN */
1242 static void do_fsl_mc_entry(struct module *mod, void *symval)
1243 {
1244 	DEF_FIELD(symval, fsl_mc_device_id, vendor);
1245 	DEF_FIELD_ADDR(symval, fsl_mc_device_id, obj_type);
1246 
1247 	module_alias_printf(mod, false, "fsl-mc:v%08Xd%s", vendor, *obj_type);
1248 }
1249 
1250 /* Looks like: tbsvc:kSpNvNrN */
1251 static void do_tbsvc_entry(struct module *mod, void *symval)
1252 {
1253 	char alias[256] = {};
1254 
1255 	DEF_FIELD(symval, tb_service_id, match_flags);
1256 	DEF_FIELD_ADDR(symval, tb_service_id, protocol_key);
1257 	DEF_FIELD(symval, tb_service_id, protocol_id);
1258 	DEF_FIELD(symval, tb_service_id, protocol_version);
1259 	DEF_FIELD(symval, tb_service_id, protocol_revision);
1260 
1261 	if (match_flags & TBSVC_MATCH_PROTOCOL_KEY)
1262 		sprintf(alias + strlen(alias), "k%s", *protocol_key);
1263 	else
1264 		strcat(alias + strlen(alias), "k*");
1265 	ADD(alias, "p", match_flags & TBSVC_MATCH_PROTOCOL_ID, protocol_id);
1266 	ADD(alias, "v", match_flags & TBSVC_MATCH_PROTOCOL_VERSION,
1267 	    protocol_version);
1268 	ADD(alias, "r", match_flags & TBSVC_MATCH_PROTOCOL_REVISION,
1269 	    protocol_revision);
1270 
1271 	module_alias_printf(mod, true, "tbsvc:%s", alias);
1272 }
1273 
1274 /* Looks like: typec:idNmN */
1275 static void do_typec_entry(struct module *mod, void *symval)
1276 {
1277 	char alias[256] = {};
1278 
1279 	DEF_FIELD(symval, typec_device_id, svid);
1280 	DEF_FIELD(symval, typec_device_id, mode);
1281 
1282 	ADD(alias, "m", mode != TYPEC_ANY_MODE, mode);
1283 
1284 	module_alias_printf(mod, false, "typec:id%04X%s", svid, alias);
1285 }
1286 
1287 /* Looks like: tee:uuid */
1288 static void do_tee_entry(struct module *mod, void *symval)
1289 {
1290 	DEF_FIELD_ADDR(symval, tee_client_device_id, uuid);
1291 
1292 	module_alias_printf(mod, true,
1293 			    "tee:%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1294 		uuid->b[0], uuid->b[1], uuid->b[2], uuid->b[3], uuid->b[4],
1295 		uuid->b[5], uuid->b[6], uuid->b[7], uuid->b[8], uuid->b[9],
1296 		uuid->b[10], uuid->b[11], uuid->b[12], uuid->b[13], uuid->b[14],
1297 		uuid->b[15]);
1298 }
1299 
1300 /* Looks like: wmi:guid */
1301 static void do_wmi_entry(struct module *mod, void *symval)
1302 {
1303 	DEF_FIELD_ADDR(symval, wmi_device_id, guid_string);
1304 
1305 	if (strlen(*guid_string) != UUID_STRING_LEN) {
1306 		warn("Invalid WMI device id 'wmi:%s' in '%s'\n",
1307 				*guid_string, mod->name);
1308 		return;
1309 	}
1310 
1311 	module_alias_printf(mod, false, WMI_MODULE_PREFIX "%s", *guid_string);
1312 }
1313 
1314 /* Looks like: mhi:S */
1315 static void do_mhi_entry(struct module *mod, void *symval)
1316 {
1317 	DEF_FIELD_ADDR(symval, mhi_device_id, chan);
1318 	module_alias_printf(mod, false, MHI_DEVICE_MODALIAS_FMT, *chan);
1319 }
1320 
1321 /* Looks like: mhi_ep:S */
1322 static void do_mhi_ep_entry(struct module *mod, void *symval)
1323 {
1324 	DEF_FIELD_ADDR(symval, mhi_device_id, chan);
1325 
1326 	module_alias_printf(mod, false, MHI_EP_DEVICE_MODALIAS_FMT, *chan);
1327 }
1328 
1329 /* Looks like: ishtp:{guid} */
1330 static void do_ishtp_entry(struct module *mod, void *symval)
1331 {
1332 	char alias[256] = {};
1333 	DEF_FIELD_ADDR(symval, ishtp_device_id, guid);
1334 
1335 	add_guid(alias, *guid);
1336 
1337 	module_alias_printf(mod, false, ISHTP_MODULE_PREFIX "{%s}", alias);
1338 }
1339 
1340 static void do_auxiliary_entry(struct module *mod, void *symval)
1341 {
1342 	DEF_FIELD_ADDR(symval, auxiliary_device_id, name);
1343 
1344 	module_alias_printf(mod, false, AUXILIARY_MODULE_PREFIX "%s", *name);
1345 }
1346 
1347 /*
1348  * Looks like: ssam:dNcNtNiNfN
1349  *
1350  * N is exactly 2 digits, where each is an upper-case hex digit.
1351  */
1352 static void do_ssam_entry(struct module *mod, void *symval)
1353 {
1354 	char alias[256] = {};
1355 
1356 	DEF_FIELD(symval, ssam_device_id, match_flags);
1357 	DEF_FIELD(symval, ssam_device_id, domain);
1358 	DEF_FIELD(symval, ssam_device_id, category);
1359 	DEF_FIELD(symval, ssam_device_id, target);
1360 	DEF_FIELD(symval, ssam_device_id, instance);
1361 	DEF_FIELD(symval, ssam_device_id, function);
1362 
1363 	ADD(alias, "t", match_flags & SSAM_MATCH_TARGET, target);
1364 	ADD(alias, "i", match_flags & SSAM_MATCH_INSTANCE, instance);
1365 	ADD(alias, "f", match_flags & SSAM_MATCH_FUNCTION, function);
1366 
1367 	module_alias_printf(mod, false, "ssam:d%02Xc%02X%s",
1368 			    domain, category, alias);
1369 }
1370 
1371 /* Looks like: dfl:tNfN */
1372 static void do_dfl_entry(struct module *mod, void *symval)
1373 {
1374 	DEF_FIELD(symval, dfl_device_id, type);
1375 	DEF_FIELD(symval, dfl_device_id, feature_id);
1376 
1377 	module_alias_printf(mod, true, "dfl:t%04Xf%04X", type, feature_id);
1378 }
1379 
1380 /* Looks like: cdx:vNdN */
1381 static void do_cdx_entry(struct module *mod, void *symval)
1382 {
1383 	char alias[256];
1384 
1385 	DEF_FIELD(symval, cdx_device_id, vendor);
1386 	DEF_FIELD(symval, cdx_device_id, device);
1387 	DEF_FIELD(symval, cdx_device_id, subvendor);
1388 	DEF_FIELD(symval, cdx_device_id, subdevice);
1389 	DEF_FIELD(symval, cdx_device_id, class);
1390 	DEF_FIELD(symval, cdx_device_id, class_mask);
1391 	DEF_FIELD(symval, cdx_device_id, override_only);
1392 
1393 	switch (override_only) {
1394 	case 0:
1395 		strcpy(alias, "cdx:");
1396 		break;
1397 	case CDX_ID_F_VFIO_DRIVER_OVERRIDE:
1398 		strcpy(alias, "vfio_cdx:");
1399 		break;
1400 	default:
1401 		warn("Unknown CDX driver_override alias %08X\n",
1402 		     override_only);
1403 		return;
1404 	}
1405 
1406 	ADD(alias, "v", vendor != CDX_ANY_ID, vendor);
1407 	ADD(alias, "d", device != CDX_ANY_ID, device);
1408 	ADD(alias, "sv", subvendor != CDX_ANY_ID, subvendor);
1409 	ADD(alias, "sd", subdevice != CDX_ANY_ID, subdevice);
1410 	ADD(alias, "c", class_mask == 0xFFFFFF, class);
1411 
1412 	module_alias_printf(mod, false, "%s", alias);
1413 }
1414 
1415 static void do_vchiq_entry(struct module *mod, void *symval)
1416 {
1417 	DEF_FIELD_ADDR(symval, vchiq_device_id, name);
1418 
1419 	module_alias_printf(mod, false, "vchiq:%s", *name);
1420 }
1421 
1422 /* Looks like: coreboot:tN */
1423 static void do_coreboot_entry(struct module *mod, void *symval)
1424 {
1425 	DEF_FIELD(symval, coreboot_device_id, tag);
1426 
1427 	module_alias_printf(mod, false, "coreboot:t%08X", tag);
1428 }
1429 
1430 /* Does namelen bytes of name exactly match the symbol? */
1431 static bool sym_is(const char *name, unsigned namelen, const char *symbol)
1432 {
1433 	if (namelen != strlen(symbol))
1434 		return false;
1435 
1436 	return memcmp(name, symbol, namelen) == 0;
1437 }
1438 
1439 static void do_table(void *symval, unsigned long size,
1440 		     unsigned long id_size,
1441 		     const char *device_id,
1442 		     void (*do_entry)(struct module *mod, void *symval),
1443 		     struct module *mod)
1444 {
1445 	unsigned int i;
1446 
1447 	device_id_check(mod->name, device_id, size, id_size, symval);
1448 	/* Leave last one: it's the terminator. */
1449 	size -= id_size;
1450 
1451 	for (i = 0; i < size; i += id_size)
1452 		do_entry(mod, symval + i);
1453 }
1454 
1455 static const struct devtable devtable[] = {
1456 	{"hid", SIZE_hid_device_id, do_hid_entry},
1457 	{"ieee1394", SIZE_ieee1394_device_id, do_ieee1394_entry},
1458 	{"pci", SIZE_pci_device_id, do_pci_entry},
1459 	{"ccw", SIZE_ccw_device_id, do_ccw_entry},
1460 	{"ap", SIZE_ap_device_id, do_ap_entry},
1461 	{"css", SIZE_css_device_id, do_css_entry},
1462 	{"serio", SIZE_serio_device_id, do_serio_entry},
1463 	{"acpi", SIZE_acpi_device_id, do_acpi_entry},
1464 	{"pcmcia", SIZE_pcmcia_device_id, do_pcmcia_entry},
1465 	{"vio", SIZE_vio_device_id, do_vio_entry},
1466 	{"input", SIZE_input_device_id, do_input_entry},
1467 	{"eisa", SIZE_eisa_device_id, do_eisa_entry},
1468 	{"parisc", SIZE_parisc_device_id, do_parisc_entry},
1469 	{"sdio", SIZE_sdio_device_id, do_sdio_entry},
1470 	{"ssb", SIZE_ssb_device_id, do_ssb_entry},
1471 	{"bcma", SIZE_bcma_device_id, do_bcma_entry},
1472 	{"virtio", SIZE_virtio_device_id, do_virtio_entry},
1473 	{"vmbus", SIZE_hv_vmbus_device_id, do_vmbus_entry},
1474 	{"rpmsg", SIZE_rpmsg_device_id, do_rpmsg_entry},
1475 	{"i2c", SIZE_i2c_device_id, do_i2c_entry},
1476 	{"i3c", SIZE_i3c_device_id, do_i3c_entry},
1477 	{"slim", SIZE_slim_device_id, do_slim_entry},
1478 	{"spi", SIZE_spi_device_id, do_spi_entry},
1479 	{"dmi", SIZE_dmi_system_id, do_dmi_entry},
1480 	{"platform", SIZE_platform_device_id, do_platform_entry},
1481 	{"mdio", SIZE_mdio_device_id, do_mdio_entry},
1482 	{"zorro", SIZE_zorro_device_id, do_zorro_entry},
1483 	{"isapnp", SIZE_isapnp_device_id, do_isapnp_entry},
1484 	{"ipack", SIZE_ipack_device_id, do_ipack_entry},
1485 	{"amba", SIZE_amba_id, do_amba_entry},
1486 	{"mipscdmm", SIZE_mips_cdmm_device_id, do_mips_cdmm_entry},
1487 	{"x86cpu", SIZE_x86_cpu_id, do_x86cpu_entry},
1488 	{"cpu", SIZE_cpu_feature, do_cpu_entry},
1489 	{"mei", SIZE_mei_cl_device_id, do_mei_entry},
1490 	{"rapidio", SIZE_rio_device_id, do_rio_entry},
1491 	{"ulpi", SIZE_ulpi_device_id, do_ulpi_entry},
1492 	{"hdaudio", SIZE_hda_device_id, do_hda_entry},
1493 	{"sdw", SIZE_sdw_device_id, do_sdw_entry},
1494 	{"fslmc", SIZE_fsl_mc_device_id, do_fsl_mc_entry},
1495 	{"tbsvc", SIZE_tb_service_id, do_tbsvc_entry},
1496 	{"typec", SIZE_typec_device_id, do_typec_entry},
1497 	{"tee", SIZE_tee_client_device_id, do_tee_entry},
1498 	{"wmi", SIZE_wmi_device_id, do_wmi_entry},
1499 	{"mhi", SIZE_mhi_device_id, do_mhi_entry},
1500 	{"mhi_ep", SIZE_mhi_device_id, do_mhi_ep_entry},
1501 	{"auxiliary", SIZE_auxiliary_device_id, do_auxiliary_entry},
1502 	{"ssam", SIZE_ssam_device_id, do_ssam_entry},
1503 	{"dfl", SIZE_dfl_device_id, do_dfl_entry},
1504 	{"ishtp", SIZE_ishtp_device_id, do_ishtp_entry},
1505 	{"cdx", SIZE_cdx_device_id, do_cdx_entry},
1506 	{"vchiq", SIZE_vchiq_device_id, do_vchiq_entry},
1507 	{"coreboot", SIZE_coreboot_device_id, do_coreboot_entry},
1508 	{"of", SIZE_of_device_id, do_of_entry},
1509 	{"pnp", SIZE_pnp_device_id, do_pnp_device_entry},
1510 	{"pnp_card", SIZE_pnp_card_device_id, do_pnp_card_entry},
1511 };
1512 
1513 /* Create MODULE_ALIAS() statements.
1514  * At this time, we cannot write the actual output C source yet,
1515  * so we write into the mod->dev_table_buf buffer. */
1516 void handle_moddevtable(struct module *mod, struct elf_info *info,
1517 			Elf_Sym *sym, const char *symname)
1518 {
1519 	void *symval;
1520 	char *zeros = NULL;
1521 	const char *name, *identifier;
1522 	unsigned int namelen;
1523 
1524 	/* We're looking for a section relative symbol */
1525 	if (!sym->st_shndx || get_secindex(info, sym) >= info->num_sections)
1526 		return;
1527 
1528 	/* We're looking for an object */
1529 	if (ELF_ST_TYPE(sym->st_info) != STT_OBJECT)
1530 		return;
1531 
1532 	/* All our symbols are of form __mod_<name>__<identifier>_device_table. */
1533 	if (strncmp(symname, "__mod_", strlen("__mod_")))
1534 		return;
1535 	name = symname + strlen("__mod_");
1536 	namelen = strlen(name);
1537 	if (namelen < strlen("_device_table"))
1538 		return;
1539 	if (strcmp(name + namelen - strlen("_device_table"), "_device_table"))
1540 		return;
1541 	identifier = strstr(name, "__");
1542 	if (!identifier)
1543 		return;
1544 	namelen = identifier - name;
1545 
1546 	/* Handle all-NULL symbols allocated into .bss */
1547 	if (info->sechdrs[get_secindex(info, sym)].sh_type & SHT_NOBITS) {
1548 		zeros = calloc(1, sym->st_size);
1549 		symval = zeros;
1550 	} else {
1551 		symval = sym_get_data(info, sym);
1552 	}
1553 
1554 	/* First handle the "special" cases */
1555 	if (sym_is(name, namelen, "usb"))
1556 		do_usb_table(symval, sym->st_size, mod);
1557 	else {
1558 		int i;
1559 
1560 		for (i = 0; i < ARRAY_SIZE(devtable); i++) {
1561 			const struct devtable *p = &devtable[i];
1562 
1563 			if (sym_is(name, namelen, p->device_id)) {
1564 				do_table(symval, sym->st_size, p->id_size,
1565 					 p->device_id, p->do_entry, mod);
1566 				break;
1567 			}
1568 		}
1569 	}
1570 	free(zeros);
1571 }
1572