search

Infineon / mtb-example-psoc6-dual-cpu-empty-app

This is a minimal starter Dual-CPU application template for PSoC 6 MCU devices.
Other
0 stars 1 forks source link
cy8ceval-062s2 cy8ceval-062s2-cyw43022cub cy8ceval-062s2-lai-43439m2 cy8ceval-062s2-lai-4373m2 cy8ceval-062s2-mur-43439m2 cy8ceval-062s2-mur-4373em2 cy8ceval-062s2-mur-4373m2 cy8ckit-062-ble cy8ckit-062-wifi-bt cy8ckit-062s2-43012 cy8ckit-062s4 cy8cproto-062-4343w cy8cproto-062s2-43439 cy8cproto-062s3-4343w cy8cproto-063-ble cysbsyskit-dev-01 cyw9p62s1-43012evb-01 cyw9p62s1-43438evb-01 getting-started

readme

PSoC™ 6 MCU: Dual-CPU empty application template

This is a minimal starter dual-CPU application template for PSoC™ 6 MCU devices.

View this README on GitHub.

Provide feedback on this code example.

Requirements

Supported toolchains (make variable 'TOOLCHAIN')

Supported kits (make variable 'TARGET')

Hardware setup

This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly.

Note: The PSoC™ 6 Bluetooth® LE Pioneer Kit (CY8CKIT-062-BLE) and the PSoC™ 6 Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-062-WIFI-BT) ship with KitProg2 installed. ModusToolbox™ requires KitProg3. Before using this code example, make sure that the board is upgraded to KitProg3. The tool and instructions are available in the Firmware Loader GitHub repository. If you do not upgrade, you will see an error like "unable to find CMSIS-DAP device" or "KitProg firmware is out of date".

Software setup

Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.

This example requires no additional software or tools.

Using the code example

Create the project

The ModusToolbox™ tools package provides the Project Creator as both a GUI tool and a command line tool.

