[thirdparty/u-boot.git] / fs / fs.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
 */

#include <config.h>
#include <errno.h>
#include <common.h>
#include <mapmem.h>
#include <part.h>
#include <ext4fs.h>
#include <fat.h>
#include <fs.h>
#include <sandboxfs.h>
#include <ubifs_uboot.h>
#include <btrfs.h>
#include <asm/io.h>
#include <div64.h>
#include <linux/math64.h>

DECLARE_GLOBAL_DATA_PTR;

static struct blk_desc *fs_dev_desc;
static int fs_dev_part;
static disk_partition_t fs_partition;
static int fs_type = FS_TYPE_ANY;

static inline int fs_probe_unsupported(struct blk_desc *fs_dev_desc,
				      disk_partition_t *fs_partition)
{
	printf("** Unrecognized filesystem type **\n");
	return -1;
}

static inline int fs_ls_unsupported(const char *dirname)
{
	return -1;
}

/* generic implementation of ls in terms of opendir/readdir/closedir */
__maybe_unused
static int fs_ls_generic(const char *dirname)
{
	struct fs_dir_stream *dirs;
	struct fs_dirent *dent;
	int nfiles = 0, ndirs = 0;

	dirs = fs_opendir(dirname);
	if (!dirs)
		return -errno;

	while ((dent = fs_readdir(dirs))) {
		if (dent->type == FS_DT_DIR) {
			printf("            %s/\n", dent->name);
			ndirs++;
		} else {
			printf(" %8lld   %s\n", dent->size, dent->name);
			nfiles++;
		}
	}

	fs_closedir(dirs);

	printf("\n%d file(s), %d dir(s)\n\n", nfiles, ndirs);

	return 0;
}

static inline int fs_exists_unsupported(const char *filename)
{
	return 0;
}

static inline int fs_size_unsupported(const char *filename, loff_t *size)
{
	return -1;
}

static inline int fs_read_unsupported(const char *filename, void *buf,
				      loff_t offset, loff_t len,
				      loff_t *actread)
{
	return -1;
}

static inline int fs_write_unsupported(const char *filename, void *buf,
				      loff_t offset, loff_t len,
				      loff_t *actwrite)
{
	return -1;
}

static inline void fs_close_unsupported(void)
{
}

static inline int fs_uuid_unsupported(char *uuid_str)
{
	return -1;
}

static inline int fs_opendir_unsupported(const char *filename,
					 struct fs_dir_stream **dirs)
{
	return -EACCES;
}

static inline int fs_mkdir_unsupported(const char *dirname)
{
	return -1;
}

struct fstype_info {
	int fstype;
	char *name;
	/*
	 * Is it legal to pass NULL as .probe()'s  fs_dev_desc parameter? This
	 * should be false in most cases. For "virtual" filesystems which
	 * aren't based on a U-Boot block device (e.g. sandbox), this can be
	 * set to true. This should also be true for the dummy entry at the end
	 * of fstypes[], since that is essentially a "virtual" (non-existent)
	 * filesystem.
	 */
	bool null_dev_desc_ok;
	int (*probe)(struct blk_desc *fs_dev_desc,
		     disk_partition_t *fs_partition);
	int (*ls)(const char *dirname);
	int (*exists)(const char *filename);
	int (*size)(const char *filename, loff_t *size);
	int (*read)(const char *filename, void *buf, loff_t offset,
		    loff_t len, loff_t *actread);
	int (*write)(const char *filename, void *buf, loff_t offset,
		     loff_t len, loff_t *actwrite);
	void (*close)(void);
	int (*uuid)(char *uuid_str);
	/*
	 * Open a directory stream.  On success return 0 and directory
	 * stream pointer via 'dirsp'.  On error, return -errno.  See
	 * fs_opendir().
	 */
	int (*opendir)(const char *filename, struct fs_dir_stream **dirsp);
	/*
	 * Read next entry from directory stream.  On success return 0
	 * and directory entry pointer via 'dentp'.  On error return
	 * -errno.  See fs_readdir().
	 */
	int (*readdir)(struct fs_dir_stream *dirs, struct fs_dirent **dentp);
	/* see fs_closedir() */
	void (*closedir)(struct fs_dir_stream *dirs);
	int (*mkdir)(const char *dirname);
};

