cyw43012-ble-RTT/btstack-integration/COMPONENT_BLESS-IPC/docs/api_reference_manual/xml/indexpage.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.15">
  <compounddef id="indexpage" kind="page">
    <compoundname>index</compoundname>
    <title>Bluetooth Host Stack solution</title>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>#AIROC™ BT STack porting layer for PSoC6 BLESS</para>
<para><heading level="2">Overview</heading>
</para>
<para>The btstack-integration/COMPONENT_BLESS-IPC is the adaptation layer (porting layer) between AIROC™ BT STack and Cypress Abstraction Layers (CYHAL and CYOSAL). This porting layer is to be used in conjunction with Cypress PSOC 6 BLE platform where the application and host stack are running on the CM4 core of PSOC and BLESS controller FW is running on CM0 core of PSOC. The porting layer implements routines to provide OS and memory services from platform and facilitates communication with controller.</para>
<para><heading level="2">Platform HCI transport config</heading>
</para>
<para>Application shall call <bold><ref refid="group__platform__cfg_1ga1ff2a9935b27efb9639974d6ddc1894a" kindref="member">cybt_platform_config_init( )</ref></bold> API to initialize the porting layer before calling any stack API. IPC Pipe is used to communicate with the controller running on CM0 processor, hence the member variable hci_config.hci_transport of input argument <ref refid="structcybt__platform__config__t" kindref="compound">cybt_platform_config_t</ref> shall be set to CYBT_HCI_IPC. Other parameters are ignored by the porting layer.</para>
<para>Please refer to cybt_platform_config.h</para>
<para><itemizedlist>
<listitem><para>structure <bold><ref refid="structcybt__platform__config__t" kindref="compound">cybt_platform_config_t</ref></bold></para>
</listitem><listitem><para>API <bold><ref refid="group__platform__cfg_1ga1ff2a9935b27efb9639974d6ddc1894a" kindref="member">cybt_platform_config_init( )</ref></bold></para>
</listitem></itemizedlist>
</para>
<para><heading level="2">Debug uart configuration</heading>
</para>
<para>The UART on PSOC can be configured for capturing application and HCI traces by calling <bold><ref refid="group__debug__uart__cfg_1ga16bde8710d82bdc7086fa44f6103ccf3" kindref="member">cybt_debug_uart_init()</ref></bold> with appropriate configuration in <bold><ref refid="structcybt__debug__uart__config__t" kindref="compound">cybt_debug_uart_config_t</ref></bold>. Passing a valid function pointer to cybt_debug_uart_data_handler_t allows application to handle any data received over UART. However, it can be set to NULL if the application is not required to handle any data. Please refer to cybt_debug_uart.h.</para>
<para><itemizedlist>
<listitem><para>structure <bold><ref refid="structcybt__debug__uart__config__t" kindref="compound">cybt_debug_uart_config_t</ref></bold></para>
</listitem><listitem><para>API <bold><ref refid="group__debug__uart__cfg_1ga16bde8710d82bdc7086fa44f6103ccf3" kindref="member">cybt_debug_uart_init( )</ref></bold></para>
</listitem></itemizedlist>
</para>
<para><heading level="2">Design</heading>
</para>
<para><itemizedlist>
<listitem><para>To initialize BLESS controller, Porting layer will send ENABLE_CNTR_CMD IPC msg to BLESS controller module via CYPIPE IPC mechanism</para>
</listitem><listitem><para>Porting layer can receive the HCI events and Command complete events from BLESS controller module as IPC msgs via CYPIPE.</para>
</listitem><listitem><para>All received events from BLESS controller module are queued in bt_task_queue. bt_task thread in porting layer would process the msgs and make calls to BTStack for further processing.</para>
</listitem><listitem><para>Porting layer could send hci commands and data by filling IPC_HOST_MSG structure with details and call IPC_Pipe_SendMsg api with destination as CM0 address.while sending the cmds to controller, HOST has to allocate memory for the cmd and its parameters</para>
</listitem><listitem><para>The received ptrs in events from controller , can be mapped to IPC_CNTR_MSG , processed in bt_task. After processing the event , HOST needs to a post a msg to Controller to free up the memory.</para>
</listitem></itemizedlist>
</para>
<para><heading level="2">API Reference Manual</heading>
</para>
<para><itemizedlist>
<listitem><para><ulink url="https://infineon.github.io/btstack-integration/COMPONENT_BLESS-IPC/docs/api_reference_manual/html/index.html">Bluetooth platform API manual</ulink></para>
</listitem><listitem><para><ulink url="https://infineon.github.io/btstack/ble/api_reference_manual/html/index.html">Bluetooth stack BLE API manual</ulink></para>
</listitem></itemizedlist>
</para>
<para>© Infineon Technologies, 2022. </para>
    </detaileddescription>
  </compounddef>
</doxygen>