onboard_sd.h File Reference

Go to the source code of this file.

Macros
#define	_DISKIO_WRITE   1 /* 1: Enable disk_write function */
#define	_DISKIO_IOCTL   1 /* 1: Enable disk_ioctl fucntion */
#define	_DISKIO_ISDIO   0 /* 1: Enable iSDIO control 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_FORMAT   5 /* Create physical format on the media */
#define	CTRL_POWER_IDLE   6 /* Put the device idle state */
#define	CTRL_POWER_OFF   7 /* Put the device off state */
#define	CTRL_LOCK   8 /* Lock media removal */
#define	CTRL_UNLOCK   9 /* Unlock media removal */
#define	CTRL_EJECT   10 /* Eject media */
#define	MMC_GET_TYPE   50 /* Get card type */
#define	MMC_GET_CSD   51 /* Get CSD */
#define	MMC_GET_CID   52 /* Get CID */
#define	MMC_GET_OCR   53 /* Get OCR */
#define	MMC_GET_SDSTAT   54 /* Get SD status */
#define	ISDIO_READ   55 /* Read data form SD iSDIO register */
#define	ISDIO_WRITE   56 /* Write data to SD iSDIO register */
#define	ISDIO_MRITE   57 /* Masked write data to SD iSDIO register */
#define	ATA_GET_REV   60 /* Get F/W revision */
#define	ATA_GET_MODEL   61 /* Get model name */
#define	ATA_GET_SN   62 /* Get serial number */
#define	CT_MMC   0x01 /* MMC ver 3 */
#define	CT_SD1   0x02 /* SD ver 1 */
#define	CT_SD2   0x04 /* SD ver 2 */
#define	CT_SDC   (CT_SD1|CT_SD2) /* SD */
#define	CT_BLOCK   0x08 /* Block addressing */

Typedefs
typedef unsigned char	BYTE
typedef unsigned short	WORD
typedef unsigned long	DWORD
typedef unsigned int	UINT
typedef BYTE	DSTATUS

Enumerations
enum	DRESULT {   RES_OK = 0, RES_ERROR, RES_WRPRT, RES_NOTRDY,   RES_PARERR, 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...

Macro Definition Documentation

_DISKIO_WRITE

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

_DISKIO_IOCTL

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

_DISKIO_ISDIO

#define _DISKIO_ISDIO   0 /* 1: Enable iSDIO control fucntion */

STA_NOINIT

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

STA_NODISK

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

STA_PROTECT

#define STA_PROTECT   0x04 /* Write protected */

CTRL_SYNC

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

GET_SECTOR_COUNT

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

GET_SECTOR_SIZE

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

GET_BLOCK_SIZE

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

CTRL_TRIM

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

CTRL_FORMAT

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

CTRL_POWER_IDLE

#define CTRL_POWER_IDLE   6 /* Put the device idle state */

CTRL_POWER_OFF

#define CTRL_POWER_OFF   7 /* Put the device off state */

CTRL_LOCK

#define CTRL_LOCK   8 /* Lock media removal */

CTRL_UNLOCK

#define CTRL_UNLOCK   9 /* Unlock media removal */

CTRL_EJECT

#define CTRL_EJECT   10 /* Eject media */

MMC_GET_TYPE

#define MMC_GET_TYPE   50 /* Get card type */

MMC_GET_CSD

#define MMC_GET_CSD   51 /* Get CSD */

MMC_GET_CID

#define MMC_GET_CID   52 /* Get CID */

MMC_GET_OCR

#define MMC_GET_OCR   53 /* Get OCR */

MMC_GET_SDSTAT

#define MMC_GET_SDSTAT   54 /* Get SD status */

ISDIO_READ

#define ISDIO_READ   55 /* Read data form SD iSDIO register */

ISDIO_WRITE

#define ISDIO_WRITE   56 /* Write data to SD iSDIO register */

ISDIO_MRITE

#define ISDIO_MRITE   57 /* Masked write data to SD iSDIO register */

ATA_GET_REV

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

ATA_GET_MODEL

#define ATA_GET_MODEL   61 /* Get model name */

ATA_GET_SN

#define ATA_GET_SN   62 /* Get serial number */

CT_MMC

#define CT_MMC   0x01 /* MMC ver 3 */

CT_SD1

#define CT_SD1   0x02 /* SD ver 1 */

CT_SD2

#define CT_SD2   0x04 /* SD ver 2 */

CT_SDC

#define CT_SDC   (CT_SD1|CT_SD2) /* SD */

CT_BLOCK

#define CT_BLOCK   0x08 /* Block addressing */

Typedef Documentation

BYTE

typedef unsigned char BYTE

WORD

typedef unsigned short WORD

DWORD

typedef unsigned long DWORD

UINT

typedef unsigned int UINT

DSTATUS

typedef BYTE DSTATUS

Enumeration Type Documentation

DRESULT

enum DRESULT

Enumerator
RES_OK
RES_ERROR
RES_WRPRT
RES_NOTRDY
RES_PARERR
RES_OK
RES_ERROR
RES_WRPRT
RES_NOTRDY
RES_PARERR

             {
  RES_OK = 0,     /* 0: Successful */
  RES_ERROR,      /* 1: R/W Error */
  RES_WRPRT,      /* 2: Write Protected */
  RES_NOTRDY,     /* 3: Not Ready */
  RES_PARERR      /* 4: Invalid Parameter */
} DRESULT;

Function Documentation

disk_initialize()

DSTATUS disk_initialize

(

BYTE

pdrv

)

Initializes a Drive.

Parameters

pdrv	Physical drive number (0..)

Return values

DSTATUS

Operation status

{
  DSTATUS stat = RES_OK;
 
  if(disk.is_initialized[pdrv] == 0)
  {
    disk.is_initialized[pdrv] = 1;
    stat = disk.drv[pdrv]->disk_initialize(disk.lun[pdrv]);
  }
  return stat;
}

Here is the caller graph for this function:

disk_status()

DSTATUS disk_status

(

BYTE

pdrv

)

Gets Disk Status.

Parameters

pdrv	Physical drive number (0..)

Return values

DSTATUS

Operation status

{
  DSTATUS stat;
 
  stat = disk.drv[pdrv]->disk_status(disk.lun[pdrv]);
  return stat;
}

Here is the caller graph for this function:

disk_read()

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

{
  DRESULT res;
 
  res = disk.drv[pdrv]->disk_read(disk.lun[pdrv], buff, sector, count);
  return res;
}

Here is the caller graph for this function:

disk_write()

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

{
  DRESULT res;
 
  res = disk.drv[pdrv]->disk_write(disk.lun[pdrv], buff, sector, count);
  return res;
}

Here is the caller graph for this function:

disk_ioctl()

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

{
  DRESULT res;
 
  res = disk.drv[pdrv]->disk_ioctl(disk.lun[pdrv], cmd, buff);
  return res;
}

Here is the caller graph for this function: