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