Merge git://git.denx.de/u-boot-marvell
[platform/kernel/u-boot.git] / include / fs.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
4  */
5 #ifndef _FS_H
6 #define _FS_H
7
8 #include <common.h>
9
10 #define FS_TYPE_ANY     0
11 #define FS_TYPE_FAT     1
12 #define FS_TYPE_EXT     2
13 #define FS_TYPE_SANDBOX 3
14 #define FS_TYPE_UBIFS   4
15 #define FS_TYPE_BTRFS   5
16
17 /*
18  * Tell the fs layer which block device an partition to use for future
19  * commands. This also internally identifies the filesystem that is present
20  * within the partition. The identification process may be limited to a
21  * specific filesystem type by passing FS_* in the fstype parameter.
22  *
23  * Returns 0 on success.
24  * Returns non-zero if there is an error accessing the disk or partition, or
25  * no known filesystem type could be recognized on it.
26  */
27 int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype);
28
29 /*
30  * fs_set_blk_dev_with_part - Set current block device + partition
31  *
32  * Similar to fs_set_blk_dev(), but useful for cases where you already
33  * know the blk_desc and part number.
34  *
35  * Returns 0 on success.
36  * Returns non-zero if invalid partition or error accessing the disk.
37  */
38 int fs_set_blk_dev_with_part(struct blk_desc *desc, int part);
39
40 /**
41  * fs_get_type_name() - Get type of current filesystem
42  *
43  * Return: Pointer to filesystem name
44  *
45  * Returns a string describing the current filesystem, or the sentinel
46  * "unsupported" for any unrecognised filesystem.
47  */
48 const char *fs_get_type_name(void);
49
50 /*
51  * Print the list of files on the partition previously set by fs_set_blk_dev(),
52  * in directory "dirname".
53  *
54  * Returns 0 on success. Returns non-zero on error.
55  */
56 int fs_ls(const char *dirname);
57
58 /*
59  * Determine whether a file exists
60  *
61  * Returns 1 if the file exists, 0 if it doesn't exist.
62  */
63 int fs_exists(const char *filename);
64
65 /*
66  * fs_size - Determine a file's size
67  *
68  * @filename: Name of the file
69  * @size: Size of file
70  * @return 0 if ok with valid *size, negative on error
71  */
72 int fs_size(const char *filename, loff_t *size);
73
74 /**
75  * fs_read() - read file from the partition previously set by fs_set_blk_dev()
76  *
77  * Note that not all filesystem drivers support either or both of offset != 0
78  * and len != 0.
79  *
80  * @filename:   full path of the file to read from
81  * @addr:       address of the buffer to write to
82  * @offset:     offset in the file from where to start reading
83  * @len:        the number of bytes to read. Use 0 to read entire file.
84  * @actread:    returns the actual number of bytes read
85  * Return:      0 if OK with valid *actread, -1 on error conditions
86  */
87 int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
88             loff_t *actread);
89
90 /**
91  * fs_write() - write file to the partition previously set by fs_set_blk_dev()
92  *
93  * Note that not all filesystem drivers support offset != 0.
94  *
95  * @filename:   full path of the file to write to
96  * @addr:       address of the buffer to read from
97  * @offset:     offset in the file from where to start writing
98  * @len:        the number of bytes to write
99  * @actwrite:   returns the actual number of bytes written
100  * Return:      0 if OK with valid *actwrite, -1 on error conditions
101  */
102 int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
103              loff_t *actwrite);
104
105 /*
106  * Directory entry types, matches the subset of DT_x in posix readdir()
107  * which apply to u-boot.
108  */
109 #define FS_DT_DIR  4         /* directory */
110 #define FS_DT_REG  8         /* regular file */
111 #define FS_DT_LNK  10        /* symbolic link */
112
113 /*
114  * A directory entry, returned by fs_readdir().  Returns information
115  * about the file/directory at the current directory entry position.
116  */
117 struct fs_dirent {
118         unsigned type;       /* one of FS_DT_x (not a mask) */
119         loff_t size;         /* size in bytes */
120         char name[256];
121 };
122
123 /* Note: fs_dir_stream should be treated as opaque to the user of fs layer */
124 struct fs_dir_stream {
125         /* private to fs. layer: */
126         struct blk_desc *desc;
127         int part;
128 };
129
130 /*
131  * fs_opendir - Open a directory
132  *
133  * @filename: the path to directory to open
134  * @return a pointer to the directory stream or NULL on error and errno
135  *    set appropriately
136  */
137 struct fs_dir_stream *fs_opendir(const char *filename);
138
139 /*
140  * fs_readdir - Read the next directory entry in the directory stream.
141  *
142  * Works in an analogous way to posix readdir().  The previously returned
143  * directory entry is no longer valid after calling fs_readdir() again.
144  * After fs_closedir() is called, the returned directory entry is no
145  * longer valid.
146  *
147  * @dirs: the directory stream
148  * @return the next directory entry (only valid until next fs_readdir() or
149  *    fs_closedir() call, do not attempt to free()) or NULL if the end of
150  *    the directory is reached.
151  */
152 struct fs_dirent *fs_readdir(struct fs_dir_stream *dirs);
153
154 /*
155  * fs_closedir - close a directory stream
156  *
157  * @dirs: the directory stream
158  */
159 void fs_closedir(struct fs_dir_stream *dirs);
160
161 /*
162  * fs_unlink - delete a file or directory
163  *
164  * If a given name is a directory, it will be deleted only if it's empty
165  *
166  * @filename: Name of file or directory to delete
167  * @return 0 on success, -1 on error conditions
168  */
169 int fs_unlink(const char *filename);
170
171 /*
172  * fs_mkdir - Create a directory
173  *
174  * @filename: Name of directory to create
175  * @return 0 on success, -1 on error conditions
176  */
177 int fs_mkdir(const char *filename);
178
179 /*
180  * Common implementation for various filesystem commands, optionally limited
181  * to a specific filesystem type via the fstype parameter.
182  */
183 int do_size(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
184                 int fstype);
185 int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
186                 int fstype);
187 int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
188                 int fstype);
189 int file_exists(const char *dev_type, const char *dev_part, const char *file,
190                 int fstype);
191 int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
192                 int fstype);
193 int do_rm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
194                 int fstype);
195 int do_mkdir(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
196                 int fstype);
197 int do_ln(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
198           int fstype);
199
200 /*
201  * Determine the UUID of the specified filesystem and print it. Optionally it is
202  * possible to store the UUID directly in env.
203  */
204 int do_fs_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
205                 int fstype);
206
207 /*
208  * Determine the type of the specified filesystem and print it. Optionally it is
209  * possible to store the type directly in env.
210  */
211 int do_fs_type(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
212
213 #endif /* _FS_H */