]> git.ipfire.org Git - thirdparty/u-boot.git/blob - lib/smbios.c
Merge tag 'smbios-2024-04-rc2' of https://source.denx.de/u-boot/custodians/u-boot-efi
[thirdparty/u-boot.git] / lib / smbios.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (C) 2015, Bin Meng <bmeng.cn@gmail.com>
4 *
5 * Adapted from coreboot src/arch/x86/smbios.c
6 */
7
8 #include <dm.h>
9 #include <env.h>
10 #include <linux/stringify.h>
11 #include <linux/string.h>
12 #include <mapmem.h>
13 #include <smbios.h>
14 #include <sysinfo.h>
15 #include <tables_csum.h>
16 #include <version.h>
17 #include <malloc.h>
18 #include <dm/ofnode.h>
19 #ifdef CONFIG_CPU
20 #include <cpu.h>
21 #include <dm/uclass-internal.h>
22 #endif
23
24 /* Safeguard for checking that U_BOOT_VERSION_NUM macros are compatible with U_BOOT_DMI */
25 #if U_BOOT_VERSION_NUM < 2000 || U_BOOT_VERSION_NUM > 2099 || \
26 U_BOOT_VERSION_NUM_PATCH < 1 || U_BOOT_VERSION_NUM_PATCH > 12
27 #error U_BOOT_VERSION_NUM macros are not compatible with DMI, fix U_BOOT_DMI macros
28 #endif
29
30 /*
31 * U_BOOT_DMI_DATE contains BIOS Release Date in format mm/dd/yyyy.
32 * BIOS Release Date is calculated from U-Boot version and fixed day 01.
33 * So for U-Boot version 2021.04 it is calculated as "04/01/2021".
34 * BIOS Release Date should contain date when code was released
35 * and not when it was built or compiled.
36 */
37 #if U_BOOT_VERSION_NUM_PATCH < 10
38 #define U_BOOT_DMI_MONTH "0" __stringify(U_BOOT_VERSION_NUM_PATCH)
39 #else
40 #define U_BOOT_DMI_MONTH __stringify(U_BOOT_VERSION_NUM_PATCH)
41 #endif
42 #define U_BOOT_DMI_DAY "01"
43 #define U_BOOT_DMI_YEAR __stringify(U_BOOT_VERSION_NUM)
44 #define U_BOOT_DMI_DATE U_BOOT_DMI_MONTH "/" U_BOOT_DMI_DAY "/" U_BOOT_DMI_YEAR
45
46 DECLARE_GLOBAL_DATA_PTR;
47
48 /**
49 * struct map_sysinfo - Mapping of sysinfo strings to DT
50 *
51 * @si_str: sysinfo string
52 * @dt_str: DT string
53 * @max: Max index of the tokenized string to pick. Counting starts from 0
54 *
55 */
56 struct map_sysinfo {
57 const char *si_node;
58 const char *si_str;
59 const char *dt_str;
60 int max;
61 };
62
63 static const struct map_sysinfo sysinfo_to_dt[] = {
64 { .si_node = "system", .si_str = "product", .dt_str = "model", 2 },
65 { .si_node = "system", .si_str = "manufacturer", .dt_str = "compatible", 1 },
66 { .si_node = "baseboard", .si_str = "product", .dt_str = "model", 2 },
67 { .si_node = "baseboard", .si_str = "manufacturer", .dt_str = "compatible", 1 },
68 };
69
70 /**
71 * struct smbios_ctx - context for writing SMBIOS tables
72 *
73 * @node: node containing the information to write (ofnode_null()
74 * if none)
75 * @dev: sysinfo device to use (NULL if none)
76 * @subnode_name: sysinfo subnode_name. Used for DT fallback
77 * @eos: end-of-string pointer for the table being processed.
78 * This is set up when we start processing a table
79 * @next_ptr: pointer to the start of the next string to be added.
80 * When the table is not empty, this points to the byte
81 * after the \0 of the previous string.
82 * @last_str: points to the last string that was written to the table,
83 * or NULL if none
84 */
85 struct smbios_ctx {
86 ofnode node;
87 struct udevice *dev;
88 const char *subnode_name;
89 char *eos;
90 char *next_ptr;
91 char *last_str;
92 };
93
94 /**
95 * Function prototype to write a specific type of SMBIOS structure
96 *
97 * @addr: start address to write the structure
98 * @handle: the structure's handle, a unique 16-bit number
99 * @ctx: context for writing the tables
100 * Return: size of the structure
101 */
102 typedef int (*smbios_write_type)(ulong *addr, int handle,
103 struct smbios_ctx *ctx);
104
105 /**
106 * struct smbios_write_method - Information about a table-writing function
107 *
108 * @write: Function to call
109 * @subnode_name: Name of subnode which has the information for this function,
110 * NULL if none
111 */
112 struct smbios_write_method {
113 smbios_write_type write;
114 const char *subnode_name;
115 };
116
117 static const struct map_sysinfo *convert_sysinfo_to_dt(const char *node, const char *si)
118 {
119 int i;
120
121 for (i = 0; i < ARRAY_SIZE(sysinfo_to_dt); i++) {
122 if (node && !strcmp(node, sysinfo_to_dt[i].si_node) &&
123 !strcmp(si, sysinfo_to_dt[i].si_str))
124 return &sysinfo_to_dt[i];
125 }
126
127 return NULL;
128 }
129
130 /**
131 * smbios_add_string() - add a string to the string area
132 *
133 * This adds a string to the string area which is appended directly after
134 * the formatted portion of an SMBIOS structure.
135 *
136 * @ctx: SMBIOS context
137 * @str: string to add
138 * Return: string number in the string area. 0 if str is NULL.
139 */
140 static int smbios_add_string(struct smbios_ctx *ctx, const char *str)
141 {
142 int i = 1;
143 char *p = ctx->eos;
144
145 if (!str)
146 return 0;
147
148 for (;;) {
149 if (!*p) {
150 ctx->last_str = p;
151 strcpy(p, str);
152 p += strlen(str);
153 *p++ = '\0';
154 ctx->next_ptr = p;
155 *p++ = '\0';
156
157 return i;
158 }
159
160 if (!strcmp(p, str)) {
161 ctx->last_str = p;
162 return i;
163 }
164
165 p += strlen(p) + 1;
166 i++;
167 }
168 }
169
170 /**
171 * get_str_from_dt - Get a substring from a DT property.
172 * After finding the property in the DT, the function
173 * will parse comma-separated values and return the value.
174 * If nprop->max exceeds the number of comma-separated
175 * elements, the last non NULL value will be returned.
176 * Counting starts from zero.
177 *
178 * @nprop: sysinfo property to use
179 * @str: pointer to fill with data
180 * @size: str buffer length
181 */
182 static
183 void get_str_from_dt(const struct map_sysinfo *nprop, char *str, size_t size)
184 {
185 const char *dt_str;
186 int cnt = 0;
187 char *token;
188
189 memset(str, 0, size);
190 if (!nprop || !nprop->max)
191 return;
192
193 dt_str = ofnode_read_string(ofnode_root(), nprop->dt_str);
194 if (!dt_str)
195 return;
196
197 memcpy(str, dt_str, size);
198 token = strtok(str, ",");
199 while (token && cnt < nprop->max) {
200 strlcpy(str, token, strlen(token) + 1);
201 token = strtok(NULL, ",");
202 cnt++;
203 }
204 }
205
206 /**
207 * smbios_add_prop_si() - Add a property from the devicetree or sysinfo
208 *
209 * Sysinfo is used if available, with a fallback to devicetree
210 *
211 * @ctx: context for writing the tables
212 * @prop: property to write
213 * @sysinfo_id: unique identifier for the string value to be read
214 * @dval: Default value to use if the string is not found or is empty
215 * Return: 0 if not found, else SMBIOS string number (1 or more)
216 */
217 static int smbios_add_prop_si(struct smbios_ctx *ctx, const char *prop,
218 int sysinfo_id, const char *dval)
219 {
220 int ret;
221
222 if (!dval || !*dval)
223 dval = NULL;
224
225 if (!prop)
226 return smbios_add_string(ctx, dval);
227
228 if (sysinfo_id && ctx->dev) {
229 char val[SMBIOS_STR_MAX];
230
231 ret = sysinfo_get_str(ctx->dev, sysinfo_id, sizeof(val), val);
232 if (!ret)
233 return smbios_add_string(ctx, val);
234 }
235 if (IS_ENABLED(CONFIG_OF_CONTROL)) {
236 const char *str = NULL;
237 char str_dt[128] = { 0 };
238 /*
239 * If the node is not valid fallback and try the entire DT
240 * so we can at least fill in manufacturer and board type
241 */
242 if (ofnode_valid(ctx->node)) {
243 str = ofnode_read_string(ctx->node, prop);
244 } else {
245 const struct map_sysinfo *nprop;
246
247 nprop = convert_sysinfo_to_dt(ctx->subnode_name, prop);
248 get_str_from_dt(nprop, str_dt, sizeof(str_dt));
249 str = (const char *)str_dt;
250 }
251
252 ret = smbios_add_string(ctx, str && *str ? str : dval);
253 return ret;
254 }
255
256 return 0;
257 }
258
259 /**
260 * smbios_add_prop() - Add a property from the devicetree
261 *
262 * @prop: property to write. The default string will be written if
263 * prop is NULL
264 * @dval: Default value to use if the string is not found or is empty
265 * Return: 0 if not found, else SMBIOS string number (1 or more)
266 */
267 static int smbios_add_prop(struct smbios_ctx *ctx, const char *prop,
268 const char *dval)
269 {
270 return smbios_add_prop_si(ctx, prop, SYSINFO_ID_NONE, dval);
271 }
272
273 static void smbios_set_eos(struct smbios_ctx *ctx, char *eos)
274 {
275 ctx->eos = eos;
276 ctx->next_ptr = eos;
277 ctx->last_str = NULL;
278 }
279
280 int smbios_update_version(const char *version)
281 {
282 char *ptr = gd->smbios_version;
283 uint old_len, len;
284
285 if (!ptr)
286 return log_ret(-ENOENT);
287
288 /*
289 * This string is supposed to have at least enough bytes and is
290 * padded with spaces. Update it, taking care not to move the
291 * \0 terminator, so that other strings in the string table
292 * are not disturbed. See smbios_add_string()
293 */
294 old_len = strnlen(ptr, SMBIOS_STR_MAX);
295 len = strnlen(version, SMBIOS_STR_MAX);
296 if (len > old_len)
297 return log_ret(-ENOSPC);
298
299 log_debug("Replacing SMBIOS type 0 version string '%s'\n", ptr);
300 memcpy(ptr, version, len);
301 #ifdef LOG_DEBUG
302 print_buffer((ulong)ptr, ptr, 1, old_len + 1, 0);
303 #endif
304
305 return 0;
306 }
307
308 /**
309 * smbios_string_table_len() - compute the string area size
310 *
311 * This computes the size of the string area including the string terminator.
312 *
313 * @ctx: SMBIOS context
314 * Return: string area size
315 */
316 static int smbios_string_table_len(const struct smbios_ctx *ctx)
317 {
318 /* In case no string is defined we have to return two \0 */
319 if (ctx->next_ptr == ctx->eos)
320 return 2;
321
322 /* Allow for the final \0 after all strings */
323 return (ctx->next_ptr + 1) - ctx->eos;
324 }
325
326 static int smbios_write_type0(ulong *current, int handle,
327 struct smbios_ctx *ctx)
328 {
329 struct smbios_type0 *t;
330 int len = sizeof(struct smbios_type0);
331
332 t = map_sysmem(*current, len);
333 memset(t, 0, sizeof(struct smbios_type0));
334 fill_smbios_header(t, SMBIOS_BIOS_INFORMATION, len, handle);
335 smbios_set_eos(ctx, t->eos);
336 t->vendor = smbios_add_prop(ctx, NULL, "U-Boot");
337
338 t->bios_ver = smbios_add_prop(ctx, "version", PLAIN_VERSION);
339 if (t->bios_ver)
340 gd->smbios_version = ctx->last_str;
341 log_debug("smbios_version = %p: '%s'\n", gd->smbios_version,
342 gd->smbios_version);
343 #ifdef LOG_DEBUG
344 print_buffer((ulong)gd->smbios_version, gd->smbios_version,
345 1, strlen(gd->smbios_version) + 1, 0);
346 #endif
347 t->bios_release_date = smbios_add_prop(ctx, NULL, U_BOOT_DMI_DATE);
348 #ifdef CONFIG_ROM_SIZE
349 t->bios_rom_size = (CONFIG_ROM_SIZE / 65536) - 1;
350 #endif
351 t->bios_characteristics = BIOS_CHARACTERISTICS_PCI_SUPPORTED |
352 BIOS_CHARACTERISTICS_SELECTABLE_BOOT |
353 BIOS_CHARACTERISTICS_UPGRADEABLE;
354 #ifdef CONFIG_GENERATE_ACPI_TABLE
355 t->bios_characteristics_ext1 = BIOS_CHARACTERISTICS_EXT1_ACPI;
356 #endif
357 #ifdef CONFIG_EFI_LOADER
358 t->bios_characteristics_ext2 |= BIOS_CHARACTERISTICS_EXT2_UEFI;
359 #endif
360 t->bios_characteristics_ext2 |= BIOS_CHARACTERISTICS_EXT2_TARGET;
361
362 /* bios_major_release has only one byte, so drop century */
363 t->bios_major_release = U_BOOT_VERSION_NUM % 100;
364 t->bios_minor_release = U_BOOT_VERSION_NUM_PATCH;
365 t->ec_major_release = 0xff;
366 t->ec_minor_release = 0xff;
367
368 len = t->length + smbios_string_table_len(ctx);
369 *current += len;
370 unmap_sysmem(t);
371
372 return len;
373 }
374
375 static int smbios_write_type1(ulong *current, int handle,
376 struct smbios_ctx *ctx)
377 {
378 struct smbios_type1 *t;
379 int len = sizeof(struct smbios_type1);
380 char *serial_str = env_get("serial#");
381
382 t = map_sysmem(*current, len);
383 memset(t, 0, sizeof(struct smbios_type1));
384 fill_smbios_header(t, SMBIOS_SYSTEM_INFORMATION, len, handle);
385 smbios_set_eos(ctx, t->eos);
386 t->manufacturer = smbios_add_prop(ctx, "manufacturer", NULL);
387 t->product_name = smbios_add_prop(ctx, "product", NULL);
388 t->version = smbios_add_prop_si(ctx, "version",
389 SYSINFO_ID_SMBIOS_SYSTEM_VERSION,
390 NULL);
391 if (serial_str) {
392 t->serial_number = smbios_add_prop(ctx, NULL, serial_str);
393 strncpy((char *)t->uuid, serial_str, sizeof(t->uuid));
394 } else {
395 t->serial_number = smbios_add_prop(ctx, "serial", NULL);
396 }
397 t->sku_number = smbios_add_prop(ctx, "sku", NULL);
398 t->family = smbios_add_prop(ctx, "family", NULL);
399
400 len = t->length + smbios_string_table_len(ctx);
401 *current += len;
402 unmap_sysmem(t);
403
404 return len;
405 }
406
407 static int smbios_write_type2(ulong *current, int handle,
408 struct smbios_ctx *ctx)
409 {
410 struct smbios_type2 *t;
411 int len = sizeof(struct smbios_type2);
412
413 t = map_sysmem(*current, len);
414 memset(t, 0, sizeof(struct smbios_type2));
415 fill_smbios_header(t, SMBIOS_BOARD_INFORMATION, len, handle);
416 smbios_set_eos(ctx, t->eos);
417 t->manufacturer = smbios_add_prop(ctx, "manufacturer", NULL);
418 t->product_name = smbios_add_prop(ctx, "product", NULL);
419 t->version = smbios_add_prop_si(ctx, "version",
420 SYSINFO_ID_SMBIOS_BASEBOARD_VERSION,
421 NULL);
422 t->asset_tag_number = smbios_add_prop(ctx, "asset-tag", NULL);
423 t->feature_flags = SMBIOS_BOARD_FEATURE_HOSTING;
424 t->board_type = SMBIOS_BOARD_MOTHERBOARD;
425 t->chassis_handle = handle + 1;
426
427 len = t->length + smbios_string_table_len(ctx);
428 *current += len;
429 unmap_sysmem(t);
430
431 return len;
432 }
433
434 static int smbios_write_type3(ulong *current, int handle,
435 struct smbios_ctx *ctx)
436 {
437 struct smbios_type3 *t;
438 int len = sizeof(struct smbios_type3);
439
440 t = map_sysmem(*current, len);
441 memset(t, 0, sizeof(struct smbios_type3));
442 fill_smbios_header(t, SMBIOS_SYSTEM_ENCLOSURE, len, handle);
443 smbios_set_eos(ctx, t->eos);
444 t->manufacturer = smbios_add_prop(ctx, "manufacturer", NULL);
445 t->chassis_type = SMBIOS_ENCLOSURE_DESKTOP;
446 t->bootup_state = SMBIOS_STATE_SAFE;
447 t->power_supply_state = SMBIOS_STATE_SAFE;
448 t->thermal_state = SMBIOS_STATE_SAFE;
449 t->security_status = SMBIOS_SECURITY_NONE;
450
451 len = t->length + smbios_string_table_len(ctx);
452 *current += len;
453 unmap_sysmem(t);
454
455 return len;
456 }
457
458 static void smbios_write_type4_dm(struct smbios_type4 *t,
459 struct smbios_ctx *ctx)
460 {
461 u16 processor_family = SMBIOS_PROCESSOR_FAMILY_UNKNOWN;
462 const char *vendor = NULL;
463 const char *name = NULL;
464
465 #ifdef CONFIG_CPU
466 char processor_name[49];
467 char vendor_name[49];
468 struct udevice *cpu = NULL;
469
470 uclass_find_first_device(UCLASS_CPU, &cpu);
471 if (cpu) {
472 struct cpu_plat *plat = dev_get_parent_plat(cpu);
473
474 if (plat->family)
475 processor_family = plat->family;
476 t->processor_id[0] = plat->id[0];
477 t->processor_id[1] = plat->id[1];
478
479 if (!cpu_get_vendor(cpu, vendor_name, sizeof(vendor_name)))
480 vendor = vendor_name;
481 if (!cpu_get_desc(cpu, processor_name, sizeof(processor_name)))
482 name = processor_name;
483 }
484 #endif
485
486 t->processor_family = 0xfe;
487 t->processor_family2 = processor_family;
488 t->processor_manufacturer = smbios_add_prop(ctx, NULL, vendor);
489 t->processor_version = smbios_add_prop(ctx, NULL, name);
490 }
491
492 static int smbios_write_type4(ulong *current, int handle,
493 struct smbios_ctx *ctx)
494 {
495 struct smbios_type4 *t;
496 int len = sizeof(struct smbios_type4);
497
498 t = map_sysmem(*current, len);
499 memset(t, 0, sizeof(struct smbios_type4));
500 fill_smbios_header(t, SMBIOS_PROCESSOR_INFORMATION, len, handle);
501 smbios_set_eos(ctx, t->eos);
502 t->processor_type = SMBIOS_PROCESSOR_TYPE_CENTRAL;
503 smbios_write_type4_dm(t, ctx);
504 t->status = SMBIOS_PROCESSOR_STATUS_ENABLED;
505 t->processor_upgrade = SMBIOS_PROCESSOR_UPGRADE_NONE;
506 t->l1_cache_handle = 0xffff;
507 t->l2_cache_handle = 0xffff;
508 t->l3_cache_handle = 0xffff;
509
510 len = t->length + smbios_string_table_len(ctx);
511 *current += len;
512 unmap_sysmem(t);
513
514 return len;
515 }
516
517 static int smbios_write_type32(ulong *current, int handle,
518 struct smbios_ctx *ctx)
519 {
520 struct smbios_type32 *t;
521 int len = sizeof(struct smbios_type32);
522
523 t = map_sysmem(*current, len);
524 memset(t, 0, sizeof(struct smbios_type32));
525 fill_smbios_header(t, SMBIOS_SYSTEM_BOOT_INFORMATION, len, handle);
526 smbios_set_eos(ctx, t->eos);
527
528 *current += len;
529 unmap_sysmem(t);
530
531 return len;
532 }
533
534 static int smbios_write_type127(ulong *current, int handle,
535 struct smbios_ctx *ctx)
536 {
537 struct smbios_type127 *t;
538 int len = sizeof(struct smbios_type127);
539
540 t = map_sysmem(*current, len);
541 memset(t, 0, sizeof(struct smbios_type127));
542 fill_smbios_header(t, SMBIOS_END_OF_TABLE, len, handle);
543
544 *current += len;
545 unmap_sysmem(t);
546
547 return len;
548 }
549
550 static struct smbios_write_method smbios_write_funcs[] = {
551 { smbios_write_type0, "bios", },
552 { smbios_write_type1, "system", },
553 { smbios_write_type2, "baseboard", },
554 /* Type 3 must immediately follow type 2 due to chassis handle. */
555 { smbios_write_type3, "chassis", },
556 { smbios_write_type4, },
557 { smbios_write_type32, },
558 { smbios_write_type127 },
559 };
560
561 ulong write_smbios_table(ulong addr)
562 {
563 ofnode parent_node = ofnode_null();
564 ulong table_addr, start_addr;
565 struct smbios3_entry *se;
566 struct smbios_ctx ctx;
567 ulong tables;
568 int len = 0;
569 int handle = 0;
570 int i;
571
572 ctx.node = ofnode_null();
573 if (IS_ENABLED(CONFIG_OF_CONTROL)) {
574 uclass_first_device(UCLASS_SYSINFO, &ctx.dev);
575 if (ctx.dev)
576 parent_node = dev_read_subnode(ctx.dev, "smbios");
577 } else {
578 ctx.dev = NULL;
579 }
580
581 start_addr = addr;
582
583 /* move past the (so-far-unwritten) header to start writing structs */
584 addr = ALIGN(addr + sizeof(struct smbios3_entry), 16);
585 tables = addr;
586
587 /* populate minimum required tables */
588 for (i = 0; i < ARRAY_SIZE(smbios_write_funcs); i++) {
589 const struct smbios_write_method *method;
590
591 method = &smbios_write_funcs[i];
592 ctx.subnode_name = NULL;
593 if (method->subnode_name) {
594 ctx.subnode_name = method->subnode_name;
595 if (IS_ENABLED(CONFIG_OF_CONTROL))
596 ctx.node = ofnode_find_subnode(parent_node,
597 method->subnode_name);
598 }
599 len += method->write((ulong *)&addr, handle++, &ctx);
600 }
601
602 /*
603 * We must use a pointer here so things work correctly on sandbox. The
604 * user of this table is not aware of the mapping of addresses to
605 * sandbox's DRAM buffer.
606 */
607 table_addr = (ulong)map_sysmem(tables, 0);
608
609 /* now go back and write the SMBIOS3 header */
610 se = map_sysmem(start_addr, sizeof(struct smbios3_entry));
611 memset(se, '\0', sizeof(struct smbios3_entry));
612 memcpy(se->anchor, "_SM3_", 5);
613 se->length = sizeof(struct smbios3_entry);
614 se->major_ver = SMBIOS_MAJOR_VER;
615 se->minor_ver = SMBIOS_MINOR_VER;
616 se->doc_rev = 0;
617 se->entry_point_rev = 1;
618 se->table_maximum_size = len;
619 se->struct_table_address = table_addr;
620 se->checksum = table_compute_checksum(se, sizeof(struct smbios3_entry));
621 unmap_sysmem(se);
622
623 return addr;
624 }