Raw access to SD and SDHC flash memory cards via dedicate SPI port.
More...
#include <SdSpiCard.h>
Raw access to SD and SDHC flash memory cards via dedicate SPI port.
◆ DedicatedSpiCard()
DedicatedSpiCard::DedicatedSpiCard |
( |
| ) |
|
|
default |
◆ begin()
Initialize the SD card.
- Parameters
-
[in] | spiConfig | SPI card configuration. |
- Returns
- true for success or false for failure.
◆ cardCMD6()
bool SharedSpiCard::cardCMD6 |
( |
uint32_t |
arg, |
|
|
uint8_t * |
status |
|
) |
| |
|
inherited |
CMD6 Switch mode: Check Function Set Function.
- Parameters
-
[in] | arg | CMD6 argument. |
[out] | status | return status data. |
- Returns
- true for success or false for failure.
◆ end()
void SharedSpiCard::end |
( |
| ) |
|
|
inherited |
◆ erase()
bool SharedSpiCard::erase |
( |
uint32_t |
firstSector, |
|
|
uint32_t |
lastSector |
|
) |
| |
|
inherited |
Erase a range of sectors.
- Parameters
-
[in] | firstSector | The address of the first sector in the range. |
[in] | lastSector | The address of the last sector in the range. |
- Note
- This function requests the SD card to do a flash erase for a range of sectors. The data on the card after an erase operation is either 0 or 1, depends on the card vendor. The card must support single sector erase.
- Returns
- true for success or false for failure.
◆ eraseSingleSectorEnable()
bool SharedSpiCard::eraseSingleSectorEnable |
( |
| ) |
|
|
inherited |
Determine if card supports single sector erase.
- Returns
- true is returned if single sector erase is supported. false is returned if single sector erase is not supported.
◆ error()
void SharedSpiCard::error |
( |
uint8_t |
code | ) |
|
|
inlineinherited |
Set SD error code.
- Parameters
-
[in] | code | value for error code. |
◆ errorCode()
uint8_t SharedSpiCard::errorCode |
( |
| ) |
const |
|
inlineinherited |
- Returns
- code for the last error. See SdCardInfo.h for a list of error codes.
◆ errorData()
uint32_t SharedSpiCard::errorData |
( |
| ) |
const |
|
inlineinherited |
- Returns
- error data for last error.
◆ hasDedicatedSpi()
bool DedicatedSpiCard::hasDedicatedSpi |
( |
| ) |
|
|
inline |
- Returns
- true, can be in dedicaded state.
◆ isBusy()
bool SharedSpiCard::isBusy |
( |
| ) |
|
|
inherited |
Check for busy. MISO low indicates the card is busy.
- Returns
- true if busy else false.
◆ isDedicatedSpi()
bool DedicatedSpiCard::isDedicatedSpi |
( |
| ) |
|
|
inline |
- Returns
- true if in dedicated SPI state.
◆ readCID()
bool SharedSpiCard::readCID |
( |
cid_t * |
cid | ) |
|
|
inlineinherited |
Read a card's CID register. The CID contains card identification information such as Manufacturer ID, Product name, Product serial number and Manufacturing date.
- Parameters
-
[out] | cid | pointer to area for returned data. |
- Returns
- true for success or false for failure.
◆ readCSD()
bool SharedSpiCard::readCSD |
( |
csd_t * |
csd | ) |
|
|
inlineinherited |
Read a card's CSD register. The CSD contains Card-Specific Data that provides information regarding access to the card's contents.
- Parameters
-
[out] | csd | pointer to area for returned data. |
- Returns
- true for success or false for failure.
◆ readData()
bool SharedSpiCard::readData |
( |
uint8_t * |
dst | ) |
|
|
inherited |
Read one data sector in a multiple sector read sequence
- Parameters
-
[out] | dst | Pointer to the location for the data to be read. |
- Returns
- true for success or false for failure.
◆ readOCR()
bool SharedSpiCard::readOCR |
( |
uint32_t * |
ocr | ) |
|
|
inherited |
Read OCR register.
- Parameters
-
[out] | ocr | Value of OCR register. |
- Returns
- true for success or false for failure.
◆ readSCR()
bool SharedSpiCard::readSCR |
( |
scr_t * |
scr | ) |
|
|
inherited |
Read SCR register.
- Parameters
-
[out] | scr | Value of SCR register. |
- Returns
- true for success or false for failure.
◆ readSDS()
bool SharedSpiCard::readSDS |
( |
sds_t * |
status | ) |
|
|
inherited |
Return the 64 byte SD Status register.
- Parameters
-
[out] | status | location for 64 status bytes. |
- Returns
- true for success or false for failure.
◆ readSector()
bool DedicatedSpiCard::readSector |
( |
uint32_t |
sector, |
|
|
uint8_t * |
dst |
|
) |
| |
Read a 512 byte sector from an SD card.
- Parameters
-
[in] | sector | Logical sector to be read. |
[out] | dst | Pointer to the location that will receive the data. |
- Returns
- true for success or false for failure.
◆ readSectors()
bool DedicatedSpiCard::readSectors |
( |
uint32_t |
sector, |
|
|
uint8_t * |
dst, |
|
|
size_t |
ns |
|
) |
| |
Read multiple 512 byte sectors from an SD card.
- Parameters
-
[in] | sector | Logical sector to be read. |
[in] | ns | Number of sectors to be read. |
[out] | dst | Pointer to the location that will receive the data. |
- Returns
- true for success or false for failure.
◆ readStart()
bool SharedSpiCard::readStart |
( |
uint32_t |
sector | ) |
|
|
inherited |
Start a read multiple sector sequence.
- Parameters
-
[in] | sector | Address of first sector in sequence. |
- Note
- This function is used with readData() and readStop() for optimized multiple sector reads. SPI chipSelect must be low for the entire sequence.
- Returns
- true for success or false for failure.
◆ readStop()
bool SharedSpiCard::readStop |
( |
| ) |
|
|
inherited |
End a read multiple sectors sequence.
- Returns
- true for success or false for failure.
◆ sdState()
uint8_t SharedSpiCard::sdState |
( |
| ) |
|
|
inlineinherited |
- Returns
- SD multi-sector read/write state
◆ sectorCount()
uint32_t SharedSpiCard::sectorCount |
( |
| ) |
|
|
inherited |
Determine the size of an SD flash memory card.
- Returns
- The number of 512 byte data sectors in the card or zero if an error occurs.
◆ setDedicatedSpi()
bool DedicatedSpiCard::setDedicatedSpi |
( |
bool |
value | ) |
|
Set SPI sharing state
- Parameters
-
- Returns
- true for success else false;
◆ stopTransfer()
bool SharedSpiCard::stopTransfer |
( |
| ) |
|
|
inherited |
end a mult-sector transfer.
- Returns
- true for success or false for failure.
◆ syncDevice()
bool SharedSpiCard::syncDevice |
( |
| ) |
|
|
inherited |
- Returns
- success if sync successful. Not for user apps.
◆ type()
uint8_t SharedSpiCard::type |
( |
| ) |
const |
|
inlineinherited |
Return the card type: SD V1, SD V2 or SDHC/SDXC
- Returns
- 0 - SD V1, 1 - SD V2, or 3 - SDHC/SDXC.
◆ writeData()
bool SharedSpiCard::writeData |
( |
const uint8_t * |
src | ) |
|
|
inherited |
Write one data sector in a multiple sector write sequence.
- Parameters
-
[in] | src | Pointer to the location of the data to be written. |
- Returns
- true for success or false for failure.
◆ writeSector()
bool DedicatedSpiCard::writeSector |
( |
uint32_t |
sector, |
|
|
const uint8_t * |
src |
|
) |
| |
Write a 512 byte sector to an SD card.
- Parameters
-
[in] | sector | Logical sector to be written. |
[in] | src | Pointer to the location of the data to be written. |
- Returns
- true for success or false for failure.
◆ writeSectors()
bool DedicatedSpiCard::writeSectors |
( |
uint32_t |
sector, |
|
|
const uint8_t * |
src, |
|
|
size_t |
ns |
|
) |
| |
Write multiple 512 byte sectors to an SD card.
- Parameters
-
[in] | sector | Logical sector to be written. |
[in] | ns | Number of sectors to be written. |
[in] | src | Pointer to the location of the data to be written. |
- Returns
- true for success or false for failure.
◆ writeStart()
bool SharedSpiCard::writeStart |
( |
uint32_t |
sector | ) |
|
|
inherited |
Start a write multiple sectors sequence.
- Parameters
-
[in] | sector | Address of first sector in sequence. |
- Note
- This function is used with writeData() and writeStop() for optimized multiple sector writes.
- Returns
- true for success or false for failure.
◆ writeStop()
bool SharedSpiCard::writeStop |
( |
| ) |
|
|
inherited |
End a write multiple sectors sequence.
- Returns
- true for success or false for failure.
◆ IDLE_STATE
const uint8_t SharedSpiCard::IDLE_STATE = 0 |
|
staticinherited |
◆ READ_STATE
const uint8_t SharedSpiCard::READ_STATE = 1 |
|
staticinherited |
SD is in multi-sector read state.
◆ WRITE_STATE
const uint8_t SharedSpiCard::WRITE_STATE = 2 |
|
staticinherited |
SD is in multi-sector write state.
The documentation for this class was generated from the following files:
- ArduinoSdFat/libraries/SdFat/src/SdCard/SdSpiCard.h
- ArduinoSdFat/libraries/SdFat/src/SdCard/SdSpiCard.cpp