Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
cce-mtb-psoc6-bt-a2dp-source/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
253 lines (142 sloc)
21.1 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # PSoC™ 6 MCU: Bluetooth® Classic- A2DP source | |
| Disclaimer: This is a community code example (CCE) released for the benefit of the community users. This code example have only been tested for the listed BSPs, tools versions, and toolchains documented in this readme. They are intended to demonstrate how a solution / concept / use-case can be achieved on a particular device. For official code examples, please click [here](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software). | |
| This community code example (CCE) demonstrates streaming 48KHz, Stereo Audio with Bluetooth® classic Advanced Audio Distribution Profile (A2DP). The A2DP source profile is demonstrated in this CCE. The PSoC™ 6 is the A2DP source and external Bluetooth® speaker/earbuds is the A2DP sink. | |
| ## Requirements | |
| - [ModusToolbox™ software](https://www.infineon.com/modustoolbox) v3.1 or later (tested with v3.1) | |
| - Board support package (BSP) minimum required version: 4.0.0 or later (tested with 4.2.0) | |
| - Programming language: C | |
| - Associated parts: All [PSoC™ 6 MCU](https://www.infineon.com/cms/en/product/microcontroller/32-bit-psoc-arm-cortex-microcontroller/psoc-6-32-bit-arm-cortex-m4-mcu/) with [AIROC™ CYW43xxx Wi-Fi & Bluetooth® combo chips](https://www.infineon.com/cms/en/product/wireless-connectivity/airoc-wi-fi-plus-bluetooth-combos/) | |
| ## Supported toolchains (make variable 'TOOLCHAIN') | |
| - GNU Arm® embedded compiler v10.3.1 (`GCC_ARM`) - Default value of `TOOLCHAIN` | |
| ## Supported kits (make variable 'TARGET') | |
| - [PSoC™ 62S2 Wi-Fi Bluetooth® Prototyping Kit](https://www.infineon.com/CY8CPROTO-062S2-43439) (`CY8CPROTO-062S2-43439`) – Default value of `TARGET` | |
| - [PSoC™ 6 Wi-Fi Bluetooth® Prototyping Kit](https://www.infineon.com/CY8CPROTO-062-4343W) (`CY8CPROTO-062-4343W`) | |
| - [PSoC™ 62S2 Wi-Fi Bluetooth® Pioneer Kit](https://www.infineon.com/CY8CKIT-062S2-43012) (`CY8CKIT-062S2-43012`) | |
| ## Hardware setup | |
| This example requires an External Bluetooth® (A2DP) Speaker/earbuds. Power on the speaker/earbuds and keep it ready to be connected from PSoC™ 6 kit. | |
| This application is tested with Bluetooth v5.0 audio devices. Here are a few headset/speaker models using which this application is tested - JBL Tune 215BT earbuds, OnePlus Bulltes Wireless Z2 earbuds, INFINITY FUZE PINT speaker. | |
| ## Software setup | |
| Install a terminal emulator if you don't have one. Instructions in this document use [Tera Term](https://ttssh2.osdn.jp/index.html.en). | |
| This example requires no additional software or tools. | |
| ## Using the code example | |
| Create the project and open it using one of the following: | |
| <details><summary><b>In Eclipse IDE for ModusToolbox™ software</b></summary> | |
| 1. Click the **New Application** link in the **Quick Panel** (or, use **File** > **New** > **ModusToolbox™ Application**). This launches the [Project Creator](https://www.infineon.com/ModusToolboxProjectCreator) tool. | |
| 2. Pick a kit supported by the code example from the list shown in the **Project Creator - Choose Board Support Package (BSP)** dialog. | |
| When you select a supported kit, the example is reconfigured automatically to work with the kit. To work with a different supported kit later, use the [Library Manager](https://www.infineon.com/ModusToolboxLibraryManager) to choose the BSP for the supported kit. You can use the Library Manager to select or update the BSP and firmware libraries used in this application. To access the Library Manager, click the link from the **Quick Panel**. | |
| You can also just start the application creation process again and select a different kit. | |
| If you want to use the application for a kit not listed here, you may need to update the source files. If the kit does not have the required resources, the application may not work. | |
| 3. In the **Project Creator - Select Application** dialog, choose the example by enabling the checkbox. | |
| 4. (Optional) Change the suggested **New Application Name**. | |
| 5. The **Application(s) Root Path** defaults to the Eclipse workspace which is usually the desired location for the application. If you want to store the application in a different location, you can change the *Application(s) Root Path* value. Applications that share libraries should be in the same root path. | |
| 6. Click **Create** to complete the application creation process. | |
| For more details, see the [Eclipse IDE for ModusToolbox™ software user guide](https://www.infineon.com/MTBEclipseIDEUserGuide) (locally available at *{ModusToolbox™ install directory}/docs_{version}/mt_ide_user_guide.pdf*). | |
| </details> | |
| <details><summary><b>In command-line interface (CLI)</b></summary> | |
| ModusToolbox™ software provides the Project Creator as both a GUI tool and the command line tool, "project-creator-cli". The CLI tool can be used to create applications from a CLI terminal or from within batch files or shell scripts. This tool is available in the *{ModusToolbox™ software install directory}/tools_{version}/project-creator/* directory. | |
| Use a CLI terminal to invoke the "project-creator-cli" tool. On Windows, use the command line "modus-shell" program provided in the ModusToolbox™ software installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ software tools. You can access it by typing `modus-shell` in the search box in the Windows menu. In Linux and macOS, you can use any terminal application. | |
| This tool has the following arguments: | |
| Argument | Description | Required/optional | |
| ---------|-------------|----------- | |
| `--board-id` | Defined in the `<id>` field of the [BSP](https://github.com/Infineon?q=bsp-manifest&type=&language=&sort=) manifest | Required | |
| `--app-id` | Defined in the `<id>` field of the [CE](https://github.com/Infineon?q=ce-manifest&type=&language=&sort=) manifest | Required | |
| `--target-dir`| Specify the directory in which the application is to be created if you prefer not to use the default current working directory | Optional | |
| `--user-app-name`| Specify the name of the application if you prefer to have a name other than the example's default name | Optional | |
| <br /> | |
| **Note:** The project-creator-cli tool uses the `git clone` and `make getlibs` commands to fetch the repository and import the required libraries. For details, see the "Project creator tools" section of the [ModusToolbox™ software user guide](https://www.infineon.com/dgdl/Infineon-ModusToolbox_User_Guide-Software-v02_40-EN.pdf?fileId=8ac78c8c7e7124d1017e9149bd391590) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*). | |
| To work with a different supported kit later, use the [Library Manager](https://www.infineon.com/ModusToolboxLibraryManager) to choose the BSP for the supported kit. You can invoke the Library Manager GUI tool from the terminal using `make modlibs` command or use the Library Manager CLI tool "library-manager-cli" to change the BSP. | |
| The "library-manager-cli" tool has the following arguments: | |
| Argument | Description | Required/optional | |
| ---------|-------------|----------- | |
| `--add-bsp-name` | Name of the BSP that should be added to the application | Required | |
| `--set-active-bsp` | Name of the BSP that should be as active BSP for the application | Required | |
| `--add-bsp-version`| Specify the version of the BSP that should be added to the application if you do not wish to use the latest from manifest | Optional | |
| `--add-bsp-location`| Specify the location of the BSP (local/shared) if you prefer to add the BSP in a shared path | Optional | |
| <br /> | |
| Following example adds the CY8CPROTO-062-4343W BSP to the already created application and makes it the active BSP for the app: | |
| ``` | |
| library-manager-cli --project "C:/mtb_projects/MyHelloWorld" --add-bsp-name CY8CPROTO-062-4343W --add-bsp-version "latest-v4.X" --add-bsp-location "local" | |
| library-manager-cli --project "C:/mtb_projects/MyHelloWorld" --set-active-bsp APP_CY8CPROTO-062-4343W | |
| ``` | |
| </details> | |
| <details><summary><b>In third-party IDEs</b></summary> | |
| Use one of the following options: | |
| - **Use the standalone [Project Creator](https://www.infineon.com/ModusToolboxProjectCreator) tool:** | |
| 1. Launch Project Creator from the Windows Start menu or from *{ModusToolbox™ software install directory}/tools_{version}/project-creator/project-creator.exe*. | |
| 2. In the initial **Choose Board Support Package** screen, select the BSP, and click **Next**. | |
| 3. In the **Select Application** screen, select the appropriate IDE from the **Target IDE** drop-down menu. | |
| 4. Click **Create** and follow the instructions printed in the bottom pane to import or open the exported project in the respective IDE. | |
| <br /> | |
| - **Use command-line interface (CLI):** | |
| 1. Follow the instructions from the **In command-line interface (CLI)** section to create the application, and then import the libraries using the `make getlibs` command. | |
| 2. Export the application to a supported IDE using the `make <ide>` command. | |
| 3. Follow the instructions displayed in the terminal to create or import the application as an IDE project. | |
| For a list of supported IDEs and more details, see the "Exporting to IDEs" section of the [ModusToolbox™ software user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*). | |
| </details> | |
| ## Operation | |
| 1. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector. | |
| 2. Open a terminal program and select the KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud. | |
| 3. Program the board using one of the following: | |
| <details><summary><b>Using Eclipse IDE for ModusToolbox™ software</b></summary> | |
| 1. Select the application project in the Project Explorer. | |
| 2. In the **Quick Panel**, scroll down, and click **\<Application Name> Program (KitProg3_MiniProg4)**. | |
| </details> | |
| <details><summary><b>Using CLI</b></summary> | |
| From the terminal, execute the `make program` command to build and program the application using the default toolchain to the default target. The default toolchain is specified in the application's Makefile but you can override this value manually: | |
| ``` | |
| make program TOOLCHAIN=<toolchain> | |
| ``` | |
| Example: | |
| ``` | |
| make program TOOLCHAIN=GCC_ARM | |
| ``` | |
| </details> | |
| 4. After programming, the application starts automatically. Confirm that "PSoC™ 6 MCU: Bluetooth® Classic- A2DP source" is displayed on the UART terminal. | |
| 5. Confirm that "Do you want to skip the Bluetooth Speaker/Earbuds scan and directly enter the address of the Bluetooth Speaker/Earbuds (Y/N) ?" is displayed on the UART terminal as shown in **Figure 1**. Enter "Y"/"y" (YES) to skip the Bluetooth® speaker/earbuds scan or enter "N"/"n" (NO) to start the Bluetooth® speaker/earbuds scan. | |
| **Figure 1. Waiting for the user response to skip the Bluetooth® speaker/earbuds scan** | |
|  | |
| 6. After giving response on the UART terminal. Confirm that the user LED toggles approximately at a 1 second interval. | |
| 7. If you entered "Y"/"y" (YES), it will start scan and print all the advertising Bluetooth® speaker/earbuds, once the scanning is completed and confirm that "Enter the Bluetooth Device Address of the Speaker/Earbuds (XX XX XX XX XX XX) :" is displayed on the UART terminal as shown in **Figure 2**. | |
| **Figure 2. Scan and print the advertising Bluetooth® speaker/earbuds** | |
|  | |
| 8. If you entered "N"/"n" (NO), then confirm that "Enter the Bluetooth Device Address of the Speaker/Earbuds (XX XX XX XX XX XX) :" is displayed on the UART terminal as shown in **Figure 3**. | |
| **Figure 3. Directly enter the Bluetooth® Device Address** | |
|  | |
| 9. Enter the Bluetooth® speaker/earbuds device address on the UART terminal. | |
| 10. After entering the Bluetooth® speaker/earbuds device address on the UART terminal. Confirm that "Do you want to connect to the Bluetooth Speaker/Earbuds (Y/N) ?" is displayed on the UART terminal as shown in **Figure 4**. | |
| **Figure 4. Waiting for the user response to connect to the Bluetooth® speaker/earbuds** | |
|  | |
| 11. If you entered "N"/"n" (NO), then it will again display the "Enter the Bluetooth Device Address of the Speaker/Earbuds (XX XX XX XX XX XX) :" on the UART terminal per **Step 9** and follow again from the **Step 9**. | |
| 12. If you entered "Y"/"y" (YES), then it will connect to the Bluetooth® speaker/earbuds. | |
| 13. The UART terminal displays the message as shown in **Figure 5**. If connection is successful, pressing the user-button will start the music playback. | |
| **Figure 5. Successfully connected to the Bluetooth® speaker/earbuds** | |
|  | |
| 14. Pressing the user-button again will pause the playback. | |
| 15. Then the user LED will change to toggles approximately at a 100-millisecond interval on successful connection to the Bluetooth® speaker/earbuds. | |
| On disconnection, it will switch back to toggles approximately at a 1 second interval. | |
| 16. If the Bluetooth® speaker/earbuds is disconnected, to reconnect back, please reset the PSoC™ 6 board. | |
| 17. If there is a connection failure with Bluetooth® speaker/earbuds, please reset the PSoC™ 6 board and the Bluetooth® speaker/earbuds. | |
| ## Debugging | |
| You can debug the example to step through the code. In the IDE, use the **\<Application Name> Debug (KitProg3_MiniProg4)** configuration in the **Quick Panel**. For details, see the "Program and debug" section in the [Eclipse IDE for ModusToolbox™ software user guide](https://www.infineon.com/dgdl/Infineon-ModusToolbox_User_Guide-Software-v02_40-EN.pdf?fileId=8ac78c8c7e7124d1017e9149bd391590). | |
| **Note:** **(Only while debugging)** On the CM4 CPU, some code in `main()` may execute before the debugger halts at the beginning of `main()`. This means that some code executes twice - once before the debugger stops execution, and again after the debugger resets the program counter to the beginning of `main()`. See [KBA231071](https://community.infineon.com/t5/Knowledge-Base-Articles/PSoC-6-MCU-Code-in-main-executes-before-the-debugger-halts-at/ta-p/253856) to learn about this and for the workaround. | |
| ## Design and implementation | |
| This CCE, demonstrates A2DP source on PSoC™ 6. Two tasks are created, one for initial Bluetooth® connection setup and another for streaming audio via A2DP. | |
| A short audio clip with PCM (Pulse-Code Modulation) samples stored as char arrays is available in the source code. The audio clip is of 48KHz, 16 bit, stereo audio. This audio clip is passed through a software codec that converts from PCM to SBC (sub-band coding) encoding. | |
| On connection establishment, the PSoC™ 6 configures the Bluetooth® speaker/earbuds to 48KHz, stereo with the appropriate SBC parameters. | |
| The streaming task sends the encoded packets using `wiced_bt_avdt_write_req` to send packets to the Bluetooth® Controller which then sends it to the Bluetooth® speaker/earbuds. | |
| The A2DP source on PSoC™ 6 is configured to work on Bluetooth® speaker/earbuds which supports 48KHz. | |
| ## Other resources | |
| Infineon provides a wealth of data at [www.Infineon.com](http://www.infineon.com/) to help you select the right device, and quickly and effectively integrate it into your design. | |
| For PSoC™ 6 MCU devices, see [How to design with PSoC™ 6 MCU - KBA223067](https://community.infineon.com/docs/DOC-14644) in the Infineon community. | |
| ## Document history | |
| Document title: *002-37317 - PSoC 6 MCU: Streaming Audio with BT Classic A2DP source profile* | |
| | Version | Description of change | | |
| | ------- | -------------------------- | | |
| | 1.0.0 | New community code example | | |
| | 1.1.0 | Added support for the CY8CPROTO-062S2-43439 kit | | |
| --------------------------------------------------------- | |
| © Cypress Semiconductor Corporation, 2023-2024. This document is the property of Cypress Semiconductor Corporation, an Infineon Technologies company, and its affiliates ("Cypress"). This document, including any software or firmware included or referenced in this document ("Software"), is owned by Cypress under the intellectual property laws and treaties of the United States and other countries worldwide. Cypress reserves all rights under such laws and treaties and does not, except as specifically stated in this paragraph, grant any license under its patents, copyrights, trademarks, or other intellectual property rights. If the Software is not accompanied by a license agreement and you do not otherwise have a written agreement with Cypress governing the use of the Software, then Cypress hereby grants you a personal, non-exclusive, nontransferable license (without the right to sublicense) (1) under its copyright rights in the Software (a) for Software provided in source code form, to modify and reproduce the Software solely for use with Cypress hardware products, only internally within your organization, and (b) to distribute the Software in binary code form externally to end users (either directly or indirectly through resellers and distributors), solely for use on Cypress hardware product units, and (2) under those claims of Cypress’s patents that are infringed by the Software (as provided by Cypress, unmodified) to make, use, distribute, and import the Software solely for use with Cypress hardware products. Any other use, reproduction, modification, translation, or compilation of the Software is prohibited. | |
| <br /> | |
| TO THE EXTENT PERMITTED BY APPLICABLE LAW, CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS DOCUMENT OR ANY SOFTWARE OR ACCOMPANYING HARDWARE, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. No computing device can be absolutely secure. Therefore, despite security measures implemented in Cypress hardware or software products, Cypress shall have no liability arising out of any security breach, such as unauthorized access to or use of a Cypress product. CYPRESS DOES NOT REPRESENT, WARRANT, OR GUARANTEE THAT CYPRESS PRODUCTS, OR SYSTEMS CREATED USING CYPRESS PRODUCTS, WILL BE FREE FROM CORRUPTION, ATTACK, VIRUSES, INTERFERENCE, HACKING, DATA LOSS OR THEFT, OR OTHER SECURITY INTRUSION (collectively, "Security Breach"). Cypress disclaims any liability relating to any Security Breach, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any Security Breach. In addition, the products described in these materials may contain design defects or errors known as errata which may cause the product to deviate from published specifications. To the extent permitted by applicable law, Cypress reserves the right to make changes to this document without further notice. Cypress does not assume any liability arising out of the application or use of any product or circuit described in this document. Any information provided in this document, including any sample design information or programming code, is provided only for reference purposes. It is the responsibility of the user of this document to properly design, program, and test the functionality and safety of any application made of this information and any resulting product. "High-Risk Device" means any device or system whose failure could cause personal injury, death, or property damage. Examples of High-Risk Devices are weapons, nuclear installations, surgical implants, and other medical devices. "Critical Component" means any component of a High-Risk Device whose failure to perform can be reasonably expected to cause, directly or indirectly, the failure of the High-Risk Device, or to affect its safety or effectiveness. Cypress is not liable, in whole or in part, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any use of a Cypress product as a Critical Component in a High-Risk Device. You shall indemnify and hold Cypress, including its affiliates, and its directors, officers, employees, agents, distributors, and assigns harmless from and against all claims, costs, damages, and expenses, arising out of any claim, including claims for product liability, personal injury or death, or property damage arising from any use of a Cypress product as a Critical Component in a High-Risk Device. Cypress products are not intended or authorized for use as a Critical Component in any High-Risk Device except to the limited extent that (i) Cypress’s published data sheet for the product explicitly states Cypress has qualified the product for use in a specific High-Risk Device, or (ii) Cypress has given you advance written authorization to use the product as a Critical Component in the specific High-Risk Device and you have signed a separate indemnification agreement. | |
| <br /> | |
| Cypress, the Cypress logo, and combinations thereof, WICED, ModusToolbox, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress or a subsidiary of Cypress in the United States or in other countries. For a more complete list of Cypress trademarks, visit www.infineon.com. Other names and brands may be claimed as property of their respective owners. |