static struct fstype_info fstypes[] = {
#ifdef CONFIG_FS_FAT
	{
		.fstype = FS_TYPE_FAT,
		.name = "fat",
		.null_dev_desc_ok = false,
		.probe = fat_set_blk_dev,
		.close = fat_close,
		.ls = fs_ls_generic,
		.exists = fat_exists,
		.size = fat_size,
		.read = fat_read_file,
#ifdef CONFIG_FAT_WRITE
		.write = file_fat_write,
		.mkdir = fat_mkdir,
#else
		.write = fs_write_unsupported,
		.mkdir = fs_mkdir_unsupported,
#endif
		.uuid = fs_uuid_unsupported,
		.opendir = fat_opendir,
		.readdir = fat_readdir,
		.closedir = fat_closedir,
	},
#endif
#ifdef CONFIG_FS_EXT4
	{
		.fstype = FS_TYPE_EXT,
		.name = "ext4",
		.null_dev_desc_ok = false,
		.probe = ext4fs_probe,
		.close = ext4fs_close,
		.ls = ext4fs_ls,
		.exists = ext4fs_exists,
		.size = ext4fs_size,
		.read = ext4_read_file,
#ifdef CONFIG_CMD_EXT4_WRITE
		.write = ext4_write_file,
#else
		.write = fs_write_unsupported,
#endif
		.uuid = ext4fs_uuid,
		.opendir = fs_opendir_unsupported,
		.mkdir = fs_mkdir_unsupported,
	},
#endif
#ifdef CONFIG_SANDBOX
	{
		.fstype = FS_TYPE_SANDBOX,
		.name = "sandbox",
		.null_dev_desc_ok = true,
		.probe = sandbox_fs_set_blk_dev,
		.close = sandbox_fs_close,
		.ls = sandbox_fs_ls,
		.exists = sandbox_fs_exists,
		.size = sandbox_fs_size,
		.read = fs_read_sandbox,
		.write = fs_write_sandbox,
		.uuid = fs_uuid_unsupported,
		.opendir = fs_opendir_unsupported,
		.mkdir = fs_mkdir_unsupported,
	},
#endif
#ifdef CONFIG_CMD_UBIFS
	{
		.fstype = FS_TYPE_UBIFS,
		.name = "ubifs",
		.null_dev_desc_ok = true,
		.probe = ubifs_set_blk_dev,
		.close = ubifs_close,
		.ls = ubifs_ls,
		.exists = ubifs_exists,
		.size = ubifs_size,
		.read = ubifs_read,
		.write = fs_write_unsupported,
		.uuid = fs_uuid_unsupported,
		.opendir = fs_opendir_unsupported,
		.mkdir = fs_mkdir_unsupported,
	},
#endif
#ifdef CONFIG_FS_BTRFS
	{
		.fstype = FS_TYPE_BTRFS,
		.name = "btrfs",
		.null_dev_desc_ok = false,
		.probe = btrfs_probe,
		.close = btrfs_close,
		.ls = btrfs_ls,
		.exists = btrfs_exists,
		.size = btrfs_size,
		.read = btrfs_read,
		.write = fs_write_unsupported,
		.uuid = btrfs_uuid,
		.opendir = fs_opendir_unsupported,
		.mkdir = fs_mkdir_unsupported,
	},
#endif
	{
		.fstype = FS_TYPE_ANY,
		.name = "unsupported",
		.null_dev_desc_ok = true,
		.probe = fs_probe_unsupported,
		.close = fs_close_unsupported,
		.ls = fs_ls_unsupported,
		.exists = fs_exists_unsupported,
		.size = fs_size_unsupported,
		.read = fs_read_unsupported,
		.write = fs_write_unsupported,
		.uuid = fs_uuid_unsupported,
		.opendir = fs_opendir_unsupported,
		.mkdir = fs_mkdir_unsupported,
	},
};

static struct fstype_info *fs_get_info(int fstype)
{
	struct fstype_info *info;
	int i;

	for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes) - 1; i++, info++) {
		if (fstype == info->fstype)
			return info;
	}

	/* Return the 'unsupported' sentinel */
	return info;
}

/**
 * fs_get_type_name() - Get type of current filesystem
 *
 * Return: Pointer to filesystem name
 *
 * Returns a string describing the current filesystem, or the sentinel
 * "unsupported" for any unrecognised filesystem.
 */
const char *fs_get_type_name(void)
{
	return fs_get_info(fs_type)->name;
}

int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype)
{
	struct fstype_info *info;
	int part, i;
#ifdef CONFIG_NEEDS_MANUAL_RELOC
	static int relocated;

	if (!relocated) {
		for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes);
				i++, info++) {
			info->name += gd->reloc_off;
			info->probe += gd->reloc_off;
			info->close += gd->reloc_off;
			info->ls += gd->reloc_off;
			info->read += gd->reloc_off;
			info->write += gd->reloc_off;
		}
		relocated = 1;
	}
#endif

	part = blk_get_device_part_str(ifname, dev_part_str, &fs_dev_desc,
					&fs_partition, 1);
	if (part < 0)
		return -1;

	for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
		if (fstype != FS_TYPE_ANY && info->fstype != FS_TYPE_ANY &&
				fstype != info->fstype)
			continue;

		if (!fs_dev_desc && !info->null_dev_desc_ok)
			continue;

		if (!info->probe(fs_dev_desc, &fs_partition)) {
			fs_type = info->fstype;
			fs_dev_part = part;
			return 0;
		}
	}

	return -1;
}

/* set current blk device w/ blk_desc + partition # */
int fs_set_blk_dev_with_part(struct blk_desc *desc, int part)
{
	struct fstype_info *info;
	int ret, i;

	if (part >= 1)
		ret = part_get_info(desc, part, &fs_partition);
	else
		ret = part_get_info_whole_disk(desc, &fs_partition);
	if (ret)
		return ret;
	fs_dev_desc = desc;

	for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
		if (!info->probe(fs_dev_desc, &fs_partition)) {
			fs_type = info->fstype;
			return 0;
		}
	}

	return -1;
}

static void fs_close(void)
{
	struct fstype_info *info = fs_get_info(fs_type);

	info->close();

	fs_type = FS_TYPE_ANY;
}

int fs_uuid(char *uuid_str)
{
	struct fstype_info *info = fs_get_info(fs_type);

	return info->uuid(uuid_str);
}

int fs_ls(const char *dirname)
{
	int ret;

	struct fstype_info *info = fs_get_info(fs_type);

	ret = info->ls(dirname);

	fs_type = FS_TYPE_ANY;
	fs_close();

	return ret;
}

int fs_exists(const char *filename)
{
	int ret;

	struct fstype_info *info = fs_get_info(fs_type);

	ret = info->exists(filename);

	fs_close();

	return ret;
}

int fs_size(const char *filename, loff_t *size)
{
	int ret;

	struct fstype_info *info = fs_get_info(fs_type);

	ret = info->size(filename, size);

	fs_close();

	return ret;
}

int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
	    loff_t *actread)
{
	struct fstype_info *info = fs_get_info(fs_type);
	void *buf;
	int ret;

	/*
	 * We don't actually know how many bytes are being read, since len==0
	 * means read the whole file.
	 */
	buf = map_sysmem(addr, len);
	ret = info->read(filename, buf, offset, len, actread);
	unmap_sysmem(buf);

	/* If we requested a specific number of bytes, check we got it */
	if (ret == 0 && len && *actread != len)
		debug("** %s shorter than offset + len **\n", filename);
	fs_close();

	return ret;
}

