High-speed access version sd-driver.
Dependents: SDBlockDevice_GR_PEACH SDBlockDevice_GR_PEACH HagridOS5
This library has modified SDBlockDevice.h based on revision "14: c7dba87" of sd-driver.
https://github.com/ARMmbed/sd-driver
Diff: features/filesystem/spif/SPIFBlockDevice.h
- Revision:
- 0:b22a1df967cb
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/features/filesystem/spif/SPIFBlockDevice.h Thu Mar 23 08:25:54 2017 +0000 @@ -0,0 +1,155 @@ +/* mbed Microcontroller Library + * Copyright (c) 2016 ARM Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#ifndef MBED_SPIF_BLOCK_DEVICE_H +#define MBED_SPIF_BLOCK_DEVICE_H + +/* If the target has no SPI support then SPIF is not supported */ +#ifdef DEVICE_SPI + +#include <mbed.h> +#include "BlockDevice.h" + + +/** BlockDevice for SPI based flash devices + * such as the MX25R or SST26F016B + * + * @code + * #include "mbed.h" + * #include "SPIFBlockDevice.h" + * + * // Create mx25r on SPI bus with PTE5 as chip select + * SPIFBlockDevice mx25r(PTE2, PTE4, PTE1, PTE5); + * + * int main() { + * printf("mx25r test\n"); + * mx52r.init(); + * printf("mx25r size: %llu\n", mx25r.size()); + * printf("mx25r read size: %llu\n", mx25r.get_read_size()); + * printf("mx25r program size: %llu\n", mx25r.get_program_size()); + * printf("mx25r erase size: %llu\n", mx25r.get_erase_size()); + * + * uint8_t *buffer = malloc(mx25r.get_erase_size()); + * sprintf(buffer, "Hello World!\n"); + * mx25r.erase(0, mx25r.get_erase_size()); + * mx25r.program(buffer, 0, mx25r.get_erase_size()); + * mx25r.read(buffer, 0, mx25r.get_erase_size()); + * printf("%s", buffer); + * + * mx25r.deinit(); + * } + */ +class SPIFBlockDevice : public BlockDevice +{ +public: + /** Creates a SPIFBlockDevice on a SPI bus specified by pins + * + * @param mosi SPI master out, slave in pin + * @param miso SPI master in, slave out pin + * @param sclk SPI clock pin + * @param csel SPI chip select pin + * @param freq Clock speed of the SPI bus (defaults to 40MHz) + */ + SPIFBlockDevice(PinName mosi, PinName miso, PinName sclk, PinName csel, int freq=4000000); + + /** 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; + +private: + // Master side hardware + SPI _spi; + DigitalOut _cs; + + // Device configuration discovered through sfdp + bd_size_t _size; + + // Internal functions + int _wren(); + int _sync(); + void _cmdread(uint8_t op, uint32_t addrc, uint32_t retc, + uint32_t addr, uint8_t *rets); + void _cmdwrite(uint8_t op, uint32_t addrc, uint32_t argc, + uint32_t addr, const uint8_t *args); +}; + + +#endif /* DEVICE_SPI */ + +#endif /* MBED_SPIF_BLOCK_DEVICE_H */