Convert CONFIG_STANDALONE_LOAD_ADDR to Kconfig
[platform/kernel/u-boot.git] / lib / smbios.c
index e8ee55c..d7f4999 100644 (file)
  */
 
 #include <common.h>
+#include <dm.h>
+#include <env.h>
+#include <linux/stringify.h>
 #include <mapmem.h>
 #include <smbios.h>
+#include <sysinfo.h>
 #include <tables_csum.h>
 #include <version.h>
 #ifdef CONFIG_CPU
 #include <cpu.h>
-#include <dm.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 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
+ */
+struct smbios_ctx {
+       ofnode node;
+       struct udevice *dev;
+       char *eos;
+       char *next_ptr;
+       char *last_str;
+};
+
+/**
+ * Function prototype to write a specific type of SMBIOS structure
+ *
+ * @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
+ */
+typedef int (*smbios_write_type)(ulong *addr, int handle,
+                                struct smbios_ctx *ctx);
+
+/**
+ * struct smbios_write_method - Information about a table-writing function
+ *
+ * @write: Function to call
+ * @subnode_name: Name of subnode which has the information for this function,
+ *     NULL if none
+ */
+struct smbios_write_method {
+       smbios_write_type write;
+       const char *subnode_name;
+};
+
 /**
  * smbios_add_string() - add a string to the string area
  *
  * This adds a string to the string area which is appended directly after
  * the formatted portion of an SMBIOS structure.
  *
- * @start:     string area start address
+ * @ctx:       SMBIOS context
  * @str:       string to add
- * @return:    string number in the string area
+ * Return:     string number in the string area (1 or more)
  */