Use Project Creator GUI 1. Open the Project Creator GUI tool. There are several ways to do this, including launching it from the dashboard or from inside the Eclipse IDE. For more details, see the [Project Creator user guide](https://www.infineon.com/ModusToolboxProjectCreator) (locally available at *{ModusToolbox™ install directory}/tools_{version}/project-creator/docs/project-creator.pdf*). 2. On the **Choose Board Support Package (BSP)** page, select a kit supported by this code example. See [Supported kits](#supported-kits-make-variable-target). > **Note:** To use this code example 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. On the **Select Application** page: a. Select the **Applications(s) Root Path** and the **Target IDE**. > **Note:** Depending on how you open the Project Creator tool, these fields may be pre-selected for you. b. Select this code example from the list by enabling its check box. > **Note:** You can narrow the list of displayed examples by typing in the filter box. c. (Optional) Change the suggested **New Application Name** and **New BSP Name**. d. Click **Create** to complete the application creation process.
Use Project Creator CLI The 'project-creator-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™ 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™ installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox™ 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. The following example clones the "[mtb-example-wifi-scan](https://github.com/Infineon/mtb-example-wifi-scan)" application with the desired name "WifiScan" configured for the *CY8CPROTO-062S2-43439* BSP into the specified working directory, *C:/mtb_projects*: ``` project-creator-cli --board-id CY8CPROTO-062S2-43439 --app-id mtb-example-mtb-example-wifi-scan --user-app-name WifiScan --target-dir "C:/mtb_projects" ``` The 'project-creator-cli' tool has the following arguments: Argument | Description | Required/optional ---------|-------------|----------- `--board-id` | Defined in the field of the [BSP](https://github.com/Infineon?q=bsp-manifest&type=&language=&sort=) manifest | Required `--app-id` | Defined in the 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 > **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™ tools package user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).

Open the project

After the project has been created, you can open it in your preferred development environment.

Eclipse IDE If you opened the Project Creator tool from the included Eclipse IDE, the project will open in Eclipse automatically. For more details, see the [Eclipse IDE for ModusToolbox™ user guide](https://www.infineon.com/MTBEclipseIDEUserGuide) (locally available at *{ModusToolbox™ install directory}/docs_{version}/mt_ide_user_guide.pdf*).
Visual Studio (VS) Code Launch VS Code manually, and then open the generated *{project-name}.code-workspace* file located in the project directory. For more details, see the [Visual Studio Code for ModusToolbox™ user guide](https://www.infineon.com/MTBVSCodeUserGuide) (locally available at *{ModusToolbox™ install directory}/docs_{version}/mt_vscode_user_guide.pdf*).
Keil µVision Double-click the generated *{project-name}.cprj* file to launch the Keil µVision IDE. For more details, see the [Keil µVision for ModusToolbox™ user guide](https://www.infineon.com/MTBuVisionUserGuide) (locally available at *{ModusToolbox™ install directory}/docs_{version}/mt_uvision_user_guide.pdf*).
IAR Embedded Workbench Open IAR Embedded Workbench manually, and create a new project. Then select the generated *{project-name}.ipcf* file located in the project directory. For more details, see the [IAR Embedded Workbench for ModusToolbox™ user guide](https://www.infineon.com/MTBIARUserGuide) (locally available at *{ModusToolbox™ install directory}/docs_{version}/mt_iar_user_guide.pdf*).
Command line If you prefer to use the CLI, open the appropriate terminal, and navigate to the project directory. On Windows, use the command-line 'modus-shell' program; on Linux and macOS, you can use any terminal application. From there, you can run various `make` commands. For more details, see the [ModusToolbox™ tools package user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf*).

Debugging

You can debug the example to step through the code.

In Eclipse IDE Use the **\ Debug (KitProg3_MiniProg4)** configuration in the **Quick Panel**. For details, see the "Program and debug" section in the [Eclipse IDE for ModusToolbox™ user guide](https://www.infineon.com/MTBEclipseIDEUserGuide). Add the below Note for relevant CEs only, like PSoC 6 MCU based. Remove this note for others. > **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/docs/DOC-21143) to learn about this and for the workaround.
In other IDEs Follow the instructions in your preferred IDE.

Design and implementation

Terminologies used in multicore applications -

  1. Project – A directory that contains a Makefile that uses the “core-make” library to build a set of source into a linked ELF image.
  2. Application - A directory that contains one or more "Projects" that are meant to build and work together.

In general, the application and individual projects have their own Makefile. The application level Makefile will have APPLICATION as the value of the MTB_TYPE variable. The project level Makefile will have PROJECT as the value of the MTB_TYPE variable. The application level Makefile has a variable called MTB_PROJECT that list the names of the projects that are associated with the application. The Makefile commands that are issued at the application level will be called for all the listed projects in sequential order. For example, if you issue a build command at the application level, all the listed projects will build one after the other. The resulting combined hex file will have the hex file data from all the listed projects.

This multicore application has two projects: proj_cm0p and proj_cm4. Both proj_cm0p and proj_cm4 projects share the same design configuration, which is located in the \/bsps/\/config folder.

The libraries added through the library manager by default will be downloaded to a folder named mtb_shared located one level above the \ directory. The libraries can be shared or project-specific. When adding the libraries through the library manager, an option is provided to select the project it belongs to. If the same library is added to both projects, then both projects can access the same library copy from the mtb_shared directory.

The Infineon HAL is not yet designed to run simultaneously on CM0+ and CM4 CPU. Because the proj_cm4 already uses HAL, proj_cm0p should only use PDL APIs.

By default, proj_cm0p uses only 8192 bytes of SRAM and flash. If you wish to allocate more memory to proj_cm0p, follow the instructions from the "Customizing linker scripts" section of AN215656 - PSoC™ 6 MCU dual-CPU system design. You can also refer the same document for other dual-CPU system design best practices.

For more details on the project structure and terminologies, see AN228571– Getting started with PSoC™ 6 MCU on ModusToolbox™ software.


Related resources

Resources Links
Application notes AN228571 – Getting started with PSoC™ 6 MCU on ModusToolbox™ software
AN215656 – PSoC™ 6 MCU: Dual-CPU system design
Code examples Using ModusToolbox™ on GitHub
Device documentation PSoC™ 6 MCU datasheets
Development kits Select your kits from the Evaluation board finder.
Libraries on GitHub mtb-pdl-cat1 – PSoC™ 6 peripheral driver library (PDL)
mtb-hal-cat1 – Hardware abstraction layer (HAL) library
retarget-io – Utility library to retarget STDIO messages to a UART port
Middleware on GitHub psoc6-middleware – Links to all PSoC™ 6 MCU middleware
Tools ModusToolbox™ – ModusToolbox™ software is a collection of easy-to-use libraries and tools enabling rapid development with Infineon MCUs for applications ranging from wireless and cloud-connected systems, edge AI/ML, embedded sense and control, to wired USB connectivity using PSoC™ Industrial/IoT MCUs, AIROC™ Wi-Fi and Bluetooth® connectivity devices, XMC™ Industrial MCUs, and EZ-USB™/EZ-PD™ wired connectivity controllers. ModusToolbox™ incorporates a comprehensive set of BSPs, HAL, libraries, configuration tools, and provides support for industry-standard IDEs to fast-track your embedded application development.


Other resources

Infineon provides a wealth of data at 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 in the Infineon Developer community.

Document history

Document title: CE230479 - PSoC™ 6 MCU: Dual-CPU empty application template

Version Description of change
1.0.0 New code example
2.0.0 Major update to support ModusToolbox™ software v2.2.
This version is not backward compatible with ModusToolbox™ software v2.1
2.1.0 Added support for CYSBSYSKIT-DEV-01 rapid IoT connect developer kit
2.2.0 Updated to support ModusToolbox™ software v2.3.
Added support for CY8CKIT-062S4.
2.3.0 Added support for 2 more kits.
Added custom design folder and modified folder name
3.0.0 Updated to support ModusToolbox™ software v3.0 and BSPs v4.X.
This version is not backward compatible with ModusToolbox™ software v2.4.
3.1.0 Added support for CY8CEVAL-062S2-LAI-43439M2
3.2.0 Added support for CY8CPROTO-062S2-43439 and missing custom linker files for few BSPs
3.3.0 Added support for CY8CEVAL-062S2-MUR-4373EM2 and CY8CEVAL-062S2-MUR-4373M2
3.4.0 Added support for CY8CEVAL-062S2-CYW43022CUB
3.5.0 Added support for CY8CKIT-062S2-AI
3.6.0 Added support for CY8CEVAL-062S2-CYW955513SDM2WLIPA


All referenced product or service names and trademarks are the property of their respective owners.

The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc., and any use of such marks by Infineon is under license.

© Cypress Semiconductor Corporation, 2020-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.
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.
Cypress, the Cypress logo, and combinations thereof, 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.