mirror of https://github.com/ARMmbed/mbed-os.git
Minor Doxygen fixes for all file system classes
- Remove Doxygen generation on protected functions - Minor description fixespull/9305/head
David Saada
parent
a9ce91686c
commit
3c7924ac9c
|
|
@ -26,19 +26,19 @@
|
|||
#include "BlockDevice.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup filesystem */
|
||||
/** \addtogroup file system */
|
||||
/** @{*/
|
||||
|
||||
|
||||
// Opaque pointer representing files and directories
|
||||
// Opaque pointer representing files and directories.
|
||||
typedef void *fs_file_t;
|
||||
typedef void *fs_dir_t;
|
||||
|
||||
// Predeclared classes
|
||||
// Predeclared classes.
|
||||
class Dir;
|
||||
class File;
|
||||
|
||||
/** A filesystem object provides filesystem operations and file operations
|
||||
/** A file system object. Provides file system operations and file operations
|
||||
* for the File and Dir classes on a block device.
|
||||
*
|
||||
* Implementations must provide at minimum file operations and mount
|
||||
|
|
@ -49,87 +49,86 @@ class File;
|
|||
class FileSystem : public FileSystemLike {
|
||||
public:
|
||||
|
||||
/** FileSystem lifetime
|
||||
/** File system lifetime.
|
||||
*
|
||||
* @param name Name to add filesystem to tree as
|
||||
* @param name Name to add file system to tree as.
|
||||
*/
|
||||
FileSystem(const char *name = NULL);
|
||||
virtual ~FileSystem() {}
|
||||
|
||||
/** Return the default filesystem
|
||||
/** Return the default file system.
|
||||
*
|
||||
* Returns the default FileSystem base on the default BlockDevice configuration.
|
||||
* Returns the default file system based on the default block device configuration.
|
||||
* Use the components in target.json or application config to change
|
||||
* the default block device and affect the default filesystem.
|
||||
* SD block device => FAT filesystem
|
||||
* SPIF block device => LITTLE filesystem
|
||||
* DATAFLASH block device => LITTLE filesystem
|
||||
* QSPIF, SPIF, DATAFLASH or FLAHIAP block device => LITTLE filesystem
|
||||
*
|
||||
* An application can override all target settings by implementing
|
||||
* FileSystem::get_default_instance() themselves - the default
|
||||
* FileSystem::get_default_instance() - the default
|
||||
* definition is weak, and calls get_target_default_instance().
|
||||
*/
|
||||
static FileSystem *get_default_instance();
|
||||
|
||||
/** Mounts a filesystem to a block device
|
||||
/** Mount a file system to a block device.
|
||||
*
|
||||
* @param bd BlockDevice to mount to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param bd Block device to mount to.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int mount(BlockDevice *bd) = 0;
|
||||
|
||||
/** Unmounts a filesystem from the underlying block device
|
||||
/** Unmount a file system from the underlying block device.
|
||||
*
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int unmount() = 0;
|
||||
|
||||
/** Reformats a filesystem, results in an empty and mounted filesystem
|
||||
/** Reformat a file system. Results in an empty and mounted file system.
|
||||
*
|
||||
* @param bd BlockDevice to reformat and mount. If NULL, the mounted
|
||||
* block device will be used.
|
||||
* Note: if mount fails, bd must be provided.
|
||||
* @param bd Block device to reformat and mount. If NULL, the mounted
|
||||
* Block device is used.
|
||||
* Note: If mount fails, bd must be provided.
|
||||
* Default: NULL
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int reformat(BlockDevice *bd = NULL);
|
||||
|
||||
/** Remove a file from the filesystem.
|
||||
/** Remove a file from the file system.
|
||||
*
|
||||
* @param path The name of the file to remove.
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int remove(const char *path);
|
||||
|
||||
/** Rename a file in the filesystem.
|
||||
/** Rename a file in the file system.
|
||||
*
|
||||
* @param path The name of the file to rename.
|
||||
* @param newpath The name to rename it to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param path The existing name of the file to rename.
|
||||
* @param newpath The new name of the file.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int rename(const char *path, const char *newpath);
|
||||
|
||||
/** Store information about the file in a stat structure
|
||||
/** Store information about the file in a stat structure.
|
||||
*
|
||||
* @param path The name of the file to find information about
|
||||
* @param st The stat buffer to write to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param path The name of the file to find information about.
|
||||
* @param st The stat buffer to write to.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int stat(const char *path, struct stat *st);
|
||||
|
||||
/** Create a directory in the filesystem.
|
||||
/** Create a directory in the file system.
|
||||
*
|
||||
* @param path The name of the directory to create.
|
||||
* @param mode The permissions with which to create the directory
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param mode The permissions with which to create the directory.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int mkdir(const char *path, mode_t mode);
|
||||
|
||||
/** Store information about the mounted filesystem in a statvfs structure
|
||||
/** Store information about the mounted file system in a statvfs structure.
|
||||
*
|
||||
* @param path The name of the file to find information about
|
||||
* @param buf The stat buffer to write to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param path The name of the file to find information about.
|
||||
* @param buf The stat buffer to write to.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int statvfs(const char *path, struct statvfs *buf);
|
||||
|
||||
|
|
@ -137,86 +136,87 @@ protected:
|
|||
friend class File;
|
||||
friend class Dir;
|
||||
|
||||
/** Open a file on the filesystem
|
||||
#if !(DOXYGEN_ONLY)
|
||||
/** Open a file on the file system.
|
||||
*
|
||||
* @param file Destination for the handle to a newly created file
|
||||
* @param path The name of the file to open
|
||||
* @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
|
||||
* bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param file Destination of the newly created handle to the referenced file.
|
||||
* @param path The name of the file to open.
|
||||
* @param flags The flags that trigger opening of the file. These flags are O_RDONLY, O_WRONLY, and O_RDWR,
|
||||
* with an O_CREAT, O_TRUNC, or O_APPEND bitwise OR operator.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_open(fs_file_t *file, const char *path, int flags) = 0;
|
||||
|
||||
/** Close a file
|
||||
/** Close a file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param file File handle.
|
||||
* return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_close(fs_file_t file) = 0;
|
||||
|
||||
/** Read the contents of a file into a buffer
|
||||
/** Read the contents of a file into a buffer.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param buffer The buffer to read in to
|
||||
* @param size The number of bytes to read
|
||||
* @return The number of bytes read, 0 at end of file, negative error on failure
|
||||
* @param file File handle.
|
||||
* @param buffer The buffer to read in to.
|
||||
* @param size The number of bytes to read.
|
||||
* @return The number of bytes read, 0 at the end of the file, negative error on failure.
|
||||
*/
|
||||
virtual ssize_t file_read(fs_file_t file, void *buffer, size_t size) = 0;
|
||||
|
||||
/** Write the contents of a buffer to a file
|
||||
/** Write the contents of a buffer to a file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param buffer The buffer to write from
|
||||
* @param size The number of bytes to write
|
||||
* @return The number of bytes written, negative error on failure
|
||||
* @param file File handle.
|
||||
* @param buffer The buffer to write from.
|
||||
* @param size The number of bytes to write.
|
||||
* @return The number of bytes written, negative error on failure.
|
||||
*/
|
||||
virtual ssize_t file_write(fs_file_t file, const void *buffer, size_t size) = 0;
|
||||
|
||||
/** Flush any buffers associated with the file
|
||||
/** Flush any buffers associated with the file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param file File handle.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_sync(fs_file_t file);
|
||||
|
||||
/** Check if the file in an interactive terminal device
|
||||
* If so, line buffered behaviour is used by default
|
||||
/** Check whether the file is an interactive terminal device.
|
||||
* If so, line buffered behavior is used by default.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return True if the file is a terminal
|
||||
* @param file File handle.
|
||||
* @return True if the file is a terminal.
|
||||
*/
|
||||
virtual int file_isatty(fs_file_t file);
|
||||
|
||||
/** Move the file position to a given offset from from a given location
|
||||
/** Move the file position to a given offset from a given location.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param offset The offset from whence to move to
|
||||
* @param whence The start of where to seek
|
||||
* SEEK_SET to start from beginning of file,
|
||||
* SEEK_CUR to start from current position in file,
|
||||
* SEEK_END to start from end of file
|
||||
* @param file File handle.
|
||||
* @param offset The offset from whence to move to.
|
||||
* @param whence The start of where to seek.
|
||||
* SEEK_SET to start from the beginning of the file,
|
||||
* SEEK_CUR to start from the current position in the file,
|
||||
* SEEK_END to start from the end of the file.
|
||||
* @return The new offset of the file
|
||||
*/
|
||||
virtual off_t file_seek(fs_file_t file, off_t offset, int whence) = 0;
|
||||
|
||||
/** Get the file position of the file
|
||||
/** Get the file position of the file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return The current offset in the file
|
||||
* @param file File handle.
|
||||
* @return The current offset in the file.
|
||||
*/
|
||||
virtual off_t file_tell(fs_file_t file);
|
||||
|
||||
/** Rewind the file position to the beginning of the file
|
||||
/** Rewind the file position to the beginning of the file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param file File handle.
|
||||
* @note This is equivalent to file_seek(file, 0, FS_SEEK_SET)
|
||||
*/
|
||||
virtual void file_rewind(fs_file_t file);
|
||||
|
||||
/** Get the size of the file
|
||||
/** Get the size of the file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return Size of the file in bytes
|
||||
* @param file File handle.
|
||||
* @return Size of the file in bytes.
|
||||
*/
|
||||
virtual off_t file_size(fs_file_t file);
|
||||
|
||||
|
|
@ -226,66 +226,67 @@ protected:
|
|||
* not changed. If the file is extended, the extended area appears as if
|
||||
* it were zero-filled.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param length The requested new length for the file
|
||||
* @param file File handle.
|
||||
* @param length The requested new length for the file.
|
||||
*
|
||||
* @return Zero on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_truncate(fs_file_t file, off_t length);
|
||||
|
||||
/** Open a directory on the filesystem
|
||||
/** Open a directory on the file system.
|
||||
*
|
||||
* @param dir Destination for the handle to the directory
|
||||
* @param path Name of the directory to open
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param dir Destination for the handle to the directory.
|
||||
* @param path Name of the directory to open.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int dir_open(fs_dir_t *dir, const char *path);
|
||||
|
||||
/** Close a directory
|
||||
/** Close a directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param dir Dir handle.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int dir_close(fs_dir_t dir);
|
||||
|
||||
/** Read the next directory entry
|
||||
/** Read the next directory entry.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param ent The directory entry to fill out
|
||||
* @return 1 on reading a filename, 0 at end of directory, negative error on failure
|
||||
* @param dir Dir handle.
|
||||
* @param ent The directory entry to fill out.
|
||||
* @return 1 on reading a filename, 0 at the end of the directory, negative error on failure.
|
||||
*/
|
||||
virtual ssize_t dir_read(fs_dir_t dir, struct dirent *ent);
|
||||
|
||||
/** Set the current position of the directory
|
||||
/** Set the current position of the directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param dir Dir handle.
|
||||
* @param offset Offset of the location to seek to,
|
||||
* must be a value returned from dir_tell
|
||||
* must be a value returned from dir_tell.
|
||||
*/
|
||||
virtual void dir_seek(fs_dir_t dir, off_t offset);
|
||||
|
||||
/** Get the current position of the directory
|
||||
/** Get the current position of the directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @return Position of the directory that can be passed to dir_rewind
|
||||
* @param dir Dir handle.
|
||||
* @return Directory position, which can be passed to dir_rewind.
|
||||
*/
|
||||
virtual off_t dir_tell(fs_dir_t dir);
|
||||
|
||||
/** Rewind the current position to the beginning of the directory
|
||||
/** Rewind the current position to the beginning of the directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param dir Dir handle.
|
||||
*/
|
||||
virtual void dir_rewind(fs_dir_t dir);
|
||||
|
||||
/** Get the sizeof the directory
|
||||
/** Get the size of the directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @return Number of files in the directory
|
||||
* @param dir Dir handle.
|
||||
* @return Number of files in the directory.
|
||||
*/
|
||||
virtual size_t dir_size(fs_dir_t dir);
|
||||
#endif //!defined(DOXYGEN_ONLY)
|
||||
|
||||
protected:
|
||||
// Hooks for FileSystemHandle
|
||||
// Hooks for file systemHandle
|
||||
virtual int open(FileHandle **file, const char *path, int flags);
|
||||
virtual int open(DirHandle **dir, const char *path);
|
||||
};
|
||||
|
|
|
|||
|
|
@ -36,21 +36,21 @@
|
|||
namespace mbed {
|
||||
|
||||
/**
|
||||
* FATFileSystem based on ChaN's Fat Filesystem library v0.8
|
||||
* FAT file system based on ChaN's FAT file system library v0.8
|
||||
*
|
||||
* Synchronization level: Thread safe
|
||||
*/
|
||||
class FATFileSystem : public FileSystem {
|
||||
public:
|
||||
/** Lifetime of the FATFileSystem
|
||||
/** Lifetime of the FAT file system.
|
||||
*
|
||||
* @param name Name to add filesystem to tree as
|
||||
* @param bd BlockDevice to mount, may be passed instead to mount call
|
||||
* @param name Name of the file system in the tree.
|
||||
* @param bd Block device to mount. Mounted immediately if not NULL.
|
||||
*/
|
||||
FATFileSystem(const char *name = NULL, BlockDevice *bd = NULL);
|
||||
virtual ~FATFileSystem();
|
||||
|
||||
/** Formats a logical drive, FDISK partitioning rule.
|
||||
/** Format a logical drive, FDISK partitioning rule.
|
||||
*
|
||||
* The block device to format should be mounted when this function is called.
|
||||
*
|
||||
|
|
@ -58,167 +58,168 @@ public:
|
|||
* This is the block device that will be formatted.
|
||||
*
|
||||
* @param cluster_size
|
||||
* This is the number of bytes per cluster. A larger cluster size will decrease
|
||||
* the overhead of the FAT table, but also increase the minimum file size. The
|
||||
* cluster_size must be a multiple of the underlying device's allocation unit
|
||||
* and is currently limited to a max of 32,768 bytes. If zero, a cluster size
|
||||
* will be determined from the device's allocation unit. Defaults to zero.
|
||||
* This is the number of bytes per cluster. A larger cluster size decreases
|
||||
* the overhead of the FAT table, but also increases the minimum file size. The
|
||||
* cluster size must be a multiple of the underlying device's allocation unit
|
||||
* and is currently limited to a max of 32,768 bytes. If the cluster size is set to zero, a cluster size
|
||||
* is determined from the device's allocation unit. Defaults to zero.
|
||||
*
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
static int format(BlockDevice *bd, bd_size_t cluster_size = 0);
|
||||
|
||||
/** Mounts a filesystem to a block device
|
||||
/** Mount a file system to a block device.
|
||||
*
|
||||
* @param bd BlockDevice to mount to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param bd Block device to mount to.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int mount(BlockDevice *bd);
|
||||
|
||||
/** Unmounts a filesystem from the underlying block device
|
||||
/** Unmount a file system from the underlying block device.
|
||||
*
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int unmount();
|
||||
|
||||
/** Reformats a filesystem, results in an empty and mounted filesystem
|
||||
/** Reformat a file system, results in an empty and mounted file system.
|
||||
*
|
||||
* @param bd
|
||||
* BlockDevice to reformat and mount. If NULL, the mounted
|
||||
* block device will be used.
|
||||
* Note: if mount fails, bd must be provided.
|
||||
* Block device to reformat and mount. If NULL, the mounted
|
||||
* Block device is used.
|
||||
* Note: If mount fails, bd must be provided.
|
||||
* Default: NULL
|
||||
*
|
||||
* @param allocation_unit
|
||||
* This is the number of bytes per cluster size. The valid value is N
|
||||
* times the sector size. N is a power of 2 from 1 to 128 for FAT
|
||||
* volume and upto 16MiB for exFAT volume. If zero is given,
|
||||
* times the sector size. N is a power of 2, from 1 to 128, for the FAT
|
||||
* volume, and up to 16MiB for the exFAT volume. If zero is given,
|
||||
* the default allocation unit size is selected by the underlying
|
||||
* filesystem, which depends on the volume size.
|
||||
* file system, which depends on the volume size.
|
||||
*
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int reformat(BlockDevice *bd, int allocation_unit);
|
||||
|
||||
/** Reformats a filesystem, results in an empty and mounted filesystem
|
||||
/** Reformat a file system, results in an empty and mounted file system.
|
||||
*
|
||||
* @param bd BlockDevice to reformat and mount. If NULL, the mounted
|
||||
* block device will be used.
|
||||
* Note: if mount fails, bd must be provided.
|
||||
* @param bd Block device to reformat and mount. If NULL, the mounted
|
||||
* Block device is used.
|
||||
* Note: If mount fails, bd must be provided.
|
||||
* Default: NULL
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int reformat(BlockDevice *bd = NULL)
|
||||
{
|
||||
// required for virtual inheritance shenanigans
|
||||
// Required for virtual inheritance shenanigans.
|
||||
return reformat(bd, 0);
|
||||
}
|
||||
|
||||
/** Remove a file from the filesystem.
|
||||
/** Remove a file from the file system.
|
||||
*
|
||||
* @param path The name of the file to remove.
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int remove(const char *path);
|
||||
|
||||
/** Rename a file in the filesystem.
|
||||
/** Rename a file in the file system.
|
||||
*
|
||||
* @param path The name of the file to rename.
|
||||
* @param newpath The name to rename it to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param path The current name of the file to rename.
|
||||
* @param newpath The new name of the file.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int rename(const char *path, const char *newpath);
|
||||
|
||||
/** Store information about the file in a stat structure
|
||||
/** Store information about the file in a stat structure.
|
||||
*
|
||||
* @param path The name of the file to find information about
|
||||
* @param st The stat buffer to write to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param path The name of the file to store information about.
|
||||
* @param st The stat buffer to write to.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int stat(const char *path, struct stat *st);
|
||||
|
||||
/** Create a directory in the filesystem.
|
||||
/** Create a directory in the file system.
|
||||
*
|
||||
* @param path The name of the directory to create.
|
||||
* @param mode The permissions with which to create the directory
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param mode The permissions with which to create the directory.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int mkdir(const char *path, mode_t mode);
|
||||
|
||||
/** Store information about the mounted filesystem in a statvfs structure
|
||||
/** Store information about the mounted file system in a statvfs structure.
|
||||
*
|
||||
* @param path The name of the file to find information about
|
||||
* @param buf The stat buffer to write to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param path The name of the file to store information about.
|
||||
* @param buf The stat buffer to write to.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int statvfs(const char *path, struct statvfs *buf);
|
||||
|
||||
protected:
|
||||
/** Open a file on the filesystem
|
||||
#if !(DOXYGEN_ONLY)
|
||||
/** Open a file on the file system.
|
||||
*
|
||||
* @param file Destination for the handle to a newly created file
|
||||
* @param path The name of the file to open
|
||||
* @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
|
||||
* bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param file Destination for the handle to a newly created file.
|
||||
* @param path The name of the file to open.
|
||||
* @param flags The flags that trigger opening of the file. These flags are O_RDONLY, O_WRONLY, and O_RDWR,
|
||||
* with an O_CREAT, O_TRUNC, or O_APPEND bitwise OR operator.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_open(fs_file_t *file, const char *path, int flags);
|
||||
|
||||
/** Close a file
|
||||
*
|
||||
* @param file File handle
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param file File handle.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_close(fs_file_t file);
|
||||
|
||||
/** Read the contents of a file into a buffer
|
||||
/** Read the contents of a file into a buffer.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param buffer The buffer to read in to
|
||||
* @param len The number of bytes to read
|
||||
* @return The number of bytes read, 0 at end of file, negative error on failure
|
||||
* @param file File handle.
|
||||
* @param buffer The buffer to read into.
|
||||
* @param len The number of bytes to read.
|
||||
* @return The number of bytes read; 0 at the end of the file, negative error on failure.
|
||||
*/
|
||||
virtual ssize_t file_read(fs_file_t file, void *buffer, size_t len);
|
||||
|
||||
/** Write the contents of a buffer to a file
|
||||
/** Write the contents of a buffer to a file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param buffer The buffer to write from
|
||||
* @param len The number of bytes to write
|
||||
* @return The number of bytes written, negative error on failure
|
||||
* @param file File handle.
|
||||
* @param buffer The buffer to write from.
|
||||
* @param len The number of bytes to write.
|
||||
* @return The number of bytes written, negative error on failure.
|
||||
*/
|
||||
virtual ssize_t file_write(fs_file_t file, const void *buffer, size_t len);
|
||||
|
||||
/** Flush any buffers associated with the file
|
||||
/** Flush any buffers associated with the file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param file File handle.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_sync(fs_file_t file);
|
||||
|
||||
/** Move the file position to a given offset from from a given location
|
||||
/** Move the file position to a given offset from a given location
|
||||
*
|
||||
* @param file File handle
|
||||
* @param offset The offset from whence to move to
|
||||
* @param whence The start of where to seek
|
||||
* SEEK_SET to start from beginning of file,
|
||||
* SEEK_CUR to start from current position in file,
|
||||
* SEEK_END to start from end of file
|
||||
* @return The new offset of the file
|
||||
* @param file File handle.
|
||||
* @param offset The offset from whence to move to.
|
||||
* @param whence The start of where to seek.
|
||||
* SEEK_SET to start from the beginning of the file,
|
||||
* SEEK_CUR to start from the current position in the file,
|
||||
* SEEK_END to start from the end of the file.
|
||||
* @return The new offset of the file.
|
||||
*/
|
||||
virtual off_t file_seek(fs_file_t file, off_t offset, int whence);
|
||||
|
||||
/** Get the file position of the file
|
||||
/** Get the file position of the file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return The current offset in the file
|
||||
* @param file File handle.
|
||||
* @return The current offset in the file.
|
||||
*/
|
||||
virtual off_t file_tell(fs_file_t file);
|
||||
|
||||
/** Get the size of the file
|
||||
/** Get the size of the file.
|
||||
*
|
||||
* @param file File handle
|
||||
* @return Size of the file in bytes
|
||||
* @param file File handle.
|
||||
* @return Size of the file in bytes.
|
||||
*/
|
||||
virtual off_t file_size(fs_file_t file);
|
||||
|
||||
|
|
@ -228,59 +229,60 @@ protected:
|
|||
* not changed. If the file is extended, the extended area appears as if
|
||||
* it were zero-filled.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param length The requested new length for the file
|
||||
* @param file File handle.
|
||||
* @param length The requested new length for the file.
|
||||
*
|
||||
* @return Zero on success, negative error code on failure
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_truncate(mbed::fs_file_t file, off_t length);
|
||||
|
||||
/** Open a directory on the filesystem
|
||||
/** Open a directory on the file system.
|
||||
*
|
||||
* @param dir Destination for the handle to the directory
|
||||
* @param path Name of the directory to open
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param dir Destination for the handle to the directory.
|
||||
* @param path Name of the directory to open.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int dir_open(fs_dir_t *dir, const char *path);
|
||||
|
||||
/** Close a directory
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param dir Dir handle.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int dir_close(fs_dir_t dir);
|
||||
|
||||
/** Read the next directory entry
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param ent The directory entry to fill out
|
||||
* @return 1 on reading a filename, 0 at end of directory, negative error on failure
|
||||
* @param dir Dir handle.
|
||||
* @param ent The directory entry to fill out.
|
||||
* @return 1 on reading a filename, 0 at the end of the directory, negative error on failure.
|
||||
*/
|
||||
virtual ssize_t dir_read(fs_dir_t dir, struct dirent *ent);
|
||||
|
||||
/** Set the current position of the directory
|
||||
/** Set the current position of the directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param offset Offset of the location to seek to,
|
||||
* must be a value returned from dir_tell
|
||||
* @param dir Dir handle.
|
||||
* @param offset Offset of the location to seek to.
|
||||
* Must be a value returned by dir_tell.
|
||||
*/
|
||||
virtual void dir_seek(fs_dir_t dir, off_t offset);
|
||||
|
||||
/** Get the current position of the directory
|
||||
/** Get the current position of the directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @return Position of the directory that can be passed to dir_rewind
|
||||
* @param dir Dir handle.
|
||||
* @return Directory position, which can be passed to dir_rewind.
|
||||
*/
|
||||
virtual off_t dir_tell(fs_dir_t dir);
|
||||
|
||||
/** Rewind the current position to the beginning of the directory
|
||||
/** Rewind the current position to the beginning of the directory.
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param dir Dir handle.
|
||||
*/
|
||||
virtual void dir_rewind(fs_dir_t dir);
|
||||
#endif //!(DOXYGEN_ONLY)
|
||||
|
||||
private:
|
||||
FATFS _fs; // Work area (file system object) for logical drive
|
||||
FATFS _fs; // Work area (file system object) for logical drive.
|
||||
char _fsid[sizeof("0:")];
|
||||
int _id;
|
||||
|
||||
|
|
@ -292,7 +294,7 @@ protected:
|
|||
|
||||
} // namespace mbed
|
||||
|
||||
// Added "using" for backwards compatibility
|
||||
// Added "using" for backwards compatibility.
|
||||
#ifndef MBED_NO_GLOBAL_USING_DIRECTIVE
|
||||
using mbed::FATFileSystem;
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
namespace mbed {
|
||||
|
||||
/**
|
||||
* LittleFileSystem, a little filesystem
|
||||
* LittleFileSystem, a little file system
|
||||
*
|
||||
* Synchronization level: Thread safe
|
||||
*/
|
||||
|
|
@ -36,8 +36,8 @@ class LittleFileSystem : public mbed::FileSystem {
|
|||
public:
|
||||
/** Lifetime of the LittleFileSystem
|
||||
*
|
||||
* @param name Name to add filesystem to tree as
|
||||
* @param bd BlockDevice to mount, may be passed instead to mount call
|
||||
* @param name Name of the file system in the tree.
|
||||
* @param bd Block device to mount. Mounted immediately if not NULL.
|
||||
* @param read_size
|
||||
* Minimum size of a block read. This determines the size of read buffers.
|
||||
* This may be larger than the physical read size to improve performance
|
||||
|
|
@ -56,7 +56,6 @@ public:
|
|||
* The lookahead buffer requires only 1 bit per block so it can be quite
|
||||
* large with little ram impact. Should be a multiple of 32.
|
||||
*/
|
||||
|
||||
LittleFileSystem(const char *name = NULL, mbed::BlockDevice *bd = NULL,
|
||||
lfs_size_t read_size = MBED_LFS_READ_SIZE,
|
||||
lfs_size_t prog_size = MBED_LFS_PROG_SIZE,
|
||||
|
|
@ -65,11 +64,11 @@ public:
|
|||
|
||||
virtual ~LittleFileSystem();
|
||||
|
||||
/** Formats a block device with the LittleFileSystem
|
||||
/** Format a block device with the LittleFileSystem.
|
||||
*
|
||||
* The block device to format should be mounted when this function is called.
|
||||
*
|
||||
* @param bd This is the block device that will be formated.
|
||||
* @param bd This is the block device that will be formatted.
|
||||
* @param read_size
|
||||
* Minimum size of a block read. This determines the size of read buffers.
|
||||
* This may be larger than the physical read size to improve performance
|
||||
|
|
@ -94,135 +93,136 @@ public:
|
|||
lfs_size_t block_size = MBED_LFS_BLOCK_SIZE,
|
||||
lfs_size_t lookahead = MBED_LFS_LOOKAHEAD);
|
||||
|
||||
/** Mounts a filesystem to a block device
|
||||
/** Mount a file system to a block device.
|
||||
*
|
||||
* @param bd BlockDevice to mount to
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param bd Block device to mount to.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int mount(mbed::BlockDevice *bd);
|
||||
|
||||
/** Unmounts a filesystem from the underlying block device
|
||||
/** Unmount a file system from the underlying block device.
|
||||
*
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int unmount();
|
||||
|
||||
/** Reformats a filesystem, results in an empty and mounted filesystem
|
||||
/** Reformat a file system. Results in an empty and mounted file system.
|
||||
*
|
||||
* @param bd
|
||||
* BlockDevice to reformat and mount. If NULL, the mounted
|
||||
* block device will be used.
|
||||
* Note: if mount fails, bd must be provided.
|
||||
* Block device to reformat and mount. If NULL, the mounted
|
||||
* Block device is used.
|
||||
* Note: If mount fails, bd must be provided.
|
||||
* Default: NULL
|
||||
*
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int reformat(mbed::BlockDevice *bd);
|
||||
|
||||
/** Remove a file from the filesystem.
|
||||
/** Remove a file from the file system.
|
||||
*
|
||||
* @param path The name of the file to remove.
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int remove(const char *path);
|
||||
|
||||
/** Rename a file in the filesystem.
|
||||
/** Rename a file in the file system.
|
||||
*
|
||||
* @param path The name of the file to rename.
|
||||
* @param newpath The name to rename it to
|
||||
* @param newpath The name to rename it to.
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int rename(const char *path, const char *newpath);
|
||||
|
||||
/** Store information about the file in a stat structure
|
||||
*
|
||||
* @param path The name of the file to find information about
|
||||
* @param st The stat buffer to write to
|
||||
* @param path The name of the file to find information about.
|
||||
* @param st The stat buffer to write to.
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int stat(const char *path, struct stat *st);
|
||||
|
||||
/** Create a directory in the filesystem.
|
||||
/** Create a directory in the file system.
|
||||
*
|
||||
* @param path The name of the directory to create.
|
||||
* @param mode The permissions with which to create the directory
|
||||
* @param mode The permissions with which to create the directory.
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int mkdir(const char *path, mode_t mode);
|
||||
|
||||
/** Store information about the mounted filesystem in a statvfs structure
|
||||
/** Store information about the mounted file system in a statvfs structure.
|
||||
*
|
||||
* @param path The name of the file to find information about
|
||||
* @param buf The stat buffer to write to
|
||||
* @param path The name of the file to find information about.
|
||||
* @param buf The stat buffer to write to.
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int statvfs(const char *path, struct statvfs *buf);
|
||||
|
||||
protected:
|
||||
/** Open a file on the filesystem
|
||||
#if !(DOXYGEN_ONLY)
|
||||
/** Open a file on the file system.
|
||||
*
|
||||
* @param file Destination for the handle to a newly created file
|
||||
* @param path The name of the file to open
|
||||
* @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
|
||||
* bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
|
||||
* @return 0 on success, negative error code on failure
|
||||
* @param file Destination of the newly created handle to the referenced file.
|
||||
* @param path The name of the file to open.
|
||||
* @param flags The flags that trigger opening of the file. These flags are O_RDONLY, O_WRONLY, and O_RDWR,
|
||||
* with an O_CREAT, O_TRUNC, or O_APPEND bitwise OR operator.
|
||||
* @return 0 on success, negative error code on failure.
|
||||
*/
|
||||
virtual int file_open(mbed::fs_file_t *file, const char *path, int flags);
|
||||
|
||||
/** Close a file
|
||||
*
|
||||
* @param file File handle
|
||||
* @param file File handle.
|
||||
* return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int file_close(mbed::fs_file_t file);
|
||||
|
||||
/** Read the contents of a file into a buffer
|
||||
*
|
||||
* @param file File handle
|
||||
* @param buffer The buffer to read in to
|
||||
* @param size The number of bytes to read
|
||||
* @param file File handle.
|
||||
* @param buffer The buffer to read in to.
|
||||
* @param size The number of bytes to read.
|
||||
* @return The number of bytes read, 0 at end of file, negative error on failure
|
||||
*/
|
||||
virtual ssize_t file_read(mbed::fs_file_t file, void *buffer, size_t size);
|
||||
|
||||
/** Write the contents of a buffer to a file
|
||||
*
|
||||
* @param file File handle
|
||||
* @param buffer The buffer to write from
|
||||
* @param size The number of bytes to write
|
||||
* @param file File handle.
|
||||
* @param buffer The buffer to write from.
|
||||
* @param size The number of bytes to write.
|
||||
* @return The number of bytes written, negative error on failure
|
||||
*/
|
||||
virtual ssize_t file_write(mbed::fs_file_t file, const void *buffer, size_t size);
|
||||
|
||||
/** Flush any buffers associated with the file
|
||||
*
|
||||
* @param file File handle
|
||||
* @param file File handle.
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int file_sync(mbed::fs_file_t file);
|
||||
|
||||
/** Move the file position to a given offset from from a given location
|
||||
/** Move the file position to a given offset from a given location
|
||||
*
|
||||
* @param file File handle
|
||||
* @param offset The offset from whence to move to
|
||||
* @param whence The start of where to seek
|
||||
* @param file File handle.
|
||||
* @param offset The offset from whence to move to.
|
||||
* @param whence The start of where to seek.
|
||||
* SEEK_SET to start from beginning of file,
|
||||
* SEEK_CUR to start from current position in file,
|
||||
* SEEK_END to start from end of file
|
||||
* SEEK_END to start from end of file.
|
||||
* @return The new offset of the file
|
||||
*/
|
||||
virtual off_t file_seek(mbed::fs_file_t file, off_t offset, int whence);
|
||||
|
||||
/** Get the file position of the file
|
||||
*
|
||||
* @param file File handle
|
||||
* @param file File handle.
|
||||
* @return The current offset in the file
|
||||
*/
|
||||
virtual off_t file_tell(mbed::fs_file_t file);
|
||||
|
||||
/** Get the size of the file
|
||||
*
|
||||
* @param file File handle
|
||||
* @param file File handle.
|
||||
* @return Size of the file in bytes
|
||||
*/
|
||||
virtual off_t file_size(mbed::fs_file_t file);
|
||||
|
|
@ -233,39 +233,39 @@ protected:
|
|||
* not changed. If the file is extended, the extended area appears as if
|
||||
* it were zero-filled.
|
||||
*
|
||||
* @param file File handle
|
||||
* @param file File handle.
|
||||
* @param length The requested new length for the file
|
||||
*
|
||||
* @return Zero on success, negative error code on failure
|
||||
*/
|
||||
virtual int file_truncate(mbed::fs_file_t file, off_t length);
|
||||
|
||||
/** Open a directory on the filesystem
|
||||
/** Open a directory on the file system.
|
||||
*
|
||||
* @param dir Destination for the handle to the directory
|
||||
* @param path Name of the directory to open
|
||||
* @param dir Destination for the handle to the directory.
|
||||
* @param path Name of the directory to open.
|
||||
* @return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int dir_open(mbed::fs_dir_t *dir, const char *path);
|
||||
|
||||
/** Close a directory
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param dir Dir handle.
|
||||
* return 0 on success, negative error code on failure
|
||||
*/
|
||||
virtual int dir_close(mbed::fs_dir_t dir);
|
||||
|
||||
/** Read the next directory entry
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param ent The directory entry to fill out
|
||||
* @param dir Dir handle.
|
||||
* @param ent The directory entry to fill out.
|
||||
* @return 1 on reading a filename, 0 at end of directory, negative error on failure
|
||||
*/
|
||||
virtual ssize_t dir_read(mbed::fs_dir_t dir, struct dirent *ent);
|
||||
|
||||
/** Set the current position of the directory
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param dir Dir handle.
|
||||
* @param offset Offset of the location to seek to,
|
||||
* must be a value returned from dir_tell
|
||||
*/
|
||||
|
|
@ -273,7 +273,7 @@ protected:
|
|||
|
||||
/** Get the current position of the directory
|
||||
*
|
||||
* @param dir Dir handle
|
||||
* @param dir Dir handle.
|
||||
* @return Position of the directory that can be passed to dir_rewind
|
||||
*/
|
||||
virtual off_t dir_tell(mbed::fs_dir_t dir);
|
||||
|
|
@ -283,11 +283,12 @@ protected:
|
|||
* @param dir Dir handle
|
||||
*/
|
||||
virtual void dir_rewind(mbed::fs_dir_t dir);
|
||||
#endif //!(DOXYGEN_ONLY)
|
||||
|
||||
private:
|
||||
lfs_t _lfs; // _the actual filesystem
|
||||
lfs_t _lfs; // The actual file system
|
||||
struct lfs_config _config;
|
||||
mbed::BlockDevice *_bd; // the block device
|
||||
mbed::BlockDevice *_bd; // The block device
|
||||
|
||||
// default parameters
|
||||
const lfs_size_t _read_size;
|
||||
|
|
|
|||
Loading…
Reference in New Issue