IONX / EALib

Update version of EALib.

Dependencies:   FATFileSystem

Fork of EALib by IONX

MCIFileSystem.h@23:7d9ca4ac0d1e, 2017-11-16 (annotated)

Committer:
bmcdonnell_ionx
Date:
Thu Nov 16 11:07:30 2017 -0500
Revision:
23:7d9ca4ac0d1e
Parent:
12:15597e45eea0 
Resolve compiler warnings.

(Comparing signed/unsigned, and "comparison between 'enum SDMMC_STATE_T' and 'enum MCIFileSystem::CardState'".)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
embeddedartists 12:15597e45eea0 1 /*
embeddedartists 12:15597e45eea0 2 * Copyright 2013 Embedded Artists AB
embeddedartists 12:15597e45eea0 3 *
embeddedartists 12:15597e45eea0 4 * Licensed under the Apache License, Version 2.0 (the "License");
embeddedartists 12:15597e45eea0 5 * you may not use this file except in compliance with the License.
embeddedartists 12:15597e45eea0 6 * You may obtain a copy of the License at
embeddedartists 12:15597e45eea0 7 *
embeddedartists 12:15597e45eea0 8 * http://www.apache.org/licenses/LICENSE-2.0
embeddedartists 12:15597e45eea0 9 *
embeddedartists 12:15597e45eea0 10 * Unless required by applicable law or agreed to in writing, software
embeddedartists 12:15597e45eea0 11 * distributed under the License is distributed on an "AS IS" BASIS,
embeddedartists 12:15597e45eea0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
embeddedartists 12:15597e45eea0 13 * See the License for the specific language governing permissions and
embeddedartists 12:15597e45eea0 14 * limitations under the License.
embeddedartists 12:15597e45eea0 15 */
embeddedartists 12:15597e45eea0 16
embeddedartists 0:0fdadbc3d852 17 #ifndef MCIFILESYSTEM_H
embeddedartists 0:0fdadbc3d852 18 #define MCIFILESYSTEM_H
embeddedartists 0:0fdadbc3d852 19
embeddedartists 0:0fdadbc3d852 20 #include "mbed.h"
embeddedartists 0:0fdadbc3d852 21 #include "FATFileSystem.h"
embeddedartists 0:0fdadbc3d852 22
embeddedartists 0:0fdadbc3d852 23 /** Access the filesystem on an SD Card using MCI
embeddedartists 0:0fdadbc3d852 24 *
embeddedartists 0:0fdadbc3d852 25 * @code
embeddedartists 0:0fdadbc3d852 26 * #include "mbed.h"
embeddedartists 0:0fdadbc3d852 27 * #include "MCIFileSystem.h"
embeddedartists 0:0fdadbc3d852 28 *
embeddedartists 0:0fdadbc3d852 29 * MCIFileSystem mcifs("mci");
embeddedartists 0:0fdadbc3d852 30 *
embeddedartists 0:0fdadbc3d852 31 * int main() {
embeddedartists 0:0fdadbc3d852 32 * printf("Please insert a SD/MMC card\n");
embeddedartists 0:0fdadbc3d852 33 * while(!mcifs.cardInserted()) {
embeddedartists 0:0fdadbc3d852 34 * wait(0.5);
embeddedartists 0:0fdadbc3d852 35 * }
embeddedartists 0:0fdadbc3d852 36 *
embeddedartists 3:9d31a3c5013e 37 * printf("Found SD/MMC card, writing to /mci/myfile.txt ...\n");
embeddedartists 3:9d31a3c5013e 38 *
embeddedartists 0:0fdadbc3d852 39 * FILE *fp = fopen("/mci/myfile.txt", "w");
embeddedartists 0:0fdadbc3d852 40 * if (fp != NULL) {
embeddedartists 0:0fdadbc3d852 41 * fprintf(fp, "Hello World!\n");
embeddedartists 0:0fdadbc3d852 42 * fclose(fp);
embeddedartists 3:9d31a3c5013e 43 * printf("Wrote to /mci/myfile.txt\n");
embeddedartists 3:9d31a3c5013e 44 * } else {
embeddedartists 3:9d31a3c5013e 45 * printf("Failed to open /mci/myfile.txt\n");
embeddedartists 0:0fdadbc3d852 46 * }
embeddedartists 0:0fdadbc3d852 47 * }
embeddedartists 0:0fdadbc3d852 48 * @endcode
embeddedartists 0:0fdadbc3d852 49 */
embeddedartists 0:0fdadbc3d852 50 class MCIFileSystem : public FATFileSystem {
embeddedartists 0:0fdadbc3d852 51 public:
embeddedartists 0:0fdadbc3d852 52
embeddedartists 0:0fdadbc3d852 53 /** Create the File System for accessing an SD/MMC Card using MCI
embeddedartists 0:0fdadbc3d852 54 *
embeddedartists 0:0fdadbc3d852 55 * @param name The name used to access the virtual filesystem
embeddedartists 0:0fdadbc3d852 56 * @param cd The pin connected to the CardDetect line
embeddedartists 0:0fdadbc3d852 57 */
embeddedartists 0:0fdadbc3d852 58 MCIFileSystem(const char* name, PinName cd = p38);
embeddedartists 0:0fdadbc3d852 59
embeddedartists 0:0fdadbc3d852 60 virtual ~MCIFileSystem();
embeddedartists 0:0fdadbc3d852 61
embeddedartists 0:0fdadbc3d852 62 virtual int disk_initialize();
embeddedartists 0:0fdadbc3d852 63 virtual int disk_status();
embeddedartists 0:0fdadbc3d852 64 virtual int disk_read(uint8_t * buffer, uint64_t block_number);
embeddedartists 0:0fdadbc3d852 65 virtual int disk_write(const uint8_t * buffer, uint64_t block_number);
embeddedartists 0:0fdadbc3d852 66 virtual int disk_sync();
embeddedartists 0:0fdadbc3d852 67 virtual uint64_t disk_sectors();
embeddedartists 0:0fdadbc3d852 68
embeddedartists 0:0fdadbc3d852 69 void mci_MCIIRQHandler();
embeddedartists 0:0fdadbc3d852 70 void mci_DMAIRQHandler();
embeddedartists 0:0fdadbc3d852 71
embeddedartists 0:0fdadbc3d852 72 /** Tests if a SD/MMC card is inserted or not.
embeddedartists 0:0fdadbc3d852 73 *
embeddedartists 0:0fdadbc3d852 74 * @returns
embeddedartists 0:0fdadbc3d852 75 * True if a card has been inserted,
embeddedartists 0:0fdadbc3d852 76 * False if no card is inserted or if the card detect pin is unavailable
embeddedartists 0:0fdadbc3d852 77 */
embeddedartists 0:0fdadbc3d852 78 bool cardInserted() const;
embeddedartists 0:0fdadbc3d852 79
embeddedartists 0:0fdadbc3d852 80 private:
embeddedartists 0:0fdadbc3d852 81
embeddedartists 0:0fdadbc3d852 82 typedef enum {
embeddedartists 0:0fdadbc3d852 83 CardStatusNumBytes = 4,
embeddedartists 0:0fdadbc3d852 84 } Constants;
embeddedartists 0:0fdadbc3d852 85
embeddedartists 0:0fdadbc3d852 86 typedef enum {
embeddedartists 0:0fdadbc3d852 87 PowerOff = 0,
embeddedartists 0:0fdadbc3d852 88 PowerUp = 2,
embeddedartists 0:0fdadbc3d852 89 PowerOn = 3,
embeddedartists 0:0fdadbc3d852 90 } power_ctrl_t;
embeddedartists 0:0fdadbc3d852 91
embeddedartists 0:0fdadbc3d852 92 typedef enum {
embeddedartists 0:0fdadbc3d852 93 SDMMC_IDLE_ST = 0, /*!< Idle state */
embeddedartists 0:0fdadbc3d852 94 SDMMC_READY_ST, /*!< Ready state */
embeddedartists 0:0fdadbc3d852 95 SDMMC_IDENT_ST, /*!< Identification State */
embeddedartists 0:0fdadbc3d852 96 SDMMC_STBY_ST, /*!< standby state */
embeddedartists 0:0fdadbc3d852 97 SDMMC_TRAN_ST, /*!< transfer state */
embeddedartists 0:0fdadbc3d852 98 SDMMC_DATA_ST, /*!< Sending-data State */
embeddedartists 0:0fdadbc3d852 99 SDMMC_RCV_ST, /*!< Receive-data State */
embeddedartists 0:0fdadbc3d852 100 SDMMC_PRG_ST, /*!< Programming State */
embeddedartists 0:0fdadbc3d852 101 SDMMC_DIS_ST /*!< Disconnect State */
embeddedartists 0:0fdadbc3d852 102 } CardState;
embeddedartists 0:0fdadbc3d852 103
embeddedartists 0:0fdadbc3d852 104
embeddedartists 0:0fdadbc3d852 105 typedef struct {
embeddedartists 0:0fdadbc3d852 106 uint8_t CmdIndex;
embeddedartists 0:0fdadbc3d852 107 uint32_t Data[CardStatusNumBytes];
embeddedartists 0:0fdadbc3d852 108 } response_t;
embeddedartists 0:0fdadbc3d852 109
embeddedartists 0:0fdadbc3d852 110 /**
embeddedartists 0:0fdadbc3d852 111 * @brief SDC Clock Control Options
embeddedartists 0:0fdadbc3d852 112 */
embeddedartists 0:0fdadbc3d852 113 typedef enum {
embeddedartists 0:0fdadbc3d852 114 SDC_CLOCK_ENABLE = 8, /*!< Enable SD Card Bus Clock */
embeddedartists 0:0fdadbc3d852 115 SDC_CLOCK_POWER_SAVE = 9, /*!< Disable SD_CLK output when bus is idle */
embeddedartists 0:0fdadbc3d852 116 SDC_CLOCK_DIVIDER_BYPASS = 10, /*!< Enable bypass of clock divide logic */
embeddedartists 0:0fdadbc3d852 117 SDC_CLOCK_WIDEBUS_MODE = 11, /*!< Enable wide bus mode (SD_DAT[3:0] is used instead of SD_DAT[0]) */
embeddedartists 0:0fdadbc3d852 118 } ClockControl;
embeddedartists 0:0fdadbc3d852 119
embeddedartists 0:0fdadbc3d852 120 /**
embeddedartists 0:0fdadbc3d852 121 * @brief SD/MMC Card specific setup data structure
embeddedartists 0:0fdadbc3d852 122 */
embeddedartists 0:0fdadbc3d852 123 typedef struct {
embeddedartists 0:0fdadbc3d852 124 uint32_t response[4]; /*!< Most recent response */
embeddedartists 0:0fdadbc3d852 125 uint32_t cid[4]; /*!< CID of acquired card */
embeddedartists 0:0fdadbc3d852 126 uint32_t csd[4]; /*!< CSD of acquired card */
embeddedartists 0:0fdadbc3d852 127 uint32_t ext_csd[512 / 4]; /*!< Ext CSD */
embeddedartists 0:0fdadbc3d852 128 uint32_t card_type; /*!< Card Type */
embeddedartists 0:0fdadbc3d852 129 uint16_t rca; /*!< Relative address assigned to card */
embeddedartists 0:0fdadbc3d852 130 uint32_t speed; /*!< Speed */
embeddedartists 0:0fdadbc3d852 131 uint32_t block_len; /*!< Card sector size */
embeddedartists 0:0fdadbc3d852 132 uint32_t device_size; /*!< Device Size */
embeddedartists 0:0fdadbc3d852 133 uint32_t blocknr; /*!< Block Number */
embeddedartists 0:0fdadbc3d852 134 uint32_t clk_rate; /*!< Clock rate */
embeddedartists 0:0fdadbc3d852 135 } SDMMC_CARD_T;
embeddedartists 0:0fdadbc3d852 136
embeddedartists 0:0fdadbc3d852 137 typedef enum {
embeddedartists 0:0fdadbc3d852 138 SDC_RET_OK = 0,
embeddedartists 0:0fdadbc3d852 139 SDC_RET_CMD_FAILED = -1,
embeddedartists 0:0fdadbc3d852 140 SDC_RET_BAD_PARAMETERS = -2,
embeddedartists 0:0fdadbc3d852 141 SDC_RET_BUS_NOT_IDLE = -3,
embeddedartists 0:0fdadbc3d852 142 SDC_RET_TIMEOUT = -4,
embeddedartists 0:0fdadbc3d852 143 SDC_RET_ERR_STATE = -5,
embeddedartists 0:0fdadbc3d852 144 SDC_RET_NOT_READY = -6,
embeddedartists 0:0fdadbc3d852 145 SDC_RET_FAILED = -7,
embeddedartists 0:0fdadbc3d852 146 } ReturnCode;
embeddedartists 0:0fdadbc3d852 147
embeddedartists 0:0fdadbc3d852 148 void initMCI();
embeddedartists 0:0fdadbc3d852 149
embeddedartists 0:0fdadbc3d852 150 int32_t mci_Acquire();
embeddedartists 0:0fdadbc3d852 151 uint32_t mci_GetCardStatus() const;
embeddedartists 0:0fdadbc3d852 152 CardState mci_GetCardState() const;
bmcdonnell_ionx 23:7d9ca4ac0d1e 153 ReturnCode mci_ReadBlocks(void *buffer, int32_t startBlock, uint32_t blockNum);
bmcdonnell_ionx 23:7d9ca4ac0d1e 154 ReturnCode mci_WriteBlocks(void *buffer, int32_t startBlock, uint32_t blockNum);
embeddedartists 0:0fdadbc3d852 155 void mci_SetClock(uint32_t freq) const;
embeddedartists 0:0fdadbc3d852 156 void mci_ClockControl(ClockControl ctrlType, bool enable) const;
embeddedartists 0:0fdadbc3d852 157 void mci_PowerControl(power_ctrl_t powerMode, uint32_t flag) const;
embeddedartists 0:0fdadbc3d852 158 ReturnCode mci_ExecuteCmd(uint32_t Command, uint32_t Arg, response_t* pResp) const;
embeddedartists 0:0fdadbc3d852 159 ReturnCode mci_SendIfCond() const;
embeddedartists 0:0fdadbc3d852 160 ReturnCode mci_SendOpCond(uint32_t *pOCR) const;
embeddedartists 0:0fdadbc3d852 161 ReturnCode mci_SendAppOpCond(uint16_t rca, bool hcs, uint32_t *pOcr, bool *pCCS) const;
embeddedartists 0:0fdadbc3d852 162 ReturnCode mci_GetCID(uint32_t *pCID) const;
embeddedartists 0:0fdadbc3d852 163 ReturnCode mci_SetAddr(uint16_t addr) const;
embeddedartists 0:0fdadbc3d852 164 ReturnCode mci_GetAddr(uint16_t *pRCA) const;
embeddedartists 0:0fdadbc3d852 165 ReturnCode mci_GetCSD(uint16_t rca, uint32_t *pCSD) const;
embeddedartists 0:0fdadbc3d852 166 ReturnCode mci_SelectCard(uint16_t addr) const;
embeddedartists 0:0fdadbc3d852 167 ReturnCode mci_GetStatus(uint16_t rca, uint32_t *pStatus) const;
embeddedartists 0:0fdadbc3d852 168 void mci_ProcessCSD();
embeddedartists 0:0fdadbc3d852 169 ReturnCode mci_SetBusWidth(uint16_t rca, uint8_t width) const;
embeddedartists 0:0fdadbc3d852 170 ReturnCode mci_SetTranState(uint16_t rca) const;
embeddedartists 0:0fdadbc3d852 171 ReturnCode mci_SetBlockLength(uint32_t rca, uint32_t block_len) const;
embeddedartists 0:0fdadbc3d852 172 ReturnCode mci_SetCardParams() const;
embeddedartists 0:0fdadbc3d852 173 ReturnCode mci_StopTransmission(uint32_t rca) const;
embeddedartists 0:0fdadbc3d852 174 bool mci_CheckR1Response(uint32_t resp, ReturnCode* pCheckResult) const;
embeddedartists 0:0fdadbc3d852 175 void mci_WriteDelay() const;
embeddedartists 0:0fdadbc3d852 176 ReturnCode mci_SendCmd(uint32_t Command, uint32_t Arg, uint32_t timeout) const;
embeddedartists 0:0fdadbc3d852 177 ReturnCode mci_SendAppCmd(uint16_t rca) const;
embeddedartists 0:0fdadbc3d852 178 void mci_SetDataTransfer(uint16_t BlockNum, bool DirFromCard, uint32_t Timeout) const;
embeddedartists 0:0fdadbc3d852 179 void mci_GetResp(response_t* pResp) const;
bmcdonnell_ionx 23:7d9ca4ac0d1e 180 uint32_t mci_GetBits(uint32_t start, uint32_t end, uint32_t *data) const;
embeddedartists 0:0fdadbc3d852 181 void mci_SetCommand(uint32_t Cmd, uint32_t Arg) const;
embeddedartists 0:0fdadbc3d852 182 void mci_ResetCommand() const;
embeddedartists 0:0fdadbc3d852 183 int32_t mci_IRQHandler(uint8_t *txBuf, uint32_t *txCnt, uint8_t *rxBuf, uint32_t *rxCnt);
embeddedartists 0:0fdadbc3d852 184 int32_t mci_FIFOIRQHandler(uint8_t *txBuf, uint32_t *txCnt, uint8_t *rxBuf, uint32_t *rxCnt);
embeddedartists 0:0fdadbc3d852 185 void mci_ReadFIFO(uint32_t *pDst, bool bFirstHalf) const;
embeddedartists 0:0fdadbc3d852 186 void mci_WriteFIFO(uint32_t *pSrc, bool bFirstHalf) const;
embeddedartists 0:0fdadbc3d852 187
embeddedartists 0:0fdadbc3d852 188 void mci_SetupEventWakeup(uint8_t dmaChannel);
embeddedartists 0:0fdadbc3d852 189 uint32_t mci_WaitForEvent() const;
embeddedartists 0:0fdadbc3d852 190
embeddedartists 0:0fdadbc3d852 191 ReturnCode _readBlocks(uint32_t card_type, uint32_t startBlock, uint32_t blockNum) const;
embeddedartists 0:0fdadbc3d852 192 ReturnCode _writeBlocks(uint32_t card_type, uint32_t startBlock, uint32_t blockNum) const;
embeddedartists 0:0fdadbc3d852 193
embeddedartists 0:0fdadbc3d852 194
embeddedartists 0:0fdadbc3d852 195 uint32_t _Stat;
embeddedartists 0:0fdadbc3d852 196 SDMMC_CARD_T _sdCardInfo;
embeddedartists 0:0fdadbc3d852 197
embeddedartists 0:0fdadbc3d852 198 DigitalIn* _cardDetect;
embeddedartists 0:0fdadbc3d852 199
embeddedartists 0:0fdadbc3d852 200 uint8_t _eventDmaChannel; /*!< DMA Channel used for transfer data */
embeddedartists 0:0fdadbc3d852 201 volatile bool _eventReceived;
embeddedartists 0:0fdadbc3d852 202 volatile bool _eventSuccess;
embeddedartists 0:0fdadbc3d852 203 };
embeddedartists 0:0fdadbc3d852 204
embeddedartists 0:0fdadbc3d852 205 #endif
embeddedartists 0:0fdadbc3d852 206