megan gimple / SDFileSystem

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   gimple_A4_3_Temp_Light

SDFileSystem.h@0:07ff9ae5339f, 2021-11-13 (annotated)

Committer:
mgimple
Date:
Sat Nov 13 20:10:05 2021 +0000
Revision:
0:07ff9ae5339f
SD

Who changed what in which revision?

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