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@16:c2c1f0b16380, 2015-01-05 (annotated)

Committer:
neilt6
Date:
Mon Jan 05 18:43:29 2015 +0000
Revision:
16:c2c1f0b16380
Parent:
13:635147efa748
Child:
17:a47f74caa04e
Added support for no card detect switch

Who changed what in which revision?

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