Merge tag 'efi-2019-07-rc3-3' of git://git.denx.de/u-boot-efi
[oweals/u-boot.git] / lib / efi_loader / efi_variable.c
index cfb3168e779190fbbbc0e66bf53397e7011385eb..50bc10537f404002f6927d1cce0133a797ea9fd2 100644 (file)
@@ -9,6 +9,9 @@
 #include <charset.h>
 #include <efi_loader.h>
 #include <hexdump.h>
+#include <environment.h>
+#include <search.h>
+#include <uuid.h>
 
 #define READ_ONLY BIT(31)
 
@@ -177,7 +180,7 @@ efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
        if (ret)
                return EFI_EXIT(ret);
 
-       debug("%s: get '%s'\n", __func__, native_name);
+       EFI_PRINT("get '%s'\n", native_name);
 
        val = env_get(native_name);
        free(native_name);
@@ -199,8 +202,10 @@ efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
                len /= 2;
                *data_size = len;
 
-               if (in_size < len)
-                       return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
+               if (in_size < len) {
+                       ret = EFI_BUFFER_TOO_SMALL;
+                       goto out;
+               }
 
                if (!data)
                        return EFI_EXIT(EFI_INVALID_PARAMETER);
@@ -208,14 +213,16 @@ efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
                if (hex2bin(data, s, len))
                        return EFI_EXIT(EFI_DEVICE_ERROR);
 
-               debug("%s: got value: \"%s\"\n", __func__, s);
+               EFI_PRINT("got value: \"%s\"\n", s);
        } else if ((s = prefix(val, "(utf8)"))) {
                unsigned len = strlen(s) + 1;
 
                *data_size = len;
 
-               if (in_size < len)
-                       return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
+               if (in_size < len) {
+                       ret = EFI_BUFFER_TOO_SMALL;
+                       goto out;
+               }
 
                if (!data)
                        return EFI_EXIT(EFI_INVALID_PARAMETER);
@@ -223,40 +230,175 @@ efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
                memcpy(data, s, len);
                ((char *)data)[len] = '\0';
 
-               debug("%s: got value: \"%s\"\n", __func__, (char *)data);
+               EFI_PRINT("got value: \"%s\"\n", (char *)data);
        } else {
-               debug("%s: invalid value: '%s'\n", __func__, val);
+               EFI_PRINT("invalid value: '%s'\n", val);
                return EFI_EXIT(EFI_DEVICE_ERROR);
        }
 
+out:
        if (attributes)
                *attributes = attr & EFI_VARIABLE_MASK;
 
