smbios.c revision 285726
1/*-
2 * Copyright (c) 2005-2009 Jung-uk Kim <jkim@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: stable/10/sys/boot/i386/libi386/smbios.c 285726 2015-07-20 22:14:55Z allanjude $");
29
30#include <stand.h>
31#include <bootstrap.h>
32#include <sys/endian.h>
33
34#ifdef EFI
35/* In EFI, we don't need PTOV(). */
36#define PTOV(x)		(caddr_t)(x)
37#else
38#include "btxv86.h"
39#endif
40#include "smbios.h"
41
42/*
43 * Detect SMBIOS and export information about the SMBIOS into the
44 * environment.
45 *
46 * System Management BIOS Reference Specification, v2.6 Final
47 * http://www.dmtf.org/standards/published_documents/DSP0134_2.6.0.pdf
48 */
49
50/*
51 * 2.1.1 SMBIOS Structure Table Entry Point
52 *
53 * "On non-EFI systems, the SMBIOS Entry Point structure, described below, can
54 * be located by application software by searching for the anchor-string on
55 * paragraph (16-byte) boundaries within the physical memory address range
56 * 000F0000h to 000FFFFFh. This entry point encapsulates an intermediate anchor
57 * string that is used by some existing DMI browsers."
58 */
59#define	SMBIOS_START		0xf0000
60#define	SMBIOS_LENGTH		0x10000
61#define	SMBIOS_STEP		0x10
62#define	SMBIOS_SIG		"_SM_"
63#define	SMBIOS_DMI_SIG		"_DMI_"
64
65#define	SMBIOS_GET8(base, off)	(*(uint8_t *)((base) + (off)))
66#define	SMBIOS_GET16(base, off)	(*(uint16_t *)((base) + (off)))
67#define	SMBIOS_GET32(base, off)	(*(uint32_t *)((base) + (off)))
68
69#define	SMBIOS_GETLEN(base)	SMBIOS_GET8(base, 0x01)
70#define	SMBIOS_GETSTR(base)	((base) + SMBIOS_GETLEN(base))
71
72struct smbios_attr {
73	int		probed;
74	caddr_t 	addr;
75	size_t		length;
76	size_t		count;
77	int		major;
78	int		minor;
79	int		ver;
80	const char*	bios_vendor;
81	const char*	maker;
82	const char*	product;
83	uint32_t	enabled_memory;
84	uint32_t	old_enabled_memory;
85	uint8_t		enabled_sockets;
86	uint8_t		populated_sockets;
87};
88
89static struct smbios_attr smbios;
90
91static uint8_t
92smbios_checksum(const caddr_t addr, const uint8_t len)
93{
94	uint8_t		sum;
95	int		i;
96
97	for (sum = 0, i = 0; i < len; i++)
98		sum += SMBIOS_GET8(addr, i);
99	return (sum);
100}
101
102static caddr_t
103smbios_sigsearch(const caddr_t addr, const uint32_t len)
104{
105	caddr_t		cp;
106
107	/* Search on 16-byte boundaries. */
108	for (cp = addr; cp < addr + len; cp += SMBIOS_STEP)
109		if (strncmp(cp, SMBIOS_SIG, 4) == 0 &&
110		    smbios_checksum(cp, SMBIOS_GET8(cp, 0x05)) == 0 &&
111		    strncmp(cp + 0x10, SMBIOS_DMI_SIG, 5) == 0 &&
112		    smbios_checksum(cp + 0x10, 0x0f) == 0)
113			return (cp);
114	return (NULL);
115}
116
117static const char*
118smbios_getstring(caddr_t addr, const int offset)
119{
120	caddr_t		cp;
121	int		i, idx;
122
123	idx = SMBIOS_GET8(addr, offset);
124	if (idx != 0) {
125		cp = SMBIOS_GETSTR(addr);
126		for (i = 1; i < idx; i++)
127			cp += strlen(cp) + 1;
128		return cp;
129	}
130	return (NULL);
131}
132
133static void
134smbios_setenv(const char *name, caddr_t addr, const int offset)
135{
136	const char*	val;
137
138	val = smbios_getstring(addr, offset);
139	if (val != NULL)
140		setenv(name, val, 1);
141}
142
143#ifdef SMBIOS_SERIAL_NUMBERS
144
145#define	UUID_SIZE		16
146#define	UUID_TYPE		uint32_t
147#define	UUID_STEP		sizeof(UUID_TYPE)
148#define	UUID_ALL_BITS		(UUID_SIZE / UUID_STEP)
149#define	UUID_GET(base, off)	(*(UUID_TYPE *)((base) + (off)))
150
151static void
152smbios_setuuid(const char *name, const caddr_t addr, const int ver)
153{
154	char		uuid[37];
155	int		i, ones, zeros;
156	UUID_TYPE	n;
157	uint32_t	f1;
158	uint16_t	f2, f3;
159
160	for (i = 0, ones = 0, zeros = 0; i < UUID_SIZE; i += UUID_STEP) {
161		n = UUID_GET(addr, i) + 1;
162		if (zeros == 0 && n == 0)
163			ones++;
164		else if (ones == 0 && n == 1)
165			zeros++;
166		else
167			break;
168	}
169
170	if (ones != UUID_ALL_BITS && zeros != UUID_ALL_BITS) {
171		/*
172		 * 3.3.2.1 System UUID
173		 *
174		 * "Although RFC 4122 recommends network byte order for all
175		 * fields, the PC industry (including the ACPI, UEFI, and
176		 * Microsoft specifications) has consistently used
177		 * little-endian byte encoding for the first three fields:
178		 * time_low, time_mid, time_hi_and_version. The same encoding,
179		 * also known as wire format, should also be used for the
180		 * SMBIOS representation of the UUID."
181		 *
182		 * Note: We use network byte order for backward compatibility
183		 * unless SMBIOS version is 2.6+ or little-endian is forced.
184		 */
185#ifndef SMBIOS_LITTLE_ENDIAN_UUID
186		if (ver < 0x0206) {
187			f1 = ntohl(SMBIOS_GET32(addr, 0));
188			f2 = ntohs(SMBIOS_GET16(addr, 4));
189			f3 = ntohs(SMBIOS_GET16(addr, 6));
190		} else
191#endif
192		{
193			f1 = le32toh(SMBIOS_GET32(addr, 0));
194			f2 = le16toh(SMBIOS_GET16(addr, 4));
195			f3 = le16toh(SMBIOS_GET16(addr, 6));
196		}
197		sprintf(uuid,
198		    "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
199		    f1, f2, f3, SMBIOS_GET8(addr, 8), SMBIOS_GET8(addr, 9),
200		    SMBIOS_GET8(addr, 10), SMBIOS_GET8(addr, 11),
201		    SMBIOS_GET8(addr, 12), SMBIOS_GET8(addr, 13),
202		    SMBIOS_GET8(addr, 14), SMBIOS_GET8(addr, 15));
203		setenv(name, uuid, 1);
204	}
205}
206
207#undef UUID_SIZE
208#undef UUID_TYPE
209#undef UUID_STEP
210#undef UUID_ALL_BITS
211#undef UUID_GET
212
213#endif
214
215static caddr_t
216smbios_parse_table(const caddr_t addr)
217{
218	caddr_t		cp;
219	int		proc, size, osize, type;
220
221	type = SMBIOS_GET8(addr, 0);	/* 3.1.2 Structure Header Format */
222	switch(type) {
223	case 0:		/* 3.3.1 BIOS Information (Type 0) */
224		smbios_setenv("smbios.bios.vendor", addr, 0x04);
225		smbios_setenv("smbios.bios.version", addr, 0x05);
226		smbios_setenv("smbios.bios.reldate", addr, 0x08);
227		break;
228
229	case 1:		/* 3.3.2 System Information (Type 1) */
230		smbios_setenv("smbios.system.maker", addr, 0x04);
231		smbios_setenv("smbios.system.product", addr, 0x05);
232		smbios_setenv("smbios.system.version", addr, 0x06);
233#ifdef SMBIOS_SERIAL_NUMBERS
234		smbios_setenv("smbios.system.serial", addr, 0x07);
235		smbios_setuuid("smbios.system.uuid", addr + 0x08, smbios.ver);
236#endif
237		break;
238
239	case 2:		/* 3.3.3 Base Board (or Module) Information (Type 2) */
240		smbios_setenv("smbios.planar.maker", addr, 0x04);
241		smbios_setenv("smbios.planar.product", addr, 0x05);
242		smbios_setenv("smbios.planar.version", addr, 0x06);
243#ifdef SMBIOS_SERIAL_NUMBERS
244		smbios_setenv("smbios.planar.serial", addr, 0x07);
245#endif
246		break;
247
248	case 3:		/* 3.3.4 System Enclosure or Chassis (Type 3) */
249		smbios_setenv("smbios.chassis.maker", addr, 0x04);
250		smbios_setenv("smbios.chassis.version", addr, 0x06);
251#ifdef SMBIOS_SERIAL_NUMBERS
252		smbios_setenv("smbios.chassis.serial", addr, 0x07);
253		smbios_setenv("smbios.chassis.tag", addr, 0x08);
254#endif
255		break;
256
257	case 4:		/* 3.3.5 Processor Information (Type 4) */
258		/*
259		 * Offset 18h: Processor Status
260		 *
261		 * Bit 7	Reserved, must be 0
262		 * Bit 6	CPU Socket Populated
263		 *		1 - CPU Socket Populated
264		 *		0 - CPU Socket Unpopulated
265		 * Bit 5:3	Reserved, must be zero
266		 * Bit 2:0	CPU Status
267		 *		0h - Unknown
268		 *		1h - CPU Enabled
269		 *		2h - CPU Disabled by User via BIOS Setup
270		 *		3h - CPU Disabled by BIOS (POST Error)
271		 *		4h - CPU is Idle, waiting to be enabled
272		 *		5-6h - Reserved
273		 *		7h - Other
274		 */
275		proc = SMBIOS_GET8(addr, 0x18);
276		if ((proc & 0x07) == 1)
277			smbios.enabled_sockets++;
278		if ((proc & 0x40) != 0)
279			smbios.populated_sockets++;
280		break;
281
282	case 6:		/* 3.3.7 Memory Module Information (Type 6, Obsolete) */
283		/*
284		 * Offset 0Ah: Enabled Size
285		 *
286		 * Bit 7	Bank connection
287		 *		1 - Double-bank connection
288		 *		0 - Single-bank connection
289		 * Bit 6:0	Size (n), where 2**n is the size in MB
290		 *		7Dh - Not determinable (Installed Size only)
291		 *		7Eh - Module is installed, but no memory
292		 *		      has been enabled
293		 *		7Fh - Not installed
294		 */
295		osize = SMBIOS_GET8(addr, 0x0a) & 0x7f;
296		if (osize > 0 && osize < 22)
297			smbios.old_enabled_memory += 1 << (osize + 10);
298		break;
299
300	case 17:	/* 3.3.18 Memory Device (Type 17) */
301		/*
302		 * Offset 0Ch: Size
303		 *
304		 * Bit 15	Granularity
305		 *		1 - Value is in kilobytes units
306		 *		0 - Value is in megabytes units
307		 * Bit 14:0	Size
308		 */
309		size = SMBIOS_GET16(addr, 0x0c);
310		if (size != 0 && size != 0xffff)
311			smbios.enabled_memory += (size & 0x8000) != 0 ?
312			    (size & 0x7fff) : (size << 10);
313		break;
314
315	default:	/* skip other types */
316		break;
317	}
318
319	/* Find structure terminator. */
320	cp = SMBIOS_GETSTR(addr);
321	while (SMBIOS_GET16(cp, 0) != 0)
322		cp++;
323
324	return (cp + 2);
325}
326
327static caddr_t
328smbios_find_struct(int type)
329{
330	caddr_t		dmi;
331	int		i;
332
333	if (smbios.addr == NULL)
334		return (NULL);
335
336	for (dmi = smbios.addr, i = 0;
337	     dmi < smbios.addr + smbios.length && i < smbios.count; i++) {
338		if (SMBIOS_GET8(dmi, 0) == type)
339			return dmi;
340		/* Find structure terminator. */
341		dmi = SMBIOS_GETSTR(dmi);
342		while (SMBIOS_GET16(dmi, 0) != 0)
343			dmi++;
344		dmi += 2;
345	}
346
347	return (NULL);
348}
349
350static void
351smbios_probe(const caddr_t addr)
352{
353	caddr_t		saddr, info;
354	uintptr_t	paddr;
355
356	if (smbios.probed)
357		return;
358	smbios.probed = 1;
359
360	/* Search signatures and validate checksums. */
361	saddr = smbios_sigsearch(addr ? addr : PTOV(SMBIOS_START),
362	    SMBIOS_LENGTH);
363	if (saddr == NULL)
364		return;
365
366	smbios.length = SMBIOS_GET16(saddr, 0x16);	/* Structure Table Length */
367	paddr = SMBIOS_GET32(saddr, 0x18);		/* Structure Table Address */
368	smbios.count = SMBIOS_GET16(saddr, 0x1c);	/* No of SMBIOS Structures */
369	smbios.ver = SMBIOS_GET8(saddr, 0x1e);		/* SMBIOS BCD Revision */
370
371	if (smbios.ver != 0) {
372		smbios.major = smbios.ver >> 4;
373		smbios.minor = smbios.ver & 0x0f;
374		if (smbios.major > 9 || smbios.minor > 9)
375			smbios.ver = 0;
376	}
377	if (smbios.ver == 0) {
378		smbios.major = SMBIOS_GET8(saddr, 0x06);/* SMBIOS Major Version */
379		smbios.minor = SMBIOS_GET8(saddr, 0x07);/* SMBIOS Minor Version */
380	}
381	smbios.ver = (smbios.major << 8) | smbios.minor;
382	smbios.addr = PTOV(paddr);
383
384	/* Get system information from SMBIOS */
385	info = smbios_find_struct(0x00);
386	if (info != NULL) {
387		smbios.bios_vendor = smbios_getstring(info, 0x04);
388	}
389	info = smbios_find_struct(0x01);
390	if (info != NULL) {
391		smbios.maker = smbios_getstring(info, 0x04);
392		smbios.product = smbios_getstring(info, 0x05);
393	}
394}
395
396void
397smbios_detect(const caddr_t addr)
398{
399	char		buf[16];
400	caddr_t		dmi;
401	int		i;
402
403	smbios_probe(addr);
404	if (smbios.addr == NULL)
405		return;
406
407	for (dmi = smbios.addr, i = 0;
408	     dmi < smbios.addr + smbios.length && i < smbios.count; i++)
409		dmi = smbios_parse_table(dmi);
410
411	sprintf(buf, "%d.%d", smbios.major, smbios.minor);
412	setenv("smbios.version", buf, 1);
413	if (smbios.enabled_memory > 0 || smbios.old_enabled_memory > 0) {
414		sprintf(buf, "%u", smbios.enabled_memory > 0 ?
415		    smbios.enabled_memory : smbios.old_enabled_memory);
416		setenv("smbios.memory.enabled", buf, 1);
417	}
418	if (smbios.enabled_sockets > 0) {
419		sprintf(buf, "%u", smbios.enabled_sockets);
420		setenv("smbios.socket.enabled", buf, 1);
421	}
422	if (smbios.populated_sockets > 0) {
423		sprintf(buf, "%u", smbios.populated_sockets);
424		setenv("smbios.socket.populated", buf, 1);
425	}
426}
427
428static int
429smbios_match_str(const char* s1, const char* s2)
430{
431	return (s1 == NULL || (s2 != NULL && !strcmp(s1, s2)));
432}
433
434int
435smbios_match(const char* bios_vendor, const char* maker,
436    const char* product)
437{
438	/* XXXRP currently, only called from non-EFI. */
439	smbios_probe(NULL);
440	return (smbios_match_str(bios_vendor, smbios.bios_vendor) &&
441	    smbios_match_str(maker, smbios.maker) &&
442	    smbios_match_str(product, smbios.product));
443}
444