diskio.h

00001 /*-----------------------------------------------------------------------/
00002 /  Low level disk interface modlue include file   (C)ChaN, 2014          /
00003 /-----------------------------------------------------------------------*/
00004 
00005 #ifndef _DISKIO_DEFINED
00006 #define _DISKIO_DEFINED
00007 
00008 #ifdef __cplusplus
00009 extern "C" {
00010 #endif
00011 
00012 #define _USE_WRITE  1   /* 1: Enable disk_write function */
00013 #define _USE_IOCTL  1   /* 1: Enable disk_ioctl fucntion */
00014 
00015 #include "integer.h"
00016 
00017 
00018 /* Status of Disk Functions */
00019 typedef BYTE    DSTATUS;
00020 
00021 /* Results of Disk Functions */
00022 typedef enum {
00023     RES_OK = 0,     /* 0: Successful */
00024     RES_ERROR,      /* 1: R/W Error */
00025     RES_WRPRT,      /* 2: Write Protected */
00026     RES_NOTRDY,     /* 3: Not Ready */
00027     RES_PARERR      /* 4: Invalid Parameter */
00028 } DRESULT;
00029 
00030 
00031 /*---------------------------------------*/
00032 /* Prototypes for disk control functions */
00033 
00034 
00035 DSTATUS disk_initialize (BYTE pdrv);
00036 DSTATUS disk_status (BYTE pdrv);
00037 DRESULT disk_read (BYTE pdrv, BYTE* buff, DWORD sector, UINT count);
00038 DRESULT disk_write (BYTE pdrv, const BYTE* buff, DWORD sector, UINT count);
00039 DRESULT disk_ioctl (BYTE pdrv, BYTE cmd, void* buff);
00040 
00041 
00042 /* Disk Status Bits (DSTATUS) */
00043 
00044 #define STA_NOINIT      0x01    /* Drive not initialized */
00045 #define STA_NODISK      0x02    /* No medium in the drive */
00046 #define STA_PROTECT     0x04    /* Write protected */
00047 
00048 
00049 /* Command code for disk_ioctrl fucntion */
00050 
00051 /* Generic command (Used by FatFs) */
00052 #define CTRL_SYNC           0   /* Complete pending write process (needed at _FS_READONLY == 0) */
00053 #define GET_SECTOR_COUNT    1   /* Get media size (needed at _USE_MKFS == 1) */
00054 #define GET_SECTOR_SIZE     2   /* Get sector size (needed at _MAX_SS != _MIN_SS) */
00055 #define GET_BLOCK_SIZE      3   /* Get erase block size (needed at _USE_MKFS == 1) */
00056 #define CTRL_TRIM           4   /* Inform device that the data on the block of sectors is no longer used (needed at _USE_TRIM == 1) */
00057 
00058 /* Generic command (Not used by FatFs) */
00059 #define CTRL_POWER          5   /* Get/Set power status */
00060 #define CTRL_LOCK           6   /* Lock/Unlock media removal */
00061 #define CTRL_EJECT          7   /* Eject media */
00062 #define CTRL_FORMAT         8   /* Create physical format on the media */
00063 
00064 /* MMC/SDC specific ioctl command */
00065 #define MMC_GET_TYPE        10  /* Get card type */
00066 #define MMC_GET_CSD         11  /* Get CSD */
00067 #define MMC_GET_CID         12  /* Get CID */
00068 #define MMC_GET_OCR         13  /* Get OCR */
00069 #define MMC_GET_SDSTAT      14  /* Get SD status */
00070 
00071 /* ATA/CF specific ioctl command */
00072 #define ATA_GET_REV         20  /* Get F/W revision */
00073 #define ATA_GET_MODEL       21  /* Get model name */
00074 #define ATA_GET_SN          22  /* Get serial number */
00075 
00076 #ifdef __cplusplus
00077 }
00078 #endif
00079 
00080 #endif