int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
	     loff_t *actwrite)
{
	struct fstype_info *info = fs_get_info(fs_type);
	void *buf;
	int ret;

	buf = map_sysmem(addr, len);
	ret = info->write(filename, buf, offset, len, actwrite);
	unmap_sysmem(buf);

	if (ret < 0 && len != *actwrite) {
		printf("** Unable to write file %s **\n", filename);
		ret = -1;
	}
	fs_close();

	return ret;
}

struct fs_dir_stream *fs_opendir(const char *filename)
{
	struct fstype_info *info = fs_get_info(fs_type);
	struct fs_dir_stream *dirs = NULL;
	int ret;

	ret = info->opendir(filename, &dirs);
	fs_close();
	if (ret) {
		errno = -ret;
		return NULL;
	}

	dirs->desc = fs_dev_desc;
	dirs->part = fs_dev_part;

	return dirs;
}

struct fs_dirent *fs_readdir(struct fs_dir_stream *dirs)
{
	struct fstype_info *info;
	struct fs_dirent *dirent;
	int ret;

	fs_set_blk_dev_with_part(dirs->desc, dirs->part);
	info = fs_get_info(fs_type);

	ret = info->readdir(dirs, &dirent);
	fs_close();
	if (ret) {
		errno = -ret;
		return NULL;
	}

	return dirent;
}

void fs_closedir(struct fs_dir_stream *dirs)
{
	struct fstype_info *info;

	if (!dirs)
		return;

	fs_set_blk_dev_with_part(dirs->desc, dirs->part);
	info = fs_get_info(fs_type);

	info->closedir(dirs);
	fs_close();
}


int fs_mkdir(const char *dirname)
{
	int ret;

	struct fstype_info *info = fs_get_info(fs_type);

	ret = info->mkdir(dirname);

	fs_type = FS_TYPE_ANY;
	fs_close();

	return ret;
}

int do_size(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
		int fstype)
{
	loff_t size;

	if (argc != 4)
		return CMD_RET_USAGE;

	if (fs_set_blk_dev(argv[1], argv[2], fstype))
		return 1;

	if (fs_size(argv[3], &size) < 0)
		return CMD_RET_FAILURE;

	env_set_hex("filesize", size);

	return 0;
}

int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
		int fstype)
{
	unsigned long addr;
	const char *addr_str;
	const char *filename;
	loff_t bytes;
	loff_t pos;
	loff_t len_read;
	int ret;
	unsigned long time;
	char *ep;

	if (argc < 2)
		return CMD_RET_USAGE;
	if (argc > 7)
		return CMD_RET_USAGE;

	if (fs_set_blk_dev(argv[1], (argc >= 3) ? argv[2] : NULL, fstype))
		return 1;

	if (argc >= 4) {
		addr = simple_strtoul(argv[3], &ep, 16);
		if (ep == argv[3] || *ep != '\0')
			return CMD_RET_USAGE;
	} else {
		addr_str = env_get("loadaddr");
		if (addr_str != NULL)
			addr = simple_strtoul(addr_str, NULL, 16);
		else
			addr = CONFIG_SYS_LOAD_ADDR;
	}
	if (argc >= 5) {
		filename = argv[4];
	} else {
		filename = env_get("bootfile");
		if (!filename) {
			puts("** No boot file defined **\n");
			return 1;
		}
	}
	if (argc >= 6)
		bytes = simple_strtoul(argv[5], NULL, 16);
	else
		bytes = 0;
	if (argc >= 7)
		pos = simple_strtoul(argv[6], NULL, 16);
	else
		pos = 0;

	time = get_timer(0);
	ret = fs_read(filename, addr, pos, bytes, &len_read);
	time = get_timer(time);
	if (ret < 0)
		return 1;

	printf("%llu bytes read in %lu ms", len_read, time);
	if (time > 0) {
		puts(" (");
		print_size(div_u64(len_read, time) * 1000, "/s");
		puts(")");
	}
	puts("\n");

	env_set_hex("fileaddr", addr);
	env_set_hex("filesize", len_read);

	return 0;
}

int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
	int fstype)
{
	if (argc < 2)
		return CMD_RET_USAGE;
	if (argc > 4)
		return CMD_RET_USAGE;

	if (fs_set_blk_dev(argv[1], (argc >= 3) ? argv[2] : NULL, fstype))
		return 1;

	if (fs_ls(argc >= 4 ? argv[3] : "/"))
		return 1;

	return 0;
}

int file_exists(const char *dev_type, const char *dev_part, const char *file,
		int fstype)
{
	if (fs_set_blk_dev(dev_type, dev_part, fstype))
		return 0;

	return fs_exists(file);
}

int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
		int fstype)
{
	unsigned long addr;
	const char *filename;
	loff_t bytes;
	loff_t pos;
	loff_t len;
	int ret;
	unsigned long time;

	if (argc < 6 || argc > 7)
		return CMD_RET_USAGE;

	if (fs_set_blk_dev(argv[1], argv[2], fstype))
		return 1;

	addr = simple_strtoul(argv[3], NULL, 16);
	filename = argv[4];
	bytes = simple_strtoul(argv[5], NULL, 16);
	if (argc >= 7)
		pos = simple_strtoul(argv[6], NULL, 16);
	else
		pos = 0;

	time = get_timer(0);
	ret = fs_write(filename, addr, pos, bytes, &len);
	time = get_timer(time);
	if (ret < 0)
		return 1;

	printf("%llu bytes written in %lu ms", len, time);
	if (time > 0) {
		puts(" (");
		print_size(div_u64(len, time) * 1000, "/s");
		puts(")");
	}
	puts("\n");

	return 0;
}

