2 * Copyright (c) 2005-2009 Jung-uk Kim <jkim@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
29 #include <sys/endian.h>
31 #define PTOV(x) ptov(x)
33 /* Only enable 64-bit entry point if it makes sense */
34 #if __SIZEOF_POINTER__ > 4
39 * Detect SMBIOS and export information about the SMBIOS into the
42 * System Management BIOS Reference Specification, v2.6 Final
43 * http://www.dmtf.org/standards/published_documents/DSP0134_2.6.0.pdf
45 * System Management BIOS (SMBIOS) Reference Specification, 3.6.0
46 * https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_3.6.0.pdf
50 * The first quoted paragraph below can also be found in section 2.1.1 SMBIOS
51 * Structure Table Entry Point of System Management BIOS Reference
52 * Specification, v2.6 Final
54 * (From System Management BIOS (SMBIOS) Reference Specification, 3.6.0)
55 * 5.2.1 SMBIOS 2.1 (32-bit) Entry Point
57 * "On non-UEFI systems, the 32-bit SMBIOS Entry Point structure, can be
58 * located by application software by searching for the anchor-string on
59 * paragraph (16-byte) boundaries within the physical memory address
60 * range 000F0000h to 000FFFFFh. This entry point encapsulates an intermediate
61 * anchor string that is used by some existing DMI browsers.
63 * On UEFI-based systems, the SMBIOS Entry Point structure can be located by
64 * looking in the EFI Configuration Table for the SMBIOS GUID
65 * (SMBIOS_TABLE_GUID, {EB9D2D31-2D88-11D3-9A16-0090273FC14D}) and using the
66 * associated pointer. See section 4.6 of the UEFI Specification for details.
67 * See section 2.3 of the UEFI Specification for how to report the containing
70 * NOTE While the SMBIOS Major and Minor Versions (offsets 06h and 07h)
71 * currently duplicate the information that is present in the SMBIOS BCD
72 * Revision (offset 1Eh), they provide a path for future growth in this
73 * specification. The BCD Revision, for example, provides only a single digit
74 * for each of the major and minor version numbers."
76 * 5.2.2 SMBIOS 860 3.0 (64-bit) Entry Point
78 * "On non-UEFI systems, the 64-bit SMBIOS Entry Point structure can be located
79 * by application software by searching for the anchor-string on paragraph
80 * (16-byte) boundaries within the physical memory address range 000F0000h to
83 * On UEFI-based systems, the SMBIOS Entry Point structure can be located by
84 * looking in the EFI Configuration Table for the SMBIOS 3.x GUID
85 * (SMBIOS3_TABLE_GUID, {F2FD1544-9794-4A2C-992E-E5BBCF20E394}) and using the
86 * associated pointer. See section 4.6 of the UEFI Specification for details.
87 * See section 2.3 of the UEFI Specification for how to report the containing
90 #define SMBIOS_START 0xf0000
91 #define SMBIOS_LENGTH 0x10000
92 #define SMBIOS_STEP 0x10
93 #define SMBIOS_SIG "_SM_"
94 #define SMBIOS3_SIG "_SM3_"
95 #define SMBIOS_DMI_SIG "_DMI_"
100 * NOTE The Entry Point Structure and all SMBIOS structures assume a
101 * little-endian ordering convention...
104 * We use memcpy to avoid unaligned access to memory. To normal memory, this is
105 * fine, but the memory we are using might be mmap'd /dev/mem which under Linux
106 * on aarch64 doesn't allow unaligned access. leXdec and friends can't be used
107 * because those can optimize to an unaligned load (which often is fine, but not
108 * for mmap'd /dev/mem which has special memory attributes).
110 static inline uint8_t SMBIOS_GET8(const caddr_t base, int off) { return (base[off]); }
112 static inline uint16_t
113 SMBIOS_GET16(const caddr_t base, int off)
117 memcpy(&v, base + off, sizeof(v));
121 static inline uint32_t
122 SMBIOS_GET32(const caddr_t base, int off)
126 memcpy(&v, base + off, sizeof(v));
130 static inline uint64_t
131 SMBIOS_GET64(const caddr_t base, int off)
135 memcpy(&v, base + off, sizeof(v));
139 #define SMBIOS_GETLEN(base) SMBIOS_GET8(base, 0x01)
140 #define SMBIOS_GETSTR(base) ((base) + SMBIOS_GETLEN(base))
150 const char* bios_vendor;
153 uint32_t enabled_memory;
154 uint32_t old_enabled_memory;
155 uint8_t enabled_sockets;
156 uint8_t populated_sockets;
159 static struct smbios_attr smbios;
165 smbios_checksum(const caddr_t addr, const uint8_t len)
170 for (sum = 0, i = 0; i < len; i++)
171 sum += SMBIOS_GET8(addr, i);
176 smbios_sigsearch(const caddr_t addr, const uint32_t len)
180 /* Search on 16-byte boundaries. */
181 for (cp = addr; cp < addr + len; cp += SMBIOS_STEP) {
182 /* v2.1, 32-bit Entry point */
183 if (strncmp(cp, SMBIOS_SIG, sizeof(SMBIOS_SIG) - 1) == 0 &&
184 smbios_checksum(cp, SMBIOS_GET8(cp, 0x05)) == 0 &&
185 strncmp(cp + 0x10, SMBIOS_DMI_SIG, 5) == 0 &&
186 smbios_checksum(cp + 0x10, 0x0f) == 0)
190 /* v3.0, 64-bit Entry point */
191 if (strncmp(cp, SMBIOS3_SIG, sizeof(SMBIOS3_SIG) - 1) == 0 &&
192 smbios_checksum(cp, SMBIOS_GET8(cp, 0x06)) == 0) {
202 smbios_getstring(caddr_t addr, const int offset)
207 idx = SMBIOS_GET8(addr, offset);
209 cp = SMBIOS_GETSTR(addr);
210 for (i = 1; i < idx; i++)
211 cp += strlen(cp) + 1;
218 smbios_setenv(const char *name, caddr_t addr, const int offset)
222 val = smbios_getstring(addr, offset);
224 setenv(name, val, 1);
227 #ifdef SMBIOS_SERIAL_NUMBERS
230 #define UUID_TYPE uint32_t
231 #define UUID_STEP sizeof(UUID_TYPE)
232 #define UUID_ALL_BITS (UUID_SIZE / UUID_STEP)
233 #define UUID_GET(base, off) SMBIOS_GET32(base, off)
236 smbios_setuuid(const char *name, const caddr_t addr, const int ver __unused)
239 int byteorder, i, ones, zeros;
244 for (i = 0, ones = 0, zeros = 0; i < UUID_SIZE; i += UUID_STEP) {
245 n = UUID_GET(addr, i) + 1;
246 if (zeros == 0 && n == 0)
248 else if (ones == 0 && n == 1)
254 if (ones != UUID_ALL_BITS && zeros != UUID_ALL_BITS) {
256 * 3.3.2.1 System UUID
258 * "Although RFC 4122 recommends network byte order for all
259 * fields, the PC industry (including the ACPI, UEFI, and
260 * Microsoft specifications) has consistently used
261 * little-endian byte encoding for the first three fields:
262 * time_low, time_mid, time_hi_and_version. The same encoding,
263 * also known as wire format, should also be used for the
264 * SMBIOS representation of the UUID."
266 * Note: We use network byte order for backward compatibility
267 * unless SMBIOS version is 2.6+ or little-endian is forced.
269 #if defined(SMBIOS_LITTLE_ENDIAN_UUID)
270 byteorder = LITTLE_ENDIAN;
271 #elif defined(SMBIOS_NETWORK_ENDIAN_UUID)
272 byteorder = BIG_ENDIAN;
274 byteorder = ver < 0x0206 ? BIG_ENDIAN : LITTLE_ENDIAN;
276 if (byteorder != LITTLE_ENDIAN) {
277 f1 = ntohl(SMBIOS_GET32(addr, 0));
278 f2 = ntohs(SMBIOS_GET16(addr, 4));
279 f3 = ntohs(SMBIOS_GET16(addr, 6));
281 f1 = le32toh(SMBIOS_GET32(addr, 0));
282 f2 = le16toh(SMBIOS_GET16(addr, 4));
283 f3 = le16toh(SMBIOS_GET16(addr, 6));
286 "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
287 f1, f2, f3, SMBIOS_GET8(addr, 8), SMBIOS_GET8(addr, 9),
288 SMBIOS_GET8(addr, 10), SMBIOS_GET8(addr, 11),
289 SMBIOS_GET8(addr, 12), SMBIOS_GET8(addr, 13),
290 SMBIOS_GET8(addr, 14), SMBIOS_GET8(addr, 15));
291 setenv(name, uuid, 1);
304 smbios_parse_chassis_type(caddr_t addr)
308 type = SMBIOS_GET8(addr, 0x5);
317 return ("Low Profile Desktop");
319 return ("Pizza Box");
321 return ("Mini Tower");
331 return ("Hand Held");
333 return ("Docking Station");
335 return ("All in One");
337 return ("Sub Notebook");
339 return ("Lunch Box");
341 return ("Space-saving");
343 return ("Main Server Chassis");
345 return ("Expansion Chassis");
347 return ("SubChassis");
349 return ("Bus Expansion Chassis");
351 return ("Peripheral Chassis");
353 return ("RAID Chassis");
355 return ("Rack Mount Chassis");
357 return ("Sealed-case PC");
359 return ("Multi-system chassis");
361 return ("Compact PCI");
363 return ("Advanced TCA");
367 return ("Blade Enclosure");
371 return ("Convertible");
373 return ("Detachable");
375 return ("IoT Gateway");
377 return ("Embedded PC");
384 return ("Undefined");
388 smbios_parse_table(const caddr_t addr)
391 int proc, size, osize, type;
392 uint8_t bios_minor, bios_major;
395 type = SMBIOS_GET8(addr, 0); /* 3.1.2 Structure Header Format */
397 case 0: /* 3.3.1 BIOS Information (Type 0) */
398 smbios_setenv("smbios.bios.vendor", addr, 0x04);
399 smbios_setenv("smbios.bios.version", addr, 0x05);
400 smbios_setenv("smbios.bios.reldate", addr, 0x08);
401 bios_major = SMBIOS_GET8(addr, 0x14);
402 bios_minor = SMBIOS_GET8(addr, 0x15);
403 if (bios_minor != 0xFF && bios_major != 0xFF) {
404 snprintf(buf, sizeof(buf), "%u.%u",
405 bios_major, bios_minor);
406 setenv("smbios.bios.revision", buf, 1);
410 case 1: /* 3.3.2 System Information (Type 1) */
411 smbios_setenv("smbios.system.maker", addr, 0x04);
412 smbios_setenv("smbios.system.product", addr, 0x05);
413 smbios_setenv("smbios.system.version", addr, 0x06);
414 #ifdef SMBIOS_SERIAL_NUMBERS
415 smbios_setenv("smbios.system.serial", addr, 0x07);
416 smbios_setuuid("smbios.system.uuid", addr + 0x08, smbios.ver);
418 if (smbios.major > 2 ||
419 (smbios.major == 2 && smbios.minor >= 4)) {
420 smbios_setenv("smbios.system.sku", addr, 0x19);
421 smbios_setenv("smbios.system.family", addr, 0x1a);
425 case 2: /* 3.3.3 Base Board (or Module) Information (Type 2) */
426 smbios_setenv("smbios.planar.maker", addr, 0x04);
427 smbios_setenv("smbios.planar.product", addr, 0x05);
428 smbios_setenv("smbios.planar.version", addr, 0x06);
429 #ifdef SMBIOS_SERIAL_NUMBERS
430 smbios_setenv("smbios.planar.serial", addr, 0x07);
431 smbios_setenv("smbios.planar.tag", addr, 0x08);
433 smbios_setenv("smbios.planar.location", addr, 0x0a);
436 case 3: /* 3.3.4 System Enclosure or Chassis (Type 3) */
437 smbios_setenv("smbios.chassis.maker", addr, 0x04);
438 setenv("smbios.chassis.type", smbios_parse_chassis_type(addr), 1);
439 smbios_setenv("smbios.chassis.version", addr, 0x06);
440 #ifdef SMBIOS_SERIAL_NUMBERS
441 smbios_setenv("smbios.chassis.serial", addr, 0x07);
442 smbios_setenv("smbios.chassis.tag", addr, 0x08);
446 case 4: /* 3.3.5 Processor Information (Type 4) */
448 * Offset 18h: Processor Status
450 * Bit 7 Reserved, must be 0
451 * Bit 6 CPU Socket Populated
452 * 1 - CPU Socket Populated
453 * 0 - CPU Socket Unpopulated
454 * Bit 5:3 Reserved, must be zero
458 * 2h - CPU Disabled by User via BIOS Setup
459 * 3h - CPU Disabled by BIOS (POST Error)
460 * 4h - CPU is Idle, waiting to be enabled
464 proc = SMBIOS_GET8(addr, 0x18);
465 if ((proc & 0x07) == 1)
466 smbios.enabled_sockets++;
467 if ((proc & 0x40) != 0)
468 smbios.populated_sockets++;
471 case 6: /* 3.3.7 Memory Module Information (Type 6, Obsolete) */
473 * Offset 0Ah: Enabled Size
475 * Bit 7 Bank connection
476 * 1 - Double-bank connection
477 * 0 - Single-bank connection
478 * Bit 6:0 Size (n), where 2**n is the size in MB
479 * 7Dh - Not determinable (Installed Size only)
480 * 7Eh - Module is installed, but no memory
482 * 7Fh - Not installed
484 osize = SMBIOS_GET8(addr, 0x0a) & 0x7f;
485 if (osize > 0 && osize < 22)
486 smbios.old_enabled_memory += 1 << (osize + 10);
489 case 17: /* 3.3.18 Memory Device (Type 17) */
494 * 1 - Value is in kilobytes units
495 * 0 - Value is in megabytes units
498 size = SMBIOS_GET16(addr, 0x0c);
499 if (size != 0 && size != 0xffff)
500 smbios.enabled_memory += (size & 0x8000) != 0 ?
501 (size & 0x7fff) : (size << 10);
504 default: /* skip other types */
508 /* Find structure terminator. */
509 cp = SMBIOS_GETSTR(addr);
510 while (SMBIOS_GET16(cp, 0) != 0)
517 smbios_find_struct(int type)
523 if (smbios.addr == NULL)
526 ep = smbios.addr + smbios.length;
527 for (dmi = smbios.addr, i = 0;
528 dmi < ep && i < smbios.count; i++) {
529 if (SMBIOS_GET8(dmi, 0) == type) {
532 /* Find structure terminator. */
533 dmi = SMBIOS_GETSTR(dmi);
534 while (SMBIOS_GET16(dmi, 0) != 0 && dmi < ep) {
537 dmi += 2; /* For checksum */
544 smbios_probe(const caddr_t addr)
555 /* Search signatures and validate checksums. */
556 saddr = smbios_sigsearch(addr ? addr : PTOV(SMBIOS_START),
563 smbios.length = SMBIOS_GET32(saddr, 0x0c); /* Structure Table Length */
564 paddr = SMBIOS_GET64(saddr, 0x10); /* Structure Table Address */
565 smbios.count = -1; /* not present in V3 */
566 smbios.ver = 0; /* not present in V3 */
572 smbios.length = SMBIOS_GET16(saddr, 0x16); /* Structure Table Length */
573 paddr = SMBIOS_GET32(saddr, 0x18); /* Structure Table Address */
574 smbios.count = SMBIOS_GET16(saddr, 0x1c); /* No of SMBIOS Structures */
575 smbios.ver = SMBIOS_GET8(saddr, 0x1e); /* SMBIOS BCD Revision */
581 if (smbios.ver != 0) {
582 smbios.major = smbios.ver >> 4;
583 smbios.minor = smbios.ver & 0x0f;
584 if (smbios.major > 9 || smbios.minor > 9)
587 if (smbios.ver == 0) {
588 smbios.major = SMBIOS_GET8(saddr, maj_off);/* SMBIOS Major Version */
589 smbios.minor = SMBIOS_GET8(saddr, min_off);/* SMBIOS Minor Version */
591 smbios.ver = (smbios.major << 8) | smbios.minor;
592 smbios.addr = PTOV(paddr);
594 /* Get system information from SMBIOS */
595 info = smbios_find_struct(0x00);
597 smbios.bios_vendor = smbios_getstring(info, 0x04);
599 info = smbios_find_struct(0x01);
601 smbios.maker = smbios_getstring(info, 0x04);
602 smbios.product = smbios_getstring(info, 0x05);
607 smbios_detect(const caddr_t addr)
614 if (smbios.addr == NULL)
617 for (dmi = smbios.addr, i = 0;
618 dmi < smbios.addr + smbios.length && i < smbios.count; i++)
619 dmi = smbios_parse_table(dmi);
621 sprintf(buf, "%d.%d", smbios.major, smbios.minor);
622 setenv("smbios.version", buf, 1);
623 if (smbios.enabled_memory > 0 || smbios.old_enabled_memory > 0) {
624 sprintf(buf, "%u", smbios.enabled_memory > 0 ?
625 smbios.enabled_memory : smbios.old_enabled_memory);
626 setenv("smbios.memory.enabled", buf, 1);
628 if (smbios.enabled_sockets > 0) {
629 sprintf(buf, "%u", smbios.enabled_sockets);
630 setenv("smbios.socket.enabled", buf, 1);
632 if (smbios.populated_sockets > 0) {
633 sprintf(buf, "%u", smbios.populated_sockets);
634 setenv("smbios.socket.populated", buf, 1);
639 smbios_match_str(const char* s1, const char* s2)
641 return (s1 == NULL || (s2 != NULL && !strcmp(s1, s2)));
645 smbios_match(const char* bios_vendor, const char* maker,
648 /* XXXRP currently, only called from non-EFI. */
650 return (smbios_match_str(bios_vendor, smbios.bios_vendor) &&
651 smbios_match_str(maker, smbios.maker) &&
652 smbios_match_str(product, smbios.product));