efi_loader: use log function in boot manager
[platform/kernel/u-boot.git] / lib / efi_loader / efi_bootmgr.c
index b2102c5..e268e9c 100644 (file)
@@ -5,8 +5,11 @@
  *  Copyright (c) 2017 Rob Clark
  */
 
+#define LOG_CATEGORY LOGC_EFI
+
 #include <common.h>
 #include <charset.h>
+#include <log.h>
 #include <malloc.h>
 #include <efi_loader.h>
 #include <asm/unaligned.h>
@@ -27,29 +30,68 @@ static const struct efi_runtime_services *rs;
  */
 
 
-/* Parse serialized data and transform it into efi_load_option structure */
-void efi_deserialize_load_option(struct efi_load_option *lo, u8 *data)
+/**
+ * efi_deserialize_load_option() - parse serialized data
+ *
+ * Parse serialized data describing a load option and transform it to the
+ * efi_load_option structure.
+ *
+ * @lo:                pointer to target
+ * @data:      serialized data
+ * @size:      size of the load option, on return size of the optional data
+ * Return:     status code
+ */
+efi_status_t efi_deserialize_load_option(struct efi_load_option *lo, u8 *data,
+                                        efi_uintn_t *size)
 {
+       efi_uintn_t len;
+
+       len = sizeof(u32);
+       if (*size < len + 2 * sizeof(u16))
+               return EFI_INVALID_PARAMETER;
        lo->attributes = get_unaligned_le32(data);
-       data += sizeof(u32);
+       data += len;
+       *size -= len;
 
+       len = sizeof(u16);
        lo->file_path_length = get_unaligned_le16(data);
-       data += sizeof(u16);
+       data += len;
+       *size -= len;
 
-       /* FIXME */
        lo->label = (u16 *)data;
-       data += (u16_strlen(lo->label) + 1) * sizeof(u16);
-
-       /* FIXME */
+       len = u16_strnlen(lo->label, *size / sizeof(u16) - 1);
+       if (lo->label[len])
+               return EFI_INVALID_PARAMETER;
+       len = (len + 1) * sizeof(u16);
+       if (*size < len)
+               return EFI_INVALID_PARAMETER;
+       data += len;
+       *size -= len;
+
+       len = lo->file_path_length;
+       if (*size < len)
+               return EFI_INVALID_PARAMETER;
        lo->file_path = (struct efi_device_path *)data;
-       data += lo->file_path_length;
+        /*
+         * TODO: validate device path. There should be an end node within
+         * the indicated file_path_length.
+         */
+       data += len;
+       *size -= len;
 
        lo->optional_data = data;
+
+       return EFI_SUCCESS;
 }
 
-/*
+/**
+ * efi_serialize_load_option() - serialize load option
+ *
  * Serialize efi_load_option structure into byte stream for BootXXXX.
- * Return a size of allocated data.
+ *
+ * @data:      buffer for serialized data
+ * @lo:                load option
+ * Return:     size of allocated buffer
  */
 unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data)
 {
@@ -92,7 +134,16 @@ unsigned long efi_serialize_load_option(struct efi_load_option *lo, u8 **data)
        return size;
 }
 
