dragonfs.h File Reference

DragonFS. More...

Go to the source code of this file.

Macros
#define	DFS_DEFAULT_LOCATION   0
	Default filesystem location. More...
#define	MAX_OPEN_FILES   4
	Maximum open files in DragonFS.
#define	MAX_FILENAME_LEN   243
	Maximum filename length. More...
#define	MAX_DIRECTORY_DEPTH   100
	Maximum depth of directories supported.
#define	FILETYPE(x)   ((x) & 3)
	Macro to extract the file type from a DragonFS file flag. More...
DragonFS Return values
#define	DFS_ESUCCESS   0
	Success.
#define	DFS_EBADINPUT   -1
	Input parameters invalid.
#define	DFS_ENOFILE   -2
	File does not exist.
#define	DFS_EBADFS   -3
	Bad filesystem.
#define	DFS_ENFILE   -4
	Too many open files.
#define	DFS_EBADHANDLE   -5
	Invalid file handle.
DragonFS file type flags
#define	FLAGS_FILE   0x0
	This is a file entry.
#define	FLAGS_DIR   0x1
	This is a directory entry.
#define	FLAGS_EOF   0x2
	This is the end of a directory list.

Functions
int	dfs_init (uint32_t base_fs_loc)
	Initialize the filesystem. More...
int	dfs_chdir (const char *const path)
	Change directories to the specified path. More...
int	dfs_dir_findfirst (const char *const path, char *buf)
	Find the first file or directory in a directory listing. More...
int	dfs_dir_findnext (char *buf)
	Find the next file or directory in a directory listing. More...
int	dfs_open (const char *const path)
	Open a file given a path. More...
int	dfs_read (void *const buf, int size, int count, uint32_t handle)
	Read data from a file. More...
int	dfs_seek (uint32_t handle, int offset, int origin)
	Seek to an offset in the file. More...
int	dfs_tell (uint32_t handle)
	Return the current offset into a file. More...
int	dfs_close (uint32_t handle)
	Close an already open file handle. More...
int	dfs_eof (uint32_t handle)
	Return whether the end of file has been reached. More...
int	dfs_size (uint32_t handle)
	Return the file size of an open file. More...
uint32_t	dfs_rom_addr (const char *path)
	Return the physical address of a file (in ROM space) More...
const char *	dfs_strerror (int error)
	Convert DFS error code into an error string.

Detailed Description

DragonFS.