Quentin Mettraux
/
MAVErIC_TEST
Working Maveric
Diff: SDBlockDevice.h
- Revision:
- 9:b6a9d1c44ed9
- Parent:
- 6:ef95300898b2
--- a/SDBlockDevice.h Mon Jun 05 14:17:38 2017 +0000 +++ b/SDBlockDevice.h Sun Jun 11 17:14:19 2017 +0000 @@ -1,172 +1,172 @@ -/* mbed Microcontroller Library - * Copyright (c) 2006-2012 ARM Limited - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ -#ifndef MBED_SD_BLOCK_DEVICE_H -#define MBED_SD_BLOCK_DEVICE_H - -/* If the target has no SPI support then SDCard is not supported */ -#ifdef DEVICE_SPI - -#include "BlockDevice.h" -#include "mbed.h" - - -/** Access an SD Card using SPI - * - * @code - * #include "mbed.h" - * #include "SDBlockDevice.h" - * - * SDBlockDevice sd(p5, p6, p7, p12); // mosi, miso, sclk, cs - * uint8_t block[512] = "Hello World!\n"; - * - * int main() { - * sd.init(); - * sd.write(block, 0, 512); - * sd.read(block, 0, 512); - * printf("%s", block); - * sd.deinit(); - * } - */ -class SDBlockDevice : public BlockDevice { -public: - /** Lifetime of an SD card - */ - SDBlockDevice(PinName mosi, PinName miso, PinName sclk, PinName cs); - virtual ~SDBlockDevice(); - - /** Initialize a block device - * - * @return 0 on success or a negative error code on failure - */ - virtual int init(); - - /** Deinitialize a block device - * - * @return 0 on success or a negative error code on failure - */ - virtual int deinit(); - - /** Read blocks from a block device - * - * @param buffer Buffer to write blocks to - * @param addr Address of block to begin reading from - * @param size Size to read in bytes, must be a multiple of read block size - * @return 0 on success, negative error code on failure - */ - virtual int read(void *buffer, bd_addr_t addr, bd_size_t size); - - /** Program blocks to a block device - * - * The blocks must have been erased prior to being programmed - * - * @param buffer Buffer of data to write to blocks - * @param addr Address of block to begin writing to - * @param size Size to write in bytes, must be a multiple of program block size - * @return 0 on success, negative error code on failure - */ - virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size); - - /** Erase blocks on a block device - * - * The state of an erased block is undefined until it has been programmed - * - * @param addr Address of block to begin erasing - * @param size Size to erase in bytes, must be a multiple of erase block size - * @return 0 on success, negative error code on failure - */ - virtual int erase(bd_addr_t addr, bd_size_t size); - - /** Get the size of a readable block - * - * @return Size of a readable block in bytes - */ - virtual bd_size_t get_read_size() const; - - /** Get the size of a programable block - * - * @return Size of a programable block in bytes - * @note Must be a multiple of the read size - */ - virtual bd_size_t get_program_size() const; - - /** Get the size of a eraseable block - * - * @return Size of a eraseable block in bytes - * @note Must be a multiple of the program size - */ - virtual bd_size_t get_erase_size() const; - - /** Get the total size of the underlying device - * - * @return Size of the underlying device in bytes - */ - virtual bd_size_t size() const; - - /** Enable or disable debugging - * - * @param State of debugging - */ - virtual void debug(bool dbg); - -private: - int _cmd(int cmd, int arg); - int _cmdx(int cmd, int arg); - int _cmd8(); - int _cmd58(); - - /* Move the SDCard into the SPI Mode idle state - * - * The card is transitioned from SDCard mode to SPI mode by sending the - * CMD0 (GO_IDLE_STATE) command with CS asserted. See the notes in the - * "SPI Startup" section of the comments at the head of the - * implementation file for further details and specification references. - * - * @return -1 if an error occurred e.g. a valid response was not - * received. Otherwise R1_IDLE_STATE (0x1), the successful - * response from CMD0. - */ - int _go_idle_state(); - int _initialise_card(); - int _initialise_card_v1(); - int _initialise_card_v2(); - - int _read(uint8_t * buffer, uint32_t length); - int _write(const uint8_t *buffer, uint32_t length); - uint32_t _sd_sectors(); - uint32_t _sectors; - - uint32_t _init_sck; - uint32_t _transfer_sck; - - SPI _spi; - DigitalOut _cs; - unsigned _block_size; - bool _is_initialized; - bool _dbg; - mutable Mutex _lock; -}; - - -#endif /* DEVICE_SPI */ - -#endif /* MBED_SD_BLOCK_DEVICE_H */ +/* mbed Microcontroller Library + * Copyright (c) 2006-2012 ARM Limited + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef MBED_SD_BLOCK_DEVICE_H +#define MBED_SD_BLOCK_DEVICE_H + +/* If the target has no SPI support then SDCard is not supported */ +#ifdef DEVICE_SPI + +#include "BlockDevice.h" +#include "mbed.h" + + +/** Access an SD Card using SPI + * + * @code + * #include "mbed.h" + * #include "SDBlockDevice.h" + * + * SDBlockDevice sd(p5, p6, p7, p12); // mosi, miso, sclk, cs + * uint8_t block[512] = "Hello World!\n"; + * + * int main() { + * sd.init(); + * sd.write(block, 0, 512); + * sd.read(block, 0, 512); + * printf("%s", block); + * sd.deinit(); + * } + */ +class SDBlockDevice : public BlockDevice { +public: + /** Lifetime of an SD card + */ + SDBlockDevice(PinName mosi, PinName miso, PinName sclk, PinName cs); + virtual ~SDBlockDevice(); + + /** Initialize a block device + * + * @return 0 on success or a negative error code on failure + */ + virtual int init(); + + /** Deinitialize a block device + * + * @return 0 on success or a negative error code on failure + */ + virtual int deinit(); + + /** Read blocks from a block device + * + * @param buffer Buffer to write blocks to + * @param addr Address of block to begin reading from + * @param size Size to read in bytes, must be a multiple of read block size + * @return 0 on success, negative error code on failure + */ + virtual int read(void *buffer, bd_addr_t addr, bd_size_t size); + /** Program blocks to a block device + * + * The blocks must have been erased prior to being programmed + * + * @param buffer Buffer of data to write to blocks + * @param addr Address of block to begin writing to + * @param size Size to write in bytes, must be a multiple of program block size + * @return 0 on success, negative error code on failure + */ + virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size); + + /** Erase blocks on a block device + * + * The state of an erased block is undefined until it has been programmed + * + * @param addr Address of block to begin erasing + * @param size Size to erase in bytes, must be a multiple of erase block size + * @return 0 on success, negative error code on failure + */ + virtual int erase(bd_addr_t addr, bd_size_t size); + + /** Get the size of a readable block + * + * @return Size of a readable block in bytes + */ + virtual bd_size_t get_read_size() const; + + /** Get the size of a programable block + * + * @return Size of a programable block in bytes + * @note Must be a multiple of the read size + */ + virtual bd_size_t get_program_size() const; + + /** Get the size of a eraseable block + * + * @return Size of a eraseable block in bytes + * @note Must be a multiple of the program size + */ + virtual bd_size_t get_erase_size() const; + + /** Get the total size of the underlying device + * + * @return Size of the underlying device in bytes + */ + virtual bd_size_t size() const; + + /** Enable or disable debugging + * + * @param State of debugging + */ + virtual void debug(bool dbg); + +private: + int _cmd(int cmd, int arg); + int _cmdx(int cmd, int arg); + int _cmd8(); + int _cmd58(); + + /* Move the SDCard into the SPI Mode idle state + * + * The card is transitioned from SDCard mode to SPI mode by sending the + * CMD0 (GO_IDLE_STATE) command with CS asserted. See the notes in the + * "SPI Startup" section of the comments at the head of the + * implementation file for further details and specification references. + * + * @return -1 if an error occurred e.g. a valid response was not + * received. Otherwise R1_IDLE_STATE (0x1), the successful + * response from CMD0. + */ + int _go_idle_state(); + int _initialise_card(); + int _initialise_card_v1(); + int _initialise_card_v2(); + + int _read(uint8_t * buffer, uint32_t length); + int _write(const uint8_t *buffer, uint32_t length); + uint32_t _sd_sectors(); + uint32_t _sectors; + + uint32_t _init_sck; + uint32_t _transfer_sck; + + SPI _spi; + DigitalOut _cs; + unsigned _block_size; + bool _is_initialized; + bool _dbg; + mutable Mutex _lock; +}; + + +#endif /* DEVICE_SPI */ + +#endif /* MBED_SD_BLOCK_DEVICE_H */ +