ff.h File Reference

#include "ffconf.h"

Go to the source code of this file.

Data Structures
struct	FATFS
struct	FFOBJID
struct	FIL
struct	DIR
struct	FILINFO
struct	MKFS_PARM

Macros
#define	FF_DEFINED   86606 /* Revision ID */
#define	FF_INTDEF   1
#define	_INC_TCHAR
#define	_T(x)   x
#define	_TEXT(x)   x
#define	f_eof(fp)   ((int)((fp)->fptr == (fp)->obj.objsize))
#define	f_error(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	EOF   (-1)
#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 char	TCHAR
typedef DWORD	FSIZE_t
typedef DWORD	LBA_t

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)
DWORD	get_fattime (void)
	Read time and convert to FAT32 time. More...
WCHAR	ff_oem2uni (WCHAR oem, WORD cp)
WCHAR	ff_uni2oem (DWORD uni, WORD cp)
DWORD	ff_wtoupper (DWORD uni)
void *	ff_memalloc (UINT msize)
void	ff_memfree (void *mblock)

Macro Definition Documentation

_INC_TCHAR

#define _INC_TCHAR

Definition at line 82 of file ff.h.

_T

#define _T

(

x

)

x

Definition at line 100 of file ff.h.

_TEXT

#define _TEXT

(

x

)

x

Definition at line 101 of file ff.h.

AM_ARC

#define AM_ARC   0x20 /* Archive */

Definition at line 419 of file ff.h.

AM_DIR

#define AM_DIR   0x10 /* Directory */

Definition at line 418 of file ff.h.

AM_HID

#define AM_HID   0x02 /* Hidden */

Definition at line 416 of file ff.h.

AM_RDO

#define AM_RDO   0x01 /* Read only */

Definition at line 415 of file ff.h.

AM_SYS

#define AM_SYS   0x04 /* System */

Definition at line 417 of file ff.h.

CREATE_LINKMAP

#define CREATE_LINKMAP   ((FSIZE_t)0 - 1)

Definition at line 399 of file ff.h.

EOF

#define EOF   (-1)

Definition at line 349 of file ff.h.

f_eof

#define f_eof

(

fp

)

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

Definition at line 339 of file ff.h.

f_error

#define f_error

(

fp

)

((fp)->err)

Definition at line 340 of file ff.h.

f_rewind

#define f_rewind

(

fp

)

f_lseek((fp), 0)

Definition at line 343 of file ff.h.

f_rewinddir

#define f_rewinddir

(

dp

)

f_readdir((dp), 0)

Definition at line 344 of file ff.h.

f_rmdir

#define f_rmdir

(

path

)

f_unlink(path)

Definition at line 345 of file ff.h.

f_size

#define f_size

(

fp

)

((fp)->obj.objsize)

Definition at line 342 of file ff.h.

f_tell

#define f_tell

(

fp

)

((fp)->fptr)

Definition at line 341 of file ff.h.

f_unmount

#define f_unmount

(

path

)

f_mount(0, path, 0)

Definition at line 346 of file ff.h.

FA_CREATE_ALWAYS

#define FA_CREATE_ALWAYS   0x08

Definition at line 394 of file ff.h.

FA_CREATE_NEW

#define FA_CREATE_NEW   0x04

Definition at line 393 of file ff.h.

FA_OPEN_ALWAYS

#define FA_OPEN_ALWAYS   0x10

Definition at line 395 of file ff.h.

FA_OPEN_APPEND

#define FA_OPEN_APPEND   0x30

Definition at line 396 of file ff.h.

FA_OPEN_EXISTING

#define FA_OPEN_EXISTING   0x00

Definition at line 392 of file ff.h.

FA_READ

#define FA_READ   0x01

Definition at line 390 of file ff.h.

FA_WRITE

#define FA_WRITE   0x02

Definition at line 391 of file ff.h.

FF_DEFINED

#define FF_DEFINED   86606 /* Revision ID */

Definition at line 23 of file ff.h.

FF_INTDEF

#define FF_INTDEF   1

Definition at line 52 of file ff.h.

FM_ANY

#define FM_ANY   0x07

Definition at line 405 of file ff.h.

FM_EXFAT

#define FM_EXFAT   0x04

Definition at line 404 of file ff.h.

FM_FAT

#define FM_FAT   0x01

Definition at line 402 of file ff.h.

FM_FAT32

#define FM_FAT32   0x02

Definition at line 403 of file ff.h.

FM_SFD

#define FM_SFD   0x08

Definition at line 406 of file ff.h.

FS_EXFAT

#define FS_EXFAT   4

Definition at line 412 of file ff.h.

FS_FAT12

#define FS_FAT12   1

Definition at line 409 of file ff.h.

FS_FAT16

#define FS_FAT16   2

Definition at line 410 of file ff.h.

FS_FAT32

#define FS_FAT32   3

Definition at line 411 of file ff.h.

Typedef Documentation

BYTE

typedef unsigned char BYTE

Definition at line 54 of file ff.h.

DWORD

typedef unsigned long DWORD

Definition at line 56 of file ff.h.

FSIZE_t

typedef DWORD FSIZE_t

Definition at line 124 of file ff.h.

LBA_t

typedef DWORD LBA_t

Definition at line 125 of file ff.h.

TCHAR

typedef char TCHAR

