xref: /openbmc/u-boot/include/fs.h (revision 71a988aa)
1 /*
2  * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms and conditions of the GNU General Public License,
6  * version 2, as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
11  * more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16 #ifndef _FS_H
17 #define _FS_H
18 
19 #include <common.h>
20 
21 #define FS_TYPE_ANY	0
22 #define FS_TYPE_FAT	1
23 #define FS_TYPE_EXT	2
24 
25 /*
26  * Tell the fs layer which block device an partition to use for future
27  * commands. This also internally identifies the filesystem that is present
28  * within the partition. The identification process may be limited to a
29  * specific filesystem type by passing FS_* in the fstype parameter.
30  *
31  * Returns 0 on success.
32  * Returns non-zero if there is an error accessing the disk or partition, or
33  * no known filesystem type could be recognized on it.
34  */
35 int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype);
36 
37 /*
38  * Print the list of files on the partition previously set by fs_set_blk_dev(),
39  * in directory "dirname".
40  *
41  * Returns 0 on success. Returns non-zero on error.
42  */
43 int fs_ls(const char *dirname);
44 
45 /*
46  * Read file "filename" from the partition previously set by fs_set_blk_dev(),
47  * to address "addr", starting at byte offset "offset", and reading "len"
48  * bytes. "offset" may be 0 to read from the start of the file. "len" may be
49  * 0 to read the entire file. Note that not all filesystem types support
50  * either/both offset!=0 or len!=0.
51  *
52  * Returns number of bytes read on success. Returns <= 0 on error.
53  */
54 int fs_read(const char *filename, ulong addr, int offset, int len);
55 
56 /*
57  * Common implementation for various filesystem commands, optionally limited
58  * to a specific filesystem type via the fstype parameter.
59  */
60 int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
61 		int fstype, int cmdline_base);
62 int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
63 		int fstype);
64 
65 #endif /* _FS_H */
66