efi_loader: device_path: support Sandbox's "host" devices
[oweals/u-boot.git] / lib / efi_loader / efi_device_path.c
index 5a61a1c1dcf95fa194ed08040b0221cf19eeadd5..86297bb7c1166537a9625adbbfd32355013fc575 100644 (file)
@@ -5,8 +5,6 @@
  * (C) Copyright 2017 Rob Clark
  */
 
-#define LOG_CATEGORY LOGL_ERR
-
 #include <common.h>
 #include <blk.h>
 #include <dm.h>
 #include <mmc.h>
 #include <efi_loader.h>
 #include <part.h>
+#include <sandboxblockdev.h>
+#include <asm-generic/unaligned.h>
+
+#ifdef CONFIG_SANDBOX
+const efi_guid_t efi_guid_host_dev = U_BOOT_HOST_DEV_GUID;
+#endif
 
 /* template END node: */
 static const struct efi_device_path END = {
@@ -82,7 +86,7 @@ struct efi_device_path *efi_dp_next(const struct efi_device_path *dp)
 
 /*
  * Compare two device-paths, stopping when the shorter of the two hits
- * an End* node.  This is useful to, for example, compare a device-path
+ * an End* node. This is useful to, for example, compare a device-path
  * representing a device with one representing a file on the device, or
  * a device with a parent device.
  */
@@ -109,16 +113,17 @@ int efi_dp_match(const struct efi_device_path *a,
 }
 
 /*
- * See UEFI spec (section 3.1.2, about short-form device-paths..
- * tl;dr: we can have a device-path that starts with a USB WWID
- * or USB Class node, and a few other cases which don't encode
- * the full device path with bus hierarchy:
+ * We can have device paths that start with a USB WWID or a USB Class node,
+ * and a few other cases which don't encode the full device path with bus
+ * hierarchy:
  *
  *   - MESSAGING:USB_WWID
  *   - MESSAGING:USB_CLASS
  *   - MEDIA:FILE_PATH
  *   - MEDIA:HARD_DRIVE
  *   - MESSAGING:URI
+ *
+ * See UEFI spec (section 3.1.2, about short-form device-paths)
  */
 static struct efi_device_path *shorten_path(struct efi_device_path *dp)
 {
@@ -150,7 +155,7 @@ static struct efi_object *find_obj(struct efi_device_path *dp, bool short_path,
                struct efi_device_path *obj_dp;
                efi_status_t ret;
 
-               ret = efi_search_protocol(efiobj->handle,
+               ret = efi_search_protocol(efiobj,
                                          &efi_guid_device_path, &handler);
                if (ret != EFI_SUCCESS)
                        continue;
@@ -336,6 +341,9 @@ struct efi_device_path *efi_dp_create_device_node(const u8 type,
 {
        struct efi_device_path *ret;
 
+       if (length < sizeof(struct efi_device_path))
+               return NULL;
+
        ret = dp_alloc(length);
        if (!ret)
                return ret;
@@ -382,7 +390,6 @@ struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
                *size = 0;
        if (!dp || !*dp)
                return NULL;
-       p = *dp;
        sz = efi_dp_instance_size(*dp);
        p = dp_alloc(sz + sizeof(END));
        if (!p)
@@ -443,6 +450,16 @@ static unsigned dp_size(struct udevice *dev)
                case UCLASS_MMC:
                        return dp_size(dev->parent) +
                                sizeof(struct efi_device_path_sd_mmc_path);
+#endif
+#ifdef CONFIG_SANDBOX
+               case UCLASS_ROOT:
+                        /*
+                         * Sandbox's host device will be represented
+                         * as vendor device with extra one byte for
+                         * device number
+                         */
+                       return dp_size(dev->parent)
+                               + sizeof(struct efi_device_path_vendor) + 1;
 #endif
                default:
                        return dp_size(dev->parent);
@@ -503,6 +520,24 @@ static void *dp_fill(void *buf, struct udevice *dev)
 #ifdef CONFIG_BLK
        case UCLASS_BLK:
                switch (dev->parent->uclass->uc_drv->id) {
+#ifdef CONFIG_SANDBOX
+               case UCLASS_ROOT: {
+                       /* stop traversing parents at this point: */
+                       struct efi_device_path_vendor *dp = buf;
+                       struct blk_desc *desc = dev_get_uclass_platdata(dev);
+
+                       dp_fill(buf, dev->parent);
+                       dp = buf;
+                       ++dp;
+                       dp->dp.type = DEVICE_PATH_TYPE_HARDWARE_DEVICE;
+                       dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_VENDOR;
+                       dp->dp.length = sizeof(*dp) + 1;
+                       memcpy(&dp->guid, &efi_guid_host_dev,
+                              sizeof(efi_guid_t));
+                       dp->vendor_data[0] = desc->devnum;
+                       return &dp->vendor_data[1];
+                       }
+#endif
 #ifdef CONFIG_IDE
                case UCLASS_IDE: {
                        struct efi_device_path_atapi *dp =
@@ -645,7 +680,7 @@ static unsigned dp_part_size(struct blk_desc *desc, int part)
 /*
  * Create a device node for a block device partition.
  *
- * @buf                buffer to which the device path is wirtten
+ * @buf                buffer to which the device path is written
  * @desc       block device descriptor
  * @part       partition number, 0 identifies a block device
  */
@@ -663,7 +698,7 @@ static void *dp_part_node(void *buf, struct blk_desc *desc, int part)
                cddp->dp.sub_type = DEVICE_PATH_SUB_TYPE_CDROM_PATH;
                cddp->dp.length = sizeof(*cddp);
                cddp->partition_start = info.start;
-               cddp->partition_end = info.size;
+               cddp->partition_size = info.size;
 
                buf = &cddp[1];
        } else {
@@ -710,7 +745,7 @@ static void *dp_part_node(void *buf, struct blk_desc *desc, int part)
 /*
  * Create a device path for a block device or one of its partitions.
  *
- * @buf                buffer to which the device path is wirtten
+ * @buf                buffer to which the device path is written
  * @desc       block device descriptor
  * @part       partition number, 0 identifies a block device
  */
@@ -729,7 +764,7 @@ static void *dp_part_fill(void *buf, struct blk_desc *desc, int part)
        /*
         * We *could* make a more accurate path, by looking at if_type
         * and handling all the different cases like we do for non-
-        * legacy (ie CONFIG_BLK=y) case.  But most important thing
+        * legacy (i.e. CONFIG_BLK=y) case. But most important thing
         * is just to have a unique device-path for if_type+devnum.
         * So map things to a fictitious USB device.
         */
@@ -753,7 +788,7 @@ static void *dp_part_fill(void *buf, struct blk_desc *desc, int part)
        return dp_part_node(buf, desc, part);
 }
 
-/* Construct a device-path from a partition on a blk device: */
+/* Construct a device-path from a partition on a block device: */
 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part)
 {
        void *buf, *start;
@@ -772,7 +807,7 @@ struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part)
 /*
  * Create a device node for a block device partition.
  *
- * @buf                buffer to which the device path is wirtten
+ * @buf                buffer to which the device path is written
  * @desc       block device descriptor
  * @part       partition number, 0 identifies a block device
  */
@@ -792,16 +827,36 @@ struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part)
        return buf;
 }
 
-/* convert path to an UEFI style path (ie. DOS style backslashes and utf16) */
-static void path_to_uefi(u16 *uefi, const char *path)
+/**
+ * path_to_uefi() - convert UTF-8 path to an UEFI style path
+ *
+ * Convert UTF-8 path to a UEFI style path (i.e. with backslashes as path
+ * separators and UTF-16).
+ *
+ * @src:       source buffer
+ * @uefi:      target buffer, possibly unaligned
+ */
+static void path_to_uefi(void *uefi, const char *src)
 {
-       while (*path) {
-               char c = *(path++);
-               if (c == '/')
-                       c = '\\';
-               *(uefi++) = c;
+       u16 *pos = uefi;
+
+       /*
+        * efi_set_bootdev() calls this routine indirectly before the UEFI
+        * subsystem is initialized. So we cannot assume unaligned access to be
+        * enabled.
+        */
+       allow_unaligned();
+
+       while (*src) {
+               s32 code = utf8_get(&src);
+
+               if (code < 0)
+                       code = '?';
+               else if (code == '/')
+                       code = '\\';
+               utf16_put(code, &pos);
        }
-       *uefi = '\0';
+       *pos = 0;
 }
 
 /*
@@ -818,7 +873,8 @@ struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
        if (desc)
                dpsize = dp_part_size(desc, part);
 
-       fpsize = sizeof(struct efi_device_path) + 2 * (strlen(path) + 1);
+       fpsize = sizeof(struct efi_device_path) +
+                2 * (utf8_utf16_strlen(path) + 1);
        dpsize += fpsize;
 
        start = buf = dp_alloc(dpsize + sizeof(END));
@@ -910,15 +966,23 @@ struct efi_device_path *efi_dp_from_mem(uint32_t memory_type,
        return start;
 }
 
-/*
- * Helper to split a full device path (containing both device and file
- * parts) into it's constituent parts.
+/**
+ * efi_dp_split_file_path() - split of relative file path from device path
+ *
+ * Given a device path indicating a file on a device, separate the device
+ * path in two: the device path of the actual device and the file path
+ * relative to this device.
+ *
+ * @full_path:         device path including device and file path
+ * @device_path:       path of the device
+ * @file_path:         relative path of the file or NULL if there is none
+ * Return:             status code
  */
 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
                                    struct efi_device_path **device_path,
                                    struct efi_device_path **file_path)
 {
-       struct efi_device_path *p, *dp, *fp;
+       struct efi_device_path *p, *dp, *fp = NULL;
 
        *device_path = NULL;
        *file_path = NULL;
@@ -929,7 +993,7 @@ efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
        while (!EFI_DP_TYPE(p, MEDIA_DEVICE, FILE_PATH)) {
                p = efi_dp_next(p);
                if (!p)
-                       return EFI_OUT_OF_RESOURCES;
+                       goto out;
        }
        fp = efi_dp_dup(p);
        if (!fp)
@@ -938,7 +1002,53 @@ efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
        p->sub_type = DEVICE_PATH_SUB_TYPE_END;
        p->length = sizeof(*p);
 
+out:
        *device_path = dp;
        *file_path = fp;
        return EFI_SUCCESS;
 }
+
+efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
+                             const char *path,
+                             struct efi_device_path **device,
+                             struct efi_device_path **file)
+{
+       int is_net;
+       struct blk_desc *desc = NULL;
+       disk_partition_t fs_partition;
+       int part = 0;
+       char filename[32] = { 0 }; /* dp->str is u16[32] long */
+       char *s;
+
+       if (path && !file)
+               return EFI_INVALID_PARAMETER;
+
+       is_net = !strcmp(dev, "Net");
+       if (!is_net) {
+               part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition,
+                                              1);
+               if (part < 0 || !desc)
+                       return EFI_INVALID_PARAMETER;
+
+               if (device)
+                       *device = efi_dp_from_part(desc, part);
+       } else {
+#ifdef CONFIG_NET
+               if (device)
+                       *device = efi_dp_from_eth();
+#endif
+       }
+
+       if (!path)
+               return EFI_SUCCESS;
+
+       snprintf(filename, sizeof(filename), "%s", path);
+       /* DOS style file path: */
+       s = filename;
+       while ((s = strchr(s, '/')))
+               *s++ = '\\';
+       *file = efi_dp_from_file(((!is_net && device) ? desc : NULL),
+                                part, filename);
+
+       return EFI_SUCCESS;
+}