rockchip: Remove ARCH= references from documentation
[oweals/u-boot.git] / cmd / fs.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
4  *
5  * Inspired by cmd_ext_common.c, cmd_fat.c.
6  */
7
8 #include <common.h>
9 #include <command.h>
10 #include <fs.h>
11
12 static int do_size_wrapper(struct cmd_tbl *cmdtp, int flag, int argc,
13                            char *const argv[])
14 {
15         return do_size(cmdtp, flag, argc, argv, FS_TYPE_ANY);
16 }
17
18 U_BOOT_CMD(
19         size,   4,      0,      do_size_wrapper,
20         "determine a file's size",
21         "<interface> <dev[:part]> <filename>\n"
22         "    - Find file 'filename' from 'dev' on 'interface'\n"
23         "      and determine its size."
24 );
25
26 static int do_load_wrapper(struct cmd_tbl *cmdtp, int flag, int argc,
27                            char *const argv[])
28 {
29         return do_load(cmdtp, flag, argc, argv, FS_TYPE_ANY);
30 }
31
32 U_BOOT_CMD(
33         load,   7,      0,      do_load_wrapper,
34         "load binary file from a filesystem",
35         "<interface> [<dev[:part]> [<addr> [<filename> [bytes [pos]]]]]\n"
36         "    - Load binary file 'filename' from partition 'part' on device\n"
37         "       type 'interface' instance 'dev' to address 'addr' in memory.\n"
38         "      'bytes' gives the size to load in bytes.\n"
39         "      If 'bytes' is 0 or omitted, the file is read until the end.\n"
40         "      'pos' gives the file byte position to start reading from.\n"
41         "      If 'pos' is 0 or omitted, the file is read from the start."
42 )
43
44 static int do_save_wrapper(struct cmd_tbl *cmdtp, int flag, int argc,
45                            char *const argv[])
46 {
47         return do_save(cmdtp, flag, argc, argv, FS_TYPE_ANY);
48 }
49
50 U_BOOT_CMD(
51         save,   7,      0,      do_save_wrapper,
52         "save file to a filesystem",
53         "<interface> <dev[:part]> <addr> <filename> bytes [pos]\n"
54         "    - Save binary file 'filename' to partition 'part' on device\n"
55         "      type 'interface' instance 'dev' from addr 'addr' in memory.\n"
56         "      'bytes' gives the size to save in bytes and is mandatory.\n"
57         "      'pos' gives the file byte position to start writing to.\n"
58         "      If 'pos' is 0 or omitted, the file is written from the start."
59 )
60
61 static int do_ls_wrapper(struct cmd_tbl *cmdtp, int flag, int argc,
62                          char *const argv[])
63 {
64         return do_ls(cmdtp, flag, argc, argv, FS_TYPE_ANY);
65 }
66
67 U_BOOT_CMD(
68         ls,     4,      1,      do_ls_wrapper,
69         "list files in a directory (default /)",
70         "<interface> [<dev[:part]> [directory]]\n"
71         "    - List files in directory 'directory' of partition 'part' on\n"
72         "      device type 'interface' instance 'dev'."
73 )
74
75 static int do_ln_wrapper(struct cmd_tbl *cmdtp, int flag, int argc,
76                          char *const argv[])
77 {
78         return do_ln(cmdtp, flag, argc, argv, FS_TYPE_ANY);
79 }
80
81 U_BOOT_CMD(
82         ln,     5,      1,      do_ln_wrapper,
83         "Create a symbolic link",
84         "<interface> <dev[:part]> target linkname\n"
85         "    - create a symbolic link to 'target' with the name 'linkname' on\n"
86         "      device type 'interface' instance 'dev'."
87 )
88
89 static int do_fstype_wrapper(struct cmd_tbl *cmdtp, int flag, int argc,
90                              char *const argv[])
91 {
92         return do_fs_type(cmdtp, flag, argc, argv);
93 }
94
95 U_BOOT_CMD(
96         fstype, 4, 1, do_fstype_wrapper,
97         "Look up a filesystem type",
98         "<interface> <dev>:<part>\n"
99         "- print filesystem type\n"
100         "fstype <interface> <dev>:<part> <varname>\n"
101         "- set environment variable to filesystem type\n"
102 );