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  * fs_size - Determine a file's size
  55  *
  56  * @filename: Name of the file
  57  * @size: Size of file
  58  * @return 0 if ok with valid *size, negative on error
  59  */
  60 int fs_size(const char *filename, loff_t *size);
  61
  62 /*
  63  * fs_read - Read file from the partition previously set by fs_set_blk_dev()
  64  * Note that not all filesystem types support either/both offset!=0 or len!=0.
  65  *
  66  * @filename: Name of file to read from
  67  * @addr: The address to read into
  68  * @offset: The offset in file to read from
  69  * @len: The number of bytes to read. Maybe 0 to read entire file
  70  * @actread: Returns the actual number of bytes read
  71  * @return 0 if ok with valid *actread, -1 on error conditions
  72  */
  73 int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
  74             loff_t *actread);
  75
  76 /*
  77  * fs_write - Write file to the partition previously set by fs_set_blk_dev()
  78  * Note that not all filesystem types support offset!=0.
  79  *
  80  * @filename: Name of file to read from
  81  * @addr: The address to read into
  82  * @offset: The offset in file to read from. Maybe 0 to write to start of file
  83  * @len: The number of bytes to write
  84  * @actwrite: Returns the actual number of bytes written
  85  * @return 0 if ok with valid *actwrite, -1 on error conditions
  86  */
  87 int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
  88              loff_t *actwrite);
  89
  90 /*
  91  * Common implementation for various filesystem commands, optionally limited
  92  * to a specific filesystem type via the fstype parameter.
  93  */
  94 int do_size(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
  95                 int fstype);
  96 int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
  97                 int fstype);
  98 int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
  99                 int fstype);
 100 int file_exists(const char *dev_type, const char *dev_part, const char *file,
 101                 int fstype);
 102 int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 103                 int fstype);
 104
 105 /*
 106  * Determine the UUID of the specified filesystem and print it. Optionally it is
 107  * possible to store the UUID directly in env.
 108  */
 109 int do_fs_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 110                 int fstype);
 111
 112 /*
 113  * Determine the type of the specified filesystem and print it. Optionally it is
 114  * possible to store the type directly in env.
 115  */
 116 int do_fs_type(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 117
 118 #endif /* _FS_H */