]> git.ipfire.org Git - thirdparty/u-boot.git/blobdiff - lib/smbios.c
Merge tag 'u-boot-stm32-20240614' of https://source.denx.de/u-boot/custodians/u-boot-stm
[thirdparty/u-boot.git] / lib / smbios.c
index 9eb226ec9fbd5d486a9ff2c439e4e3b440571422..b190b010f30f31a615b49528615a602b70a1a3b4 100644 (file)
@@ -5,37 +5,87 @@
  * Adapted from coreboot src/arch/x86/smbios.c
  */
 
-#include <common.h>
 #include <dm.h>
 #include <env.h>
+#include <linux/stringify.h>
+#include <linux/string.h>
 #include <mapmem.h>
 #include <smbios.h>
 #include <sysinfo.h>
 #include <tables_csum.h>
 #include <version.h>
+#include <malloc.h>
+#include <dm/ofnode.h>
 #ifdef CONFIG_CPU
 #include <cpu.h>
 #include <dm/uclass-internal.h>
 #endif
 
+/* Safeguard for checking that U_BOOT_VERSION_NUM macros are compatible with U_BOOT_DMI */
+#if U_BOOT_VERSION_NUM < 2000 || U_BOOT_VERSION_NUM > 2099 || \
+    U_BOOT_VERSION_NUM_PATCH < 1 || U_BOOT_VERSION_NUM_PATCH > 12
+#error U_BOOT_VERSION_NUM macros are not compatible with DMI, fix U_BOOT_DMI macros
+#endif
+
+/*
+ * U_BOOT_DMI_DATE contains BIOS Release Date in format mm/dd/yyyy.
+ * BIOS Release Date is calculated from U-Boot version and fixed day 01.
+ * So for U-Boot version 2021.04 it is calculated as "04/01/2021".
+ * BIOS Release Date should contain date when code was released
+ * and not when it was built or compiled.
+ */
+#if U_BOOT_VERSION_NUM_PATCH < 10
+#define U_BOOT_DMI_MONTH "0" __stringify(U_BOOT_VERSION_NUM_PATCH)
+#else
+#define U_BOOT_DMI_MONTH __stringify(U_BOOT_VERSION_NUM_PATCH)
+#endif
+#define U_BOOT_DMI_DAY "01"
+#define U_BOOT_DMI_YEAR __stringify(U_BOOT_VERSION_NUM)
+#define U_BOOT_DMI_DATE U_BOOT_DMI_MONTH "/" U_BOOT_DMI_DAY "/" U_BOOT_DMI_YEAR
+
 DECLARE_GLOBAL_DATA_PTR;
 