-       return EFI_EXIT(EFI_SUCCESS);
+       return EFI_EXIT(ret);
+}
+
+static char *efi_variables_list;
+static char *efi_cur_variable;
+
+/**
+ * parse_uboot_variable() - parse a u-boot variable and get uefi-related
+ *                         information
+ * @variable:          whole data of u-boot variable (ie. name=value)
+ * @variable_name_size: size of variable_name buffer in byte
+ * @variable_name:     name of uefi variable in u16, null-terminated
+ * @vendor:            vendor's guid
+ * @attributes:                attributes
+ *
+ * A uefi variable is encoded into a u-boot variable as described above.
+ * This function parses such a u-boot variable and retrieve uefi-related
+ * information into respective parameters. In return, variable_name_size
+ * is the size of variable name including NULL.
+ *
+ * Return:             EFI_SUCCESS if parsing is OK, EFI_NOT_FOUND when
+                       the entire variable list has been returned,
+                       otherwise non-zero status code
+ */
+static efi_status_t parse_uboot_variable(char *variable,
+                                        efi_uintn_t *variable_name_size,
+                                        u16 *variable_name,
+                                        const efi_guid_t *vendor,
+                                        u32 *attributes)
+{
+       char *guid, *name, *end, c;
+       unsigned long name_len;
+       u16 *p;
+
+       guid = strchr(variable, '_');
+       if (!guid)
+               return EFI_INVALID_PARAMETER;
+       guid++;
+       name = strchr(guid, '_');
+       if (!name)
+               return EFI_INVALID_PARAMETER;
+       name++;
+       end = strchr(name, '=');
+       if (!end)
+               return EFI_INVALID_PARAMETER;
+
+       name_len = end - name;
+       if (*variable_name_size < (name_len + 1)) {
+               *variable_name_size = name_len + 1;
+               return EFI_BUFFER_TOO_SMALL;
+       }
+       end++; /* point to value */
+
+       /* variable name */
+       p = variable_name;
+       utf8_utf16_strncpy(&p, name, name_len);
+       variable_name[name_len] = 0;
+       *variable_name_size = name_len + 1;
+
+       /* guid */
+       c = *(name - 1);
+       *(name - 1) = '\0'; /* guid need be null-terminated here */
+       uuid_str_to_bin(guid, (unsigned char *)vendor, UUID_STR_FORMAT_GUID);
+       *(name - 1) = c;
+
+       /* attributes */
+       parse_attr(end, attributes);
+
+       return EFI_SUCCESS;
 }
 
 /**
- * efi_efi_get_next_variable() - get next UEFI variable
+ * efi_get_next_variable_name() - enumerate the current variable names
+ * @variable_name_size:        size of variable_name buffer in byte
+ * @variable_name:     name of uefi variable's name in u16
+ * @vendor:            vendor's guid
  *
- * This function implements the GetNextVariable runtime service.
+ * This function implements the GetNextVariableName service.
  *
  * See the Unified Extensible Firmware Interface (UEFI) specification for
- * details.
+ * details: http://wiki.phoenix.com/wiki/index.php/
+ *             EFI_RUNTIME_SERVICES#GetNextVariableName.28.29
  *
- * @variable_name_size:        on entry size of the buffer for the variable name, on
- *                     exit the length of the name of the next variable
- * @variable_name:     on entry name of the current variable, on exit the name
- *                     of the next variable
- * @vendor:            vendor GUID
- * Return:             status code
+ * Return: status code
  */
 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
                                               u16 *variable_name,
                                               const efi_guid_t *vendor)
 {
+       char *native_name, *variable;
+       ssize_t name_len, list_len;
+       char regex[256];
+       char * const regexlist[] = {regex};
+       u32 attributes;
+       int i;
+       efi_status_t ret;
+
        EFI_ENTRY("%p \"%ls\" %pUl", variable_name_size, variable_name, vendor);
 
-       return EFI_EXIT(EFI_DEVICE_ERROR);
+       if (!variable_name_size || !variable_name || !vendor)
+               return EFI_EXIT(EFI_INVALID_PARAMETER);
+
+       if (variable_name[0]) {
+               /* check null-terminated string */
+               for (i = 0; i < *variable_name_size; i++)
+                       if (!variable_name[i])
+                               break;
+               if (i >= *variable_name_size)
+                       return EFI_EXIT(EFI_INVALID_PARAMETER);
+
+               /* search for the last-returned variable */
+               ret = efi_to_native(&native_name, variable_name, vendor);
+               if (ret)
+                       return EFI_EXIT(ret);
+
+               name_len = strlen(native_name);
+               for (variable = efi_variables_list; variable && *variable;) {
+                       if (!strncmp(variable, native_name, name_len) &&
+                           variable[name_len] == '=')
+                               break;
+
+                       variable = strchr(variable, '\n');
+                       if (variable)
+                               variable++;
+               }
+
+               free(native_name);
+               if (!(variable && *variable))
+                       return EFI_EXIT(EFI_INVALID_PARAMETER);
+
+               /* next variable */
+               variable = strchr(variable, '\n');
+               if (variable)
+                       variable++;
+               if (!(variable && *variable))
+                       return EFI_EXIT(EFI_NOT_FOUND);
+       } else {
+               /*
+                *new search: free a list used in the previous search
+                */
+               free(efi_variables_list);
+               efi_variables_list = NULL;
+               efi_cur_variable = NULL;
+
+               snprintf(regex, 256, "efi_.*-.*-.*-.*-.*_.*");
+               list_len = hexport_r(&env_htab, '\n',
+                                    H_MATCH_REGEX | H_MATCH_KEY,
+                                    &efi_variables_list, 0, 1, regexlist);
+               /* 1 indicates that no match was found */
+               if (list_len <= 1)
+                       return EFI_EXIT(EFI_NOT_FOUND);
+
+               variable = efi_variables_list;
+       }
+
+       ret = parse_uboot_variable(variable, variable_name_size, variable_name,
+                                  vendor, &attributes);
+
+       return EFI_EXIT(ret);
 }
 
 /**
@@ -285,7 +427,9 @@ efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
        EFI_ENTRY("\"%ls\" %pUl %x %zu %p", variable_name, vendor, attributes,
                  data_size, data);
 
-       if (!variable_name || !vendor) {
+       /* TODO: implement APPEND_WRITE */
+       if (!variable_name || !vendor ||
+           (attributes & EFI_VARIABLE_APPEND_WRITE)) {
                ret = EFI_INVALID_PARAMETER;
                goto out;
        }
@@ -307,12 +451,21 @@ efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
        if (val) {
                parse_attr(val, &attr);
 
+               /* We should not free val */
+               val = NULL;
                if (attr & READ_ONLY) {
-                       /* We should not free val */
-                       val = NULL;
                        ret = EFI_WRITE_PROTECTED;
                        goto out;
                }
+
+               /*
+                * attributes won't be changed
+                * TODO: take care of APPEND_WRITE once supported
+                */
+               if (attr != attributes) {
+                       ret = EFI_INVALID_PARAMETER;
+                       goto out;
+               }
        }
 
        val = malloc(2 * data_size + strlen("{ro,run,boot}(blob)") + 1);
@@ -348,7 +501,7 @@ efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
        s = bin2hex(s, data, data_size);
        *s = '\0';
 
-       debug("%s: setting: %s=%s\n", __func__, native_name, val);
+       EFI_PRINT("setting: %s=%s\n", native_name, val);
 
        if (env_set(native_name, val))
                ret = EFI_DEVICE_ERROR;