Raw SDIO access to SD and SDHC flash memory cards. More...

#include <SdioCard.h>

Inheritance diagram for SdioCard:

Collaboration diagram for SdioCard:

Public Member Functions
bool	begin ()

uint32_t	cardSize ()

bool	erase (uint32_t firstBlock, uint32_t lastBlock)

uint8_t	errorCode ()

uint32_t	errorData ()

uint32_t	errorLine ()

bool	isBusy ()

uint32_t	kHzSdClk ()

bool	readBlock (uint32_t lba, uint8_t *dst)

bool	readBlocks (uint32_t lba, uint8_t *dst, size_t nb)

bool	readCID (void *cid)

bool	readCSD (void *csd)

bool	readData (uint8_t *dst)

bool	readOCR (uint32_t *ocr)

bool	readStart (uint32_t lba)

bool	readStart (uint32_t lba, uint32_t count)

bool	readStop ()

bool	syncBlocks ()

uint8_t	type ()

bool	writeBlock (uint32_t lba, const uint8_t *src)

bool	writeBlocks (uint32_t lba, const uint8_t *src, size_t nb)

bool	writeData (const uint8_t *src)

bool	writeStart (uint32_t lba)

bool	writeStart (uint32_t lba, uint32_t count)

bool	writeStop ()

Detailed Description

Raw SDIO access to SD and SDHC flash memory cards.

MIT License

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.

Member Function Documentation

◆ begin()

bool SdioCard::begin ( )

Initialize the SD card.

Returns: true for success else false.

◆ cardSize()

uint32_t SdioCard::cardSize ( )

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.

◆ erase()

bool SdioCard::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 true is returned for success and the value false is returned for failure.

◆ errorCode()

uint8_t SdioCard::errorCode ( )

Returns: code for the last error. See SdInfo.h for a list of error codes.

◆ errorData()

uint32_t SdioCard::errorData ( )

Returns: error data for last error.

◆ errorLine()

uint32_t SdioCard::errorLine ( )

Returns: error line for last error. Tmp function for debug.

◆ isBusy()

bool SdioCard::isBusy ( )

Check for busy with CMD13.

Returns: true if busy else false.

◆ kHzSdClk()

uint32_t SdioCard::kHzSdClk ( )

Returns: the SD clock frequency in kHz.

◆ readBlock()

bool SdioCard::readBlock	(	uint32_t	lba,
		uint8_t *	dst
	)

virtual

Read a 512 byte block from an SD card.

Parameters

[in]	lba	Logical block to be read.
[out]	dst	Pointer to the location that will receive the data.

Returns: The value true is returned for success and the value false is returned for failure.

Implements BaseBlockDriver.

Reimplemented in SdioCardEX.

◆ readBlocks()

bool SdioCard::readBlocks	(	uint32_t	lba,
		uint8_t *	dst,
		size_t	nb
	)

virtual

Read multiple 512 byte blocks from an SD card.

Parameters

[in]	lba	Logical block to be read.
[in]	nb	Number of blocks to be read.
[out]	dst	Pointer to the location that will receive the data.

Returns: The value true is returned for success and the value false is returned for failure.

Implements BaseBlockDriver.

Reimplemented in SdioCardEX.

◆ readCID()

bool SdioCard::readCID ( void * cid )

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 SdioCard::readCSD ( void * csd )

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 SdioCard::readData ( uint8_t * dst )

Read one data block in a multiple block read sequence

Parameters

[out] dst Pointer to the location for the data to be read.

Returns: The value true is returned for success and the value false is returned for failure.

◆ readOCR()

bool SdioCard::readOCR ( uint32_t * ocr )

Read OCR register.

Parameters

[out] ocr Value of OCR register.

Returns: true for success else false.

◆ readStart() [1/2]

bool SdioCard::readStart ( uint32_t lba )

Start a read multiple blocks sequence.

Parameters

[in] lba Address of first block in sequence.

