Analog Devices Wi-Fi Software Reference Manual  Release 1.0.0
Classes | Enumerations | Functions
Transport Abstraction Layer

Transport Abstraction Layer (TAL) API. More...

Classes

struct  ADI_WIFI_TAL_DATA
 Data structure for the Wi-Fi transport layer driver. More...
 

Enumerations

enum  ADI_WIFI_TAL_RESULT {
  ADI_WIFI_TAL_SUCCESS, ADI_WIFI_TAL_FAILED_OPEN, ADI_WIFI_TAL_FAILED_CLOSE, ADI_WIFI_TAL_FAILED_TRANSACTION,
  ADI_WIFI_TAL_FAILED_CONFIGURE_BAUDRATE, ADI_WIFI_TAL_FAILED_CONFIGURE_DATA, ADI_WIFI_TAL_FAILED_FLUSH_CHANNEL
}
 

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...
 

Detailed Description

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.

Enumeration Type Documentation

§ 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.

Enumerator
ADI_WIFI_TAL_SUCCESS 

Function call completed successfully.

ADI_WIFI_TAL_FAILED_OPEN 

Transport layer failed on initialization.

ADI_WIFI_TAL_FAILED_CLOSE 

Transport layer failed on uninitialization.

ADI_WIFI_TAL_FAILED_TRANSACTION 

Transport layer failed on a data transaction.

ADI_WIFI_TAL_FAILED_CONFIGURE_BAUDRATE 

Transport layer failed to configure the baudrate.

ADI_WIFI_TAL_FAILED_CONFIGURE_DATA 

Transport layer failed to configure the data format.

ADI_WIFI_TAL_FAILED_FLUSH_CHANNEL 

Transport layer failed to flush rx channel.

Function Documentation

§ adi_wifi_tal_Init()

ADI_WIFI_TAL_RESULT adi_wifi_tal_Init ( ADI_CALLBACK  pEventCallback)

Transport layer initialization.

Sets up the transaction driver (SPI or UART).

Parameters
[in]pEventCallback: Pointer to the companion module callback function.
Returns
ADI_WIFI_TAL_RESULT

§ adi_wifi_tal_Read()

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.

Parameters
[in]pBuf: Pointer to the destination buffer.
[in]nNumBytes: Number of bytes to read.
Returns
ADI_WIFI_TAL_RESULT

§ adi_wifi_tal_Uninit()

ADI_WIFI_TAL_RESULT adi_wifi_tal_Uninit ( )

Transport layer un-initialization.

Frees transport layer driver memory.

Returns
ADI_WIFI_TAL_RESULT

§ adi_wifi_tal_Write()

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.

Parameters
[in]pBuf: Pointer to the data to write.
[in]nBufSize: Number of valid bytes in pBuf to write.
Returns
ADI_WIFI_TAL_RESULT