Denwis La / sd-driver-master

sd-driver 1.2.0 from github

Dependents:   Saver2

SDBlockDevice.h@0:f72b3e7f1ec8, 2018-04-12 (annotated)

Committer:
SDesign2018
Date:
Thu Apr 12 01:36:31 2018 +0000
Revision:
0:f72b3e7f1ec8
Same stuff;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
SDesign2018 0:f72b3e7f1ec8 1 /* mbed Microcontroller Library
SDesign2018 0:f72b3e7f1ec8 2 * Copyright (c) 2006-2012 ARM Limited
SDesign2018 0:f72b3e7f1ec8 3 *
SDesign2018 0:f72b3e7f1ec8 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
SDesign2018 0:f72b3e7f1ec8 5 * of this software and associated documentation files (the "Software"), to deal
SDesign2018 0:f72b3e7f1ec8 6 * in the Software without restriction, including without limitation the rights
SDesign2018 0:f72b3e7f1ec8 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
SDesign2018 0:f72b3e7f1ec8 8 * copies of the Software, and to permit persons to whom the Software is
SDesign2018 0:f72b3e7f1ec8 9 * furnished to do so, subject to the following conditions:
SDesign2018 0:f72b3e7f1ec8 10 *
SDesign2018 0:f72b3e7f1ec8 11 * The above copyright notice and this permission notice shall be included in
SDesign2018 0:f72b3e7f1ec8 12 * all copies or substantial portions of the Software.
SDesign2018 0:f72b3e7f1ec8 13 *
SDesign2018 0:f72b3e7f1ec8 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
SDesign2018 0:f72b3e7f1ec8 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
SDesign2018 0:f72b3e7f1ec8 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
SDesign2018 0:f72b3e7f1ec8 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
SDesign2018 0:f72b3e7f1ec8 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
SDesign2018 0:f72b3e7f1ec8 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SDesign2018 0:f72b3e7f1ec8 20 * SOFTWARE.
SDesign2018 0:f72b3e7f1ec8 21 */
SDesign2018 0:f72b3e7f1ec8 22 #ifndef MBED_SD_BLOCK_DEVICE_H
SDesign2018 0:f72b3e7f1ec8 23 #define MBED_SD_BLOCK_DEVICE_H
SDesign2018 0:f72b3e7f1ec8 24
SDesign2018 0:f72b3e7f1ec8 25 /* If the target has no SPI support then SDCard is not supported */
SDesign2018 0:f72b3e7f1ec8 26 #ifdef DEVICE_SPI
SDesign2018 0:f72b3e7f1ec8 27
SDesign2018 0:f72b3e7f1ec8 28 #include "BlockDevice.h"
SDesign2018 0:f72b3e7f1ec8 29 #include "mbed.h"
SDesign2018 0:f72b3e7f1ec8 30
SDesign2018 0:f72b3e7f1ec8 31
SDesign2018 0:f72b3e7f1ec8 32 /** Access an SD Card using SPI
SDesign2018 0:f72b3e7f1ec8 33 *
SDesign2018 0:f72b3e7f1ec8 34 * @code
SDesign2018 0:f72b3e7f1ec8 35 * #include "mbed.h"
SDesign2018 0:f72b3e7f1ec8 36 * #include "SDBlockDevice.h"
SDesign2018 0:f72b3e7f1ec8 37 *
SDesign2018 0:f72b3e7f1ec8 38 * SDBlockDevice sd(p5, p6, p7, p12); // mosi, miso, sclk, cs
SDesign2018 0:f72b3e7f1ec8 39 * uint8_t block[512] = "Hello World!\n";
SDesign2018 0:f72b3e7f1ec8 40 *
SDesign2018 0:f72b3e7f1ec8 41 * int main() {
SDesign2018 0:f72b3e7f1ec8 42 * sd.init();
SDesign2018 0:f72b3e7f1ec8 43 * sd.write(block, 0, 512);
SDesign2018 0:f72b3e7f1ec8 44 * sd.read(block, 0, 512);
SDesign2018 0:f72b3e7f1ec8 45 * printf("%s", block);
SDesign2018 0:f72b3e7f1ec8 46 * sd.deinit();
SDesign2018 0:f72b3e7f1ec8 47 * }
SDesign2018 0:f72b3e7f1ec8 48 */
SDesign2018 0:f72b3e7f1ec8 49 class SDBlockDevice : public BlockDevice {
SDesign2018 0:f72b3e7f1ec8 50 public:
SDesign2018 0:f72b3e7f1ec8 51 /** Lifetime of an SD card
SDesign2018 0:f72b3e7f1ec8 52 */
SDesign2018 0:f72b3e7f1ec8 53 SDBlockDevice(PinName mosi, PinName miso, PinName sclk, PinName cs, uint64_t hz=1000000);
SDesign2018 0:f72b3e7f1ec8 54 virtual ~SDBlockDevice();
SDesign2018 0:f72b3e7f1ec8 55
SDesign2018 0:f72b3e7f1ec8 56 /** Initialize a block device
SDesign2018 0:f72b3e7f1ec8 57 *
SDesign2018 0:f72b3e7f1ec8 58 * @return 0 on success or a negative error code on failure
SDesign2018 0:f72b3e7f1ec8 59 */
SDesign2018 0:f72b3e7f1ec8 60 virtual int init();
SDesign2018 0:f72b3e7f1ec8 61
SDesign2018 0:f72b3e7f1ec8 62 /** Deinitialize a block device
SDesign2018 0:f72b3e7f1ec8 63 *
SDesign2018 0:f72b3e7f1ec8 64 * @return 0 on success or a negative error code on failure
SDesign2018 0:f72b3e7f1ec8 65 */
SDesign2018 0:f72b3e7f1ec8 66 virtual int deinit();
SDesign2018 0:f72b3e7f1ec8 67
SDesign2018 0:f72b3e7f1ec8 68 /** Read blocks from a block device
SDesign2018 0:f72b3e7f1ec8 69 *
SDesign2018 0:f72b3e7f1ec8 70 * @param buffer Buffer to write blocks to
SDesign2018 0:f72b3e7f1ec8 71 * @param addr Address of block to begin reading from
SDesign2018 0:f72b3e7f1ec8 72 * @param size Size to read in bytes, must be a multiple of read block size
SDesign2018 0:f72b3e7f1ec8 73 * @return 0 on success, negative error code on failure
SDesign2018 0:f72b3e7f1ec8 74 */
SDesign2018 0:f72b3e7f1ec8 75 virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
SDesign2018 0:f72b3e7f1ec8 76
SDesign2018 0:f72b3e7f1ec8 77 /** Program blocks to a block device
SDesign2018 0:f72b3e7f1ec8 78 *
SDesign2018 0:f72b3e7f1ec8 79 * The blocks must have been erased prior to being programmed
SDesign2018 0:f72b3e7f1ec8 80 *
SDesign2018 0:f72b3e7f1ec8 81 * @param buffer Buffer of data to write to blocks
SDesign2018 0:f72b3e7f1ec8 82 * @param addr Address of block to begin writing to
SDesign2018 0:f72b3e7f1ec8 83 * @param size Size to write in bytes, must be a multiple of program block size
SDesign2018 0:f72b3e7f1ec8 84 * @return 0 on success, negative error code on failure
SDesign2018 0:f72b3e7f1ec8 85 */
SDesign2018 0:f72b3e7f1ec8 86 virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
SDesign2018 0:f72b3e7f1ec8 87
SDesign2018 0:f72b3e7f1ec8 88 /** Mark blocks as no longer in use
SDesign2018 0:f72b3e7f1ec8 89 *
SDesign2018 0:f72b3e7f1ec8 90 * This function provides a hint to the underlying block device that a region of blocks
SDesign2018 0:f72b3e7f1ec8 91 * is no longer in use and may be erased without side effects. Erase must still be called
SDesign2018 0:f72b3e7f1ec8 92 * before programming, but trimming allows flash-translation-layers to schedule erases when
SDesign2018 0:f72b3e7f1ec8 93 * the device is not busy.
SDesign2018 0:f72b3e7f1ec8 94 *
SDesign2018 0:f72b3e7f1ec8 95 * @param addr Address of block to mark as unused
SDesign2018 0:f72b3e7f1ec8 96 * @param size Size to mark as unused in bytes, must be a multiple of erase block size
SDesign2018 0:f72b3e7f1ec8 97 * @return 0 on success, negative error code on failure
SDesign2018 0:f72b3e7f1ec8 98 */
SDesign2018 0:f72b3e7f1ec8 99 virtual int trim(bd_addr_t addr, bd_size_t size);
SDesign2018 0:f72b3e7f1ec8 100
SDesign2018 0:f72b3e7f1ec8 101 /** Get the size of a readable block
SDesign2018 0:f72b3e7f1ec8 102 *
SDesign2018 0:f72b3e7f1ec8 103 * @return Size of a readable block in bytes
SDesign2018 0:f72b3e7f1ec8 104 */
SDesign2018 0:f72b3e7f1ec8 105 virtual bd_size_t get_read_size() const;
SDesign2018 0:f72b3e7f1ec8 106
SDesign2018 0:f72b3e7f1ec8 107 /** Get the size of a programable block
SDesign2018 0:f72b3e7f1ec8 108 *
SDesign2018 0:f72b3e7f1ec8 109 * @return Size of a programable block in bytes
SDesign2018 0:f72b3e7f1ec8 110 * @note Must be a multiple of the read size
SDesign2018 0:f72b3e7f1ec8 111 */
SDesign2018 0:f72b3e7f1ec8 112 virtual bd_size_t get_program_size() const;
SDesign2018 0:f72b3e7f1ec8 113
SDesign2018 0:f72b3e7f1ec8 114 /** Get the total size of the underlying device
SDesign2018 0:f72b3e7f1ec8 115 *
SDesign2018 0:f72b3e7f1ec8 116 * @return Size of the underlying device in bytes
SDesign2018 0:f72b3e7f1ec8 117 */
SDesign2018 0:f72b3e7f1ec8 118 virtual bd_size_t size() const;
SDesign2018 0:f72b3e7f1ec8 119
SDesign2018 0:f72b3e7f1ec8 120 /** Enable or disable debugging
SDesign2018 0:f72b3e7f1ec8 121 *
SDesign2018 0:f72b3e7f1ec8 122 * @param State of debugging
SDesign2018 0:f72b3e7f1ec8 123 */
SDesign2018 0:f72b3e7f1ec8 124 virtual void debug(bool dbg);
SDesign2018 0:f72b3e7f1ec8 125
SDesign2018 0:f72b3e7f1ec8 126 /** Set the transfer frequency
SDesign2018 0:f72b3e7f1ec8 127 *
SDesign2018 0:f72b3e7f1ec8 128 * @param Transfer frequency
SDesign2018 0:f72b3e7f1ec8 129 * @note Max frequency supported is 25MHZ
SDesign2018 0:f72b3e7f1ec8 130 */
SDesign2018 0:f72b3e7f1ec8 131 virtual int frequency(uint64_t freq);
SDesign2018 0:f72b3e7f1ec8 132
SDesign2018 0:f72b3e7f1ec8 133
SDesign2018 0:f72b3e7f1ec8 134 private:
SDesign2018 0:f72b3e7f1ec8 135 /* Commands : Listed below are commands supported
SDesign2018 0:f72b3e7f1ec8 136 * in SPI mode for SD card : Only Mandatory ones
SDesign2018 0:f72b3e7f1ec8 137 */
SDesign2018 0:f72b3e7f1ec8 138 enum cmdSupported {
SDesign2018 0:f72b3e7f1ec8 139 CMD_NOT_SUPPORTED = -1, /**< Command not supported error */
SDesign2018 0:f72b3e7f1ec8 140 CMD0_GO_IDLE_STATE = 0, /**< Resets the SD Memory Card */
SDesign2018 0:f72b3e7f1ec8 141 CMD1_SEND_OP_COND = 1, /**< Sends host capacity support */
SDesign2018 0:f72b3e7f1ec8 142 CMD6_SWITCH_FUNC = 6, /**< Check and Switches card function */
SDesign2018 0:f72b3e7f1ec8 143 CMD8_SEND_IF_COND = 8, /**< Supply voltage info */
SDesign2018 0:f72b3e7f1ec8 144 CMD9_SEND_CSD = 9, /**< Provides Card Specific data */
SDesign2018 0:f72b3e7f1ec8 145 CMD10_SEND_CID = 10, /**< Provides Card Identification */
SDesign2018 0:f72b3e7f1ec8 146 CMD12_STOP_TRANSMISSION = 12, /**< Forces the card to stop transmission */
SDesign2018 0:f72b3e7f1ec8 147 CMD13_SEND_STATUS = 13, /**< Card responds with status */
SDesign2018 0:f72b3e7f1ec8 148 CMD16_SET_BLOCKLEN = 16, /**< Length for SC card is set */
SDesign2018 0:f72b3e7f1ec8 149 CMD17_READ_SINGLE_BLOCK = 17, /**< Read single block of data */
SDesign2018 0:f72b3e7f1ec8 150 CMD18_READ_MULTIPLE_BLOCK = 18, /**< Card transfers data blocks to host until interrupted
SDesign2018 0:f72b3e7f1ec8 151 by a STOP_TRANSMISSION command */
SDesign2018 0:f72b3e7f1ec8 152 CMD24_WRITE_BLOCK = 24, /**< Write single block of data */
SDesign2018 0:f72b3e7f1ec8 153 CMD25_WRITE_MULTIPLE_BLOCK = 25, /**< Continuously writes blocks of data until
SDesign2018 0:f72b3e7f1ec8 154 'Stop Tran' token is sent */
SDesign2018 0:f72b3e7f1ec8 155 CMD27_PROGRAM_CSD = 27, /**< Programming bits of CSD */
SDesign2018 0:f72b3e7f1ec8 156 CMD32_ERASE_WR_BLK_START_ADDR = 32, /**< Sets the address of the first write
SDesign2018 0:f72b3e7f1ec8 157 block to be erased. */
SDesign2018 0:f72b3e7f1ec8 158 CMD33_ERASE_WR_BLK_END_ADDR = 33, /**< Sets the address of the last write
SDesign2018 0:f72b3e7f1ec8 159 block of the continuous range to be erased.*/
SDesign2018 0:f72b3e7f1ec8 160 CMD38_ERASE = 38, /**< Erases all previously selected write blocks */
SDesign2018 0:f72b3e7f1ec8 161 CMD55_APP_CMD = 55, /**< Extend to Applications specific commands */
SDesign2018 0:f72b3e7f1ec8 162 CMD56_GEN_CMD = 56, /**< General Purpose Command */
SDesign2018 0:f72b3e7f1ec8 163 CMD58_READ_OCR = 58, /**< Read OCR register of card */
SDesign2018 0:f72b3e7f1ec8 164 CMD59_CRC_ON_OFF = 59, /**< Turns the CRC option on or off*/
SDesign2018 0:f72b3e7f1ec8 165 // App Commands
SDesign2018 0:f72b3e7f1ec8 166 ACMD6_SET_BUS_WIDTH = 6,
SDesign2018 0:f72b3e7f1ec8 167 ACMD13_SD_STATUS = 13,
SDesign2018 0:f72b3e7f1ec8 168 ACMD22_SEND_NUM_WR_BLOCKS = 22,
SDesign2018 0:f72b3e7f1ec8 169 ACMD23_SET_WR_BLK_ERASE_COUNT = 23,
SDesign2018 0:f72b3e7f1ec8 170 ACMD41_SD_SEND_OP_COND = 41,
SDesign2018 0:f72b3e7f1ec8 171 ACMD42_SET_CLR_CARD_DETECT = 42,
SDesign2018 0:f72b3e7f1ec8 172 ACMD51_SEND_SCR = 51,
SDesign2018 0:f72b3e7f1ec8 173 };
SDesign2018 0:f72b3e7f1ec8 174
SDesign2018 0:f72b3e7f1ec8 175 uint8_t _card_type;
SDesign2018 0:f72b3e7f1ec8 176 int _cmd(SDBlockDevice::cmdSupported cmd, uint32_t arg, bool isAcmd=0, uint32_t *resp=NULL);
SDesign2018 0:f72b3e7f1ec8 177 int _cmd8();
SDesign2018 0:f72b3e7f1ec8 178
SDesign2018 0:f72b3e7f1ec8 179 /* Move the SDCard into the SPI Mode idle state
SDesign2018 0:f72b3e7f1ec8 180 *
SDesign2018 0:f72b3e7f1ec8 181 * The card is transitioned from SDCard mode to SPI mode by sending the
SDesign2018 0:f72b3e7f1ec8 182 * CMD0 (GO_IDLE_STATE) command with CS asserted. See the notes in the
SDesign2018 0:f72b3e7f1ec8 183 * "SPI Startup" section of the comments at the head of the
SDesign2018 0:f72b3e7f1ec8 184 * implementation file for further details and specification references.
SDesign2018 0:f72b3e7f1ec8 185 *
SDesign2018 0:f72b3e7f1ec8 186 * @return Response form the card. R1_IDLE_STATE (0x1), the successful
SDesign2018 0:f72b3e7f1ec8 187 * response from CMD0. R1_XXX_XXX for more response
SDesign2018 0:f72b3e7f1ec8 188 */
SDesign2018 0:f72b3e7f1ec8 189 uint32_t _go_idle_state();
SDesign2018 0:f72b3e7f1ec8 190 int _initialise_card();
SDesign2018 0:f72b3e7f1ec8 191
SDesign2018 0:f72b3e7f1ec8 192 uint32_t _sectors;
SDesign2018 0:f72b3e7f1ec8 193 uint32_t _sd_sectors();
SDesign2018 0:f72b3e7f1ec8 194
SDesign2018 0:f72b3e7f1ec8 195 bool _is_valid_trim(bd_addr_t addr, bd_size_t size);
SDesign2018 0:f72b3e7f1ec8 196
SDesign2018 0:f72b3e7f1ec8 197 /* SPI functions */
SDesign2018 0:f72b3e7f1ec8 198 Timer _spi_timer; /**< Timer Class object used for busy wait */
SDesign2018 0:f72b3e7f1ec8 199 uint32_t _init_sck; /**< Intial SPI frequency */
SDesign2018 0:f72b3e7f1ec8 200 uint32_t _transfer_sck; /**< SPI frequency during data transfer/after initialization */
SDesign2018 0:f72b3e7f1ec8 201 SPI _spi; /**< SPI Class object */
SDesign2018 0:f72b3e7f1ec8 202
SDesign2018 0:f72b3e7f1ec8 203 /* SPI initialization function */
SDesign2018 0:f72b3e7f1ec8 204 void _spi_init();
SDesign2018 0:f72b3e7f1ec8 205 uint8_t _cmd_spi(SDBlockDevice::cmdSupported cmd, uint32_t arg);
SDesign2018 0:f72b3e7f1ec8 206 void _spi_wait(uint8_t count);
SDesign2018 0:f72b3e7f1ec8 207
SDesign2018 0:f72b3e7f1ec8 208 bool _wait_token(uint8_t token); /**< Wait for token */
SDesign2018 0:f72b3e7f1ec8 209 bool _wait_ready(uint16_t ms=300); /**< 300ms default wait for card to be ready */
SDesign2018 0:f72b3e7f1ec8 210 int _read(uint8_t * buffer, uint32_t length);
SDesign2018 0:f72b3e7f1ec8 211 int _read_bytes(uint8_t * buffer, uint32_t length);
SDesign2018 0:f72b3e7f1ec8 212 uint8_t _write(const uint8_t *buffer,uint8_t token, uint32_t length);
SDesign2018 0:f72b3e7f1ec8 213 int _freq(void);
SDesign2018 0:f72b3e7f1ec8 214
SDesign2018 0:f72b3e7f1ec8 215 /* Chip Select and SPI mode select */
SDesign2018 0:f72b3e7f1ec8 216 DigitalOut _cs;
SDesign2018 0:f72b3e7f1ec8 217 void _select();
SDesign2018 0:f72b3e7f1ec8 218 void _deselect();
SDesign2018 0:f72b3e7f1ec8 219
SDesign2018 0:f72b3e7f1ec8 220 mutable Mutex _lock;
SDesign2018 0:f72b3e7f1ec8 221 uint32_t _block_size;
SDesign2018 0:f72b3e7f1ec8 222 uint32_t _erase_size;
SDesign2018 0:f72b3e7f1ec8 223 bool _is_initialized;
SDesign2018 0:f72b3e7f1ec8 224 bool _dbg;
SDesign2018 0:f72b3e7f1ec8 225 };
SDesign2018 0:f72b3e7f1ec8 226
SDesign2018 0:f72b3e7f1ec8 227 #endif /* DEVICE_SPI */
SDesign2018 0:f72b3e7f1ec8 228
SDesign2018 0:f72b3e7f1ec8 229 #endif /* MBED_SD_BLOCK_DEVICE_H */
SDesign2018 0:f72b3e7f1ec8 230