Merge branch 'master' of git://git.denx.de/u-boot-spi
[platform/kernel/u-boot.git] / include / fs.h
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 #define FS_TYPE_SANDBOX 3
25
26 /*
27  * Tell the fs layer which block device an partition to use for future
28  * commands. This also internally identifies the filesystem that is present
29  * within the partition. The identification process may be limited to a
30  * specific filesystem type by passing FS_* in the fstype parameter.
31  *
32  * Returns 0 on success.
33  * Returns non-zero if there is an error accessing the disk or partition, or
34  * no known filesystem type could be recognized on it.
35  */
36 int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype);
37
38 /*
39  * Print the list of files on the partition previously set by fs_set_blk_dev(),
40  * in directory "dirname".
41  *
42  * Returns 0 on success. Returns non-zero on error.
43  */
44 int fs_ls(const char *dirname);
45
46 /*
47  * Determine whether a file exists
48  *
49  * Returns 1 if the file exists, 0 if it doesn't exist.
50  */
51 int fs_exists(const char *filename);
52
53 /*
54  * Read file "filename" from the partition previously set by fs_set_blk_dev(),
55  * to address "addr", starting at byte offset "offset", and reading "len"
56  * bytes. "offset" may be 0 to read from the start of the file. "len" may be
57  * 0 to read the entire file. Note that not all filesystem types support
58  * either/both offset!=0 or len!=0.
59  *
60  * Returns number of bytes read on success. Returns <= 0 on error.
61  */
62 int fs_read(const char *filename, ulong addr, int offset, int len);
63
64 /*
65  * Write file "filename" to the partition previously set by fs_set_blk_dev(),
66  * from address "addr", starting at byte offset "offset", and writing "len"
67  * bytes. "offset" may be 0 to write to the start of the file. Note that not
68  * all filesystem types support offset!=0.
69  *
70  * Returns number of bytes read on success. Returns <= 0 on error.
71  */
72 int fs_write(const char *filename, ulong addr, int offset, int len);
73
74 /*
75  * Common implementation for various filesystem commands, optionally limited
76  * to a specific filesystem type via the fstype parameter.
77  */
78 int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
79                 int fstype);
80 int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
81                 int fstype);
82 int file_exists(const char *dev_type, const char *dev_part, const char *file,
83                 int fstype);
84 int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
85                 int fstype);
86
87 #endif /* _FS_H */