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 #define FS_TYPE_UBIFS   4
  26
  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  */
  37 int 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  */
  45 int fs_ls(const char *dirname);
  46
  47 /*
  48  * Determine whether a file exists
  49  *
  50  * Returns 1 if the file exists, 0 if it doesn't exist.
  51  */
  52 int fs_exists(const char *filename);
  53
  54 /*
  55  * fs_size - Determine a file's size
  56  *
  57  * @filename: Name of the file
  58  * @size: Size of file
  59  * @return 0 if ok with valid *size, negative on error
  60  */
  61 int fs_size(const char *filename, loff_t *size);
  62
  63 /*
  64  * 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.
  66  *
  67  * @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
  73  */
  74 int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
  75             loff_t *actread);
  76
  77 /*
  78  * fs_write - Write file to the partition previously set by fs_set_blk_dev()
  79  * Note that not all filesystem types support offset!=0.
  80  *
  81  * @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
  87  */
  88 int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
  89              loff_t *actwrite);
  90
  91 /*
  92  * Common implementation for various filesystem commands, optionally limited
  93  * to a specific filesystem type via the fstype parameter.
  94  */
  95 int do_size(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
  96                 int fstype);
  97 int do_load(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
  98                 int fstype);
  99 int do_ls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 100                 int fstype);
 101 int file_exists(const char *dev_type, const char *dev_part, const char *file,
 102                 int fstype);
 103 int do_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 104                 int fstype);
 105
 106 /*
 107  * Determine the UUID of the specified filesystem and print it. Optionally it is
 108  * possible to store the UUID directly in env.
 109  */
 110 int do_fs_uuid(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
 111                 int fstype);
 112
 113 /*
 114  * Determine the type of the specified filesystem and print it. Optionally it is
 115  * possible to store the type directly in env.
 116  */
 117 int do_fs_type(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 118
 119 #endif /* _FS_H */