diskio.h File Reference

#include "integer.h"

Go to the source code of this file.

Macros
#define	_USE_WRITE   1 /* 1: Enable disk_write function */
#define	_USE_IOCTL   1 /* 1: Enable disk_ioctl fucntion */
#define	STA_NOINIT   0x01 /* Drive not initialized */
#define	STA_NODISK   0x02 /* No medium in the drive */
#define	STA_PROTECT   0x04 /* Write protected */
#define	CTRL_SYNC   0 /* Complete pending write process (needed at _FS_READONLY == 0) */
#define	GET_SECTOR_COUNT   1 /* Get media size (needed at _USE_MKFS == 1) */
#define	GET_SECTOR_SIZE   2 /* Get sector size (needed at _MAX_SS != _MIN_SS) */
#define	GET_BLOCK_SIZE   3 /* Get erase block size (needed at _USE_MKFS == 1) */
#define	CTRL_TRIM   4 /* Inform device that the data on the block of sectors is no longer used (needed at _USE_TRIM == 1) */
#define	CTRL_POWER   5 /* Get/Set power status */
#define	CTRL_LOCK   6 /* Lock/Unlock media removal */
#define	CTRL_EJECT   7 /* Eject media */
#define	CTRL_FORMAT   8 /* Create physical format on the media */
#define	MMC_GET_TYPE   10 /* Get card type */
#define	MMC_GET_CSD   11 /* Get CSD */
#define	MMC_GET_CID   12 /* Get CID */
#define	MMC_GET_OCR   13 /* Get OCR */
#define	MMC_GET_SDSTAT   14 /* Get SD status */
#define	ATA_GET_REV   20 /* Get F/W revision */
#define	ATA_GET_MODEL   21 /* Get model name */
#define	ATA_GET_SN   22 /* Get serial number */

Typedefs
typedef BYTE	DSTATUS

Enumerations
enum	DRESULT {   RES_OK = 0, RES_ERROR, RES_WRPRT, RES_NOTRDY,   RES_PARERR }

Functions
DSTATUS	disk_initialize (BYTE pdrv)
	Initializes a Drive. More...
DSTATUS	disk_status (BYTE pdrv)
	Gets Disk Status. More...
DRESULT	disk_read (BYTE pdrv, BYTE *buff, DWORD sector, UINT count)
	Reads Sector(s) More...
DRESULT	disk_write (BYTE pdrv, const BYTE *buff, DWORD sector, UINT count)
	Writes Sector(s) More...
DRESULT	disk_ioctl (BYTE pdrv, BYTE cmd, void *buff)
	I/O control operation. More...
DWORD	get_fattime (void)
	Gets Time from RTC. More...

Macro Definition Documentation

#define _USE_IOCTL   1 /* 1: Enable disk_ioctl fucntion */

Definition at line 13 of file diskio.h.

#define _USE_WRITE   1 /* 1: Enable disk_write function */

Definition at line 12 of file diskio.h.

#define ATA_GET_MODEL   21 /* Get model name */

Definition at line 73 of file diskio.h.

#define ATA_GET_REV   20 /* Get F/W revision */

Definition at line 72 of file diskio.h.

#define ATA_GET_SN   22 /* Get serial number */

Definition at line 74 of file diskio.h.

#define CTRL_EJECT   7 /* Eject media */

Definition at line 61 of file diskio.h.

#define CTRL_FORMAT   8 /* Create physical format on the media */

Definition at line 62 of file diskio.h.

#define CTRL_LOCK   6 /* Lock/Unlock media removal */

Definition at line 60 of file diskio.h.

#define CTRL_POWER   5 /* Get/Set power status */

Definition at line 59 of file diskio.h.

#define CTRL_SYNC   0 /* Complete pending write process (needed at _FS_READONLY == 0) */

Definition at line 52 of file diskio.h.

#define CTRL_TRIM   4 /* Inform device that the data on the block of sectors is no longer used (needed at _USE_TRIM == 1) */

Definition at line 56 of file diskio.h.

#define GET_BLOCK_SIZE   3 /* Get erase block size (needed at _USE_MKFS == 1) */

Definition at line 55 of file diskio.h.

#define GET_SECTOR_COUNT   1 /* Get media size (needed at _USE_MKFS == 1) */

Definition at line 53 of file diskio.h.

#define GET_SECTOR_SIZE   2 /* Get sector size (needed at _MAX_SS != _MIN_SS) */

Definition at line 54 of file diskio.h.

#define MMC_GET_CID   12 /* Get CID */

Definition at line 67 of file diskio.h.

#define MMC_GET_CSD   11 /* Get CSD */

Definition at line 66 of file diskio.h.

#define MMC_GET_OCR   13 /* Get OCR */

Definition at line 68 of file diskio.h.

#define MMC_GET_SDSTAT   14 /* Get SD status */

Definition at line 69 of file diskio.h.

#define MMC_GET_TYPE   10 /* Get card type */

Definition at line 65 of file diskio.h.

#define STA_NODISK   0x02 /* No medium in the drive */

Definition at line 45 of file diskio.h.

#define STA_NOINIT   0x01 /* Drive not initialized */

Definition at line 44 of file diskio.h.

#define STA_PROTECT   0x04 /* Write protected */

Definition at line 46 of file diskio.h.

Typedef Documentation

typedef BYTE DSTATUS

Definition at line 19 of file diskio.h.

Enumeration Type Documentation

enum DRESULT

Enumerator
RES_OK
RES_ERROR
RES_WRPRT
RES_NOTRDY
RES_PARERR

Definition at line 22 of file diskio.h.

Function Documentation

DSTATUS disk_initialize

(

BYTE

pdrv

)

Initializes a Drive.

Parameters

pdrv	Physical drive number (0..)

Return values

DSTATUS

Operation status

Definition at line 70 of file diskio.c.

DRESULT disk_ioctl	(	BYTE	pdrv,
		BYTE	cmd,
		void *	buff
	)

I/O control operation.

Parameters

pdrv	Physical drive number (0..)
cmd	Control code
*buff	Buffer to send/receive control data

Return values

DRESULT

Operation result

Definition at line 136 of file diskio.c.

DRESULT disk_read	(	BYTE	pdrv,
		BYTE *	buff,
		DWORD	sector,
		UINT	count
	)

Reads Sector(s)

Parameters

pdrv	Physical drive number (0..)
*buff	Data buffer to store read data
sector	Sector address (LBA)
count	Number of sectors to read (1..128)

Return values

DRESULT

Operation result

Definition at line 92 of file diskio.c.

DSTATUS disk_status

(

BYTE

pdrv

)

Gets Disk Status.

Parameters

pdrv	Physical drive number (0..)

Return values

DSTATUS

Operation status

Definition at line 55 of file diskio.c.

DRESULT disk_write	(	BYTE	pdrv,
		const BYTE *	buff,
		DWORD	sector,
		UINT	count
	)

Writes Sector(s)

Parameters

pdrv	Physical drive number (0..)
*buff	Data to be written
sector	Sector address (LBA)
count	Number of sectors to write (1..128)

Return values

DRESULT

Operation result

Definition at line 114 of file diskio.c.

DWORD get_fattime

(

void

)

Gets Time from RTC.

Parameters

None

Return values

Time

in DWORD

Definition at line 154 of file diskio.c.