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