diskio.h

Go to the documentation of this file.

/*-----------------------------------------------------------------------/
/  Low level disk interface modlue include file   (C)ChaN, 2014          /
/-----------------------------------------------------------------------*/

#ifndef _DISKIO_DEFINED
#define _DISKIO_DEFINED

#ifdef __cplusplus
extern "C" {
#endif

#define _USE_WRITE      1       /* 1: Enable disk_write function */
#define _USE_IOCTL      1       /* 1: Enable disk_ioctl fucntion */

#include "integer.h"


/* Status of Disk Functions */
typedef BYTE    DSTATUS;

/* Results of Disk Functions */
typedef enum {
        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;


/*---------------------------------------*/
/* Prototypes for disk control functions */


DSTATUS disk_initialize (BYTE pdrv);
DSTATUS disk_status (BYTE pdrv);
DRESULT disk_read (BYTE pdrv, BYTE* buff, DWORD sector, UINT count);
DRESULT disk_write (BYTE pdrv, const BYTE* buff, DWORD sector, UINT count);
DRESULT disk_ioctl (BYTE pdrv, BYTE cmd, void* buff);


/* Disk Status Bits (DSTATUS) */

#define STA_NOINIT              0x01    /* Drive not initialized */
#define STA_NODISK              0x02    /* No medium in the drive */
#define STA_PROTECT             0x04    /* Write protected */


/* Command code for disk_ioctrl fucntion */

/* Generic command (Used by FatFs) */
#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) */

/* Generic command (Not used by FatFs) */
#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 */

/* MMC/SDC specific ioctl command */
#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 */

/* ATA/CF specific ioctl command */
#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 */


/*
 * Updates made by Texas Instruments
 *
 * The following additions are needed in order to control the total number of
 * volumes supported and to allow the disk_* APIs to call media specific disk
 * functions which are registered in a table of type 'diskio_fxns'
 */

/* Disk I/O function table object, used to map media specific implementations */
typedef struct {
    DSTATUS (*d_init)   (BYTE drive);
    DSTATUS (*d_status) (BYTE drive);
    DRESULT (*d_read)   (BYTE drive, BYTE *buf, DWORD sector, UINT num);
    DRESULT (*d_write)  (BYTE drive, const BYTE *buf, DWORD sector, UINT num);
    DRESULT (*d_ioctl)  (BYTE drive, BYTE cmd, void * buf);
} diskio_fxns;

DRESULT disk_register(
    BYTE drive,
    DSTATUS (*d_init)   (BYTE drive),
    DSTATUS (*d_status) (BYTE drive),
    DRESULT (*d_read)   (BYTE drive, BYTE *buf, DWORD sector, UINT num),
    DRESULT (*d_write)  (BYTE drive, const BYTE *buf, DWORD sector, UINT num),
    DRESULT (*d_ioctl)  (BYTE drive, BYTE cmd, void * buf)
);

DRESULT disk_unregister(BYTE drive);

#ifdef __cplusplus
}
#endif

#endif