[people/ms/u-boot.git] / include / fs.h

/*
 * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _FS_H
#define _FS_H

#include <common.h>

#define FS_TYPE_ANY	0
#define FS_TYPE_FAT	1
#define FS_TYPE_EXT	2
#define FS_TYPE_SANDBOX	3

/*
 * Tell the fs layer which block device an partition to use for future
 * commands. This also internally identifies the filesystem that is present
 * within the partition. The identification process may be limited to a
 * specific filesystem type by passing FS_* in the fstype parameter.
 *
 * Returns 0 on success.
 * Returns non-zero if there is an error accessing the disk or partition, or
 * no known filesystem type could be recognized on it.
 */
int fs_set_blk_dev(const char *ifname, const char *dev_part_str, int fstype);

/*
 * Print the list of files on the partition previously set by fs_set_blk_dev(),
 * in directory "dirname".
 *
 * Returns 0 on success. Returns non-zero on error.
 */
int fs_ls(const char *dirname);

/*
 * Read file "filename" from the partition previously set by fs_set_blk_dev(),
 * to address "addr", starting at byte offset "offset", and reading "len"
 * bytes. "offset" may be 0 to read from the start of the file. "len" may be
 * 0 to read the entire file. Note that not all filesystem types support
 * either/both offset!=0 or len!=0.
 *
 * Returns number of bytes read on success. Returns <= 0 on error.
 */
int fs_read(const char *filename, ulong addr, int offset, int len);

/*
 * Write file "filename" to the partition previously set by fs_set_blk_dev(),
 * from address "addr", starting at byte offset "offset", and writing "len"
 * bytes. "offset" may be 0 to write to the start of the file. Note that not
 * all filesystem types support offset!=0.
 *
 * Returns number of bytes read on success. Returns <= 0 on error.
 */
int fs_write(const char *filename, ulong addr, int offset, int len);

/*
 * Common implementation for various filesystem commands, optionally limited
 * to a specific filesystem type via the fstype parameter.
 */
int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
		int fstype);
int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
		int fstype);
int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
		int fstype);

#endif /* _FS_H */
Commit	Line	Data
045fa1e1 SW	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
92ccc96b	24	#define FS_TYPE_SANDBOX 3
045fa1e1 SW	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	* Read file "filename" from the partition previously set by fs_set_blk_dev(),
	48	* to address "addr", starting at byte offset "offset", and reading "len"
	49	* bytes. "offset" may be 0 to read from the start of the file. "len" may be
	50	* 0 to read the entire file. Note that not all filesystem types support
	51	* either/both offset!=0 or len!=0.
	52	*
	53	* Returns number of bytes read on success. Returns <= 0 on error.
	54	*/
	55	int fs_read(const char *filename, ulong addr, int offset, int len);
	56
bd6fb31f SW	57	/*
	58	* Write file "filename" to the partition previously set by fs_set_blk_dev(),
	59	* from address "addr", starting at byte offset "offset", and writing "len"
	60	* bytes. "offset" may be 0 to write to the start of the file. Note that not
	61	* all filesystem types support offset!=0.
	62	*
	63	* Returns number of bytes read on success. Returns <= 0 on error.
	64	*/
	65	int fs_write(const char *filename, ulong addr, int offset, int len);
	66
045fa1e1 SW	67	/*
	68	* Common implementation for various filesystem commands, optionally limited
	69	* to a specific filesystem type via the fstype parameter.
	70	*/
f9b55e22	71	int do_load(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
b770e88a	72	int fstype);
045fa1e1 SW	73	int do_ls(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
045fa1e1 SW	74	int fstype);
a8f6ab52	75	int do_save(cmd_tbl_t cmdtp, int flag, int argc, char const argv[],
b770e88a	76	int fstype);
045fa1e1 SW	77
045fa1e1 SW	78	#endif /* _FS_H */