include/fs.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
   4  */
   5 #ifndef _FS_H
   6 #define _FS_H
   7
   8 #include <common.h>
   9
  10 #define FS_TYPE_ANY     0
  11 #define FS_TYPE_FAT     1
  12 #define FS_TYPE_EXT     2
  13 #define FS_TYPE_SANDBOX 3
  14 #define FS_TYPE_UBIFS   4
  15 #define FS_TYPE_BTRFS   5
  16
  17 /*
  18  * Tell the fs layer which block device an partition to use for future
  19  * commands. This also internally identifies the filesystem that is present
  20  * within the partition. The identification process may be limited to a
  21  * specific filesystem type by passing FS_* in the fstype parameter.
  22  *
  23  * Returns 0 on success.
  24  * Returns non-zero if there is an error accessing the disk or partition, or
  25  * no known filesystem type could be recognized on it.
  26  */
  27 int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype);
  28
  29 /*
  30  * fs_set_blk_dev_with_part - Set current block device + partition
  31  *
  32  * Similar to fs_set_blk_dev(), but useful for cases where you already
  33  * know the blk_desc and part number.
  34  *
  35  * Returns 0 on success.
  36  * Returns non-zero if invalid partition or error accessing the disk.
  37  */
  38 int fs_set_blk_dev_with_part(struct blk_desc *desc, int part);
  39
  40 /**
  41  * fs_close() - Unset current block device and partition
  42  *
  43  * fs_close() closes the connection to a file system opened with either
  44  * fs_set_blk_dev() or fs_set_dev_with_part().
  45  *
  46  * Many file functions implicitly call fs_close(), e.g. fs_closedir(),
  47  * fs_exist(), fs_ln(), fs_ls(), fs_mkdir(), fs_read(), fs_size(), fs_write(),
  48  * fs_unlink().
  49  */
  50 void fs_close(void);
  51
  52 /**
  53  * fs_get_type_name() - Get type of current filesystem
  54  *
  55  * Return: Pointer to filesystem name
  56  *
  57  * Returns a string describing the current filesystem, or the sentinel
  58  * "unsupported" for any unrecognised filesystem.
  59  */
  60 const char *fs_get_type_name(void);
  61
  62 /*
  63  * Print the list of files on the partition previously set by fs_set_blk_dev(),
  64  * in directory "dirname".
  65  *
  66  * Returns 0 on success. Returns non-zero on error.
  67  */
  68 int fs_ls(const char *dirname);
  69
  70 /*
  71  * Determine whether a file exists
  72  *
  73  * Returns 1 if the file exists, 0 if it doesn't exist.
  74  */
  75 int fs_exists(const char *filename);
  76
  77 /*
  78  * fs_size - Determine a file's size
  79  *
  80  * @filename: Name of the file
  81  * @size: Size of file
  82  * @return 0 if ok with valid *size, negative on error
  83  */
  84 int fs_size(const char *filename, loff_t *size);
  85
  86 /**
  87  * fs_read() - read file from the partition previously set by fs_set_blk_dev()
  88  *
  89  * Note that not all filesystem drivers support either or both of offset != 0
  90  * and len != 0.
  91  *
  92  * @filename:   full path of the file to read from
  93  * @addr:       address of the buffer to write to
  94  * @offset:     offset in the file from where to start reading
  95  * @len:        the number of bytes to read. Use 0 to read entire file.
  96  * @actread:    returns the actual number of bytes read
  97  * Return:      0 if OK with valid *actread, -1 on error conditions
  98  */
  99 int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
 100             loff_t *actread);
 101
 102 /**
 103  * fs_write() - write file to the partition previously set by fs_set_blk_dev()
 104  *
 105  * Note that not all filesystem drivers support offset != 0.
 106  *
 107  * @filename:   full path of the file to write to
 108  * @addr:       address of the buffer to read from
 109  * @offset:     offset in the file from where to start writing
 110  * @len:        the number of bytes to write
 111  * @actwrite:   returns the actual number of bytes written
 112  * Return:      0 if OK with valid *actwrite, -1 on error conditions
 113  */
 114 int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
 115              loff_t *actwrite);
 116
 117 /*
 118  * Directory entry types, matches the subset of DT_x in posix readdir()
 119  * which apply to u-boot.
 120  */
 121 #define FS_DT_DIR  4         /* directory */
 122 #define FS_DT_REG  8         /* regular file */
 123 #define FS_DT_LNK  10        /* symbolic link */
 124
 125 /*
 126  * A directory entry, returned by fs_readdir().  Returns information
 127  * about the file/directory at the current directory entry position.
 128  */
 129 struct fs_dirent {
 130         unsigned type;       /* one of FS_DT_x (not a mask) */
 131         loff_t size;         /* size in bytes */
 132         char name[256];
 133 };
 134
 135 /* Note: fs_dir_stream should be treated as opaque to the user of fs layer */
 136 struct fs_dir_stream {
 137         /* private to fs. layer: */
 138         struct blk_desc *desc;
 139         int part;
 140 };
 141
 142 /*
 143  * fs_opendir - Open a directory
 144  *
 145  * @filename: the path to directory to open
 146  * @return a pointer to the directory stream or NULL on error and errno
 147  *    set appropriately
 148  */
 149 struct fs_dir_stream *fs_opendir(const char *filename);
 150
 151 /*
 152  * fs_readdir - Read the next directory entry in the directory stream.
 153  *
 154  * Works in an analogous way to posix readdir().  The previously returned
 155  * directory entry is no longer valid after calling fs_readdir() again.
 156  * After fs_closedir() is called, the returned directory entry is no
 157  * longer valid.
 158  *
 159  * @dirs: the directory stream
 160  * @return the next directory entry (only valid until next fs_readdir() or
 161  *    fs_closedir() call, do not attempt to free()) or NULL if the end of
 162  *    the directory is reached.
 163  */
 164 struct fs_dirent *fs_readdir(struct fs_dir_stream *dirs);
 165
 166 /*
 167  * fs_closedir - close a directory stream
 168  *
 169  * @dirs: the directory stream
 170  */
 171 void fs_closedir(struct fs_dir_stream *dirs);
 172
 173 /*
 174  * fs_unlink - delete a file or directory
 175  *
 176  * If a given name is a directory, it will be deleted only if it's empty
 177  *
 178  * @filename: Name of file or directory to delete
 179  * @return 0 on success, -1 on error conditions
 180  */
 181 int fs_unlink(const char *filename);
 182
 183 /*
 184  * fs_mkdir - Create a directory
 185  *
 186  * @filename: Name of directory to create
 187  * @return 0 on success, -1 on error conditions
 188  */
 189 int fs_mkdir(const char *filename);
 190
 191 /*
 192  * Common implementation for various filesystem commands, optionally limited
 193  * to a specific filesystem type via the fstype parameter.
 194  */
 195 int do_size(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 196                 int fstype);
 197 int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 198                 int fstype);
 199 int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 200                 int fstype);
 201 int file_exists(const char *dev_type, const char *dev_part, const char *file,
 202                 int fstype);
 203 int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 204                 int fstype);
 205 int do_rm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 206                 int fstype);
 207 int do_mkdir(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 208                 int fstype);
 209 int do_ln(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 210           int fstype);
 211
 212 /*
 213  * Determine the UUID of the specified filesystem and print it. Optionally it is
 214  * possible to store the UUID directly in env.
 215  */
 216 int do_fs_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 217                 int fstype);
 218
 219 /*
 220  * Determine the type of the specified filesystem and print it. Optionally it is
 221  * possible to store the type directly in env.
 222  */
 223 int do_fs_type(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 224
 225 #endif /* _FS_H */