Analog Devices Wi-Fi Software Reference Manual
Release 1.0.0
|
Transport Abstraction Layer (TAL) API. More...
Classes | |
struct | ADI_WIFI_TAL_DATA |
Data structure for the Wi-Fi transport layer driver. More... | |
Functions | |
ADI_WIFI_TAL_RESULT | adi_wifi_tal_Init (ADI_CALLBACK pEventCallback) |
Transport layer initialization. More... | |
ADI_WIFI_TAL_RESULT | adi_wifi_tal_Uninit () |
Transport layer un-initialization. More... | |
ADI_WIFI_TAL_RESULT | adi_wifi_tal_Write (uint8_t *const pBuf, const uint32_t nBufSize) |
Transport layer write. More... | |
ADI_WIFI_TAL_RESULT | adi_wifi_tal_Read (uint8_t *const pBuf, uint32_t nNumBytes) |
Transport layer blocking read. More... | |
Transport Abstraction Layer (TAL) API.
The set of functions in this module provide an abstraction layer between the radio (companion) module and the underlying hardware.
enum ADI_WIFI_TAL_RESULT |
The return value of all transport layer APIs returning ADI_WIFI_TAL_RESULT should always be tested at the application level for success or failure.
ADI_WIFI_TAL_RESULT adi_wifi_tal_Init | ( | ADI_CALLBACK | pEventCallback | ) |
Transport layer initialization.
Sets up the transaction driver (SPI or UART).
[in] | pEventCallback | : Pointer to the companion module callback function. |
ADI_WIFI_TAL_RESULT adi_wifi_tal_Read | ( | uint8_t *const | pBuf, |
uint32_t | nNumBytes | ||
) |
Transport layer blocking read.
Reads nNumBytes byte from the device to pBuf.
[in] | pBuf | : Pointer to the destination buffer. |
[in] | nNumBytes | : Number of bytes to read. |
ADI_WIFI_TAL_RESULT adi_wifi_tal_Uninit | ( | ) |
Transport layer un-initialization.
Frees transport layer driver memory.
ADI_WIFI_TAL_RESULT adi_wifi_tal_Write | ( | uint8_t *const | pBuf, |
const uint32_t | nBufSize | ||
) |
Transport layer write.
Writes nBufSize bytes from pBuf to the device. For the UART, this is a blocking call.
[in] | pBuf | : Pointer to the data to write. |
[in] | nBufSize | : Number of valid bytes in pBuf to write. |