-/* free() the result */
+/**
+ * get_var() - get UEFI variable
+ *
+ * It is the caller's duty to free the returned buffer.
+ *
+ * @name:      name of variable
+ * @vendor:    vendor GUID of variable
+ * @size:      size of allocated buffer
+ * Return:     buffer with variable data or NULL
+ */
 static void *get_var(u16 *name, const efi_guid_t *vendor,
                     efi_uintn_t *size)
 {
@@ -116,10 +167,16 @@ static void *get_var(u16 *name, const efi_guid_t *vendor,
        return buf;
 }
 
-/*
+/**
+ * try_load_entry() - try to load image for boot option
+ *
  * Attempt to load load-option number 'n', returning device_path and file_path
- * if successful.  This checks that the EFI_LOAD_OPTION is active (enabled)
+ * if successful. This checks that the EFI_LOAD_OPTION is active (enabled)
  * and that the specified file to boot exists.
+ *
+ * @n:         number of the boot option, e.g. 0x0a13 for Boot0A13
+ * @handle:    on return handle for the newly installed image
+ * Return:     status code
  */
 static efi_status_t try_load_entry(u16 n, efi_handle_t *handle)
 {
@@ -139,19 +196,23 @@ static efi_status_t try_load_entry(u16 n, efi_handle_t *handle)
        if (!load_option)
                return EFI_LOAD_ERROR;
 
-       efi_deserialize_load_option(&lo, load_option);
+       ret = efi_deserialize_load_option(&lo, load_option, &size);
+       if (ret != EFI_SUCCESS) {
+               log_warning("Invalid load option for %ls\n", varname);
+               goto error;
+       }
 
        if (lo.attributes & LOAD_OPTION_ACTIVE) {
                u32 attributes;
 
-               debug("%s: trying to load \"%ls\" from %pD\n",
-                     __func__, lo.label, lo.file_path);
+               log_debug("%s: trying to load \"%ls\" from %pD\n",
+                         __func__, lo.label, lo.file_path);
 
                ret = EFI_CALL(efi_load_image(true, efi_root, lo.file_path,
                                              NULL, 0, handle));
                if (ret != EFI_SUCCESS) {
-                       printf("Loading from Boot%04X '%ls' failed\n", n,
-                              lo.label);
+                       log_warning("Loading %ls '%ls' failed\n",
+                                   varname, lo.label);
                        goto error;
                }
 
@@ -165,11 +226,11 @@ static efi_status_t try_load_entry(u16 n, efi_handle_t *handle)
                if (ret != EFI_SUCCESS) {
                        if (EFI_CALL(efi_unload_image(*handle))
                            != EFI_SUCCESS)
-                               printf("Unloading image failed\n");
+                               log_err("Unloading image failed\n");
                        goto error;
                }
 
-               printf("Booting: %ls\n", lo.label);
+               log_info("Booting: %ls\n", lo.label);
        } else {
                ret = EFI_LOAD_ERROR;
        }
@@ -180,10 +241,15 @@ error:
        return ret;
 }
 
-/*
+/**
+ * efi_bootmgr_load() - try to load from BootNext or BootOrder
+ *
  * Attempt to load from BootNext or in the order specified by BootOrder
  * EFI variable, the available load-options, finding and returning
  * the first one that can be loaded successfully.
+ *
+ * @handle:    on return handle for the newly installed image
+ * Return:     status code
  */
 efi_status_t efi_bootmgr_load(efi_handle_t *handle)
 {
@@ -204,7 +270,7 @@ efi_status_t efi_bootmgr_load(efi_handle_t *handle)
        if (ret == EFI_SUCCESS || ret == EFI_BUFFER_TOO_SMALL) {
                /* BootNext does exist here */
                if (ret == EFI_BUFFER_TOO_SMALL || size != sizeof(u16))
-                       printf("BootNext must be 16-bit integer\n");
+                       log_err("BootNext must be 16-bit integer\n");
 
                /* delete BootNext */
                ret = EFI_CALL(efi_set_variable(
@@ -219,24 +285,26 @@ efi_status_t efi_bootmgr_load(efi_handle_t *handle)
                                ret = try_load_entry(bootnext, handle);
                                if (ret == EFI_SUCCESS)
                                        return ret;
-                               printf("Loading from BootNext failed, falling back to BootOrder\n");
+                               log_warning(
+                                       "Loading from BootNext failed, falling back to BootOrder\n");
                        }
                } else {
-                       printf("Deleting BootNext failed\n");
+                       log_err("Deleting BootNext failed\n");
                }
        }
 
        /* BootOrder */
        bootorder = get_var(L"BootOrder", &efi_global_variable_guid, &size);
        if (!bootorder) {
-               printf("BootOrder not defined\n");
+               log_info("BootOrder not defined\n");
                ret = EFI_NOT_FOUND;
                goto error;
        }
 
        num = size / sizeof(uint16_t);
        for (i = 0; i < num; i++) {
-               debug("%s: trying to load Boot%04X\n", __func__, bootorder[i]);
+               log_debug("%s trying to load Boot%04X\n", __func__,
+                         bootorder[i]);
                ret = try_load_entry(bootorder[i], handle);
                if (ret == EFI_SUCCESS)
                        break;