int do_fs_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
		int fstype)
{
	int ret;
	char uuid[37];
	memset(uuid, 0, sizeof(uuid));

	if (argc < 3 || argc > 4)
		return CMD_RET_USAGE;

	if (fs_set_blk_dev(argv[1], argv[2], fstype))
		return 1;

	ret = fs_uuid(uuid);
	if (ret)
		return CMD_RET_FAILURE;

	if (argc == 4)
		env_set(argv[3], uuid);
	else
		printf("%s\n", uuid);

	return CMD_RET_SUCCESS;
}

int do_fs_type(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	struct fstype_info *info;

	if (argc < 3 || argc > 4)
		return CMD_RET_USAGE;

	if (fs_set_blk_dev(argv[1], argv[2], FS_TYPE_ANY))
		return 1;

	info = fs_get_info(fs_type);

	if (argc == 4)
		env_set(argv[3], info->name);
	else
		printf("%s\n", info->name);

	return CMD_RET_SUCCESS;
}

int do_mkdir(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
	     int fstype)
{
	int ret;

	if (argc != 4)
		return CMD_RET_USAGE;

	if (fs_set_blk_dev(argv[1], argv[2], fstype))
		return 1;

	ret = fs_mkdir(argv[3]);
	if (ret) {
		printf("** Unable to create a directory \"%s\" **\n", argv[3]);
		return 1;
	}

	return 0;
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0
045fa1e1 SW	2	/*
045fa1e1 SW	3	* Copyright (c) 2012, NVIDIA CORPORATION. All rights reserved.
045fa1e1 SW	4	*/
	5
	6	#include <config.h>
59e890ef	7	#include <errno.h>
045fa1e1	8	#include <common.h>
0eb25b61	9	#include <mapmem.h>
045fa1e1 SW	10	#include <part.h>
	11	#include <ext4fs.h>
	12	#include <fat.h>
	13	#include <fs.h>
92ccc96b	14	#include <sandboxfs.h>
251cee0d	15	#include <ubifs_uboot.h>
0c936ee3	16	#include <btrfs.h>
117e0507	17	#include <asm/io.h>
9e374e7b TR	18	#include <div64.h>
9e374e7b TR	19	#include <linux/math64.h>
045fa1e1	20
a1b231ce SW	21	DECLARE_GLOBAL_DATA_PTR;
a1b231ce SW	22
4101f687	23	static struct blk_desc *fs_dev_desc;
4bbcc965	24	static int fs_dev_part;
045fa1e1 SW	25	static disk_partition_t fs_partition;
	26	static int fs_type = FS_TYPE_ANY;
	27
4101f687	28	static inline int fs_probe_unsupported(struct blk_desc *fs_dev_desc,
2ded0d47	29	disk_partition_t *fs_partition)
436e2b73 SG	30	{
	31	printf(" Unrecognized filesystem type \n");
	32	return -1;
	33	}
	34
045fa1e1 SW	35	static inline int fs_ls_unsupported(const char *dirname)
045fa1e1 SW	36	{
045fa1e1 SW	37	return -1;
	38	}
	39
89191d62 RC	40	/* generic implementation of ls in terms of opendir/readdir/closedir */
	41	__maybe_unused
	42	static int fs_ls_generic(const char *dirname)
	43	{
	44	struct fs_dir_stream *dirs;
	45	struct fs_dirent *dent;
	46	int nfiles = 0, ndirs = 0;
	47
	48	dirs = fs_opendir(dirname);
	49	if (!dirs)
	50	return -errno;
	51
	52	while ((dent = fs_readdir(dirs))) {
	53	if (dent->type == FS_DT_DIR) {
	54	printf(" %s/\n", dent->name);
	55	ndirs++;
	56	} else {
	57	printf(" %8lld %s\n", dent->size, dent->name);
	58	nfiles++;
	59	}
	60	}
	61
	62	fs_closedir(dirs);
	63
	64	printf("\n%d file(s), %d dir(s)\n\n", nfiles, ndirs);
	65
	66	return 0;
	67	}
	68
6152916a SW	69	static inline int fs_exists_unsupported(const char *filename)
	70	{
	71	return 0;
	72	}
	73
d455d878	74	static inline int fs_size_unsupported(const char filename, loff_t size)
cf659819 SW	75	{
	76	return -1;
	77	}
	78
117e0507	79	static inline int fs_read_unsupported(const char filename, void buf,
d455d878 SR	80	loff_t offset, loff_t len,
d455d878 SR	81	loff_t *actread)
045fa1e1	82	{
045fa1e1 SW	83	return -1;
	84	}
	85
a8f6ab52	86	static inline int fs_write_unsupported(const char filename, void buf,
d455d878 SR	87	loff_t offset, loff_t len,
d455d878 SR	88	loff_t *actwrite)
a8f6ab52 SG	89	{
	90	return -1;
	91	}
	92
436e2b73 SG	93	static inline void fs_close_unsupported(void)
	94	{
	95	}
	96
59e890ef CG	97	static inline int fs_uuid_unsupported(char *uuid_str)
	98	{
	99	return -1;
	100	}
	101
4bbcc965 RC	102	static inline int fs_opendir_unsupported(const char *filename,
	103	struct fs_dir_stream **dirs)
	104	{
	105	return -EACCES;
	106	}
	107
e7074cff AT	108	static inline int fs_mkdir_unsupported(const char *dirname)
	109	{
	110	return -1;
	111	}
	112
436e2b73	113	struct fstype_info {
045fa1e1	114	int fstype;
1a1ad8e0	115	char *name;
377202b5 SW	116	/*
	117	* Is it legal to pass NULL as .probe()'s fs_dev_desc parameter? This
	118	* should be false in most cases. For "virtual" filesystems which
	119	* aren't based on a U-Boot block device (e.g. sandbox), this can be
ca230b09	120	* set to true. This should also be true for the dummy entry at the end
377202b5 SW	121	* of fstypes[], since that is essentially a "virtual" (non-existent)
	122	* filesystem.
	123	*/
	124	bool null_dev_desc_ok;
4101f687	125	int (probe)(struct blk_desc fs_dev_desc,
2ded0d47	126	disk_partition_t *fs_partition);
436e2b73	127	int (ls)(const char dirname);
6152916a	128	int (exists)(const char filename);
d455d878 SR	129	int (size)(const char filename, loff_t *size);
	130	int (read)(const char filename, void *buf, loff_t offset,
	131	loff_t len, loff_t *actread);
	132	int (write)(const char filename, void *buf, loff_t offset,
	133	loff_t len, loff_t *actwrite);
436e2b73	134	void (*close)(void);
59e890ef	135	int (uuid)(char uuid_str);
4bbcc965 RC	136	/*
	137	* Open a directory stream. On success return 0 and directory
	138	* stream pointer via 'dirsp'. On error, return -errno. See
	139	* fs_opendir().
	140	*/
	141	int (opendir)(const char filename, struct fs_dir_stream **dirsp);
	142	/*
	143	* Read next entry from directory stream. On success return 0
	144	* and directory entry pointer via 'dentp'. On error return
	145	* -errno. See fs_readdir().
	146	*/
	147	int (readdir)(struct fs_dir_stream dirs, struct fs_dirent **dentp);
	148	/* see fs_closedir() */
	149	void (closedir)(struct fs_dir_stream dirs);
e7074cff	150	int (mkdir)(const char dirname);
436e2b73 SG	151	};
	152
	153	static struct fstype_info fstypes[] = {
	154	#ifdef CONFIG_FS_FAT
045fa1e1 SW	155	{
045fa1e1 SW	156	.fstype = FS_TYPE_FAT,
1a1ad8e0	157	.name = "fat",
377202b5	158	.null_dev_desc_ok = false,
e6d52415 SG	159	.probe = fat_set_blk_dev,
e6d52415 SG	160	.close = fat_close,
89191d62	161	.ls = fs_ls_generic,
b7b5f319	162	.exists = fat_exists,
cf659819	163	.size = fat_size,
e6d52415	164	.read = fat_read_file,
d455d878 SR	165	#ifdef CONFIG_FAT_WRITE
d455d878 SR	166	.write = file_fat_write,
31a18d57	167	.mkdir = fat_mkdir,
d455d878	168	#else
bd6fb31f	169	.write = fs_write_unsupported,
31a18d57	170	.mkdir = fs_mkdir_unsupported,
d455d878	171	#endif
59e890ef	172	.uuid = fs_uuid_unsupported,
89191d62 RC	173	.opendir = fat_opendir,
	174	.readdir = fat_readdir,
	175	.closedir = fat_closedir,
045fa1e1	176	},
436e2b73 SG	177	#endif
436e2b73 SG	178	#ifdef CONFIG_FS_EXT4
045fa1e1 SW	179	{
045fa1e1 SW	180	.fstype = FS_TYPE_EXT,
1a1ad8e0	181	.name = "ext4",
377202b5	182	.null_dev_desc_ok = false,
e6d52415 SG	183	.probe = ext4fs_probe,
e6d52415 SG	184	.close = ext4fs_close,
436e2b73	185	.ls = ext4fs_ls,
55af5c93	186	.exists = ext4fs_exists,
cf659819	187	.size = ext4fs_size,
e6d52415	188	.read = ext4_read_file,
d455d878 SR	189	#ifdef CONFIG_CMD_EXT4_WRITE
	190	.write = ext4_write_file,
	191	#else
bd6fb31f	192	.write = fs_write_unsupported,
d455d878	193	#endif
59e890ef	194	.uuid = ext4fs_uuid,
4bbcc965	195	.opendir = fs_opendir_unsupported,
e7074cff	196	.mkdir = fs_mkdir_unsupported,
436e2b73	197	},
92ccc96b SG	198	#endif
	199	#ifdef CONFIG_SANDBOX
	200	{
	201	.fstype = FS_TYPE_SANDBOX,
1a1ad8e0	202	.name = "sandbox",
377202b5	203	.null_dev_desc_ok = true,
92ccc96b SG	204	.probe = sandbox_fs_set_blk_dev,
	205	.close = sandbox_fs_close,
	206	.ls = sandbox_fs_ls,
0a30aa1e	207	.exists = sandbox_fs_exists,
cf659819	208	.size = sandbox_fs_size,
92ccc96b	209	.read = fs_read_sandbox,
7eb2c8d5	210	.write = fs_write_sandbox,
59e890ef	211	.uuid = fs_uuid_unsupported,
4bbcc965	212	.opendir = fs_opendir_unsupported,
e7074cff	213	.mkdir = fs_mkdir_unsupported,
92ccc96b	214	},
251cee0d HG	215	#endif
	216	#ifdef CONFIG_CMD_UBIFS
	217	{
	218	.fstype = FS_TYPE_UBIFS,
	219	.name = "ubifs",
	220	.null_dev_desc_ok = true,
	221	.probe = ubifs_set_blk_dev,
	222	.close = ubifs_close,
	223	.ls = ubifs_ls,
	224	.exists = ubifs_exists,
	225	.size = ubifs_size,
	226	.read = ubifs_read,
	227	.write = fs_write_unsupported,
	228	.uuid = fs_uuid_unsupported,
4bbcc965	229	.opendir = fs_opendir_unsupported,
e7074cff	230	.mkdir = fs_mkdir_unsupported,
251cee0d	231	},
0c936ee3 MB	232	#endif
	233	#ifdef CONFIG_FS_BTRFS
	234	{
	235	.fstype = FS_TYPE_BTRFS,
	236	.name = "btrfs",
	237	.null_dev_desc_ok = false,
	238	.probe = btrfs_probe,
	239	.close = btrfs_close,
	240	.ls = btrfs_ls,
	241	.exists = btrfs_exists,
	242	.size = btrfs_size,
	243	.read = btrfs_read,
	244	.write = fs_write_unsupported,
	245	.uuid = btrfs_uuid,
38fc683d	246	.opendir = fs_opendir_unsupported,
e7074cff	247	.mkdir = fs_mkdir_unsupported,
0c936ee3	248	},
436e2b73 SG	249	#endif
	250	{
	251	.fstype = FS_TYPE_ANY,
1a1ad8e0	252	.name = "unsupported",
377202b5	253	.null_dev_desc_ok = true,
436e2b73 SG	254	.probe = fs_probe_unsupported,
	255	.close = fs_close_unsupported,
	256	.ls = fs_ls_unsupported,
6152916a	257	.exists = fs_exists_unsupported,
cf659819	258	.size = fs_size_unsupported,
436e2b73	259	.read = fs_read_unsupported,
a8f6ab52	260	.write = fs_write_unsupported,
59e890ef	261	.uuid = fs_uuid_unsupported,
4bbcc965	262	.opendir = fs_opendir_unsupported,
e7074cff	263	.mkdir = fs_mkdir_unsupported,
045fa1e1 SW	264	},
	265	};
	266
c6f548d2 SG	267	static struct fstype_info *fs_get_info(int fstype)
	268	{
	269	struct fstype_info *info;
	270	int i;
	271
	272	for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes) - 1; i++, info++) {
	273	if (fstype == info->fstype)
	274	return info;
	275	}
	276
	277	/* Return the 'unsupported' sentinel */
	278	return info;
	279	}
	280
