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