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