0d488e8f AK	281	/**
	282	* fs_get_type_name() - Get type of current filesystem
	283	*
	284	* Return: Pointer to filesystem name
	285	*
	286	* Returns a string describing the current filesystem, or the sentinel
	287	* "unsupported" for any unrecognised filesystem.
	288	*/
	289	const char *fs_get_type_name(void)
	290	{
	291	return fs_get_info(fs_type)->name;
	292	}
	293
045fa1e1 SW	294	int fs_set_blk_dev(const char ifname, const char dev_part_str, int fstype)
045fa1e1 SW	295	{
436e2b73	296	struct fstype_info *info;
045fa1e1	297	int part, i;
a1b231ce SW	298	#ifdef CONFIG_NEEDS_MANUAL_RELOC
	299	static int relocated;
	300
	301	if (!relocated) {
436e2b73 SG	302	for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes);
436e2b73 SG	303	i++, info++) {
1a1ad8e0	304	info->name += gd->reloc_off;
436e2b73 SG	305	info->probe += gd->reloc_off;
	306	info->close += gd->reloc_off;
	307	info->ls += gd->reloc_off;
	308	info->read += gd->reloc_off;
a8f6ab52	309	info->write += gd->reloc_off;
436e2b73	310	}
a1b231ce SW	311	relocated = 1;
	312	}
	313	#endif
