README.md

AIROC™ Bluetooth® Host Stack solution (for FreeRTOS)

Overview

AIROC™ Bluetooth® host stack solution includes Bluetooth® stack library, Bluetooth® controller firmware and platform/os porting layer. Bluetooth® stack library is designed for embedded device, it consumes less RAM/ROM usage but still keeps high performance. With AIROC™ Bluetooth® API set, application developers can use them easily to create their own application. The porting layer is implemented by CYHAL and CY_RTOS_AL (Hardware/Operation System Adaptation Layer), hence it can adapt to Cypress platforms, and easy to port to other vendor's platform.

Platform HCI transport config

Besides of stack settings, HCI configuration is also required to specify, including pins, format and UART baudrate. Please refer to cybt_platform_config.h for more detail:

• structure cybt_platform_config_t
• API cybt_platform_config_init( )

The API cybt_platform_config_init( ) shall be invoked prior to wiced_bt_stack_init( )

How to enable trace log?

• Compile time definition: Please refer to cybt_platform_trace.h which can set individual trace log level
  • Application makefile add DEFINES+=CYBT_PLATFORM_TRACE_ENABLE=0 to disable debug log
  • Application makefile add DEFINES+=CYBT_PLATFORM_TRACE_ENABLE=1 to enable debug log
  • Default set all category is CYBT_TRACE_LEVEL_ERROR
• Run time update: Dynamic set trace level by using API cybt_platform_set_trace_level(id, level);
  • For example: set all catoegories as debug level

    cybt_platform_set_trace_level(CYBT_TRACE_ID_ALL, CYBT_TRACE_LEVEL_DEBUG);
    

How to enable BTSpy logs?

• BTSpy is a trace utility that can be used in the AIROC™ Bluetooth® platforms to view protocol and generic trace messages from the embedded device
• Add macro ENABLE_BT_SPY_LOG in Makefile or command line
  • DEFINES+=ENABLE_BT_SPY_LOG
• Call cybt_debug_uart_init(&debug_uart_configuration, NULL);
  • The first argument is the debug_uart_configurations structure pointer, which has hardware pin configurations along with baud_rate and flow_control configurations. Recommended baudrate is 3000000, although 115200 is also supported by the BTSpy tool. The second argument is an optional callback function which can be set to NULL
  • Ensure retarget-io is not enabled on the same UART port as BTSpy. There is no need to initialize the retarget-io libray if the application wants to send both application messages and BT protocol traces to the same port through BTSpy
  • Compiler directives can be used to either initialize the retarget-io library or BTSpy logs depending on the debug macro setting. For example:

    #ifdef ENABLE_BT_SPY_LOG
       {
           #define DEBUG_UART_BAUDRATE 3000000
           #define DEBUG_UART_RTS        (P5_2)
           #define DEBUG_UART_CTS        (P5_3)
           cybt_debug_uart_config_t debug_uart_config = {
                   .uart_tx_pin = CYBSP_DEBUG_UART_TX,
                   .uart_rx_pin = CYBSP_DEBUG_UART_RX,
                   .uart_cts_pin = DEBUG_UART_CTS,
                   .uart_rts_pin = DEBUG_UART_RTS,
                   .baud_rate = DEBUG_UART_BAUDRATE,
                   .flow_control = TRUE
           };
           cybt_debug_uart_init(&debug_uart_config, NULL);
       }
    #else
       cy_retarget_io_init(CYBSP_DEBUG_UART_TX, CYBSP_DEBUG_UART_RX, CY_RETARGET_IO_BAUDRATE);
    #endif
    

• Download and use BTSPY
  • Click on serial port setup
  • Select "Enable Serial Port"
  • Select the corrct baudrate, port number and enable HW flow control

Working flow

~ release-v1.3.0

• Porting layer create 2 tasks
  • HCI task which handles HCI packet transmission and reception
  • BTU/BT task which handles Bluetooth® core stack and profiles
• TX path:
  • Bluetooth® stack calls pf_write_xxx_to_lower( ) with packet data
  • Inside those functions,
    • Allocate memory from porting layer heap for the TX packet
    • Put TX packet into HCI task queue
  • HCI task gets TX packet from the queue then write the same to HCI UART
• RX path:
  • UART driver fires the interrupt when data was coming from Bluetooth® controller
  • In IRQ handler, put the related message to HCI task queue
  • Once HCI task gets the message,
    • Allocate memory from porting layer heap, read the packet from UART and write the same to the allocated memory
    • Put RX packet into Bluetooth® task queue.
  • Bluetooth® task gets RX packet then calls wiced_bt_process_xxx() to notify Bluetooth® stack

since release-v2.0.0

• Porting layer create 2 tasks
  • HCI_TX task which handles HCI packet from Bluetooth® stack to Bluetooth® controller
  • HCI_RX task which handles HCI packet from Bluetooth® controller to Bluetooth® stack
• TX path:
  • Bluetooth® stack calls pf_write_xxx_to_lower() with packet data
  • Inside those functions,
    • Allocate memory from porting layer heap for the TX packet
    • Put TX packet into HCI_TX task queue
  • HCI_TX task gets TX packet from the queue then write the same to HCI UART
• RX path:
  • UART driver fires the interrupt when data was coming from Bluetooth® controller
  • In IRQ handler, put the related message to HCI_RX task queue
  • Once HCI_RX task gets the message,
    • Read the packet from UART and write the same to the static buffer
    • Call wiced_bt_process_xxx() to notify Bluetooth® stack

API Reference Manual

• Bluetooth® platform API manual
• Bluetooth® stack BLE API manual

© Infineon Technologies, 2019.