Merge branch 'master' of git://git.denx.de/u-boot-spi
[platform/kernel/u-boot.git] / lib / efi_loader / efi_file.c
index 52a4e74..128cb0a 100644 (file)
@@ -1,17 +1,20 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  *  EFI utils
  *
  *  Copyright (c) 2017 Rob Clark
- *
- *  SPDX-License-Identifier:     GPL-2.0+
  */
 
 #include <common.h>
 #include <charset.h>
 #include <efi_loader.h>
 #include <malloc.h>
+#include <mapmem.h>
 #include <fs.h>
 
+/* GUID for file system information */
+const efi_guid_t efi_file_system_info_guid = EFI_FILE_SYSTEM_INFO_GUID;
+
 struct file_system {
        struct efi_simple_file_system_protocol base;
        struct efi_device_path *dp;
@@ -49,11 +52,18 @@ static int set_blk_dev(struct file_handle *fh)
        return fs_set_blk_dev_with_part(fh->fs->desc, fh->fs->part);
 }
 
+/**
+ * is_dir() - check if file handle points to directory
+ *
+ * We assume that set_blk_dev(fh) has been called already.
+ *
+ * @fh:                file handle
+ * Return:     true if file handle points to a directory
+ */
 static int is_dir(struct file_handle *fh)
 {
        struct fs_dir_stream *dirs;
 
-       set_blk_dev(fh);
        dirs = fs_opendir(fh->path);
        if (!dirs)
                return 0;
@@ -124,11 +134,22 @@ static int sanitize_path(char *path)
        return 0;
 }
 