Definition at line 99 of file ff.h.

UINT

typedef unsigned int UINT

Definition at line 53 of file ff.h.

WCHAR

typedef WORD WCHAR

Definition at line 57 of file ff.h.

WORD

typedef unsigned short WORD

Definition at line 55 of file ff.h.

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

Definition at line 276 of file ff.h.

Function Documentation

f_chdir()

FRESULT f_chdir

(

const TCHAR *

path

)

Definition at line 4246 of file ff.c.

Referenced by chdir().

f_chdrive()

FRESULT f_chdrive

(

const TCHAR *

path

)

Definition at line 4229 of file ff.c.

f_chmod()

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

Definition at line 5218 of file ff.c.

Referenced by chmod(), and fatfs_tests().

f_close()

FRESULT f_close

(

FIL *

fp

)

Definition at line 4193 of file ff.c.

Referenced by close(), dbf_close(), and open().

f_closedir()

FRESULT f_closedir

(

DIR *

dp

)

Definition at line 4637 of file ff.c.

Referenced by closedir(), and fatfs_ls().

f_expand()

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

Definition at line 5527 of file ff.c.

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
	)

Definition at line 4728 of file ff.c.

f_findnext()

FRESULT f_findnext	(	DIR *	dp,
		FILINFO *	fno
	)

Definition at line 4703 of file ff.c.

Referenced by f_findfirst().

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
	)

Definition at line 4308 of file ff.c.

Referenced by getcwd().

f_getfree()

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

Definition at line 4790 of file ff.c.

Referenced by fatfs_ls(), and fatfs_status().

f_getlabel()

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

Definition at line 5312 of file ff.c.

Referenced by fatfs_status().

f_gets()

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

f_lseek()

FRESULT f_lseek	(	FIL *	fp,
		FSIZE_t	ofs
	)

Definition at line 4408 of file ff.c.

Referenced by dbf_lseek(), fatfs_getc(), ftruncate(), lseek(), open(), and truncate().

f_mkdir()

FRESULT f_mkdir

(

const TCHAR *

path

)

Definition at line 5024 of file ff.c.

Referenced by mkdir().

f_mkfs()

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

Definition at line 5838 of file ff.c.

Referenced by fatfs_tests(), and mkfs().

f_mount()

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

Definition at line 3649 of file ff.c.

Referenced by fatfs_tests(), mkfs(), and mmc_init().

f_open()

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

Definition at line 3697 of file ff.c.

Referenced by dbf_open(), open(), and truncate().

f_opendir()

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

Definition at line 4571 of file ff.c.

Referenced by f_findfirst(), fatfs_ls(), fatfs_scan_files(), and opendir().

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
	)

Definition at line 3889 of file ff.c.

Referenced by dbf_read(), fatfs_getc(), and read().

f_readdir()

FRESULT f_readdir	(	DIR *	dp,
		FILINFO *	fno
	)

Definition at line 4667 of file ff.c.

Referenced by f_findnext(), fatfs_ls(), fatfs_scan_files(), and readdir().

f_rename()

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

Definition at line 5108 of file ff.c.

Referenced by rename().

f_setcp()

FRESULT f_setcp

(

WORD

cp

)

f_setlabel()

FRESULT f_setlabel

(

const TCHAR *

label

)

Definition at line 5407 of file ff.c.

f_stat()

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

Definition at line 4755 of file ff.c.

Referenced by stat().

f_sync()

FRESULT f_sync

(

FIL *

fp

)

Definition at line 4112 of file ff.c.

Referenced by f_close(), and syncfs().

f_truncate()

FRESULT f_truncate

(

FIL *

fp

)

Definition at line 4880 of file ff.c.

Referenced by ftruncate(), and truncate().

f_unlink()

FRESULT f_unlink

(

const TCHAR *

path

)

Definition at line 4930 of file ff.c.

Referenced by rmdir(), and unlink().

f_utime()

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

Definition at line 5265 of file ff.c.

Referenced by utime().

f_write()

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

Definition at line 3990 of file ff.c.

Referenced by dbf_write(), fatfs_putc(), and write().

ff_memalloc()

void* ff_memalloc

(

UINT

msize

)

Definition at line 23 of file ffsystem.c.

Referenced by dir_clear(), and f_mkfs().

ff_memfree()

void ff_memfree

(

void *

mblock

)

Definition at line 35 of file ffsystem.c.

Referenced by dir_clear().

ff_oem2uni()

WCHAR ff_oem2uni	(	WCHAR	oem,
		WORD	cp
	)

Definition at line 15244 of file ffunicode.c.

Referenced by f_getlabel(), get_fileinfo(), and tchar2uni().

ff_uni2oem()

WCHAR ff_uni2oem	(	DWORD	uni,
		WORD	cp
	)

Definition at line 15222 of file ffunicode.c.

Referenced by create_name(), f_setlabel(), and put_utf().

ff_wtoupper()

DWORD ff_wtoupper

(

DWORD

uni

)

Definition at line 15464 of file ffunicode.c.

Referenced by cmp_lfn(), create_name(), dir_find(), f_mkfs(), f_setlabel(), and get_achar().

get_fattime()

DWORD get_fattime

(

void

)

Read time and convert to FAT32 time.

Returns

FAT32 time.

See also

tm_to_fat().

Definition at line 129 of file fatfs_sup.c.