tool/mbed/mbed-sdk/libraries/fs/sd/SDFileSystem.h

   1 /* mbed Microcontroller Library
   2  * Copyright (c) 2006-2012 ARM Limited
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22 #ifndef MBED_SDFILESYSTEM_H
  23 #define MBED_SDFILESYSTEM_H
  24
  25 #include "mbed.h"
  26 #include "FATFileSystem.h"
  27 #include <stdint.h>
  28
  29 /** Access the filesystem on an SD Card using SPI
  30  *
  31  * @code
  32  * #include "mbed.h"
  33  * #include "SDFileSystem.h"
  34  *
  35  * SDFileSystem sd(p5, p6, p7, p12, "sd"); // mosi, miso, sclk, cs
  36  *
  37  * int main() {
  38  *     FILE *fp = fopen("/sd/myfile.txt", "w");
  39  *     fprintf(fp, "Hello World!\n");
  40  *     fclose(fp);
  41  * }
  42  */
  43 class SDFileSystem : public FATFileSystem {
  44 public:
  45
  46     /** Create the File System for accessing an SD Card using SPI
  47      *
  48      * @param mosi SPI mosi pin connected to SD Card
  49      * @param miso SPI miso pin conencted to SD Card
  50      * @param sclk SPI sclk pin connected to SD Card
  51      * @param cs   DigitalOut pin used as SD Card chip select
  52      * @param name The name used to access the virtual filesystem
  53      */
  54     SDFileSystem(PinName mosi, PinName miso, PinName sclk, PinName cs, const char* name);
  55     virtual int disk_initialize();
  56     virtual int disk_status();
  57     virtual int disk_read(uint8_t* buffer, uint64_t block_number, uint8_t count);
  58     virtual int disk_write(const uint8_t* buffer, uint64_t block_number, uint8_t count);
  59     virtual int disk_sync();
  60     virtual uint64_t disk_sectors();
  61
  62 protected:
  63
  64     int _cmd(int cmd, int arg);
  65     int _cmdx(int cmd, int arg);
  66     int _cmd8();
  67     int _cmd58();
  68     int initialise_card();
  69     int initialise_card_v1();
  70     int initialise_card_v2();
  71
  72     int _read(uint8_t * buffer, uint32_t length);
  73     int _write(const uint8_t *buffer, uint32_t length);
  74     uint64_t _sd_sectors();
  75     uint64_t _sectors;
  76
  77     void set_init_sck(uint32_t sck) { _init_sck = sck; }
  78     // Note: The highest SPI clock rate is 20 MHz for MMC and 25 MHz for SD
  79     void set_transfer_sck(uint32_t sck) { _transfer_sck = sck; }
  80     uint32_t _init_sck;
  81     uint32_t _transfer_sck;
  82
  83     SPI _spi;
  84     DigitalOut _cs;
  85     int cdv;
  86     int _is_initialized;
  87 };
  88
  89 #endif