transfer associated with transaction
More...
#include "distortos/devices/memory/SdMmcCardLowLevel.hpp"
transfer associated with transaction
◆ Transfer() [1/3]
constexpr distortos::devices::SdMmcCardLowLevel::Transfer::Transfer |
( |
| ) |
|
|
inline |
Transfer's constructor.
Used when no transfer is associated with transaction.
◆ Transfer() [2/3]
constexpr distortos::devices::SdMmcCardLowLevel::Transfer::Transfer |
( |
void *const |
readBuffer, |
|
|
const size_t |
size, |
|
|
const size_t |
blockSize, |
|
|
const uint16_t |
timeoutMs |
|
) |
| |
|
inline |
Transfer's constructor.
Used when read transfer is associated with transaction.
- Parameters
-
[out] | readBuffer | is the buffer into which the data will be read |
[in] | size | is the size of readBuffer, bytes, must be a multiple of block size |
[in] | blockSize | is the block size, bytes |
[in] | timeoutMs | is the timeout of read transfer, milliseconds |
◆ Transfer() [3/3]
constexpr distortos::devices::SdMmcCardLowLevel::Transfer::Transfer |
( |
const void *const |
writeBuffer, |
|
|
const size_t |
size, |
|
|
const size_t |
blockSize, |
|
|
const uint16_t |
timeoutMs |
|
) |
| |
|
inline |
Transfer's constructor.
Used when write transfer is associated with transaction.
- Parameters
-
[in] | writeBuffer | is the buffer with data that will be written |
[in] | size | is the size of writeBuffer, bytes, must be a multiple of block size |
[in] | blockSize | is the block size, bytes |
[in] | timeoutMs | is the timeout of write transfer, milliseconds |
◆ getBlockSize()
size_t distortos::devices::SdMmcCardLowLevel::Transfer::getBlockSize |
( |
| ) |
const |
|
inline |
◆ getReadBuffer()
void* distortos::devices::SdMmcCardLowLevel::Transfer::getReadBuffer |
( |
| ) |
const |
|
inline |
- Returns
- buffer into which the data will be read, valid only if isWriteTransfer() returns false
◆ getSize()
size_t distortos::devices::SdMmcCardLowLevel::Transfer::getSize |
( |
| ) |
const |
|
inline |
- Returns
- size of read buffer or write buffer, bytes
◆ getTimeoutMs()
uint16_t distortos::devices::SdMmcCardLowLevel::Transfer::getTimeoutMs |
( |
| ) |
const |
|
inline |
- Returns
- timeout of transfer, milliseconds
◆ getWriteBuffer()
const void* distortos::devices::SdMmcCardLowLevel::Transfer::getWriteBuffer |
( |
| ) |
const |
|
inline |
- Returns
- buffer with data that will be written, valid only if isWriteTransfer() returns true
◆ isWriteTransfer()
bool distortos::devices::SdMmcCardLowLevel::Transfer::isWriteTransfer |
( |
| ) |
const |
|
inline |
- Returns
- false if this is a read transfer, true if this is a write transfer
◆ blockSize_
size_t distortos::devices::SdMmcCardLowLevel::Transfer::blockSize_ |
|
private |
◆ readBuffer_
void* distortos::devices::SdMmcCardLowLevel::Transfer::readBuffer_ |
buffer into which the data will be read, valid only if writeTransfer_ is false
◆ size_
size_t distortos::devices::SdMmcCardLowLevel::Transfer::size_ |
|
private |
size of readBuffer_ or writeBuffer_, bytes
◆ timeoutMs_
uint16_t distortos::devices::SdMmcCardLowLevel::Transfer::timeoutMs_ |
|
private |
timeout of transfer, milliseconds
◆ writeBuffer_
const void* distortos::devices::SdMmcCardLowLevel::Transfer::writeBuffer_ |
buffer with data that will be written, valid only if writeTransfer_ is true
◆ writeTransfer_
bool distortos::devices::SdMmcCardLowLevel::Transfer::writeTransfer_ |
|
private |
selects whether this is a read (false) or write (true) transfer
The documentation for this class was generated from the following file: