ff.h File Reference

#include "ffconf.h"

Include dependency graph for ff.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	FATFS
struct	FFOBJID
struct	FIL
struct	DIR
struct	FILINFO
struct	MKFS_PARM

Macros
#define	FF_DEFINED   80286 /* Revision ID */
#define	FF_INTDEF   1
#define	_T(x)   u8##x
#define	_TEXT(x)   u8##x
#define	f_eof(fp)   ((int) ((fp)->fptr == (fp)->obj.objsize))
#define	f_printf(fp)   ((fp)->err)
#define	f_tell(fp)   ((fp)->fptr)
#define	f_size(fp)   ((fp)->obj.objsize)
#define	f_rewind(fp)   f_lseek((fp), 0)
#define	f_rewinddir(dp)   f_readdir((dp), 0)
#define	f_rmdir(path)   f_unlink(path)
#define	f_unmount(path)   f_mount(0, path, 0)
#define	FA_READ   0x01
#define	FA_WRITE   0x02
#define	FA_OPEN_EXISTING   0x00
#define	FA_CREATE_NEW   0x04
#define	FA_CREATE_ALWAYS   0x08
#define	FA_OPEN_ALWAYS   0x10
#define	FA_OPEN_APPEND   0x30
#define	CREATE_LINKMAP   ((FSIZE_t) 0 - 1)
#define	FM_FAT   0x01
#define	FM_FAT32   0x02
#define	FM_EXFAT   0x04
#define	FM_ANY   0x07
#define	FM_SFD   0x08
#define	FS_FAT12   1
#define	FS_FAT16   2
#define	FS_FAT32   3
#define	FS_EXFAT   4
#define	AM_RDO   0x01 /* Read only */
#define	AM_HID   0x02 /* Hidden */
#define	AM_SYS   0x04 /* System */
#define	AM_DIR   0x10 /* Directory */
#define	AM_ARC   0x20 /* Archive */

Typedefs
typedef unsigned int	UINT
typedef unsigned char	BYTE
typedef unsigned short	WORD
typedef unsigned long	DWORD
typedef WORD	WCHAR
typedef QWORD	FSIZE_t
typedef QWORD	LBA_t
typedef char	TCHAR

Enumerations
enum	FRESULT {   FR_OK = 0 , FR_DISK_ERR , FR_INT_ERR , FR_NOT_READY ,   FR_NO_FILE , FR_NO_PATH , FR_INVALID_NAME , FR_DENIED ,   FR_EXIST , FR_INVALID_OBJECT , FR_WRITE_PROTECTED , FR_INVALID_DRIVE ,   FR_NOT_ENABLED , FR_NO_FILESYSTEM , FR_MKFS_ABORTED , FR_TIMEOUT ,   FR_LOCKED , FR_NOT_ENOUGH_CORE , FR_TOO_MANY_OPEN_FILES , FR_INVALID_PARAMETER }

Functions
FRESULT	f_open (FIL *fp, const TCHAR *path, BYTE mode)
FRESULT	f_close (FIL *fp)
FRESULT	f_read (FIL *fp, void *buff, UINT btr, UINT *br)
FRESULT	f_write (FIL *fp, const void *buff, UINT btw, UINT *bw)
FRESULT	f_lseek (FIL *fp, FSIZE_t ofs)
FRESULT	f_truncate (FIL *fp)
FRESULT	f_sync (FIL *fp)
FRESULT	f_opendir (DIR *dp, const TCHAR *path)
FRESULT	f_closedir (DIR *dp)
FRESULT	f_readdir (DIR *dp, FILINFO *fno)
FRESULT	f_findfirst (DIR *dp, FILINFO *fno, const TCHAR *path, const TCHAR *pattern)
FRESULT	f_findnext (DIR *dp, FILINFO *fno)
FRESULT	f_mkdir (const TCHAR *path)
FRESULT	f_unlink (const TCHAR *path)
FRESULT	f_rename (const TCHAR *path_old, const TCHAR *path_new)
FRESULT	f_stat (const TCHAR *path, FILINFO *fno)
FRESULT	f_chmod (const TCHAR *path, BYTE attr, BYTE mask)
FRESULT	f_utime (const TCHAR *path, const FILINFO *fno)
FRESULT	f_chdir (const TCHAR *path)
FRESULT	f_chdrive (const TCHAR *path)
FRESULT	f_getcwd (TCHAR *buff, UINT len)
FRESULT	f_getfree (const TCHAR *path, DWORD *nclst, FATFS **fatfs)
FRESULT	f_getlabel (const TCHAR *path, TCHAR *label, DWORD *vsn)
FRESULT	f_setlabel (const TCHAR *label)
FRESULT	f_forward (FIL *fp, UINT(*func)(const BYTE *, UINT), UINT btf, UINT *bf)
FRESULT	f_expand (FIL *fp, FSIZE_t fsz, BYTE opt)
FRESULT	f_mount (FATFS *fs, const TCHAR *path, BYTE opt)
FRESULT	f_mkfs (const TCHAR *path, const MKFS_PARM *opt, void *work, UINT len)
FRESULT	f_fdisk (BYTE pdrv, const LBA_t ptbl[], void *work)
FRESULT	f_setcp (WORD cp)
int	f_putc (TCHAR c, FIL *fp)
int	f_puts (const TCHAR *str, FIL *cp)
int	f_printf (FIL *fp, const TCHAR *str,...)
TCHAR *	f_gets (TCHAR *buff, int len, FIL *fp)
WCHAR	ff_oem2uni (WCHAR oem, WORD cp)
WCHAR	ff_uni2oem (DWORD uni, WORD cp)
DWORD	ff_wtoupper (DWORD uni)

Macro Definition Documentation

_T

#define _T

(

x

)

u8##x

_TEXT

#define _TEXT

(

x

)

u8##x

AM_ARC

#define AM_ARC   0x20 /* Archive */

AM_DIR

#define AM_DIR   0x10 /* Directory */

AM_HID

#define AM_HID   0x02 /* Hidden */

AM_RDO

#define AM_RDO   0x01 /* Read only */

AM_SYS

#define AM_SYS   0x04 /* System */

CREATE_LINKMAP

#define CREATE_LINKMAP   ((FSIZE_t) 0 - 1)

f_eof

#define f_eof

(

fp

)

((int) ((fp)->fptr == (fp)->obj.objsize))

f_printf

#define f_printf

(

fp

)

((fp)->err)

f_rewind

#define f_rewind

(

fp

)

f_lseek((fp), 0)

f_rewinddir

#define f_rewinddir

(

dp

)

f_readdir((dp), 0)

f_rmdir

#define f_rmdir

(

path

)

f_unlink(path)

f_size

#define f_size

(

fp

)

((fp)->obj.objsize)

f_tell

#define f_tell

(

fp

)

((fp)->fptr)

f_unmount

#define f_unmount

(

path

)

f_mount(0, path, 0)

FA_CREATE_ALWAYS

#define FA_CREATE_ALWAYS   0x08

FA_CREATE_NEW

#define FA_CREATE_NEW   0x04

FA_OPEN_ALWAYS

#define FA_OPEN_ALWAYS   0x10

FA_OPEN_APPEND

#define FA_OPEN_APPEND   0x30

FA_OPEN_EXISTING

#define FA_OPEN_EXISTING   0x00

FA_READ

#define FA_READ   0x01

FA_WRITE

#define FA_WRITE   0x02

FF_DEFINED

#define FF_DEFINED   80286 /* Revision ID */

FF_INTDEF

#define FF_INTDEF   1

FM_ANY

#define FM_ANY   0x07

FM_EXFAT

#define FM_EXFAT   0x04

FM_FAT

#define FM_FAT   0x01

FM_FAT32

#define FM_FAT32   0x02

FM_SFD

#define FM_SFD   0x08

FS_EXFAT

#define FS_EXFAT   4

FS_FAT12

#define FS_FAT12   1

FS_FAT16

#define FS_FAT16   2

FS_FAT32

#define FS_FAT32   3

Typedef Documentation

BYTE

typedef unsigned char BYTE

DWORD

typedef unsigned long DWORD

FSIZE_t

typedef QWORD FSIZE_t

LBA_t

typedef QWORD LBA_t

TCHAR

typedef char TCHAR

UINT

typedef unsigned int UINT

WCHAR

typedef WORD WCHAR

WORD

typedef unsigned short WORD

Enumeration Type Documentation

FRESULT

enum FRESULT

Enumerator
FR_OK
FR_DISK_ERR
FR_INT_ERR
FR_NOT_READY
FR_NO_FILE
FR_NO_PATH
FR_INVALID_NAME
FR_DENIED
FR_EXIST
FR_INVALID_OBJECT
FR_WRITE_PROTECTED
FR_INVALID_DRIVE
FR_NOT_ENABLED
FR_NO_FILESYSTEM
FR_MKFS_ABORTED
FR_TIMEOUT
FR_LOCKED
FR_NOT_ENOUGH_CORE
FR_TOO_MANY_OPEN_FILES
FR_INVALID_PARAMETER

Function Documentation

f_chdir()

FRESULT f_chdir

(

const TCHAR *

path

)

f_chdrive()

FRESULT f_chdrive

(

const TCHAR *

path

)

f_chmod()

FRESULT f_chmod	(	const TCHAR *	path,
		BYTE	attr,
		BYTE	mask
	)

f_close()

FRESULT f_close

(

FIL *

fp

)

f_closedir()

FRESULT f_closedir

(

DIR *

dp

)

f_expand()

FRESULT f_expand	(	FIL *	fp,
		FSIZE_t	fsz,
		BYTE	opt
	)

f_fdisk()

FRESULT f_fdisk	(	BYTE	pdrv,
		const LBA_t	ptbl[],
		void *	work
	)

f_findfirst()

FRESULT f_findfirst	(	DIR *	dp,
		FILINFO *	fno,
		const TCHAR *	path,
		const TCHAR *	pattern
	)

f_findnext()

FRESULT f_findnext	(	DIR *	dp,
		FILINFO *	fno
	)

f_forward()

FRESULT f_forward	(	FIL *	fp,
		UINT(*)(const BYTE *, UINT)	func,
		UINT	btf,
		UINT *	bf
	)

f_getcwd()

FRESULT f_getcwd	(	TCHAR *	buff,
		UINT	len
	)

f_getfree()

FRESULT f_getfree	(	const TCHAR *	path,
		DWORD *	nclst,
		FATFS **	fatfs
	)

f_getlabel()

FRESULT f_getlabel	(	const TCHAR *	path,
		TCHAR *	label,
		DWORD *	vsn
	)

f_gets()

TCHAR * f_gets	(	TCHAR *	buff,
		int	len,
		FIL *	fp
	)

f_lseek()

FRESULT f_lseek	(	FIL *	fp,
		FSIZE_t	ofs
	)

f_mkdir()

FRESULT f_mkdir

(

const TCHAR *

path

)

f_mkfs()

FRESULT f_mkfs	(	const TCHAR *	path,
		const MKFS_PARM *	opt,
		void *	work,
		UINT	len
	)

f_mount()

FRESULT f_mount	(	FATFS *	fs,
		const TCHAR *	path,
		BYTE	opt
	)

f_open()

FRESULT f_open	(	FIL *	fp,
		const TCHAR *	path,
		BYTE	mode
	)

f_opendir()

FRESULT f_opendir	(	DIR *	dp,
		const TCHAR *	path
	)

f_printf()

int f_printf	(	FIL *	fp,
		const TCHAR *	str,
			...
	)

f_putc()

int f_putc	(	TCHAR	c,
		FIL *	fp
	)

f_puts()

int f_puts	(	const TCHAR *	str,
		FIL *	cp
	)

f_read()

FRESULT f_read	(	FIL *	fp,
		void *	buff,
		UINT	btr,
		UINT *	br
	)

f_readdir()

FRESULT f_readdir	(	DIR *	dp,
		FILINFO *	fno
	)

f_rename()

FRESULT f_rename	(	const TCHAR *	path_old,
		const TCHAR *	path_new
	)

f_setcp()

FRESULT f_setcp

(

WORD

cp

)

f_setlabel()

FRESULT f_setlabel

(

const TCHAR *

label

)

f_stat()

FRESULT f_stat	(	const TCHAR *	path,
		FILINFO *	fno
	)

f_sync()

FRESULT f_sync

(

FIL *

fp

)

f_truncate()

FRESULT f_truncate

(

FIL *

fp

)

f_unlink()

FRESULT f_unlink

(

const TCHAR *

path

)

f_utime()

FRESULT f_utime	(	const TCHAR *	path,
		const FILINFO *	fno
	)

f_write()

FRESULT f_write	(	FIL *	fp,
		const void *	buff,
		UINT	btw,
		UINT *	bw
	)

ff_oem2uni()

WCHAR ff_oem2uni	(	WCHAR	oem,
		WORD	cp
	)

ff_uni2oem()

WCHAR ff_uni2oem	(	DWORD	uni,
		WORD	cp
	)

ff_wtoupper()

DWORD ff_wtoupper

(

DWORD

uni

)