Cameron Rutherford / SDFileSystem

This is a previous version

Dependencies:   FATFileSystem

Fork of SDFileSystem by Neil Thiessen

SDFileSystem.h@13:635147efa748, 2014-08-18 (annotated)

Committer:
neilt6
Date:
Mon Aug 18 15:09:52 2014 +0000
Revision:
13:635147efa748
Parent:
12:eebddab6eff2
Child:
16:c2c1f0b16380
Significant performance improvements with better busy wait logic

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