-/* NOTE: despite what you would expect, 'file_name' is actually a path.
- * With windoze style backlashes, ofc.
+/**
+ * file_open() - open a file handle
+ *
+ * @fs:                        file system
+ * @parent:            directory relative to which the file is to be opened
+ * @file_name:         path of the file to be opened. '\', '.', or '..' may
+ *                     be used as modifiers. A leading backslash indicates an
+ *                     absolute path.
+ * @mode:              bit mask indicating the access mode (read, write,
+ *                     create)
+ * @attributes:                attributes for newly created file
+ * Returns:            handle to the opened file or NULL
  */
 static struct efi_file_handle *file_open(struct file_system *fs,
-               struct file_handle *parent, s16 *file_name, u64 mode)
+               struct file_handle *parent, s16 *file_name, u64 mode,
+               u64 attributes)
 {
        struct file_handle *fh;
        char f0[MAX_UTF8_PER_UTF16] = {0};
@@ -137,7 +158,7 @@ static struct efi_file_handle *file_open(struct file_system *fs,
 
        if (file_name) {
                utf16_to_utf8((u8 *)f0, (u16 *)file_name, 1);
-               flen = utf16_strlen((u16 *)file_name);
+               flen = u16_strlen((u16 *)file_name);
        }
 
        /* we could have a parent, but also an absolute path: */
@@ -171,7 +192,12 @@ static struct efi_file_handle *file_open(struct file_system *fs,
                if (set_blk_dev(fh))
                        goto error;
 
-               if (!((mode & EFI_FILE_MODE_CREATE) || fs_exists(fh->path)))
+               if ((mode & EFI_FILE_MODE_CREATE) &&
+                   (attributes & EFI_FILE_DIRECTORY)) {
+                       if (fs_mkdir(fh->path))
+                               goto error;
+               } else if (!((mode & EFI_FILE_MODE_CREATE) ||
+                            fs_exists(fh->path)))
                        goto error;
 
                /* figure out if file is a directory: */
@@ -193,15 +219,46 @@ static efi_status_t EFIAPI efi_file_open(struct efi_file_handle *file,
                s16 *file_name, u64 open_mode, u64 attributes)
 {
        struct file_handle *fh = to_fh(file);
+       efi_status_t ret;
 
        EFI_ENTRY("%p, %p, \"%ls\", %llx, %llu", file, new_handle, file_name,
                  open_mode, attributes);
 
-       *new_handle = file_open(fh->fs, fh, file_name, open_mode);
-       if (!*new_handle)
-               return EFI_EXIT(EFI_NOT_FOUND);
+       /* Check parameters */
+       if (!file || !new_handle || !file_name) {
+               ret = EFI_INVALID_PARAMETER;
+               goto out;
+       }
+       if (open_mode != EFI_FILE_MODE_READ &&
+           open_mode != (EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE) &&
+           open_mode != (EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE |
+                        EFI_FILE_MODE_CREATE)) {
+               ret = EFI_INVALID_PARAMETER;
+               goto out;
+       }
+       /*
+        * The UEFI spec requires that attributes are only set in create mode.
+        * The SCT does not care about this and sets EFI_FILE_DIRECTORY in
+        * read mode. EDK2 does not check that attributes are zero if not in
+        * create mode.
+        *
+        * So here we only check attributes in create mode and do not check
+        * that they are zero otherwise.
+        */
+       if ((open_mode & EFI_FILE_MODE_CREATE) &&
+           (attributes & (EFI_FILE_READ_ONLY | ~EFI_FILE_VALID_ATTR))) {
+               ret = EFI_INVALID_PARAMETER;
+               goto out;
+       }
 
-       return EFI_EXIT(EFI_SUCCESS);
+       /* Open file */
+       *new_handle = file_open(fh->fs, fh, file_name, open_mode, attributes);
+       if (*new_handle)
+               ret = EFI_SUCCESS;
+       else
+               ret = EFI_NOT_FOUND;
+out:
+       return EFI_EXIT(ret);
 }
 
 static efi_status_t file_close(struct file_handle *fh)
@@ -221,9 +278,21 @@ static efi_status_t EFIAPI efi_file_close(struct efi_file_handle *file)
 static efi_status_t EFIAPI efi_file_delete(struct efi_file_handle *file)
 {
        struct file_handle *fh = to_fh(file);
+       efi_status_t ret = EFI_SUCCESS;
+
        EFI_ENTRY("%p", file);
+
+       if (set_blk_dev(fh)) {
+               ret = EFI_DEVICE_ERROR;
+               goto error;
+       }
+
+       if (fs_unlink(fh->path))
+               ret = EFI_DEVICE_ERROR;
        file_close(fh);
-       return EFI_EXIT(EFI_WARN_DELETE_FAILURE);
+
+error:
+       return EFI_EXIT(ret);
 }
 
 static efi_status_t file_read(struct file_handle *fh, u64 *buffer_size,
@@ -231,7 +300,7 @@ static efi_status_t file_read(struct file_handle *fh, u64 *buffer_size,
 {
        loff_t actread;
 
-       if (fs_read(fh->path, (ulong)buffer, fh->offset,
+       if (fs_read(fh->path, map_to_sysmem(buffer), fh->offset,
                    *buffer_size, &actread))
                return EFI_DEVICE_ERROR;
 
@@ -314,29 +383,41 @@ static efi_status_t dir_read(struct file_handle *fh, u64 *buffer_size,
 }
 
 static efi_status_t EFIAPI efi_file_read(struct efi_file_handle *file,
-               u64 *buffer_size, void *buffer)
+                                        efi_uintn_t *buffer_size, void *buffer)
 {
        struct file_handle *fh = to_fh(file);
        efi_status_t ret = EFI_SUCCESS;
+       u64 bs;
 
        EFI_ENTRY("%p, %p, %p", file, buffer_size, buffer);
 
+       if (!buffer_size || !buffer) {
+               ret = EFI_INVALID_PARAMETER;
+               goto error;
+       }
+
        if (set_blk_dev(fh)) {
                ret = EFI_DEVICE_ERROR;
                goto error;
        }
 
+       bs = *buffer_size;
        if (fh->isdir)
-               ret = dir_read(fh, buffer_size, buffer);
+               ret = dir_read(fh, &bs, buffer);
        else
-               ret = file_read(fh, buffer_size, buffer);
+               ret = file_read(fh, &bs, buffer);
+       if (bs <= SIZE_MAX)
+               *buffer_size = bs;
+       else
+               *buffer_size = SIZE_MAX;
 
 error:
        return EFI_EXIT(ret);
 }
 
 static efi_status_t EFIAPI efi_file_write(struct efi_file_handle *file,
-               u64 *buffer_size, void *buffer)
+                                         efi_uintn_t *buffer_size,
+                                         void *buffer)
 {
        struct file_handle *fh = to_fh(file);
        efi_status_t ret = EFI_SUCCESS;
@@ -349,7 +430,7 @@ static efi_status_t EFIAPI efi_file_write(struct efi_file_handle *file,
                goto error;
        }
 
-       if (fs_write(fh->path, (ulong)buffer, fh->offset, *buffer_size,
+       if (fs_write(fh->path, map_to_sysmem(buffer), fh->offset, *buffer_size,
                     &actwrite)) {
                ret = EFI_DEVICE_ERROR;
                goto error;
@@ -362,17 +443,46 @@ error:
        return EFI_EXIT(ret);
 }
 
+/**
+ * efi_file_getpos() - get current position in file
+ *
+ * This function implements the GetPosition service of the EFI file protocol.
+ * See the UEFI spec for details.
+ *
+ * @file:      file handle
+ * @pos:       pointer to file position
+ * Return:     status code
+ */
 static efi_status_t EFIAPI efi_file_getpos(struct efi_file_handle *file,
-               u64 *pos)
+                                          u64 *pos)
 {
+       efi_status_t ret = EFI_SUCCESS;
        struct file_handle *fh = to_fh(file);
+
        EFI_ENTRY("%p, %p", file, pos);
+
+       if (fh->isdir) {
+               ret = EFI_UNSUPPORTED;
+               goto out;
+       }
+
        *pos = fh->offset;
-       return EFI_EXIT(EFI_SUCCESS);
+out:
+       return EFI_EXIT(ret);
 }
 
+/**
+ * efi_file_setpos() - set current position in file
+ *
+ * This function implements the SetPosition service of the EFI file protocol.
+ * See the UEFI spec for details.
+ *
+ * @file:      file handle
+ * @pos:       new file position
+ * Return:     status code
+ */
 static efi_status_t EFIAPI efi_file_setpos(struct efi_file_handle *file,
-               u64 pos)
+                                          u64 pos)
 {
        struct file_handle *fh = to_fh(file);
        efi_status_t ret = EFI_SUCCESS;
@@ -411,12 +521,14 @@ error:
 }
 
 static efi_status_t EFIAPI efi_file_getinfo(struct efi_file_handle *file,
-               efi_guid_t *info_type, u64 *buffer_size, void *buffer)
+                                           const efi_guid_t *info_type,
+                                           efi_uintn_t *buffer_size,
+                                           void *buffer)
 {
        struct file_handle *fh = to_fh(file);
        efi_status_t ret = EFI_SUCCESS;
 
-       EFI_ENTRY("%p, %p, %p, %p", file, info_type, buffer_size, buffer);
+       EFI_ENTRY("%p, %pUl, %p, %p", file, info_type, buffer_size, buffer);
 
        if (!guidcmp(info_type, &efi_file_info_guid)) {
                struct efi_file_info *info = buffer;
@@ -451,7 +563,42 @@ static efi_status_t EFIAPI efi_file_getinfo(struct efi_file_handle *file,
                if (fh->isdir)
                        info->attribute |= EFI_FILE_DIRECTORY;
 
-               ascii2unicode((u16 *)info->file_name, filename);
+               ascii2unicode(info->file_name, filename);
+       } else if (!guidcmp(info_type, &efi_file_system_info_guid)) {
+               struct efi_file_system_info *info = buffer;
+               disk_partition_t part;
+               efi_uintn_t required_size;
+               int r;
+
+               if (fh->fs->part >= 1)
+                       r = part_get_info(fh->fs->desc, fh->fs->part, &part);
+               else
+                       r = part_get_info_whole_disk(fh->fs->desc, &part);
+               if (r < 0) {
+                       ret = EFI_DEVICE_ERROR;
+                       goto error;
+               }
+               required_size = sizeof(info) + 2 *
+                               (strlen((const char *)part.name) + 1);
+               if (*buffer_size < required_size) {
+                       *buffer_size = required_size;
+                       ret = EFI_BUFFER_TOO_SMALL;
+                       goto error;
+               }
+
+               memset(info, 0, required_size);
+
+               info->size = required_size;
+               info->read_only = true;
+               info->volume_size = part.size * part.blksz;
+               info->free_space = 0;
+               info->block_size = part.blksz;
+               /*
+                * TODO: The volume label is not available in U-Boot.
+                * Use the partition name as substitute.
+                */
+               ascii2unicode((u16 *)info->volume_label,
+                             (const char *)part.name);
        } else {
                ret = EFI_UNSUPPORTED;
        }
@@ -461,9 +608,12 @@ error:
 }
 
 static efi_status_t EFIAPI efi_file_setinfo(struct efi_file_handle *file,
-               efi_guid_t *info_type, u64 buffer_size, void *buffer)
+                                           const efi_guid_t *info_type,
+                                           efi_uintn_t buffer_size,
+                                           void *buffer)
 {
-       EFI_ENTRY("%p, %p, %llu, %p", file, info_type, buffer_size, buffer);
+       EFI_ENTRY("%p, %p, %zu, %p", file, info_type, buffer_size, buffer);
+
        return EFI_EXIT(EFI_UNSUPPORTED);
 }
 
@@ -538,7 +688,7 @@ efi_open_volume(struct efi_simple_file_system_protocol *this,
 
        EFI_ENTRY("%p, %p", this, root);
 
-       *root = file_open(fs, NULL, NULL, 0);
+       *root = file_open(fs, NULL, NULL, 0, 0);
 
        return EFI_EXIT(EFI_SUCCESS);
 }