+/**
+ * struct map_sysinfo - Mapping of sysinfo strings to DT
+ *
+ * @si_str: sysinfo string
+ * @dt_str: DT string
+ * @max: Max index of the tokenized string to pick. Counting starts from 0
+ *
+ */
+struct map_sysinfo {
+       const char *si_node;
+       const char *si_str;
+       const char *dt_str;
+       int max;
+};
+
+static const struct map_sysinfo sysinfo_to_dt[] = {
+       { .si_node = "system", .si_str = "product", .dt_str = "model", 2 },
+       { .si_node = "system", .si_str = "manufacturer", .dt_str = "compatible", 1 },
+       { .si_node = "baseboard", .si_str = "product", .dt_str = "model", 2 },
+       { .si_node = "baseboard", .si_str = "manufacturer", .dt_str = "compatible", 1 },
+};
+
 /**
  * struct smbios_ctx - context for writing SMBIOS tables
  *
- * @node:      node containing the information to write (ofnode_null() if none)
- * @dev:       sysinfo device to use (NULL if none)
- * @eos:       end-of-string pointer for the table being processed. This is set
- *             up when we start processing a table
- * @next_ptr:  pointer to the start of the next string to be added. When the
- *             table is nopt empty, this points to the byte after the \0 of the
- *             previous string.
- * @last_str:  points to the last string that was written to the table, or NULL
- *             if none
+ * @node:              node containing the information to write (ofnode_null()
+ *                     if none)
+ * @dev:               sysinfo device to use (NULL if none)
+ * @subnode_name:      sysinfo subnode_name. Used for DT fallback
+ * @eos:               end-of-string pointer for the table being processed.
+ *                     This is set up when we start processing a table
+ * @next_ptr:          pointer to the start of the next string to be added.
+ *                     When the table is not empty, this points to the byte
+ *                     after the \0 of the previous string.
+ * @last_str:          points to the last string that was written to the table,
+ *                     or NULL if none
  */
 struct smbios_ctx {
        ofnode node;
        struct udevice *dev;
+       const char *subnode_name;
        char *eos;
        char *next_ptr;
        char *last_str;
@@ -47,7 +97,7 @@ struct smbios_ctx {
  * @addr:      start address to write the structure
  * @handle:    the structure's handle, a unique 16-bit number
  * @ctx:       context for writing the tables
- * @return:    size of the structure
+ * Return:     size of the structure
  */
 typedef int (*smbios_write_type)(ulong *addr, int handle,
                                 struct smbios_ctx *ctx);
@@ -64,6 +114,19 @@ struct smbios_write_method {
        const char *subnode_name;
 };
 
+static const struct map_sysinfo *convert_sysinfo_to_dt(const char *node, const char *si)
+{
+       int i;
+
+       for (i = 0; i < ARRAY_SIZE(sysinfo_to_dt); i++) {
+               if (node && !strcmp(node, sysinfo_to_dt[i].si_node) &&
+                   !strcmp(si, sysinfo_to_dt[i].si_str))
+                       return &sysinfo_to_dt[i];
+       }
+
+       return NULL;
+}
+
 /**
  * smbios_add_string() - add a string to the string area
  *
@@ -72,15 +135,15 @@ struct smbios_write_method {
  *
  * @ctx:       SMBIOS context
  * @str:       string to add
- * @return:    string number in the string area (1 or more)
+ * Return:     string number in the string area. 0 if str is NULL.
  */
 static int smbios_add_string(struct smbios_ctx *ctx, const char *str)
 {
        int i = 1;
        char *p = ctx->eos;
 
-       if (!*str)
-               str = "Unknown";
+       if (!str)
+               return 0;
 
        for (;;) {
                if (!*p) {
@@ -104,6 +167,42 @@ static int smbios_add_string(struct smbios_ctx *ctx, const char *str)
        }
 }
 
+/**
+ * get_str_from_dt - Get a substring from a DT property.
+ *                   After finding the property in the DT, the function
+ *                   will parse comma-separated values and return the value.
+ *                   If nprop->max exceeds the number of comma-separated
+ *                   elements, the last non NULL value will be returned.
+ *                   Counting starts from zero.
+ *
+ * @nprop: sysinfo property to use
+ * @str: pointer to fill with data
+ * @size: str buffer length
+ */
+static
+void get_str_from_dt(const struct map_sysinfo *nprop, char *str, size_t size)
+{
+       const char *dt_str;
+       int cnt = 0;
+       char *token;
+
+       memset(str, 0, size);
+       if (!nprop || !nprop->max)
+               return;
+
+       dt_str = ofnode_read_string(ofnode_root(), nprop->dt_str);
+       if (!dt_str)
+               return;
+
+       memcpy(str, dt_str, size);
+       token = strtok(str, ",");
+       while (token && cnt < nprop->max) {
+               strlcpy(str, token, strlen(token) + 1);
+               token = strtok(NULL, ",");
+               cnt++;
+       }
+}
+
 /**
  * smbios_add_prop_si() - Add a property from the devicetree or sysinfo
  *
@@ -111,25 +210,47 @@ static int smbios_add_string(struct smbios_ctx *ctx, const char *str)
  *
  * @ctx:       context for writing the tables
  * @prop:      property to write
- * @return 0 if not found, else SMBIOS string number (1 or more)
+ * @sysinfo_id: unique identifier for the string value to be read
+ * @dval:      Default value to use if the string is not found or is empty
+ * Return:     0 if not found, else SMBIOS string number (1 or more)
  */
 static int smbios_add_prop_si(struct smbios_ctx *ctx, const char *prop,
-                             int sysinfo_id)
+                             int sysinfo_id, const char *dval)
 {
+       int ret;
+
+       if (!dval || !*dval)
+               dval = NULL;
+
+       if (!prop)
+               return smbios_add_string(ctx, dval);
+
        if (sysinfo_id && ctx->dev) {
                char val[SMBIOS_STR_MAX];
-               int ret;
 
                ret = sysinfo_get_str(ctx->dev, sysinfo_id, sizeof(val), val);
                if (!ret)
                        return smbios_add_string(ctx, val);
        }
        if (IS_ENABLED(CONFIG_OF_CONTROL)) {
-               const char *str;
+               const char *str = NULL;
+               char str_dt[128] = { 0 };
+               /*
+                * If the node is not valid fallback and try the entire DT
+                * so we can at least fill in manufacturer and board type
+                */
+               if (ofnode_valid(ctx->node)) {
+                       str = ofnode_read_string(ctx->node, prop);
+               } else {
+                       const struct map_sysinfo *nprop;
+
+                       nprop = convert_sysinfo_to_dt(ctx->subnode_name, prop);
+                       get_str_from_dt(nprop, str_dt, sizeof(str_dt));
+                       str = (const char *)str_dt;
+               }
 
-               str = ofnode_read_string(ctx->node, prop);
-               if (str)
-                       return smbios_add_string(ctx, str);
+               ret = smbios_add_string(ctx, str && *str ? str : dval);
+               return ret;
        }
 
        return 0;
@@ -138,12 +259,15 @@ static int smbios_add_prop_si(struct smbios_ctx *ctx, const char *prop,
 /**
  * smbios_add_prop() - Add a property from the devicetree
  *
- * @prop:      property to write
- * @return 0 if not found, else SMBIOS string number (1 or more)
+ * @prop:      property to write. The default string will be written if
+ *             prop is NULL
+ * @dval:      Default value to use if the string is not found or is empty
+ * Return:     0 if not found, else SMBIOS string number (1 or more)
  */
-static int smbios_add_prop(struct smbios_ctx *ctx, const char *prop)
+static int smbios_add_prop(struct smbios_ctx *ctx, const char *prop,
+                          const char *dval)
 {
-       return smbios_add_prop_si(ctx, prop, SYSINFO_ID_NONE);
+       return smbios_add_prop_si(ctx, prop, SYSINFO_ID_NONE, dval);
 }
 
 static void smbios_set_eos(struct smbios_ctx *ctx, char *eos)
@@ -187,10 +311,14 @@ int smbios_update_version(const char *version)
  * This computes the size of the string area including the string terminator.
  *
  * @ctx:       SMBIOS context
- * @return:    string area size
+ * Return:     string area size
  */
 static int smbios_string_table_len(const struct smbios_ctx *ctx)
 {
+       /* In case no string is defined we have to return two \0 */
+       if (ctx->next_ptr == ctx->eos)
+               return 2;
+
        /* Allow for the final \0 after all strings */
        return (ctx->next_ptr + 1) - ctx->eos;
 }
@@ -205,11 +333,9 @@ static int smbios_write_type0(ulong *current, int handle,
        memset(t, 0, sizeof(struct smbios_type0));
        fill_smbios_header(t, SMBIOS_BIOS_INFORMATION, len, handle);
        smbios_set_eos(ctx, t->eos);
-       t->vendor = smbios_add_string(ctx, "U-Boot");
+       t->vendor = smbios_add_prop(ctx, NULL, "U-Boot");
 
-       t->bios_ver = smbios_add_prop(ctx, "version");
-       if (!t->bios_ver)
-               t->bios_ver = smbios_add_string(ctx, PLAIN_VERSION);
+       t->bios_ver = smbios_add_prop(ctx, "version", PLAIN_VERSION);
        if (t->bios_ver)
                gd->smbios_version = ctx->last_str;
        log_debug("smbios_version = %p: '%s'\n", gd->smbios_version,
@@ -218,7 +344,7 @@ static int smbios_write_type0(ulong *current, int handle,
        print_buffer((ulong)gd->smbios_version, gd->smbios_version,
                     1, strlen(gd->smbios_version) + 1, 0);
 #endif
-       t->bios_release_date = smbios_add_string(ctx, U_BOOT_DMI_DATE);
+       t->bios_release_date = smbios_add_prop(ctx, NULL, U_BOOT_DMI_DATE);
 #ifdef CONFIG_ROM_SIZE
        t->bios_rom_size = (CONFIG_ROM_SIZE / 65536) - 1;
 #endif
@@ -229,9 +355,9 @@ static int smbios_write_type0(ulong *current, int handle,
        t->bios_characteristics_ext1 = BIOS_CHARACTERISTICS_EXT1_ACPI;
 #endif
 #ifdef CONFIG_EFI_LOADER
-       t->bios_characteristics_ext1 |= BIOS_CHARACTERISTICS_EXT1_UEFI;
+       t->bios_characteristics_ext2 |= BIOS_CHARACTERISTICS_EXT2_UEFI;
 #endif
-       t->bios_characteristics_ext2 = BIOS_CHARACTERISTICS_EXT2_TARGET;
+       t->bios_characteristics_ext2 |= BIOS_CHARACTERISTICS_EXT2_TARGET;
 
        /* bios_major_release has only one byte, so drop century */
        t->bios_major_release = U_BOOT_VERSION_NUM % 100;
@@ -257,18 +383,20 @@ static int smbios_write_type1(ulong *current, int handle,
        memset(t, 0, sizeof(struct smbios_type1));
        fill_smbios_header(t, SMBIOS_SYSTEM_INFORMATION, len, handle);
        smbios_set_eos(ctx, t->eos);
-       t->manufacturer = smbios_add_prop(ctx, "manufacturer");
-       t->product_name = smbios_add_prop(ctx, "product");
+       t->manufacturer = smbios_add_prop(ctx, "manufacturer", NULL);
+       t->product_name = smbios_add_prop(ctx, "product", NULL);
        t->version = smbios_add_prop_si(ctx, "version",
-                                       SYSINFO_ID_SMBIOS_SYSTEM_VERSION);
+                                       SYSINFO_ID_SMBIOS_SYSTEM_VERSION,
+                                       NULL);
        if (serial_str) {
-               t->serial_number = smbios_add_string(ctx, serial_str);
+               t->serial_number = smbios_add_prop(ctx, NULL, serial_str);
                strncpy((char *)t->uuid, serial_str, sizeof(t->uuid));
        } else {
-               t->serial_number = smbios_add_prop(ctx, "serial");
+               t->serial_number = smbios_add_prop(ctx, "serial", NULL);
        }
-       t->sku_number = smbios_add_prop(ctx, "sku");
-       t->family = smbios_add_prop(ctx, "family");
+       t->wakeup_type = SMBIOS_WAKEUP_TYPE_UNKNOWN;
+       t->sku_number = smbios_add_prop(ctx, "sku", NULL);
+       t->family = smbios_add_prop(ctx, "family", NULL);
 
        len = t->length + smbios_string_table_len(ctx);
        *current += len;
@@ -287,13 +415,15 @@ static int smbios_write_type2(ulong *current, int handle,
        memset(t, 0, sizeof(struct smbios_type2));
        fill_smbios_header(t, SMBIOS_BOARD_INFORMATION, len, handle);
        smbios_set_eos(ctx, t->eos);
-       t->manufacturer = smbios_add_prop(ctx, "manufacturer");
-       t->product_name = smbios_add_prop(ctx, "product");
+       t->manufacturer = smbios_add_prop(ctx, "manufacturer", NULL);
+       t->product_name = smbios_add_prop(ctx, "product", NULL);
        t->version = smbios_add_prop_si(ctx, "version",
-                                       SYSINFO_ID_SMBIOS_BASEBOARD_VERSION);
-       t->asset_tag_number = smbios_add_prop(ctx, "asset-tag");
+                                       SYSINFO_ID_SMBIOS_BASEBOARD_VERSION,
+                                       NULL);
+       t->asset_tag_number = smbios_add_prop(ctx, "asset-tag", NULL);
        t->feature_flags = SMBIOS_BOARD_FEATURE_HOSTING;
        t->board_type = SMBIOS_BOARD_MOTHERBOARD;
+       t->chassis_handle = handle + 1;
 
        len = t->length + smbios_string_table_len(ctx);
        *current += len;
@@ -312,7 +442,7 @@ static int smbios_write_type3(ulong *current, int handle,
        memset(t, 0, sizeof(struct smbios_type3));
        fill_smbios_header(t, SMBIOS_SYSTEM_ENCLOSURE, len, handle);
        smbios_set_eos(ctx, t->eos);
-       t->manufacturer = smbios_add_prop(ctx, "manufacturer");
+       t->manufacturer = smbios_add_prop(ctx, "manufacturer", NULL);
        t->chassis_type = SMBIOS_ENCLOSURE_DESKTOP;
        t->bootup_state = SMBIOS_STATE_SAFE;
        t->power_supply_state = SMBIOS_STATE_SAFE;
@@ -330,8 +460,8 @@ static void smbios_write_type4_dm(struct smbios_type4 *t,
                                  struct smbios_ctx *ctx)
 {
        u16 processor_family = SMBIOS_PROCESSOR_FAMILY_UNKNOWN;
-       const char *vendor = "Unknown";
-       const char *name = "Unknown";
+       const char *vendor = NULL;
+       const char *name = NULL;
 
 #ifdef CONFIG_CPU
        char processor_name[49];
@@ -354,9 +484,10 @@ static void smbios_write_type4_dm(struct smbios_type4 *t,
        }
 #endif
 
-       t->processor_family = processor_family;
-       t->processor_manufacturer = smbios_add_string(ctx, vendor);
-       t->processor_version = smbios_add_string(ctx, name);
+       t->processor_family = 0xfe;
+       t->processor_family2 = processor_family;
+       t->processor_manufacturer = smbios_add_prop(ctx, NULL, vendor);
+       t->processor_version = smbios_add_prop(ctx, NULL, name);
 }
 
 static int smbios_write_type4(ulong *current, int handle,
@@ -376,7 +507,6 @@ static int smbios_write_type4(ulong *current, int handle,
        t->l1_cache_handle = 0xffff;
        t->l2_cache_handle = 0xffff;
        t->l3_cache_handle = 0xffff;
-       t->processor_family2 = t->processor_family;
 
        len = t->length + smbios_string_table_len(ctx);
        *current += len;
@@ -422,6 +552,7 @@ static struct smbios_write_method smbios_write_funcs[] = {
        { smbios_write_type0, "bios", },
        { smbios_write_type1, "system", },
        { smbios_write_type2, "baseboard", },
+       /* Type 3 must immediately follow type 2 due to chassis handle. */
        { smbios_write_type3, "chassis", },
        { smbios_write_type4, },
        { smbios_write_type32, },
@@ -431,15 +562,12 @@ static struct smbios_write_method smbios_write_funcs[] = {
 ulong write_smbios_table(ulong addr)
 {
        ofnode parent_node = ofnode_null();
-       struct smbios_entry *se;
+       ulong table_addr, start_addr;
+       struct smbios3_entry *se;
        struct smbios_ctx ctx;
-       ulong table_addr;
        ulong tables;
        int len = 0;
-       int max_struct_size = 0;
        int handle = 0;
-       char *istart;
-       int isize;
        int i;
 
        ctx.node = ofnode_null();
@@ -451,63 +579,46 @@ ulong write_smbios_table(ulong addr)
                ctx.dev = NULL;
        }
 
-       /* 16 byte align the table address */
-       addr = ALIGN(addr, 16);
-
-       se = map_sysmem(addr, sizeof(struct smbios_entry));
-       memset(se, 0, sizeof(struct smbios_entry));
+       start_addr = addr;
 
-       addr += sizeof(struct smbios_entry);
-       addr = ALIGN(addr, 16);
+       /* move past the (so-far-unwritten) header to start writing structs */
+       addr = ALIGN(addr + sizeof(struct smbios3_entry), 16);
        tables = addr;
 
        /* populate minimum required tables */
        for (i = 0; i < ARRAY_SIZE(smbios_write_funcs); i++) {
                const struct smbios_write_method *method;
-               int tmp;
 
                method = &smbios_write_funcs[i];
-               if (IS_ENABLED(CONFIG_OF_CONTROL) && method->subnode_name)
-                       ctx.node = ofnode_find_subnode(parent_node,
-                                                      method->subnode_name);
-               tmp = method->write((ulong *)&addr, handle++, &ctx);
-
-               max_struct_size = max(max_struct_size, tmp);
-               len += tmp;
+               ctx.subnode_name = NULL;
+               if (method->subnode_name) {
+                       ctx.subnode_name = method->subnode_name;
+                       if (IS_ENABLED(CONFIG_OF_CONTROL))
+                               ctx.node = ofnode_find_subnode(parent_node,
+                                                              method->subnode_name);
+               }
+               len += method->write((ulong *)&addr, handle++, &ctx);
        }
 
-       memcpy(se->anchor, "_SM_", 4);
-       se->length = sizeof(struct smbios_entry);
-       se->major_ver = SMBIOS_MAJOR_VER;
-       se->minor_ver = SMBIOS_MINOR_VER;
-       se->max_struct_size = max_struct_size;
-       memcpy(se->intermediate_anchor, "_DMI_", 5);
-       se->struct_table_length = len;
-
        /*
         * We must use a pointer here so things work correctly on sandbox. The
         * user of this table is not aware of the mapping of addresses to
         * sandbox's DRAM buffer.
         */
        table_addr = (ulong)map_sysmem(tables, 0);
-       if (sizeof(table_addr) > sizeof(u32) && table_addr > (ulong)UINT_MAX) {
-               /*
-                * We need to put this >32-bit pointer into the table but the
-                * field is only 32 bits wide.
-                */
-               printf("WARNING: SMBIOS table_address overflow %llx\n",
-                      (unsigned long long)table_addr);
-               table_addr = 0;
-       }
-       se->struct_table_address = table_addr;
-
-       se->struct_count = handle;
 
-       /* calculate checksums */
-       istart = (char *)se + SMBIOS_INTERMEDIATE_OFFSET;
-       isize = sizeof(struct smbios_entry) - SMBIOS_INTERMEDIATE_OFFSET;
-       se->intermediate_checksum = table_compute_checksum(istart, isize);
-       se->checksum = table_compute_checksum(se, sizeof(struct smbios_entry));
+       /* now go back and write the SMBIOS3 header */
+       se = map_sysmem(start_addr, sizeof(struct smbios3_entry));
+       memset(se, '\0', sizeof(struct smbios3_entry));
+       memcpy(se->anchor, "_SM3_", 5);
+       se->length = sizeof(struct smbios3_entry);
+       se->major_ver = SMBIOS_MAJOR_VER;
+       se->minor_ver = SMBIOS_MINOR_VER;
+       se->doc_rev = 0;
+       se->entry_point_rev = 1;
+       se->table_maximum_size = len;
+       se->struct_table_address = table_addr;
+       se->checksum = table_compute_checksum(se, sizeof(struct smbios3_entry));
        unmap_sysmem(se);
 
        return addr;