-static int smbios_add_string(char *start, const char *str)
+static int smbios_add_string(struct smbios_ctx *ctx, const char *str)
 {
        int i = 1;
-       char *p = start;
+       char *p = ctx->eos;
+
+       if (!*str)
+               str = "Unknown";
 
        for (;;) {
                if (!*p) {
+                       ctx->last_str = p;
                        strcpy(p, str);
                        p += strlen(str);
                        *p++ = '\0';
+                       ctx->next_ptr = p;
                        *p++ = '\0';
 
                        return i;
                }
 
-               if (!strcmp(p, str))
+               if (!strcmp(p, str)) {
+                       ctx->last_str = p;
                        return i;
+               }
 
                p += strlen(p) + 1;
                i++;
@@ -50,28 +128,98 @@ static int smbios_add_string(char *start, const char *str)
 }
 
 /**
- * smbios_string_table_len() - compute the string area size
+ * smbios_add_prop_si() - Add a property from the devicetree or sysinfo
  *
- * This computes the size of the string area including the string terminator.
+ * Sysinfo is used if available, with a fallback to devicetree
  *
- * @start:     string area start address
- * @return:    string area size
+ * @ctx:       context for writing the tables
+ * @prop:      property to write
+ * Return:     0 if not found, else SMBIOS string number (1 or more)
  */
-static int smbios_string_table_len(char *start)
+static int smbios_add_prop_si(struct smbios_ctx *ctx, const char *prop,
+                             int sysinfo_id)
 {
-       char *p = start;
-       int i, len = 0;
+       if (sysinfo_id && ctx->dev) {
+               char val[SMBIOS_STR_MAX];
+               int ret;
 
-       while (*p) {
-               i = strlen(p) + 1;
-               p += i;
-               len += i;
+               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;
+
+               str = ofnode_read_string(ctx->node, prop);
+               if (str)
+                       return smbios_add_string(ctx, str);
+       }
+
+       return 0;
+}
+
+/**
+ * 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)
+ */
+static int smbios_add_prop(struct smbios_ctx *ctx, const char *prop)
+{
+       return smbios_add_prop_si(ctx, prop, SYSINFO_ID_NONE);
+}
+
+static void smbios_set_eos(struct smbios_ctx *ctx, char *eos)
+{
+       ctx->eos = eos;
+       ctx->next_ptr = eos;
+       ctx->last_str = NULL;
+}
+
+int smbios_update_version(const char *version)
+{
+       char *ptr = gd->smbios_version;
+       uint old_len, len;
+
+       if (!ptr)
+               return log_ret(-ENOENT);
+
+       /*
+        * This string is supposed to have at least enough bytes and is
+        * padded with spaces. Update it, taking care not to move the
+        * \0 terminator, so that other strings in the string table
+        * are not disturbed. See smbios_add_string()
+        */
+       old_len = strnlen(ptr, SMBIOS_STR_MAX);
+       len = strnlen(version, SMBIOS_STR_MAX);
+       if (len > old_len)
+               return log_ret(-ENOSPC);
+
+       log_debug("Replacing SMBIOS type 0 version string '%s'\n", ptr);
+       memcpy(ptr, version, len);
+#ifdef LOG_DEBUG
+       print_buffer((ulong)ptr, ptr, 1, old_len + 1, 0);
+#endif
 
-       return len + 1;
+       return 0;
 }
 
-static int smbios_write_type0(ulong *current, int handle)
+/**
+ * smbios_string_table_len() - compute the string area size
+ *
+ * This computes the size of the string area including the string terminator.
+ *
+ * @ctx:       SMBIOS context
+ * Return:     string area size
+ */
+static int smbios_string_table_len(const struct smbios_ctx *ctx)
+{
+       /* Allow for the final \0 after all strings */
+       return (ctx->next_ptr + 1) - ctx->eos;
+}
+
+static int smbios_write_type0(ulong *current, int handle,
+                             struct smbios_ctx *ctx)
 {
        struct smbios_type0 *t;
        int len = sizeof(struct smbios_type0);
@@ -79,9 +227,21 @@ static int smbios_write_type0(ulong *current, int handle)
        t = map_sysmem(*current, len);
        memset(t, 0, sizeof(struct smbios_type0));
        fill_smbios_header(t, SMBIOS_BIOS_INFORMATION, len, handle);
-       t->vendor = smbios_add_string(t->eos, "U-Boot");
-       t->bios_ver = smbios_add_string(t->eos, PLAIN_VERSION);
-       t->bios_release_date = smbios_add_string(t->eos, U_BOOT_DMI_DATE);
+       smbios_set_eos(ctx, t->eos);
+       t->vendor = smbios_add_string(ctx, "U-Boot");
+
+       t->bios_ver = smbios_add_prop(ctx, "version");
+       if (!t->bios_ver)
+               t->bios_ver = smbios_add_string(ctx, PLAIN_VERSION);
+       if (t->bios_ver)
+               gd->smbios_version = ctx->last_str;
+       log_debug("smbios_version = %p: '%s'\n", gd->smbios_version,
+                 gd->smbios_version);
+#ifdef LOG_DEBUG
+       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);
 #ifdef CONFIG_ROM_SIZE
        t->bios_rom_size = (CONFIG_ROM_SIZE / 65536) - 1;
 #endif
@@ -92,23 +252,25 @@ 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;
 
-       t->bios_major_release = 0xff;
-       t->bios_minor_release = 0xff;
+       /* bios_major_release has only one byte, so drop century */
+       t->bios_major_release = U_BOOT_VERSION_NUM % 100;
+       t->bios_minor_release = U_BOOT_VERSION_NUM_PATCH;
        t->ec_major_release = 0xff;
        t->ec_minor_release = 0xff;
 
-       len = t->length + smbios_string_table_len(t->eos);
+       len = t->length + smbios_string_table_len(ctx);
        *current += len;
        unmap_sysmem(t);
 
        return len;
 }
 
-static int smbios_write_type1(ulong *current, int handle)
+static int smbios_write_type1(ulong *current, int handle,
+                             struct smbios_ctx *ctx)
 {
        struct smbios_type1 *t;
        int len = sizeof(struct smbios_type1);
@@ -117,21 +279,33 @@ static int smbios_write_type1(ulong *current, int handle)
        t = map_sysmem(*current, len);
        memset(t, 0, sizeof(struct smbios_type1));
        fill_smbios_header(t, SMBIOS_SYSTEM_INFORMATION, len, handle);
-       t->manufacturer = smbios_add_string(t->eos, CONFIG_SMBIOS_MANUFACTURER);
-       t->product_name = smbios_add_string(t->eos, CONFIG_SMBIOS_PRODUCT_NAME);
+       smbios_set_eos(ctx, t->eos);
+       t->manufacturer = smbios_add_prop(ctx, "manufacturer");
+       if (!t->manufacturer)
+               t->manufacturer = smbios_add_string(ctx, "Unknown");
+       t->product_name = smbios_add_prop(ctx, "product");
+       if (!t->product_name)
+               t->product_name = smbios_add_string(ctx, "Unknown Product");
+       t->version = smbios_add_prop_si(ctx, "version",
+                                       SYSINFO_ID_SMBIOS_SYSTEM_VERSION);
        if (serial_str) {
+               t->serial_number = smbios_add_string(ctx, serial_str);
                strncpy((char *)t->uuid, serial_str, sizeof(t->uuid));
-               t->serial_number = smbios_add_string(t->eos, serial_str);
+       } else {
+               t->serial_number = smbios_add_prop(ctx, "serial");
        }
+       t->sku_number = smbios_add_prop(ctx, "sku");
+       t->family = smbios_add_prop(ctx, "family");
 
-       len = t->length + smbios_string_table_len(t->eos);
+       len = t->length + smbios_string_table_len(ctx);
        *current += len;
        unmap_sysmem(t);
 
        return len;
 }
 
-static int smbios_write_type2(ulong *current, int handle)
+static int smbios_write_type2(ulong *current, int handle,
+                             struct smbios_ctx *ctx)
 {
        struct smbios_type2 *t;
        int len = sizeof(struct smbios_type2);
@@ -139,19 +313,28 @@ static int smbios_write_type2(ulong *current, int handle)
        t = map_sysmem(*current, len);
        memset(t, 0, sizeof(struct smbios_type2));
        fill_smbios_header(t, SMBIOS_BOARD_INFORMATION, len, handle);
-       t->manufacturer = smbios_add_string(t->eos, CONFIG_SMBIOS_MANUFACTURER);
-       t->product_name = smbios_add_string(t->eos, CONFIG_SMBIOS_PRODUCT_NAME);
+       smbios_set_eos(ctx, t->eos);
+       t->manufacturer = smbios_add_prop(ctx, "manufacturer");
+       if (!t->manufacturer)
+               t->manufacturer = smbios_add_string(ctx, "Unknown");
+       t->product_name = smbios_add_prop(ctx, "product");
+       if (!t->product_name)
+               t->product_name = smbios_add_string(ctx, "Unknown Product");
+       t->version = smbios_add_prop_si(ctx, "version",
+                                       SYSINFO_ID_SMBIOS_BASEBOARD_VERSION);
+       t->asset_tag_number = smbios_add_prop(ctx, "asset-tag");
        t->feature_flags = SMBIOS_BOARD_FEATURE_HOSTING;
        t->board_type = SMBIOS_BOARD_MOTHERBOARD;
 
-       len = t->length + smbios_string_table_len(t->eos);
+       len = t->length + smbios_string_table_len(ctx);
        *current += len;
        unmap_sysmem(t);
 
        return len;
 }
 
-static int smbios_write_type3(ulong *current, int handle)
+static int smbios_write_type3(ulong *current, int handle,
+                             struct smbios_ctx *ctx)
 {
        struct smbios_type3 *t;
        int len = sizeof(struct smbios_type3);
@@ -159,21 +342,25 @@ static int smbios_write_type3(ulong *current, int handle)
        t = map_sysmem(*current, len);
        memset(t, 0, sizeof(struct smbios_type3));
        fill_smbios_header(t, SMBIOS_SYSTEM_ENCLOSURE, len, handle);
-       t->manufacturer = smbios_add_string(t->eos, CONFIG_SMBIOS_MANUFACTURER);
+       smbios_set_eos(ctx, t->eos);
+       t->manufacturer = smbios_add_prop(ctx, "manufacturer");
+       if (!t->manufacturer)
+               t->manufacturer = smbios_add_string(ctx, "Unknown");
        t->chassis_type = SMBIOS_ENCLOSURE_DESKTOP;
        t->bootup_state = SMBIOS_STATE_SAFE;
        t->power_supply_state = SMBIOS_STATE_SAFE;
        t->thermal_state = SMBIOS_STATE_SAFE;
        t->security_status = SMBIOS_SECURITY_NONE;
 
-       len = t->length + smbios_string_table_len(t->eos);
+       len = t->length + smbios_string_table_len(ctx);
        *current += len;
        unmap_sysmem(t);
 
        return len;
 }
 
-static void smbios_write_type4_dm(struct smbios_type4 *t)
+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";
@@ -182,30 +369,31 @@ static void smbios_write_type4_dm(struct smbios_type4 *t)
 #ifdef CONFIG_CPU
        char processor_name[49];
        char vendor_name[49];
-       struct udevice *dev = NULL;
+       struct udevice *cpu = NULL;
 
-       uclass_find_first_device(UCLASS_CPU, &dev);
-       if (dev) {
-               struct cpu_platdata *plat = dev_get_parent_platdata(dev);
+       uclass_find_first_device(UCLASS_CPU, &cpu);
+       if (cpu) {
+               struct cpu_plat *plat = dev_get_parent_plat(cpu);
 
                if (plat->family)
                        processor_family = plat->family;
                t->processor_id[0] = plat->id[0];
                t->processor_id[1] = plat->id[1];
 
-               if (!cpu_get_vendor(dev, vendor_name, sizeof(vendor_name)))
+               if (!cpu_get_vendor(cpu, vendor_name, sizeof(vendor_name)))
                        vendor = vendor_name;
-               if (!cpu_get_desc(dev, processor_name, sizeof(processor_name)))
+               if (!cpu_get_desc(cpu, processor_name, sizeof(processor_name)))
                        name = processor_name;
        }
 #endif
 
        t->processor_family = processor_family;
-       t->processor_manufacturer = smbios_add_string(t->eos, vendor);
-       t->processor_version = smbios_add_string(t->eos, name);
+       t->processor_manufacturer = smbios_add_string(ctx, vendor);
+       t->processor_version = smbios_add_string(ctx, name);
 }
 
-static int smbios_write_type4(ulong *current, int handle)
+static int smbios_write_type4(ulong *current, int handle,
+                             struct smbios_ctx *ctx)
 {
        struct smbios_type4 *t;
        int len = sizeof(struct smbios_type4);
@@ -213,8 +401,9 @@ static int smbios_write_type4(ulong *current, int handle)
        t = map_sysmem(*current, len);
        memset(t, 0, sizeof(struct smbios_type4));
        fill_smbios_header(t, SMBIOS_PROCESSOR_INFORMATION, len, handle);
+       smbios_set_eos(ctx, t->eos);
        t->processor_type = SMBIOS_PROCESSOR_TYPE_CENTRAL;
-       smbios_write_type4_dm(t);
+       smbios_write_type4_dm(t, ctx);
        t->status = SMBIOS_PROCESSOR_STATUS_ENABLED;
        t->processor_upgrade = SMBIOS_PROCESSOR_UPGRADE_NONE;
        t->l1_cache_handle = 0xffff;
@@ -222,14 +411,15 @@ static int smbios_write_type4(ulong *current, int handle)
        t->l3_cache_handle = 0xffff;
        t->processor_family2 = t->processor_family;
 
-       len = t->length + smbios_string_table_len(t->eos);
+       len = t->length + smbios_string_table_len(ctx);
        *current += len;
        unmap_sysmem(t);
 
        return len;
 }
 
-static int smbios_write_type32(ulong *current, int handle)
+static int smbios_write_type32(ulong *current, int handle,
+                              struct smbios_ctx *ctx)
 {
        struct smbios_type32 *t;
        int len = sizeof(struct smbios_type32);
@@ -237,6 +427,7 @@ static int smbios_write_type32(ulong *current, int handle)
        t = map_sysmem(*current, len);
        memset(t, 0, sizeof(struct smbios_type32));
        fill_smbios_header(t, SMBIOS_SYSTEM_BOOT_INFORMATION, len, handle);
+       smbios_set_eos(ctx, t->eos);
 
        *current += len;
        unmap_sysmem(t);
@@ -244,7 +435,8 @@ static int smbios_write_type32(ulong *current, int handle)
        return len;
 }
 
-static int smbios_write_type127(ulong *current, int handle)
+static int smbios_write_type127(ulong *current, int handle,
+                               struct smbios_ctx *ctx)
 {
        struct smbios_type127 *t;
        int len = sizeof(struct smbios_type127);
@@ -259,19 +451,21 @@ static int smbios_write_type127(ulong *current, int handle)
        return len;
 }
 
-static smbios_write_type smbios_write_funcs[] = {
-       smbios_write_type0,
-       smbios_write_type1,
-       smbios_write_type2,
-       smbios_write_type3,
-       smbios_write_type4,
-       smbios_write_type32,
-       smbios_write_type127
+static struct smbios_write_method smbios_write_funcs[] = {
+       { smbios_write_type0, "bios", },
+       { smbios_write_type1, "system", },
+       { smbios_write_type2, "baseboard", },
+       { smbios_write_type3, "chassis", },
+       { smbios_write_type4, },
+       { smbios_write_type32, },
+       { smbios_write_type127 },
 };
 
 ulong write_smbios_table(ulong addr)
 {
+       ofnode parent_node = ofnode_null();
        struct smbios_entry *se;
+       struct smbios_ctx ctx;
        ulong table_addr;
        ulong tables;
        int len = 0;
@@ -281,6 +475,15 @@ ulong write_smbios_table(ulong addr)
        int isize;
        int i;
 
+       ctx.node = ofnode_null();
+       if (IS_ENABLED(CONFIG_OF_CONTROL)) {
+               uclass_first_device(UCLASS_SYSINFO, &ctx.dev);
+               if (ctx.dev)
+                       parent_node = dev_read_subnode(ctx.dev, "smbios");
+       } else {
+               ctx.dev = NULL;
+       }
+
        /* 16 byte align the table address */
        addr = ALIGN(addr, 16);
 
@@ -293,7 +496,14 @@ ulong write_smbios_table(ulong addr)
 
        /* populate minimum required tables */
        for (i = 0; i < ARRAY_SIZE(smbios_write_funcs); i++) {
-               int tmp = smbios_write_funcs[i]((ulong *)&addr, handle++);
+               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;
@@ -320,7 +530,8 @@ ulong write_smbios_table(ulong addr)
                 */
                printf("WARNING: SMBIOS table_address overflow %llx\n",
                       (unsigned long long)table_addr);
-               table_addr = 0;
+               addr = 0;
+               goto out;
        }
        se->struct_table_address = table_addr;
 
@@ -331,6 +542,7 @@ ulong write_smbios_table(ulong addr)
        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));
+out:
        unmap_sysmem(se);
 
        return addr;