045fa1e1	314
e35929e4	315	part = blk_get_device_part_str(ifname, dev_part_str, &fs_dev_desc,
045fa1e1 SW	316	&fs_partition, 1);
	317	if (part < 0)
	318	return -1;
	319
436e2b73 SG	320	for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
	321	if (fstype != FS_TYPE_ANY && info->fstype != FS_TYPE_ANY &&
	322	fstype != info->fstype)
045fa1e1 SW	323	continue;
045fa1e1 SW	324
377202b5 SW	325	if (!fs_dev_desc && !info->null_dev_desc_ok)
	326	continue;
	327
4bbcc965 RC	328	if (!info->probe(fs_dev_desc, &fs_partition)) {
	329	fs_type = info->fstype;
	330	fs_dev_part = part;
	331	return 0;
	332	}
	333	}
	334
	335	return -1;
	336	}
	337
	338	/* set current blk device w/ blk_desc + partition # */
	339	int fs_set_blk_dev_with_part(struct blk_desc *desc, int part)
	340	{
	341	struct fstype_info *info;
	342	int ret, i;
	343
	344	if (part >= 1)
	345	ret = part_get_info(desc, part, &fs_partition);
	346	else
	347	ret = part_get_info_whole_disk(desc, &fs_partition);
	348	if (ret)
	349	return ret;
	350	fs_dev_desc = desc;
	351
	352	for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
2ded0d47	353	if (!info->probe(fs_dev_desc, &fs_partition)) {
436e2b73	354	fs_type = info->fstype;
045fa1e1 SW	355	return 0;
	356	}
	357	}
	358
045fa1e1 SW	359	return -1;
	360	}
	361
	362	static void fs_close(void)
	363	{
c6f548d2	364	struct fstype_info *info = fs_get_info(fs_type);
045fa1e1	365
c6f548d2	366	info->close();
e6d52415	367
045fa1e1 SW	368	fs_type = FS_TYPE_ANY;
	369	}
	370
59e890ef CG	371	int fs_uuid(char *uuid_str)
	372	{
	373	struct fstype_info *info = fs_get_info(fs_type);
	374
	375	return info->uuid(uuid_str);
	376	}
	377
045fa1e1 SW	378	int fs_ls(const char *dirname)
	379	{
	380	int ret;
	381
c6f548d2 SG	382	struct fstype_info *info = fs_get_info(fs_type);
	383
	384	ret = info->ls(dirname);
045fa1e1	385
e6d52415	386	fs_type = FS_TYPE_ANY;
045fa1e1 SW	387	fs_close();
	388
	389	return ret;
	390	}
	391
6152916a SW	392	int fs_exists(const char *filename)
	393	{
	394	int ret;
	395
	396	struct fstype_info *info = fs_get_info(fs_type);
	397
	398	ret = info->exists(filename);
	399
	400	fs_close();
	401
	402	return ret;
	403	}
	404