Note: This function is used with readData() and readStop() for optimized multiple block reads. SPI chipSelect must be low for the entire sequence.

Returns: The value true is returned for success and the value false is returned for failure.

◆ readStart() [2/2]

bool SdioCard::readStart	(	uint32_t	lba,
		uint32_t	count
	)

Start a read multiple blocks sequence.

Parameters

[in]	lba	Address of first block in sequence.
[in]	count	Maximum block count.

Note: This function is used with readData() and readStop() for optimized multiple block reads. SPI chipSelect must be low for the entire sequence.

Returns: The value true is returned for success and the value false is returned for failure.

◆ readStop()

bool SdioCard::readStop ( )

End a read multiple blocks sequence.

Returns: The value true is returned for success and the value false is returned for failure.

◆ syncBlocks()

bool SdioCard::syncBlocks ( )

virtual

Returns: success if sync successful. Not for user apps.

Implements BaseBlockDriver.

Reimplemented in SdioCardEX.

◆ type()

uint8_t SdioCard::type ( )

Return the card type: SD V1, SD V2 or SDHC

Returns: 0 - SD V1, 1 - SD V2, or 3 - SDHC.

◆ writeBlock()

bool SdioCard::writeBlock	(	uint32_t	lba,
		const uint8_t *	src
	)

virtual

Writes a 512 byte block to an SD card.

Parameters

[in]	lba	Logical block to be written.
[in]	src	Pointer to the location of the data to be written.

Returns: The value true is returned for success and the value false is returned for failure.

Implements BaseBlockDriver.

Reimplemented in SdioCardEX.

◆ writeBlocks()

bool SdioCard::writeBlocks	(	uint32_t	lba,
		const uint8_t *	src,
		size_t	nb
	)

virtual

Write multiple 512 byte blocks to an SD card.

Parameters

[in]	lba	Logical block to be written.
[in]	nb	Number of blocks to be written.
[in]	src	Pointer to the location of the data to be written.

Returns: The value true is returned for success and the value false is returned for failure.

Implements BaseBlockDriver.

Reimplemented in SdioCardEX.

◆ writeData()

bool SdioCard::writeData ( const uint8_t * src )

Write one data block in a multiple block write sequence.

Parameters

[in] src Pointer to the location of the data to be written.

Returns: The value true is returned for success and the value false is returned for failure.

◆ writeStart() [1/2]

bool SdioCard::writeStart ( uint32_t lba )

Start a write multiple blocks sequence.

Parameters

[in] lba Address of first block in sequence.

Note: This function is used with writeData() and writeStop() for optimized multiple block writes.

Returns: The value true is returned for success and the value false is returned for failure.

◆ writeStart() [2/2]

bool SdioCard::writeStart	(	uint32_t	lba,
		uint32_t	count
	)

Start a write multiple blocks sequence.

Parameters

[in]	lba	Address of first block in sequence.
[in]	count	Maximum block count.

Note: This function is used with writeData() and writeStop() for optimized multiple block writes.

Returns: The value true is returned for success and the value false is returned for failure.

◆ writeStop()

bool SdioCard::writeStop ( )

End a write multiple blocks sequence.

Returns: The value true is returned for success and the value false is returned for failure.

The documentation for this class was generated from the following file:

Arduino/libraries/SdFat/src/SdCard/SdioCard.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ begin()

◆ cardSize()

◆ erase()

◆ errorCode()

◆ errorData()

◆ errorLine()

◆ isBusy()

◆ kHzSdClk()

◆ readBlock()

◆ readBlocks()

◆ readCID()

◆ readCSD()

◆ readData()

◆ readOCR()

◆ readStart() [1/2]

◆ readStart() [2/2]

◆ readStop()

◆ syncBlocks()

◆ type()

◆ writeBlock()

◆ writeBlocks()

◆ writeData()

◆ writeStart() [1/2]

◆ writeStart() [2/2]

◆ writeStop()