ref/dragonfs_8h_source.html

#ifndef __LIBDRAGON_DRAGONFS_H

#define __LIBDRAGON_DRAGONFS_H


#define DFS_DEFAULT_LOCATION    0


#define MAX_OPEN_FILES      4


#define MAX_FILENAME_LEN    243


#define MAX_DIRECTORY_DEPTH 100


#define DFS_ESUCCESS        0

#define DFS_EBADINPUT       -1

#define DFS_ENOFILE         -2

#define DFS_EBADFS          -3

#define DFS_ENFILE          -4

#define DFS_EBADHANDLE      -5

// Deprecated naming

#define DFS_ENOMEM          -4

#define FILETYPE(x)         ((x) & 3)


#define FLAGS_FILE          0x0

#define FLAGS_DIR           0x1

#define FLAGS_EOF           0x2

#ifdef __cplusplus

extern "C" {

#endif


int dfs_init(uint32_t base_fs_loc);

int dfs_chdir(const char * const path);

int dfs_dir_findfirst(const char * const path, char *buf);

int dfs_dir_findnext(char *buf);


int dfs_open(const char * const path);

int dfs_read(void * const buf, int size, int count, uint32_t handle);

int dfs_seek(uint32_t handle, int offset, int origin);

int dfs_tell(uint32_t handle);

int dfs_close(uint32_t handle);

int dfs_eof(uint32_t handle);

int dfs_size(uint32_t handle);

uint32_t dfs_rom_addr(const char *path);


const char *dfs_strerror(int error);


#ifdef __cplusplus

}

#endif


#endif

dfs_seek
int dfs_seek(uint32_t handle, int offset, int origin)
Seek to an offset in the file.
Definition: dragonfs.c:839

dfs_size
int dfs_size(uint32_t handle)
Return the file size of an open file.
Definition: dragonfs.c:1045

dfs_dir_findfirst
int dfs_dir_findfirst(const char *const path, char *buf)
Find the first file or directory in a directory listing.
Definition: dragonfs.c:693

dfs_chdir
int dfs_chdir(const char *const path)
Change directories to the specified path.
Definition: dragonfs.c:666

dfs_open
int dfs_open(const char *const path)
Open a file given a path.
Definition: dragonfs.c:767

dfs_read
int dfs_read(void *const buf, int size, int count, uint32_t handle)
Read data from a file.
Definition: dragonfs.c:939

dfs_init
int dfs_init(uint32_t base_fs_loc)
Initialize the filesystem.
Definition: dragonfs.c:1371

dfs_rom_addr
uint32_t dfs_rom_addr(const char *path)
Return the physical address of a file (in ROM space)
Definition: dragonfs.c:1076

dfs_dir_findnext
int dfs_dir_findnext(char *buf)
Find the next file or directory in a directory listing.
Definition: dragonfs.c:732

dfs_tell
int dfs_tell(uint32_t handle)
Return the current offset into a file.
Definition: dragonfs.c:912

dfs_strerror
const char * dfs_strerror(int error)
Convert DFS error code into an error string.
Definition: dragonfs.c:1409

dfs_close
int dfs_close(uint32_t handle)
Close an already open file handle.
Definition: dragonfs.c:812

dfs_eof
int dfs_eof(uint32_t handle)
Return whether the end of file has been reached.
Definition: dragonfs.c:1104