d455d878	405	int fs_size(const char filename, loff_t size)
cf659819 SW	406	{
	407	int ret;
	408
	409	struct fstype_info *info = fs_get_info(fs_type);
	410
d455d878	411	ret = info->size(filename, size);
cf659819 SW	412
	413	fs_close();
	414
	415	return ret;
	416	}
	417
d455d878 SR	418	int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
d455d878 SR	419	loff_t *actread)
045fa1e1	420	{
c6f548d2	421	struct fstype_info *info = fs_get_info(fs_type);
117e0507	422	void *buf;
045fa1e1 SW	423	int ret;
045fa1e1 SW	424
117e0507 SG	425	/*
	426	* We don't actually know how many bytes are being read, since len==0
	427	* means read the whole file.
	428	*/
	429	buf = map_sysmem(addr, len);
d455d878	430	ret = info->read(filename, buf, offset, len, actread);
117e0507	431	unmap_sysmem(buf);
045fa1e1	432
c6f548d2	433	/* If we requested a specific number of bytes, check we got it */
7a3e70cf	434	if (ret == 0 && len && *actread != len)
a327bde7	435	debug(" %s shorter than offset + len \n", filename);
045fa1e1 SW	436	fs_close();
	437
	438	return ret;
	439	}
	440
d455d878 SR	441	int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
d455d878 SR	442	loff_t *actwrite)
a8f6ab52 SG	443	{
	444	struct fstype_info *info = fs_get_info(fs_type);
	445	void *buf;
	446	int ret;
	447
a8f6ab52	448	buf = map_sysmem(addr, len);
d455d878	449	ret = info->write(filename, buf, offset, len, actwrite);
a8f6ab52 SG	450	unmap_sysmem(buf);
a8f6ab52 SG	451
d455d878	452	if (ret < 0 && len != *actwrite) {
a8f6ab52 SG	453	printf(" Unable to write file %s \n", filename);
	454	ret = -1;
	455	}
	456	fs_close();
	457
	458	return ret;
	459	}
	460
4bbcc965 RC	461	struct fs_dir_stream fs_opendir(const char filename)
	462	{
	463	struct fstype_info *info = fs_get_info(fs_type);
	464	struct fs_dir_stream *dirs = NULL;
	465	int ret;
	466
	467	ret = info->opendir(filename, &dirs);
	468	fs_close();
	469	if (ret) {
	470	errno = -ret;
	471	return NULL;
	472	}
	473
	474	dirs->desc = fs_dev_desc;
	475	dirs->part = fs_dev_part;
	476
	477	return dirs;
	478	}
	479
	480	struct fs_dirent fs_readdir(struct fs_dir_stream dirs)
	481	{
	482	struct fstype_info *info;
	483	struct fs_dirent *dirent;
	484	int ret;
	485
	486	fs_set_blk_dev_with_part(dirs->desc, dirs->part);
	487	info = fs_get_info(fs_type);
	488
	489	ret = info->readdir(dirs, &dirent);
	490	fs_close();
	491	if (ret) {
	492	errno = -ret;
	493	return NULL;
	494	}
	495
	496	return dirent;
	497	}
	498
	499	void fs_closedir(struct fs_dir_stream *dirs)
	500	{
	501	struct fstype_info *info;
	502
	503	if (!dirs)
	504	return;
	505
	506	fs_set_blk_dev_with_part(dirs->desc, dirs->part);
	507	info = fs_get_info(fs_type);
	508
	509	info->closedir(dirs);
	510	fs_close();
	511	}
	512
	513
e7074cff AT	514	int fs_mkdir(const char *dirname)
	515	{
	516	int ret;
	517
	518	struct fstype_info *info = fs_get_info(fs_type);
	519
	520	ret = info->mkdir(dirname);
	521
	522	fs_type = FS_TYPE_ANY;
	523	fs_close();
	524
	525	return ret;
	526	}
	527
cf659819 SW	528	int do_size(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
	529	int fstype)
	530	{
d455d878	531	loff_t size;
cf659819 SW	532
	533	if (argc != 4)
	534	return CMD_RET_USAGE;
	535
	536	if (fs_set_blk_dev(argv[1], argv[2], fstype))
	537	return 1;
	538
d455d878	539	if (fs_size(argv[3], &size) < 0)
cf659819 SW	540	return CMD_RET_FAILURE;
cf659819 SW	541
018f5303	542	env_set_hex("filesize", size);
cf659819 SW	543
	544	return 0;
	545	}
	546
