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