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