f9b55e22	547	int do_load(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
b770e88a	548	int fstype)
045fa1e1 SW	549	{
	550	unsigned long addr;
	551	const char *addr_str;
	552	const char *filename;
d455d878 SR	553	loff_t bytes;
	554	loff_t pos;
	555	loff_t len_read;
	556	int ret;
da1fd96c	557	unsigned long time;
949bbd7c	558	char *ep;
045fa1e1	559
e9b0f99e SW	560	if (argc < 2)
	561	return CMD_RET_USAGE;
	562	if (argc > 7)
045fa1e1 SW	563	return CMD_RET_USAGE;
045fa1e1 SW	564
e9b0f99e	565	if (fs_set_blk_dev(argv[1], (argc >= 3) ? argv[2] : NULL, fstype))
045fa1e1 SW	566	return 1;
	567
	568	if (argc >= 4) {
949bbd7c PM	569	addr = simple_strtoul(argv[3], &ep, 16);
	570	if (ep == argv[3] \|\| *ep != '\0')
	571	return CMD_RET_USAGE;
045fa1e1	572	} else {
00caae6d	573	addr_str = env_get("loadaddr");
045fa1e1 SW	574	if (addr_str != NULL)
	575	addr = simple_strtoul(addr_str, NULL, 16);
	576	else
	577	addr = CONFIG_SYS_LOAD_ADDR;
	578	}
	579	if (argc >= 5) {
	580	filename = argv[4];
	581	} else {
00caae6d	582	filename = env_get("bootfile");
045fa1e1 SW	583	if (!filename) {
	584	puts(" No boot file defined \n");
	585	return 1;
	586	}
	587	}
	588	if (argc >= 6)
b770e88a	589	bytes = simple_strtoul(argv[5], NULL, 16);
045fa1e1 SW	590	else
	591	bytes = 0;
	592	if (argc >= 7)
b770e88a	593	pos = simple_strtoul(argv[6], NULL, 16);
045fa1e1 SW	594	else
	595	pos = 0;
	596
da1fd96c	597	time = get_timer(0);
d455d878	598	ret = fs_read(filename, addr, pos, bytes, &len_read);
da1fd96c	599	time = get_timer(time);
d455d878	600	if (ret < 0)
045fa1e1 SW	601	return 1;
045fa1e1 SW	602
d455d878	603	printf("%llu bytes read in %lu ms", len_read, time);
da1fd96c AB	604	if (time > 0) {
da1fd96c AB	605	puts(" (");
9e374e7b	606	print_size(div_u64(len_read, time) * 1000, "/s");
da1fd96c AB	607	puts(")");
	608	}
	609	puts("\n");
045fa1e1	610
018f5303 SG	611	env_set_hex("fileaddr", addr);
018f5303 SG	612	env_set_hex("filesize", len_read);
045fa1e1 SW	613
	614	return 0;
	615	}
	616
	617	int do_ls(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
	618	int fstype)
	619	{
	620	if (argc < 2)
	621	return CMD_RET_USAGE;
e9b0f99e SW	622	if (argc > 4)
e9b0f99e SW	623	return CMD_RET_USAGE;
045fa1e1 SW	624
	625	if (fs_set_blk_dev(argv[1], (argc >= 3) ? argv[2] : NULL, fstype))
	626	return 1;
	627
e9b0f99e	628	if (fs_ls(argc >= 4 ? argv[3] : "/"))
045fa1e1 SW	629	return 1;
	630
	631	return 0;
	632	}
a8f6ab52	633
6152916a SW	634	int file_exists(const char dev_type, const char dev_part, const char *file,
	635	int fstype)
	636	{
	637	if (fs_set_blk_dev(dev_type, dev_part, fstype))
	638	return 0;
	639
	640	return fs_exists(file);
	641	}
	642
a8f6ab52	643	int do_save(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
b770e88a	644	int fstype)
a8f6ab52 SG	645	{
	646	unsigned long addr;
	647	const char *filename;
d455d878 SR	648	loff_t bytes;
	649	loff_t pos;
	650	loff_t len;
	651	int ret;
a8f6ab52 SG	652	unsigned long time;
	653
	654	if (argc < 6 \|\| argc > 7)
	655	return CMD_RET_USAGE;
	656
	657	if (fs_set_blk_dev(argv[1], argv[2], fstype))
	658	return 1;
	659
d455d878 SR	660	addr = simple_strtoul(argv[3], NULL, 16);
d455d878 SR	661	filename = argv[4];
b770e88a	662	bytes = simple_strtoul(argv[5], NULL, 16);
a8f6ab52	663	if (argc >= 7)
b770e88a	664	pos = simple_strtoul(argv[6], NULL, 16);
a8f6ab52 SG	665	else
	666	pos = 0;
	667
	668	time = get_timer(0);
d455d878	669	ret = fs_write(filename, addr, pos, bytes, &len);
a8f6ab52	670	time = get_timer(time);
d455d878	671	if (ret < 0)
a8f6ab52 SG	672	return 1;
a8f6ab52 SG	673
d455d878	674	printf("%llu bytes written in %lu ms", len, time);
a8f6ab52 SG	675	if (time > 0) {
a8f6ab52 SG	676	puts(" (");
9e374e7b	677	print_size(div_u64(len, time) * 1000, "/s");
a8f6ab52 SG	678	puts(")");
	679	}
	680	puts("\n");
	681
	682	return 0;
	683	}
59e890ef CG	684
	685	int do_fs_uuid(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
	686	int fstype)
	687	{
	688	int ret;
	689	char uuid[37];
	690	memset(uuid, 0, sizeof(uuid));
	691
	692	if (argc < 3 \|\| argc > 4)
	693	return CMD_RET_USAGE;
	694
	695	if (fs_set_blk_dev(argv[1], argv[2], fstype))
	696	return 1;
	697
	698	ret = fs_uuid(uuid);
	699	if (ret)
	700	return CMD_RET_FAILURE;
	701
	702	if (argc == 4)
382bee57	703	env_set(argv[3], uuid);
59e890ef CG	704	else
	705	printf("%s\n", uuid);
	706
	707	return CMD_RET_SUCCESS;
	708	}
1a1ad8e0 SS	709
	710	int do_fs_type(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
	711	{
	712	struct fstype_info *info;
	713
	714	if (argc < 3 \|\| argc > 4)
	715	return CMD_RET_USAGE;
	716
	717	if (fs_set_blk_dev(argv[1], argv[2], FS_TYPE_ANY))
	718	return 1;
	719
	720	info = fs_get_info(fs_type);
	721
	722	if (argc == 4)
382bee57	723	env_set(argv[3], info->name);
1a1ad8e0 SS	724	else
	725	printf("%s\n", info->name);
	726
	727	return CMD_RET_SUCCESS;
	728	}
	729
e7074cff AT	730	int do_mkdir(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
	731	int fstype)
	732	{
	733	int ret;
	734
	735	if (argc != 4)
	736	return CMD_RET_USAGE;
	737
	738	if (fs_set_blk_dev(argv[1], argv[2], fstype))
	739	return 1;
	740
	741	ret = fs_mkdir(argv[3]);
	742	if (ret) {
	743	printf(" Unable to create a directory \"%s\" \n", argv[3]);
	744	return 1;
	745	}
	746
	747	return 0;
	748	}