Neil Thiessen / SDFileSystem

A re-written SDFileSystem library with improved compatibility, CRC support, and card removal/replacement support.

Dependencies:   FATFileSystem

Dependents:   xadow_m0_SD_Hello roam_v1 roam_v2 Polytech_tours ... more

SDFileSystem.h@18:2286a4e7fa31, 2015-08-27 (annotated)

Committer:
neilt6
Date:
Thu Aug 27 21:50:40 2015 +0000
Revision:
18:2286a4e7fa31
Parent:
17:a47f74caa04e
Child:
20:2c1e8d442f68
Updated FATFileSystem and implemented minor improvements

Who changed what in which revision?

UserRevisionLine numberNew contents of line
neilt6 0:2a6d8a096edc 1 /* SD/MMC File System Library
neilt6 18:2286a4e7fa31 2 * Copyright (c) 2015 Neil Thiessen
neilt6 0:2a6d8a096edc 3 *
neilt6 0:2a6d8a096edc 4 * Licensed under the Apache License, Version 2.0 (the "License");
neilt6 0:2a6d8a096edc 5 * you may not use this file except in compliance with the License.
neilt6 0:2a6d8a096edc 6 * You may obtain a copy of the License at
neilt6 0:2a6d8a096edc 7 *
neilt6 0:2a6d8a096edc 8 * http://www.apache.org/licenses/LICENSE-2.0
neilt6 0:2a6d8a096edc 9 *
neilt6 0:2a6d8a096edc 10 * Unless required by applicable law or agreed to in writing, software
neilt6 0:2a6d8a096edc 11 * distributed under the License is distributed on an "AS IS" BASIS,
neilt6 0:2a6d8a096edc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
neilt6 0:2a6d8a096edc 13 * See the License for the specific language governing permissions and
neilt6 0:2a6d8a096edc 14 * limitations under the License.
neilt6 0:2a6d8a096edc 15 */
neilt6 0:2a6d8a096edc 16
neilt6 0:2a6d8a096edc 17 #ifndef SD_FILE_SYSTEM_H
neilt6 0:2a6d8a096edc 18 #define SD_FILE_SYSTEM_H
neilt6 0:2a6d8a096edc 19
neilt6 0:2a6d8a096edc 20 #include "mbed.h"
neilt6 0:2a6d8a096edc 21 #include "FATFileSystem.h"
neilt6 0:2a6d8a096edc 22
neilt6 0:2a6d8a096edc 23 /** SDFileSystem class.
neilt6 0:2a6d8a096edc 24 * Used for creating a virtual file system for accessing SD/MMC cards via SPI.
neilt6 0:2a6d8a096edc 25 *
neilt6 0:2a6d8a096edc 26 * Example:
neilt6 0:2a6d8a096edc 27 * @code
neilt6 0:2a6d8a096edc 28 * #include "mbed.h"
neilt6 0:2a6d8a096edc 29 * #include "SDFileSystem.h"
neilt6 0:2a6d8a096edc 30 *
neilt6 0:2a6d8a096edc 31 * //Create an SDFileSystem object
neilt6 16:c2c1f0b16380 32 * SDFileSystem sd(p5, p6, p7, p20, "sd");
neilt6 0:2a6d8a096edc 33 *
neilt6 0:2a6d8a096edc 34 * int main()
neilt6 0:2a6d8a096edc 35 * {
neilt6 16:c2c1f0b16380 36 * //Mount the filesystem
neilt6 16:c2c1f0b16380 37 * sd.mount();
neilt6 16:c2c1f0b16380 38 *
neilt6 0:2a6d8a096edc 39 * //Perform a write test
neilt6 0:2a6d8a096edc 40 * printf("\nWriting to SD card...");
neilt6 0:2a6d8a096edc 41 * FILE *fp = fopen("/sd/sdtest.txt", "w");
neilt6 0:2a6d8a096edc 42 * if (fp != NULL) {
neilt6 0:2a6d8a096edc 43 * fprintf(fp, "We're writing to an SD card!");
neilt6 0:2a6d8a096edc 44 * fclose(fp);
neilt6 0:2a6d8a096edc 45 * printf("success!\n");
neilt6 0:2a6d8a096edc 46 * } else {
neilt6 0:2a6d8a096edc 47 * printf("failed!\n");
neilt6 0:2a6d8a096edc 48 * }
neilt6 0:2a6d8a096edc 49 *
neilt6 0:2a6d8a096edc 50 * //Perform a read test
neilt6 0:2a6d8a096edc 51 * printf("Reading from SD card...");
neilt6 0:2a6d8a096edc 52 * fp = fopen("/sd/sdtest.txt", "r");
neilt6 0:2a6d8a096edc 53 * if (fp != NULL) {
neilt6 0:2a6d8a096edc 54 * char c = fgetc(fp);
neilt6 0:2a6d8a096edc 55 * if (c == 'W')
neilt6 0:2a6d8a096edc 56 * printf("success!\n");
neilt6 0:2a6d8a096edc 57 * else
neilt6 0:2a6d8a096edc 58 * printf("incorrect char (%c)!\n", c);
neilt6 0:2a6d8a096edc 59 * fclose(fp);
neilt6 0:2a6d8a096edc 60 * } else {
neilt6 0:2a6d8a096edc 61 * printf("failed!\n");
neilt6 0:2a6d8a096edc 62 * }
neilt6 16:c2c1f0b16380 63 *
neilt6 16:c2c1f0b16380 64 * //Unmount the filesystem
neilt6 16:c2c1f0b16380 65 * sd.unmount();
neilt6 0:2a6d8a096edc 66 * }
neilt6 0:2a6d8a096edc 67 * @endcode
neilt6 0:2a6d8a096edc 68 */
neilt6 0:2a6d8a096edc 69 class SDFileSystem : public FATFileSystem
neilt6 0:2a6d8a096edc 70 {
neilt6 0:2a6d8a096edc 71 public:
neilt6 1:25f4ba436b81 72 /** Represents the different card detect switch types
neilt6 1:25f4ba436b81 73 */
neilt6 1:25f4ba436b81 74 enum SwitchType {
neilt6 16:c2c1f0b16380 75 SWITCH_NONE, /**< No card detect switch (assumes socket is always occupied) */
neilt6 12:eebddab6eff2 76 SWITCH_POS_NO, /**< Switch shorts to VDD when the socket is occupied (positive logic, normally open) */
neilt6 12:eebddab6eff2 77 SWITCH_POS_NC, /**< Switch shorts to VDD when the socket is empty (positive logic, normally closed) */
neilt6 12:eebddab6eff2 78 SWITCH_NEG_NO, /**< Switch shorts to GND when the socket is occupied (negative logic, normally open) */
neilt6 12:eebddab6eff2 79 SWITCH_NEG_NC /**< Switch shorts to GND when the socket is empty (negative logic, normally closed) */
neilt6 1:25f4ba436b81 80 };
neilt6 1:25f4ba436b81 81
neilt6 0:2a6d8a096edc 82 /** Represents the different SD/MMC card types
neilt6 0:2a6d8a096edc 83 */
neilt6 0:2a6d8a096edc 84 enum CardType {
neilt6 0:2a6d8a096edc 85 CARD_NONE, /**< No card is present */
neilt6 0:2a6d8a096edc 86 CARD_MMC, /**< MMC card */
neilt6 0:2a6d8a096edc 87 CARD_SD, /**< Standard capacity SD card */
neilt6 0:2a6d8a096edc 88 CARD_SDHC, /**< High capacity SD card */
neilt6 0:2a6d8a096edc 89 CARD_UNKNOWN /**< Unknown or unsupported card */
neilt6 0:2a6d8a096edc 90 };
neilt6 0:2a6d8a096edc 91
neilt6 0:2a6d8a096edc 92 /** Create a virtual file system for accessing SD/MMC cards via SPI
neilt6 0:2a6d8a096edc 93 *
neilt6 0:2a6d8a096edc 94 * @param mosi The SPI data out pin.
neilt6 0:2a6d8a096edc 95 * @param miso The SPI data in pin.
neilt6 0:2a6d8a096edc 96 * @param sclk The SPI clock pin.
neilt6 0:2a6d8a096edc 97 * @param cs The SPI chip select pin.
neilt6 3:7cf3d1835ef5 98 * @param name The name used to access the virtual filesystem.
neilt6 1:25f4ba436b81 99 * @param cd The card detect pin.
neilt6 12:eebddab6eff2 100 * @param cdtype The type of card detect switch.
neilt6 0:2a6d8a096edc 101 * @param hz The SPI bus frequency (defaults to 1MHz).
neilt6 0:2a6d8a096edc 102 */
neilt6 16:c2c1f0b16380 103 SDFileSystem(PinName mosi, PinName miso, PinName sclk, PinName cs, const char* name, PinName cd = NC, SwitchType cdtype = SWITCH_NONE, int hz = 1000000);
neilt6 0:2a6d8a096edc 104
neilt6 0:2a6d8a096edc 105 /** Get the detected SD/MMC card type
neilt6 0:2a6d8a096edc 106 *
neilt6 0:2a6d8a096edc 107 * @returns The detected card type as a CardType enum.
neilt6 0:2a6d8a096edc 108 */
neilt6 0:2a6d8a096edc 109 SDFileSystem::CardType card_type();
neilt6 0:2a6d8a096edc 110
neilt6 6:55a26a56046a 111 /** Get whether or not CRC is enabled for commands and data
neilt6 6:55a26a56046a 112 *
neilt6 6:55a26a56046a 113 * @returns
neilt6 6:55a26a56046a 114 * 'true' if CRC is enabled for commands and data,
neilt6 6:55a26a56046a 115 * 'false' if CRC is disabled for commands and data.
neilt6 6:55a26a56046a 116 */
neilt6 7:61db99e52c0d 117 bool crc();
neilt6 6:55a26a56046a 118
neilt6 6:55a26a56046a 119 /** Set whether or not CRC is enabled for commands and data
neilt6 6:55a26a56046a 120 *
neilt6 6:55a26a56046a 121 * @param enabled Whether or not to enable CRC for commands and data.
neilt6 6:55a26a56046a 122 */
neilt6 7:61db99e52c0d 123 void crc(bool enabled);
neilt6 6:55a26a56046a 124
neilt6 6:55a26a56046a 125 /** Get whether or not 16-bit frames are enabled for data read/write operations
neilt6 6:55a26a56046a 126 *
neilt6 6:55a26a56046a 127 * @returns
neilt6 6:55a26a56046a 128 * 'true' if 16-bit frames will be used during data read/write operations,
neilt6 6:55a26a56046a 129 * 'false' if 8-bit frames will be used during data read/write operations.
neilt6 6:55a26a56046a 130 */
neilt6 6:55a26a56046a 131 bool large_frames();
neilt6 6:55a26a56046a 132
neilt6 6:55a26a56046a 133 /** Set whether or not 16-bit frames are enabled for data read/write operations
neilt6 6:55a26a56046a 134 *
neilt6 6:55a26a56046a 135 * @param enabled Whether or not 16-bit frames are enabled for data read/write operations.
neilt6 6:55a26a56046a 136 */
neilt6 6:55a26a56046a 137 void large_frames(bool enabled);
neilt6 6:55a26a56046a 138
neilt6 13:635147efa748 139 /** Get whether or not write validation is enabled for data write operations
neilt6 13:635147efa748 140 *
neilt6 13:635147efa748 141 * @returns
neilt6 13:635147efa748 142 * 'true' if data writes will be verified using CMD13,
neilt6 13:635147efa748 143 * 'false' if data writes will not be verified.
neilt6 13:635147efa748 144 */
neilt6 13:635147efa748 145 bool write_validation();
neilt6 13:635147efa748 146
neilt6 13:635147efa748 147 /** Set whether or not write validation is enabled for data write operations
neilt6 13:635147efa748 148 *
neilt6 13:635147efa748 149 * @param enabled Whether or not write validation is enabled for data write operations.
neilt6 13:635147efa748 150 */
neilt6 13:635147efa748 151 void write_validation(bool enabled);
neilt6 13:635147efa748 152
neilt6 11:67ddc53e3983 153 virtual int unmount();
neilt6 0:2a6d8a096edc 154 virtual int disk_initialize();
neilt6 0:2a6d8a096edc 155 virtual int disk_status();
neilt6 11:67ddc53e3983 156 virtual int disk_read(uint8_t* buffer, uint64_t sector, uint8_t count);
neilt6 11:67ddc53e3983 157 virtual int disk_write(const uint8_t* buffer, uint64_t sector, uint8_t count);
neilt6 0:2a6d8a096edc 158 virtual int disk_sync();
neilt6 0:2a6d8a096edc 159 virtual uint64_t disk_sectors();
neilt6 0:2a6d8a096edc 160
neilt6 0:2a6d8a096edc 161 private:
neilt6 0:2a6d8a096edc 162 //Commands
neilt6 0:2a6d8a096edc 163 enum Command {
neilt6 4:49b29888eca7 164 CMD0 = (0x40 | 0), /**< GO_IDLE_STATE */
neilt6 4:49b29888eca7 165 CMD1 = (0x40 | 1), /**< SEND_OP_COND */
neilt6 4:49b29888eca7 166 CMD8 = (0x40 | 8), /**< SEND_IF_COND */
neilt6 4:49b29888eca7 167 CMD9 = (0x40 | 9), /**< SEND_CSD */
neilt6 11:67ddc53e3983 168 CMD12 = (0x40 | 12), /**< STOP_TRANSMISSION */
neilt6 11:67ddc53e3983 169 CMD13 = (0x40 | 13), /**< SEND_STATUS */
neilt6 4:49b29888eca7 170 CMD16 = (0x40 | 16), /**< SET_BLOCKLEN */
neilt6 4:49b29888eca7 171 CMD17 = (0x40 | 17), /**< READ_SINGLE_BLOCK */
neilt6 11:67ddc53e3983 172 CMD18 = (0x40 | 18), /**< READ_MULTIPLE_BLOCK */
neilt6 11:67ddc53e3983 173 ACMD22 = (0x40 | 22), /**< SEND_NUM_WR_BLOCKS */
neilt6 11:67ddc53e3983 174 ACMD23 = (0x40 | 23), /**< SET_WR_BLK_ERASE_COUNT */
neilt6 4:49b29888eca7 175 CMD24 = (0x40 | 24), /**< WRITE_BLOCK */
neilt6 11:67ddc53e3983 176 CMD25 = (0x40 | 25), /**< WRITE_MULTIPLE_BLOCK */
neilt6 5:6befff2300d0 177 ACMD41 = (0x40 | 41), /**< SD_SEND_OP_COND */
neilt6 5:6befff2300d0 178 ACMD42 = (0x40 | 42), /**< SET_CLR_CARD_DETECT */
neilt6 4:49b29888eca7 179 CMD55 = (0x40 | 55), /**< APP_CMD */
neilt6 4:49b29888eca7 180 CMD58 = (0x40 | 58), /**< READ_OCR */
neilt6 4:49b29888eca7 181 CMD59 = (0x40 | 59) /**< CRC_ON_OFF */
neilt6 0:2a6d8a096edc 182 };
neilt6 0:2a6d8a096edc 183
neilt6 0:2a6d8a096edc 184 //Member variables
neilt6 13:635147efa748 185 Timer m_Timer;
neilt6 7:61db99e52c0d 186 SPI m_Spi;
neilt6 7:61db99e52c0d 187 DigitalOut m_Cs;
neilt6 7:61db99e52c0d 188 InterruptIn m_Cd;
neilt6 12:eebddab6eff2 189 int m_CdAssert;
neilt6 6:55a26a56046a 190 const int m_FREQ;
neilt6 6:55a26a56046a 191 SDFileSystem::CardType m_CardType;
neilt6 7:61db99e52c0d 192 bool m_Crc;
neilt6 6:55a26a56046a 193 bool m_LargeFrames;
neilt6 13:635147efa748 194 bool m_WriteValidation;
neilt6 0:2a6d8a096edc 195 int m_Status;
neilt6 0:2a6d8a096edc 196
neilt6 0:2a6d8a096edc 197 //Internal methods
neilt6 13:635147efa748 198 void onCardRemoval();
neilt6 0:2a6d8a096edc 199 void checkSocket();
neilt6 0:2a6d8a096edc 200 bool waitReady(int timeout);
neilt6 0:2a6d8a096edc 201 bool select();
neilt6 0:2a6d8a096edc 202 void deselect();
neilt6 11:67ddc53e3983 203 char commandTransaction(char cmd, unsigned int arg, unsigned int* resp = NULL);
neilt6 13:635147efa748 204 char writeCommand(char cmd, unsigned int arg, unsigned int* resp = NULL);
neilt6 0:2a6d8a096edc 205 bool readData(char* buffer, int length);
neilt6 11:67ddc53e3983 206 char writeData(const char* buffer, char token);
neilt6 17:a47f74caa04e 207 bool readBlock(char* buffer, unsigned int lba);
neilt6 17:a47f74caa04e 208 bool readBlocks(char* buffer, unsigned int lba, unsigned int count);
neilt6 17:a47f74caa04e 209 bool writeBlock(const char* buffer, unsigned int lba);
neilt6 17:a47f74caa04e 210 bool writeBlocks(const char* buffer, unsigned int lba, unsigned int count);
neilt6 0:2a6d8a096edc 211 };
neilt6 0:2a6d8a096edc 212
neilt6 0:2a6d8a096edc 213 #endif