1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2012, NVIDIA CORPORATION. All rights reserved.
6 #define LOG_CATEGORY LOGC_CORE
10 #include <display_options.h>
21 #include <sandboxfs.h>
22 #include <semihostingfs.h>
24 #include <ubifs_uboot.h>
26 #include <asm/global_data.h>
29 #include <linux/math64.h>
30 #include <linux/sizes.h>
31 #include <efi_loader.h>
35 DECLARE_GLOBAL_DATA_PTR;
37 static struct blk_desc *fs_dev_desc;
38 static int fs_dev_part;
39 static struct disk_partition fs_partition;
40 static int fs_type = FS_TYPE_ANY;
42 void fs_set_type(int type)
47 static inline int fs_probe_unsupported(struct blk_desc *fs_dev_desc,
48 struct disk_partition *fs_partition)
50 log_debug("Unrecognized filesystem type\n");
54 static inline int fs_ls_unsupported(const char *dirname)
59 /* generic implementation of ls in terms of opendir/readdir/closedir */
61 static int fs_ls_generic(const char *dirname)
63 struct fs_dir_stream *dirs;
64 struct fs_dirent *dent;
65 int nfiles = 0, ndirs = 0;
67 dirs = fs_opendir(dirname);
71 while ((dent = fs_readdir(dirs))) {
72 if (dent->type == FS_DT_DIR) {
73 printf(" %s/\n", dent->name);
75 } else if (dent->type == FS_DT_LNK) {
76 printf(" <SYM> %s\n", dent->name);
79 printf(" %8lld %s\n", dent->size, dent->name);
86 printf("\n%d file(s), %d dir(s)\n\n", nfiles, ndirs);
91 static inline int fs_exists_unsupported(const char *filename)
96 static inline int fs_size_unsupported(const char *filename, loff_t *size)
101 static inline int fs_read_unsupported(const char *filename, void *buf,
102 loff_t offset, loff_t len,
108 static inline int fs_write_unsupported(const char *filename, void *buf,
109 loff_t offset, loff_t len,
115 static inline int fs_ln_unsupported(const char *filename, const char *target)
120 static inline void fs_close_unsupported(void)
124 static inline int fs_uuid_unsupported(char *uuid_str)
129 static inline int fs_opendir_unsupported(const char *filename,
130 struct fs_dir_stream **dirs)
135 static inline int fs_unlink_unsupported(const char *filename)
140 static inline int fs_mkdir_unsupported(const char *dirname)
149 * Is it legal to pass NULL as .probe()'s fs_dev_desc parameter? This
150 * should be false in most cases. For "virtual" filesystems which
151 * aren't based on a U-Boot block device (e.g. sandbox), this can be
152 * set to true. This should also be true for the dummy entry at the end
153 * of fstypes[], since that is essentially a "virtual" (non-existent)
156 bool null_dev_desc_ok;
157 int (*probe)(struct blk_desc *fs_dev_desc,
158 struct disk_partition *fs_partition);
159 int (*ls)(const char *dirname);
160 int (*exists)(const char *filename);
161 int (*size)(const char *filename, loff_t *size);
162 int (*read)(const char *filename, void *buf, loff_t offset,
163 loff_t len, loff_t *actread);
164 int (*write)(const char *filename, void *buf, loff_t offset,
165 loff_t len, loff_t *actwrite);
167 int (*uuid)(char *uuid_str);
169 * Open a directory stream. On success return 0 and directory
170 * stream pointer via 'dirsp'. On error, return -errno. See
173 int (*opendir)(const char *filename, struct fs_dir_stream **dirsp);
175 * Read next entry from directory stream. On success return 0
176 * and directory entry pointer via 'dentp'. On error return
177 * -errno. See fs_readdir().
179 int (*readdir)(struct fs_dir_stream *dirs, struct fs_dirent **dentp);
180 /* see fs_closedir() */
181 void (*closedir)(struct fs_dir_stream *dirs);
182 int (*unlink)(const char *filename);
183 int (*mkdir)(const char *dirname);
184 int (*ln)(const char *filename, const char *target);
187 static struct fstype_info fstypes[] = {
188 #if CONFIG_IS_ENABLED(FS_FAT)
190 .fstype = FS_TYPE_FAT,
192 .null_dev_desc_ok = false,
193 .probe = fat_set_blk_dev,
196 .exists = fat_exists,
198 .read = fat_read_file,
199 #if CONFIG_IS_ENABLED(FAT_WRITE)
200 .write = file_fat_write,
201 .unlink = fat_unlink,
204 .write = fs_write_unsupported,
205 .unlink = fs_unlink_unsupported,
206 .mkdir = fs_mkdir_unsupported,
209 .opendir = fat_opendir,
210 .readdir = fat_readdir,
211 .closedir = fat_closedir,
212 .ln = fs_ln_unsupported,
216 #if CONFIG_IS_ENABLED(FS_EXT4)
218 .fstype = FS_TYPE_EXT,
220 .null_dev_desc_ok = false,
221 .probe = ext4fs_probe,
222 .close = ext4fs_close,
224 .exists = ext4fs_exists,
226 .read = ext4_read_file,
227 #ifdef CONFIG_EXT4_WRITE
228 .write = ext4_write_file,
229 .ln = ext4fs_create_link,
231 .write = fs_write_unsupported,
232 .ln = fs_ln_unsupported,
235 .opendir = fs_opendir_unsupported,
236 .unlink = fs_unlink_unsupported,
237 .mkdir = fs_mkdir_unsupported,
240 #if IS_ENABLED(CONFIG_SANDBOX) && !IS_ENABLED(CONFIG_XPL_BUILD)
242 .fstype = FS_TYPE_SANDBOX,
244 .null_dev_desc_ok = true,
245 .probe = sandbox_fs_set_blk_dev,
246 .close = sandbox_fs_close,
248 .exists = sandbox_fs_exists,
249 .size = sandbox_fs_size,
250 .read = fs_read_sandbox,
251 .write = fs_write_sandbox,
252 .uuid = fs_uuid_unsupported,
253 .opendir = fs_opendir_unsupported,
254 .unlink = fs_unlink_unsupported,
255 .mkdir = fs_mkdir_unsupported,
256 .ln = fs_ln_unsupported,
259 #if CONFIG_IS_ENABLED(SEMIHOSTING)
261 .fstype = FS_TYPE_SEMIHOSTING,
262 .name = "semihosting",
263 .null_dev_desc_ok = true,
264 .probe = smh_fs_set_blk_dev,
265 .close = fs_close_unsupported,
266 .ls = fs_ls_unsupported,
267 .exists = fs_exists_unsupported,
270 .write = smh_fs_write,
271 .uuid = fs_uuid_unsupported,
272 .opendir = fs_opendir_unsupported,
273 .unlink = fs_unlink_unsupported,
274 .mkdir = fs_mkdir_unsupported,
275 .ln = fs_ln_unsupported,
278 #ifndef CONFIG_XPL_BUILD
279 #ifdef CONFIG_CMD_UBIFS
281 .fstype = FS_TYPE_UBIFS,
283 .null_dev_desc_ok = true,
284 .probe = ubifs_set_blk_dev,
285 .close = ubifs_close,
287 .exists = ubifs_exists,
290 .write = fs_write_unsupported,
291 .uuid = fs_uuid_unsupported,
292 .opendir = fs_opendir_unsupported,
293 .unlink = fs_unlink_unsupported,
294 .mkdir = fs_mkdir_unsupported,
295 .ln = fs_ln_unsupported,
299 #ifndef CONFIG_XPL_BUILD
300 #ifdef CONFIG_FS_BTRFS
302 .fstype = FS_TYPE_BTRFS,
304 .null_dev_desc_ok = false,
305 .probe = btrfs_probe,
306 .close = btrfs_close,
308 .exists = btrfs_exists,
311 .write = fs_write_unsupported,
313 .opendir = fs_opendir_unsupported,
314 .unlink = fs_unlink_unsupported,
315 .mkdir = fs_mkdir_unsupported,
316 .ln = fs_ln_unsupported,
320 #if CONFIG_IS_ENABLED(FS_SQUASHFS)
322 .fstype = FS_TYPE_SQUASHFS,
324 .null_dev_desc_ok = false,
326 .opendir = sqfs_opendir,
327 .readdir = sqfs_readdir,
332 .closedir = sqfs_closedir,
333 .exists = sqfs_exists,
334 .uuid = fs_uuid_unsupported,
335 .write = fs_write_unsupported,
336 .ln = fs_ln_unsupported,
337 .unlink = fs_unlink_unsupported,
338 .mkdir = fs_mkdir_unsupported,
341 #if IS_ENABLED(CONFIG_FS_EROFS)
343 .fstype = FS_TYPE_EROFS,
345 .null_dev_desc_ok = false,
346 .probe = erofs_probe,
347 .opendir = erofs_opendir,
348 .readdir = erofs_readdir,
352 .close = erofs_close,
353 .closedir = erofs_closedir,
354 .exists = erofs_exists,
355 .uuid = fs_uuid_unsupported,
356 .write = fs_write_unsupported,
357 .ln = fs_ln_unsupported,
358 .unlink = fs_unlink_unsupported,
359 .mkdir = fs_mkdir_unsupported,
363 .fstype = FS_TYPE_ANY,
364 .name = "unsupported",
365 .null_dev_desc_ok = true,
366 .probe = fs_probe_unsupported,
367 .close = fs_close_unsupported,
368 .ls = fs_ls_unsupported,
369 .exists = fs_exists_unsupported,
370 .size = fs_size_unsupported,
371 .read = fs_read_unsupported,
372 .write = fs_write_unsupported,
373 .uuid = fs_uuid_unsupported,
374 .opendir = fs_opendir_unsupported,
375 .unlink = fs_unlink_unsupported,
376 .mkdir = fs_mkdir_unsupported,
377 .ln = fs_ln_unsupported,
381 static struct fstype_info *fs_get_info(int fstype)
383 struct fstype_info *info;
386 for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes) - 1; i++, info++) {
387 if (fstype == info->fstype)
391 /* Return the 'unsupported' sentinel */
396 * fs_get_type() - Get type of current filesystem
398 * Return: filesystem type
400 * Returns filesystem type representing the current filesystem, or
401 * FS_TYPE_ANY for any unrecognised filesystem.
403 int fs_get_type(void)
409 * fs_get_type_name() - Get type of current filesystem
411 * Return: Pointer to filesystem name
413 * Returns a string describing the current filesystem, or the sentinel
414 * "unsupported" for any unrecognised filesystem.
416 const char *fs_get_type_name(void)
418 return fs_get_info(fs_type)->name;
421 int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype)
423 struct fstype_info *info;
426 part = part_get_info_by_dev_and_name_or_num(ifname, dev_part_str, &fs_dev_desc,
431 for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
432 if (fstype != FS_TYPE_ANY && info->fstype != FS_TYPE_ANY &&
433 fstype != info->fstype)
436 if (!fs_dev_desc && !info->null_dev_desc_ok)
439 if (!info->probe(fs_dev_desc, &fs_partition)) {
440 fs_type = info->fstype;
449 /* set current blk device w/ blk_desc + partition # */
450 int fs_set_blk_dev_with_part(struct blk_desc *desc, int part)
452 struct fstype_info *info;
456 ret = part_get_info(desc, part, &fs_partition);
458 ret = part_get_info_whole_disk(desc, &fs_partition);
463 for (i = 0, info = fstypes; i < ARRAY_SIZE(fstypes); i++, info++) {
464 if (!info->probe(fs_dev_desc, &fs_partition)) {
465 fs_type = info->fstype;
476 struct fstype_info *info = fs_get_info(fs_type);
480 fs_type = FS_TYPE_ANY;
483 int fs_uuid(char *uuid_str)
485 struct fstype_info *info = fs_get_info(fs_type);
487 return info->uuid(uuid_str);
490 int fs_ls(const char *dirname)
494 struct fstype_info *info = fs_get_info(fs_type);
496 ret = info->ls(dirname);
503 int fs_exists(const char *filename)
507 struct fstype_info *info = fs_get_info(fs_type);
509 ret = info->exists(filename);
516 int fs_size(const char *filename, loff_t *size)
520 struct fstype_info *info = fs_get_info(fs_type);
522 ret = info->size(filename, size);
529 #if CONFIG_IS_ENABLED(LMB)
530 /* Check if a file may be read to the given address */
531 static int fs_read_lmb_check(const char *filename, ulong addr, loff_t offset,
532 loff_t len, struct fstype_info *info)
538 /* get the actual size of the file */
539 ret = info->size(filename, &size);
542 if (offset >= size) {
543 /* offset >= EOF, no bytes will be written */
546 read_len = size - offset;
548 /* limit to 'len' if it is smaller */
549 if (len && len < read_len)
554 if (lmb_alloc_addr(addr, read_len) == addr)
557 log_err("** Reading file would overwrite reserved memory **\n");
562 static int _fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
563 int do_lmb_check, loff_t *actread)
565 struct fstype_info *info = fs_get_info(fs_type);
569 #if CONFIG_IS_ENABLED(LMB)
571 ret = fs_read_lmb_check(filename, addr, offset, len, info);
578 * We don't actually know how many bytes are being read, since len==0
579 * means read the whole file.
581 buf = map_sysmem(addr, len);
582 ret = info->read(filename, buf, offset, len, actread);
585 /* If we requested a specific number of bytes, check we got it */
586 if (ret == 0 && len && *actread != len)
587 log_debug("** %s shorter than offset + len **\n", filename);
593 int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
596 return _fs_read(filename, addr, offset, len, 0, actread);
599 int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
602 struct fstype_info *info = fs_get_info(fs_type);
606 buf = map_sysmem(addr, len);
607 ret = info->write(filename, buf, offset, len, actwrite);
610 if (ret < 0 && len != *actwrite) {
611 log_err("** Unable to write file %s **\n", filename);
619 struct fs_dir_stream *fs_opendir(const char *filename)
621 struct fstype_info *info = fs_get_info(fs_type);
622 struct fs_dir_stream *dirs = NULL;
625 ret = info->opendir(filename, &dirs);
632 dirs->desc = fs_dev_desc;
633 dirs->part = fs_dev_part;
638 struct fs_dirent *fs_readdir(struct fs_dir_stream *dirs)
640 struct fstype_info *info;
641 struct fs_dirent *dirent;
644 fs_set_blk_dev_with_part(dirs->desc, dirs->part);
645 info = fs_get_info(fs_type);
647 ret = info->readdir(dirs, &dirent);
657 void fs_closedir(struct fs_dir_stream *dirs)
659 struct fstype_info *info;
664 fs_set_blk_dev_with_part(dirs->desc, dirs->part);
665 info = fs_get_info(fs_type);
667 info->closedir(dirs);
671 int fs_unlink(const char *filename)
675 struct fstype_info *info = fs_get_info(fs_type);
677 ret = info->unlink(filename);
684 int fs_mkdir(const char *dirname)
688 struct fstype_info *info = fs_get_info(fs_type);
690 ret = info->mkdir(dirname);
697 int fs_ln(const char *fname, const char *target)
699 struct fstype_info *info = fs_get_info(fs_type);
702 ret = info->ln(fname, target);
705 log_err("** Unable to create link %s -> %s **\n", fname, target);
713 int do_size(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
719 return CMD_RET_USAGE;
721 if (fs_set_blk_dev(argv[1], argv[2], fstype))
724 if (fs_size(argv[3], &size) < 0)
725 return CMD_RET_FAILURE;
727 env_set_hex("filesize", size);
732 int do_load(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
736 const char *addr_str;
737 const char *filename;
746 return CMD_RET_USAGE;
748 return CMD_RET_USAGE;
750 if (fs_set_blk_dev(argv[1], cmd_arg2(argc, argv), fstype)) {
751 log_err("Can't set block device\n");
756 addr = hextoul(argv[3], &ep);
757 if (ep == argv[3] || *ep != '\0')
758 return CMD_RET_USAGE;
760 addr_str = env_get("loadaddr");
761 if (addr_str != NULL)
762 addr = hextoul(addr_str, NULL);
764 addr = CONFIG_SYS_LOAD_ADDR;
769 filename = env_get("bootfile");
771 puts("** No boot file defined **\n");
776 bytes = hextoul(argv[5], NULL);
780 pos = hextoul(argv[6], NULL);
785 ret = _fs_read(filename, addr, pos, bytes, 1, &len_read);
786 time = get_timer(time);
788 log_err("Failed to load '%s'\n", filename);
792 efi_set_bootdev(argv[1], (argc > 2) ? argv[2] : "",
793 (argc > 4) ? argv[4] : "", map_sysmem(addr, 0),
796 printf("%llu bytes read in %lu ms", len_read, time);
799 print_size(div_u64(len_read, time) * 1000, "/s");
804 env_set_hex("fileaddr", addr);
805 env_set_hex("filesize", len_read);
810 int do_ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
814 return CMD_RET_USAGE;
816 return CMD_RET_USAGE;
818 if (fs_set_blk_dev(argv[1], cmd_arg2(argc, argv), fstype))
821 if (fs_ls(argc >= 4 ? argv[3] : "/"))
827 int file_exists(const char *dev_type, const char *dev_part, const char *file,
830 if (fs_set_blk_dev(dev_type, dev_part, fstype))
833 return fs_exists(file);
836 int do_save(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
840 const char *filename;
847 if (argc < 6 || argc > 7)
848 return CMD_RET_USAGE;
850 if (fs_set_blk_dev(argv[1], argv[2], fstype))
853 addr = hextoul(argv[3], NULL);
855 bytes = hextoul(argv[5], NULL);
857 pos = hextoul(argv[6], NULL);
862 ret = fs_write(filename, addr, pos, bytes, &len);
863 time = get_timer(time);
867 printf("%llu bytes written in %lu ms", len, time);
870 print_size(div_u64(len, time) * 1000, "/s");
878 int do_fs_uuid(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
883 memset(uuid, 0, sizeof(uuid));
885 if (argc < 3 || argc > 4)
886 return CMD_RET_USAGE;
888 if (fs_set_blk_dev(argv[1], argv[2], fstype))
893 return CMD_RET_FAILURE;
896 env_set(argv[3], uuid);
898 printf("%s\n", uuid);
900 return CMD_RET_SUCCESS;
903 int do_fs_type(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
905 struct fstype_info *info;
907 if (argc < 3 || argc > 4)
908 return CMD_RET_USAGE;
910 if (fs_set_blk_dev(argv[1], argv[2], FS_TYPE_ANY))
913 info = fs_get_info(fs_type);
916 env_set(argv[3], info->name);
918 printf("%s\n", info->name);
922 return CMD_RET_SUCCESS;
925 int do_rm(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
929 return CMD_RET_USAGE;
931 if (fs_set_blk_dev(argv[1], argv[2], fstype))
934 if (fs_unlink(argv[3]))
940 int do_mkdir(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
946 return CMD_RET_USAGE;
948 if (fs_set_blk_dev(argv[1], argv[2], fstype))
951 ret = fs_mkdir(argv[3]);
953 log_err("** Unable to create a directory \"%s\" **\n", argv[3]);
960 int do_ln(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[],
964 return CMD_RET_USAGE;
966 if (fs_set_blk_dev(argv[1], argv[2], fstype))
969 if (fs_ln(argv[3], argv[4]))
975 int do_fs_types(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[])
977 struct fstype_info *drv = fstypes;
978 const int n_ents = ARRAY_SIZE(fstypes);
979 struct fstype_info *entry;
982 puts("Supported filesystems");
983 for (entry = drv; entry != drv + n_ents; entry++) {
984 if (entry->fstype != FS_TYPE_ANY) {
985 printf("%c %s", i ? ',' : ':', entry->name);
992 return CMD_RET_SUCCESS;
995 int fs_read_alloc(const char *fname, ulong size, uint align, void **bufp)
1002 buf = memalign(align, size + 1);
1004 return log_msg_ret("buf", -ENOMEM);
1005 addr = map_to_sysmem(buf);
1007 ret = fs_read(fname, addr, 0, size, &bytes_read);
1010 return log_msg_ret("read", ret);
1012 if (size != bytes_read)
1013 return log_msg_ret("bread", -EIO);
1021 int fs_load_alloc(const char *ifname, const char *dev_part_str,
1022 const char *fname, ulong max_size, ulong align, void **bufp,
1029 if (fs_set_blk_dev(ifname, dev_part_str, FS_TYPE_ANY))
1030 return log_msg_ret("set", -ENOMEDIUM);
1032 ret = fs_size(fname, &size);
1034 return log_msg_ret("sz", -ENOENT);
1036 if (size >= (max_size ?: SZ_1G))
1037 return log_msg_ret("sz", -E2BIG);
1039 if (fs_set_blk_dev(ifname, dev_part_str, FS_TYPE_ANY))
1040 return log_msg_ret("set", -ENOMEDIUM);
1042 ret = fs_read_alloc(fname, size, align, &buf);
1044 return log_msg_ret("al", ret);