blob: 059a39505d43abb30dcbf66820c60a328e67069f [file] [log] [blame]
Stephen Warren045fa1e2012-10-22 06:43:51 +00001/*
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
Simon Glass92ccc962012-12-26 09:53:35 +000024#define FS_TYPE_SANDBOX 3
Hans de Goede251cee02015-09-17 18:46:58 -040025#define FS_TYPE_UBIFS 4
Stephen Warren045fa1e2012-10-22 06:43:51 +000026
27/*
28 * Tell the fs layer which block device an partition to use for future
29 * commands. This also internally identifies the filesystem that is present
30 * within the partition. The identification process may be limited to a
31 * specific filesystem type by passing FS_* in the fstype parameter.
32 *
33 * Returns 0 on success.
34 * Returns non-zero if there is an error accessing the disk or partition, or
35 * no known filesystem type could be recognized on it.
36 */
37int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype);
38
39/*
40 * Print the list of files on the partition previously set by fs_set_blk_dev(),
41 * in directory "dirname".
42 *
43 * Returns 0 on success. Returns non-zero on error.
44 */
45int fs_ls(const char *dirname);
46
47/*
Stephen Warren61529162014-02-03 13:21:00 -070048 * Determine whether a file exists
49 *
50 * Returns 1 if the file exists, 0 if it doesn't exist.
51 */
52int fs_exists(const char *filename);
53
54/*
Suriyan Ramasamid455d872014-11-17 14:39:38 -080055 * fs_size - Determine a file's size
Stephen Warrencf659812014-06-11 12:47:26 -060056 *
Suriyan Ramasamid455d872014-11-17 14:39:38 -080057 * @filename: Name of the file
58 * @size: Size of file
59 * @return 0 if ok with valid *size, negative on error
Stephen Warrencf659812014-06-11 12:47:26 -060060 */
Suriyan Ramasamid455d872014-11-17 14:39:38 -080061int fs_size(const char *filename, loff_t *size);
Stephen Warrencf659812014-06-11 12:47:26 -060062
63/*
Suriyan Ramasamid455d872014-11-17 14:39:38 -080064 * fs_read - Read file from the partition previously set by fs_set_blk_dev()
65 * Note that not all filesystem types support either/both offset!=0 or len!=0.
Stephen Warren045fa1e2012-10-22 06:43:51 +000066 *
Suriyan Ramasamid455d872014-11-17 14:39:38 -080067 * @filename: Name of file to read from
68 * @addr: The address to read into
69 * @offset: The offset in file to read from
70 * @len: The number of bytes to read. Maybe 0 to read entire file
71 * @actread: Returns the actual number of bytes read
72 * @return 0 if ok with valid *actread, -1 on error conditions
Stephen Warren045fa1e2012-10-22 06:43:51 +000073 */
Suriyan Ramasamid455d872014-11-17 14:39:38 -080074int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
75 loff_t *actread);
Stephen Warren045fa1e2012-10-22 06:43:51 +000076
77/*
Suriyan Ramasamid455d872014-11-17 14:39:38 -080078 * fs_write - Write file to the partition previously set by fs_set_blk_dev()
79 * Note that not all filesystem types support offset!=0.
Stephen Warrenbd6fb312014-02-03 13:20:59 -070080 *
Suriyan Ramasamid455d872014-11-17 14:39:38 -080081 * @filename: Name of file to read from
82 * @addr: The address to read into
83 * @offset: The offset in file to read from. Maybe 0 to write to start of file
84 * @len: The number of bytes to write
85 * @actwrite: Returns the actual number of bytes written
86 * @return 0 if ok with valid *actwrite, -1 on error conditions
Stephen Warrenbd6fb312014-02-03 13:20:59 -070087 */
Suriyan Ramasamid455d872014-11-17 14:39:38 -080088int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
89 loff_t *actwrite);
Stephen Warrenbd6fb312014-02-03 13:20:59 -070090
91/*
Stephen Warren045fa1e2012-10-22 06:43:51 +000092 * Common implementation for various filesystem commands, optionally limited
93 * to a specific filesystem type via the fstype parameter.
94 */
Stephen Warrencf659812014-06-11 12:47:26 -060095int do_size(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
96 int fstype);
Stephen Warrenf9b55e22012-10-31 11:05:07 +000097int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
Wolfgang Denkb770e882013-10-05 21:07:25 +020098 int fstype);
Stephen Warren045fa1e2012-10-22 06:43:51 +000099int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
100 int fstype);
Stephen Warren61529162014-02-03 13:21:00 -0700101int file_exists(const char *dev_type, const char *dev_part, const char *file,
102 int fstype);
Simon Glassa8f6ab52013-04-20 08:42:50 +0000103int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
Wolfgang Denkb770e882013-10-05 21:07:25 +0200104 int fstype);
Stephen Warren045fa1e2012-10-22 06:43:51 +0000105
Christian Gmeiner59e890e2014-11-12 14:35:04 +0100106/*
107 * Determine the UUID of the specified filesystem and print it. Optionally it is
108 * possible to store the UUID directly in env.
109 */
110int do_fs_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
111 int fstype);
112
Sjoerd Simons1a1ad8e2015-01-05 18:13:36 +0100113/*
114 * Determine the type of the specified filesystem and print it. Optionally it is
115 * possible to store the type directly in env.
116 */
117int do_fs_type(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
118
Stephen Warren045fa1e2012-10-22 06:43:51 +0000119#endif /* _FS_H */