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.
Sd2Card Class Reference
Raw access to SD and SDHC flash memory cards. More...
#include <Sd2Card.h>
Public Member Functions | |
| Sd2Card (void) | |
| Construct an instance of Sd2Card. | |
| uint32_t | cardSize (void) |
| Determine the size of an SD flash memory card. | |
| uint8_t | erase (uint32_t firstBlock, uint32_t lastBlock) |
| Erase a range of blocks. | |
| uint8_t | eraseSingleBlockEnable (void) |
| Determine if card supports single block erase. | |
| uint8_t | errorCode (void) const |
| uint8_t | errorData (void) const |
| uint8_t | init (void) |
| Initialize an SD flash memory card with default clock rate and chip select pin. | |
| uint8_t | init (uint8_t sckRateID) |
| Initialize an SD flash memory card with the selected SPI clock rate and the default SD chip select pin. | |
| uint8_t | init (uint8_t sckRateID, uint8_t chipSelectPin) |
| Initialize an SD flash memory card. | |
| void | partialBlockRead (uint8_t value) |
| Enable or disable partial block reads. | |
| uint8_t | partialBlockRead (void) const |
| Returns the current value, true or false, for partial block read. | |
| uint8_t | readBlock (uint32_t block, uint8_t *dst) |
| Read a 512 byte block from an SD card device. | |
| uint8_t | readData (uint32_t block, uint16_t offset, uint16_t count, uint8_t *dst) |
| Read part of a 512 byte block from an SD card. | |
| uint8_t | readCID (cid_t *cid) |
| Read a cards CID register. | |
| uint8_t | readCSD (csd_t *csd) |
| Read a cards CSD register. | |
| void | readEnd (void) |
| Skip remaining data in a block when in partial block read mode. | |
| uint8_t | setSckRate (uint8_t sckRateID) |
| Set the SPI clock rate. | |
| uint8_t | type (void) const |
| Return the card type: SD V1, SD V2 or SDHC. | |
| uint8_t | writeBlock (uint32_t blockNumber, const uint8_t *src) |
| Writes a 512 byte block to an SD card. | |
| uint8_t | writeData (const uint8_t *src) |
| Write one data block in a multiple block write sequence. | |
| uint8_t | writeStart (uint32_t blockNumber, uint32_t eraseCount) |
| Start a write multiple blocks sequence. | |
| uint8_t | writeStop (void) |
| End a write multiple blocks sequence. | |
Detailed Description
Raw access to SD and SDHC flash memory cards.
Definition at line 152 of file Sd2Card.h.
Constructor & Destructor Documentation
Member Function Documentation
| uint32_t cardSize | ( | void | ) |
Determine the size of an SD flash memory card.
- Returns:
- The number of 512 byte data blocks in the card or zero if an error occurs.
Definition at line 126 of file Sd2Card.cpp.
| uint8_t erase | ( | uint32_t | firstBlock, |
| uint32_t | lastBlock | ||
| ) |
Erase a range of blocks.
- Parameters:
-
[in] firstBlock The address of the first block in the range. [in] lastBlock The address of the last block in the range.
- Note:
- This function requests the SD card to do a flash erase for a range of blocks. The data on the card after an erase operation is either 0 or 1, depends on the card vendor. The card must support single block erase.
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for failure.
Definition at line 169 of file Sd2Card.cpp.
| uint8_t eraseSingleBlockEnable | ( | void | ) |
Determine if card supports single block erase.
- Returns:
- The value one, true, is returned if single block erase is supported. The value zero, false, is returned if single block erase is not supported.
Definition at line 201 of file Sd2Card.cpp.
| uint8_t errorCode | ( | void | ) | const |
| uint8_t errorData | ( | void | ) | const |
| uint8_t init | ( | uint8_t | sckRateID, |
| uint8_t | chipSelectPin | ||
| ) |
Initialize an SD flash memory card.
- Parameters:
-
[in] sckRateID SPI clock rate selector. See setSckRate(). [in] chipSelectPin SD chip select pin number.
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for failure. The reason for failure can be determined by calling errorCode() and errorData().
Definition at line 216 of file Sd2Card.cpp.
| uint8_t init | ( | void | ) |
| uint8_t init | ( | uint8_t | sckRateID ) |
| void partialBlockRead | ( | uint8_t | value ) |
Enable or disable partial block reads.
Enabling partial block reads improves performance by allowing a block to be read over the SPI bus as several sub-blocks. Errors may occur if the time between reads is too long since the SD card may timeout. The SPI SS line will be held low until the entire block is read or readEnd() is called.
Use this for applications like the Adafruit Wave Shield.
- Parameters:
-
[in] value The value TRUE (non-zero) or FALSE (zero).)
Definition at line 310 of file Sd2Card.cpp.
| uint8_t partialBlockRead | ( | void | ) | const |
| uint8_t readBlock | ( | uint32_t | block, |
| uint8_t * | dst | ||
| ) |
Read a 512 byte block from an SD card device.
- Parameters:
-
[in] block Logical block to be read. [out] dst Pointer to the location that will receive the data.
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for failure.
Definition at line 324 of file Sd2Card.cpp.
| uint8_t readCID | ( | cid_t * | cid ) |
| uint8_t readCSD | ( | csd_t * | csd ) |
| uint8_t readData | ( | uint32_t | block, |
| uint16_t | offset, | ||
| uint16_t | count, | ||
| uint8_t * | dst | ||
| ) |
Read part of a 512 byte block from an SD card.
- Parameters:
-
[in] block Logical block to be read. [in] offset Number of bytes to skip at start of block [out] dst Pointer to the location that will receive the data. [in] count Number of bytes to read
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for failure.
Definition at line 338 of file Sd2Card.cpp.
| void readEnd | ( | void | ) |
Skip remaining data in a block when in partial block read mode.
Definition at line 405 of file Sd2Card.cpp.
| uint8_t setSckRate | ( | uint8_t | sckRateID ) |
Set the SPI clock rate.
- Parameters:
-
[in] sckRateID A value in the range [0, 6].
The SPI clock will be set to F_CPU/pow(2, 1 + sckRateID). The maximum SPI rate is F_CPU/2 for sckRateID = 0 and the minimum rate is F_CPU/128 for scsRateID = 6.
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for an invalid value of sckRateID.
Definition at line 457 of file Sd2Card.cpp.
| uint8_t type | ( | void | ) | const |
| uint8_t writeBlock | ( | uint32_t | blockNumber, |
| const uint8_t * | src | ||
| ) |
Writes a 512 byte block to an SD card.
- Parameters:
-
[in] blockNumber Logical block to be written. [in] src Pointer to the location of the data to be written.
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for failure.
Definition at line 512 of file Sd2Card.cpp.
| uint8_t writeData | ( | const uint8_t * | src ) |
Write one data block in a multiple block write sequence.
Definition at line 548 of file Sd2Card.cpp.
| uint8_t writeStart | ( | uint32_t | blockNumber, |
| uint32_t | eraseCount | ||
| ) |
Start a write multiple blocks sequence.
- Parameters:
-
[in] blockNumber Address of first block in sequence. [in] eraseCount The number of blocks to be pre-erased.
- Note:
- This function is used with writeData() and writeStop() for optimized multiple block writes.
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for failure.
Definition at line 605 of file Sd2Card.cpp.
| uint8_t writeStop | ( | void | ) |
End a write multiple blocks sequence.
- Returns:
- The value one, true, is returned for success and the value zero, false, is returned for failure.
Definition at line 636 of file Sd2Card.cpp.
Generated on Thu Jul 14 2022 02:07:54 by
1.7.2