#ifndef _FS_H
#define _FS_H
-#include <common.h>
#include <rtc.h>
struct cmd_tbl;
* do_fat_fsload - Run the fatload command
*
* @cmdtp: Command information for fatload
- * @flag: Command flags (CMD_FLAG_...)
+ * @flag: Command flags (CMD_FLAG\_...)
* @argc: Number of arguments
* @argv: List of arguments
* Return: result (see enum command_ret_t)
* do_ext2load - Run the ext2load command
*
* @cmdtp: Command information for ext2load
- * @flag: Command flags (CMD_FLAG_...)
+ * @flag: Command flags (CMD_FLAG\_...)
* @argc: Number of arguments
* @argv: List of arguments
* Return: result (see enum command_ret_t)
* @offset: offset in the file from where to start reading
* @len: the number of bytes to read. Use 0 to read entire file.
* @actread: returns the actual number of bytes read
- * Return: 0 if OK with valid *actread, -1 on error conditions
+ * Return: 0 if OK with valid @actread, -1 on error conditions
*/
int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
loff_t *actread);
* @offset: offset in the file from where to start writing
* @len: the number of bytes to write
* @actwrite: returns the actual number of bytes written
- * Return: 0 if OK with valid *actwrite, -1 on error conditions
+ * Return: 0 if OK with valid @actwrite, -1 on error conditions
*/
int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
loff_t *actwrite);
unsigned int type;
/** @size: file size */
loff_t size;
- /** @flags: attribute flags (FS_ATTR_*) */
+ /** @attr: attribute flags (FS_ATTR_*) */
u32 attr;
- /** create_time: time of creation */
+ /** @create_time: time of creation */
struct rtc_time create_time;
- /** access_time: time of last access */
+ /** @access_time: time of last access */
struct rtc_time access_time;
- /** change_time: time of last modification */
+ /** @change_time: time of last modification */
struct rtc_time change_time;
- /** name: file name */
+ /** @name: file name */
char name[FS_DIRENT_NAME_LEN];
};
-/* Note: fs_dir_stream should be treated as opaque to the user of fs layer */
+/**
+ * struct fs_dir_stream - Structure representing an opened directory
+ *
+ * Struct fs_dir_stream should be treated opaque to the user of fs layer.
+ * The fields @desc and @part are used by the fs layer.
+ * File system drivers pass additional private fields with the pointers
+ * to this structure.
+ *
+ * @desc: block device descriptor
+ * @part: partition number
+ */
struct fs_dir_stream {
- /* private to fs. layer: */
struct blk_desc *desc;
int part;
};
-/*
+/**
* fs_opendir - Open a directory
*
- * @filename: the path to directory to open
- * Return: a pointer to the directory stream or NULL on error and errno
- * set appropriately
+ * .. note::
+ * The returned struct fs_dir_stream should be treated opaque to the
+ * user of the fs layer.
+ *
+ * @filename: path to the directory to open
+ * Return:
+ * A pointer to the directory stream or NULL on error and errno set
+ * appropriately
*/
struct fs_dir_stream *fs_opendir(const char *filename);
-/*
+/**
* fs_readdir - Read the next directory entry in the directory stream.
*
- * Works in an analogous way to posix readdir(). The previously returned
- * directory entry is no longer valid after calling fs_readdir() again.
+ * fs_readir works in an analogous way to posix readdir().
+ * The previously returned directory entry is no longer valid after calling
+ * fs_readdir() again.
* After fs_closedir() is called, the returned directory entry is no
* longer valid.
*
* @dirs: the directory stream
- * Return: the next directory entry (only valid until next fs_readdir() or
- * fs_closedir() call, do not attempt to free()) or NULL if the end of
- * the directory is reached.
+ * Return:
+ * the next directory entry (only valid until next fs_readdir() or
+ * fs_closedir() call, do not attempt to free()) or NULL if the end of
+ * the directory is reached.
*/
struct fs_dirent *fs_readdir(struct fs_dir_stream *dirs);
-/*
+/**
* fs_closedir - close a directory stream
*
* @dirs: the directory stream
*/
void fs_closedir(struct fs_dir_stream *dirs);
-/*
+/**
* fs_unlink - delete a file or directory
*
* If a given name is a directory, it will be deleted only if it's empty
*/
int fs_unlink(const char *filename);
-/*
+/**
* fs_mkdir - Create a directory
*
* @filename: Name of directory to create
* do_fs_types - List supported filesystems.
*
* @cmdtp: Command information for fstypes
- * @flag: Command flags (CMD_FLAG_...)
+ * @flag: Command flags (CMD_FLAG\_...)
* @argc: Number of arguments
* @argv: List of arguments
* Return: result (see enum command_ret_t)
*/
int do_fs_types(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[]);
+/**
+ * fs_read_alloc() - Allocate space for a file and read it
+ *
+ * You must call fs_set_blk_dev() or a similar function before calling this,
+ * since that sets up the block device to use.
+ *
+ * The file is terminated with a nul character
+ *
+ * @fname: Filename to read
+ * @size: Size of file to read (must be correct!)
+ * @align: Alignment to use for memory allocation (0 for default: ARCH_DMA_MINALIGN)
+ * @bufp: On success, returns the allocated buffer with the nul-terminated file
+ * in it
+ * Return: 0 if OK, -ENOMEM if out of memory, -EIO if read failed
+ */
+int fs_read_alloc(const char *fname, ulong size, uint align, void **bufp);
+
+/**
+ * fs_load_alloc() - Load a file into allocated space
+ *
+ * The file is terminated with a nul character
+ *
+ * @ifname: Interface name to read from (e.g. "mmc")
+ * @dev_part_str: Device and partition string (e.g. "1:2")
+ * @fname: Filename to read
+ * @max_size: Maximum allowed size for the file (use 0 for 1GB)
+ * @align: Alignment to use for memory allocation (0 for default)
+ * @bufp: On success, returns the allocated buffer with the nul-terminated file
+ * in it
+ * @sizep: On success, returns the size of the file
+ * Return: 0 if OK, -ENOMEM if out of memory, -ENOENT if the file does not
+ * exist, -ENOMEDIUM if the device does not exist, -E2BIG if the file is too
+ * large (greater than @max_size), -EIO if read failed
+ */
+int fs_load_alloc(const char *ifname, const char *dev_part_str,
+ const char *fname, ulong max_size, ulong align, void **bufp,
+ ulong *sizep);
+
#endif /* _FS_H */
projects / J-u-boot.git / blobdiff