RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/sdcard_spi: doc cleanup to fit in 100 characters per line

Browse Source
This commit is contained in:
Gunar Schorcht 2023-05-01 14:30:03 +02:00
parent bfc2a51f70
commit 36f0162b34
1 changed files with 46 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
drivers/include/sdcard_spi.h
View File

@ -198,13 +198,15 @@ typedef struct {
/**
* @brief Initializes the sd-card with the given parameters in sdcard_spi_t structure.
* The init procedure also takes care of initializing the spi peripheral to master
* mode and performing all necessary steps to set the sd-card to spi-mode. Reading
* the CID and CSD registers is also done within this routine and their
*
* The init procedure also takes care of initializing the spi peripheral to
* master mode and performing all necessary steps to set the sd-card to spi-mode.
* Reading the CID and CSD registers is also done within this routine and their
* values are copied to the given sdcard_spi_t struct.
*
* @param[out] card the device descriptor
* @param[in] params parameters for this device (pins and spi device are initialized by this driver)
* @param[in] params parameters for this device (pins and spi device are
* initialized by this driver)
*
* @return 0 if the card could be initialized successfully
* @return false if an error occurred while initializing the card
@ -215,19 +217,22 @@ int sdcard_spi_init(sdcard_spi_t *card, const sdcard_spi_params_t *params);
* @brief Reads data blocks (usually multiples of 512 Bytes) from card to buffer.
*
* @param[in] card Initialized sd-card struct
* @param[in] blockaddr Start address to read from. Independent of the actual addressing scheme of
* the used card the address needs to be given as block address
* (e.g. 0, 1, 2... NOT: 0, 512... ). The driver takes care of mapping to
* byte addressing if needed.
* @param[out] data Buffer to store the read data in. The user is responsible for providing a
* suitable buffer size.
* @param[in] blocksize Size of data blocks. For now only 512 byte blocks are supported because
* only older (SDSC) cards support variable blocksizes anyway.
* With SDHC/SDXC-cards this is always fixed to 512 bytes. SDSC cards are
* automatically forced to use 512 byte as blocksize by the init procedure.
* @param[in] blockaddr Start address to read from. Independent of the actual
* addressing scheme of the used card the address needs
* to be given as block address (e.g. 0, 1, 2...
* NOT: 0, 512... ). The driver takes care of mapping
* to byte addressing if needed.
* @param[out] data Buffer to store the read data in. The user is
* responsible for providing a suitable buffer size.
* @param[in] blocksize Size of data blocks. For now only 512 byte blocks
* are supported because only older (SDSC) cards support
* variable blocksizes anyway. With SDHC/SDXC-cards this
* is always fixed to 512 bytes. SDSC cards are
* automatically forced to use 512 byte as blocksize by
* the init procedure.
* @param[in] nblocks Number of blocks to read
* @param[out] state Contains information about the error state if something went wrong
* (if return value is lower than nblocks).
* @param[out] state Contains information about the error state if
* something went wrong (if return value is lower than nblocks).
*
* @return number of successfully read blocks (0 if no block was read).
*/
@ -239,17 +244,21 @@ int sdcard_spi_read_blocks(sdcard_spi_t *card, uint32_t blockaddr,
* @brief Writes data blocks (usually multiples of 512 Bytes) from buffer to card.
*
* @param[in] card Initialized sd-card struct
* @param[in] blockaddr Start address to read from. Independent of the actual addressing scheme of
* the used card the address needs to be given as block address
* (e.g. 0, 1, 2... NOT: 0, 512... ). The driver takes care of mapping to
* @param[in] blockaddr Start address to read from. Independent of the actual
* addressing scheme of the used card the address needs
* to be given as block address (e.g. 0, 1, 2...
* NOT: 0, 512... ). The driver takes care of mapping to
* byte addressing if needed.
* @param[out] data Buffer that contains the data to be sent.
* @param[in] blocksize Size of data blocks. For now only 512 byte blocks are supported because
* only older (SDSC) cards support variable blocksizes anyway.
* With SDHC/SDXC-cards this is always fixed to 512 bytes. SDSC cards are
* automatically forced to use 512 byte as blocksize by the init procedure.
* @param[in] blocksize Size of data blocks. For now only 512 byte blocks
* are supported because only older (SDSC) cards support
* variable blocksizes anyway. With SDHC/SDXC-cards this
* is always fixed to 512 bytes. SDSC cards are
* automatically forced to use 512 byte as blocksize by
* the init procedure.
* @param[in] nblocks Number of blocks to write
* @param[out] state Contains information about the error state if something went wrong
* @param[out] state Contains information about the error state if
* something went wrong
* (if return value is lower than nblocks).
*
* @return number of successfully written blocks (0 if no block was written).