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