AIROC™ BTSDK v4.9 - Documentation | ||||
> More...
Typedefs | |
typedef struct _wiced_trans_buffer_pool_t | wiced_transport_buffer_pool_t |
AIROC Transport Internal Buffer Pool structure. | |
typedef void(* | wiced_transport_status_handler_t )(wiced_transport_type_t type) |
AIROC Transport Status Handler. More... | |
typedef uint32_t(* | wiced_tranport_data_handler_t )(uint8_t *p_data, uint32_t data_len) |
AIROC Transport Data Handler. More... | |
typedef void(* | wiced_transport_tx_complete_t )(wiced_transport_buffer_pool_t *p_pool) |
AIROC Transport Transmit complete indication. More... | |
struct { | |
wiced_transport_uart_mode_t mode | |
UART mode, HCI or Raw. More... | |
uint32_t baud_rate | |
UART baud rate. More... | |
} | wiced_uart_transport_cfg_t |
UART Transport Configuration. | |
struct { | |
uint8_t dev_role | |
The SPI HW to play either master (1) or slave (2). More... | |
uint32_t spi_gpio_cfg | |
The pins to use for the data and clk lines. More... | |
uint16_t spi_pin_pull_config | |
The pin pull-up or pull-down. More... | |
uint32_t clock_speed | |
The clock speed (non-zero for master, zero for slave). More... | |
SPI_ENDIAN endian | |
The direction of the bit data flow (MSB or LSB first). More... | |
SPI_SS_POLARITY polarity | |
Active high or active low for the chip select line. More... | |
SPI_MODE mode | |
SPI mode (0-3). More... | |
uint8_t cs_pin | |
The GPIO pin of chip select line. More... | |
uint8_t slave_ready_pin | |
The GPIO pin to be used as the slave is ready. More... | |
} | wiced_spi_transport_cfg_t |
AIROC SPI Transport Configuration. | |
union { | |
wiced_uart_transport_cfg_t uart_cfg | |
wiced_spi_transport_cfg_t spi_cfg | |
} | wiced_transport_interface_cfg_t |
AIROC Transport Interface Configuration. | |
struct { | |
uint32_t buffer_size | |
uint32_t buffer_count | |
} | wiced_transport_rx_buff_pool_cfg_t |
AIROC Transport receive buffer pool configuration. More... | |
struct { | |
wiced_transport_type_t type | |
AIROC transport type. More... | |
wiced_transport_interface_cfg_t cfg | |
AIROC transport interface config. More... | |
wiced_transport_rx_buff_pool_cfg_t rx_buff_pool_cfg | |
AIROC RX buffer pool config. More... | |
wiced_transport_status_handler_t p_status_handler | |
AIROC transport status handler. More... | |
wiced_tranport_data_handler_t p_data_handler | |
AIROC transport receive data handler. More... | |
wiced_transport_tx_complete_t p_tx_complete_cback | |
AIROC transport TX complete callback. More... | |
} | wiced_transport_cfg_t |
AIROC Transport Configuration. | |
Enumerations | |
enum | wiced_transport_type_t { WICED_TRANSPORT_UART, WICED_TRANSPORT_SPI, WICED_TRANSPORT_UNDEFINED } |
AIROC Transport Types. | |
enum | wiced_transport_uart_mode_t { WICED_TRANSPORT_UART_HCI_MODE, WICED_TRANSPORT_UART_RAW_MODE } |
AIROC UART Transport Mode. | |
Functions | |
wiced_result_t | wiced_transport_init (const wiced_transport_cfg_t *p_cfg) |
Initializes and configures the transport interface and also registers the callback handlers to be invoked when receiving data, init complete, etc. More... | |
wiced_transport_buffer_pool_t * | wiced_transport_create_buffer_pool (uint32_t buffer_size, uint32_t buffer_count) |
Creates a buffer pool for the transport usage. More... | |
void * | wiced_transport_allocate_buffer (wiced_transport_buffer_pool_t *p_pool) |
Allocates a buffer from the pool. More... | |
uint32_t | wiced_transport_get_buffer_size (wiced_transport_buffer_pool_t *p_pool) |
Returns the size of the buffer in the pool. More... | |
uint32_t | wiced_transport_get_buffer_count (wiced_transport_buffer_pool_t *p_pool) |
Gets the number of buffers available in the pool. More... | |
wiced_result_t | wiced_transport_send_buffer (uint16_t code, uint8_t *p_buf, uint16_t length) |
Sends the packet to the host over the transport using the buffer allocated by the application. More... | |
void | wiced_transport_free_buffer (void *p_buf) |
Frees the transport buffer. More... | |
wiced_result_t | wiced_transport_send_data (uint16_t code, uint8_t *p_data, uint16_t length) |
Sends the packet to the host over the transport interface. More... | |
wiced_result_t | wiced_transport_send_hci_trace (wiced_transport_buffer_pool_t *hci_trans_pool, wiced_bt_hci_trace_type_t type, uint16_t length, uint8_t *p_data) |
Sends the HCI trace data over the transport. More... | |
wiced_result_t | wiced_transport_send_raw_buffer (uint8_t *p_buf, uint16_t length) |
Used when transport mode is WICED_TRANSPORT_UART_RAW_MODE. More... | |
void | wiced_set_hci_uart_cts_rts_flow_control (BOOL32 on) |
Function wiced_set_hci_uart_cts_rts_flow_control. More... | |
>
This file provides the API declarations for the AIROC Transport driver
uint32_t baud_rate |
UART baud rate.
AIROC transport interface config.
uint32_t clock_speed |
The clock speed (non-zero for master, zero for slave).
uint8_t cs_pin |
The GPIO pin of chip select line.
uint8_t dev_role |
The SPI HW to play either master (1) or slave (2).
SPI_ENDIAN endian |
The direction of the bit data flow (MSB or LSB first).
SPI_MODE mode |
UART mode, HCI or Raw.
SPI mode (0-3).
wiced_tranport_data_handler_t p_data_handler |
AIROC transport receive data handler.
wiced_transport_status_handler_t p_status_handler |
AIROC transport status handler.
wiced_transport_tx_complete_t p_tx_complete_cback |
AIROC transport TX complete callback.
SPI_SS_POLARITY polarity |
Active high or active low for the chip select line.
wiced_transport_rx_buff_pool_cfg_t rx_buff_pool_cfg |
AIROC RX buffer pool config.
uint8_t slave_ready_pin |
The GPIO pin to be used as the slave is ready.
uint32_t spi_gpio_cfg |
The pins to use for the data and clk lines.
Refer to spiffdriver.h for details;
uint16_t spi_pin_pull_config |
The pin pull-up or pull-down.
AIROC transport type.