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?
mtb-example-ce240065-safety-stack-test-freertos/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.
288 lines (157 sloc)
22.8 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
| # Class-B Safety Test: Stack test (FreeRTOS) | |
| This code example demonstrates the use of the Class-B Safety Test Library to test the stack overflow and stack underflow in a FreeRTOS environment for the PSoC™ 6 and XMC7000 MCUs. The example verifies the proper operation and accuracy of the stack memory adhering to the IEC 60730 standards. | |
| [View this README on GitHub.](https://github.com/Infineon/mtb-example-ce240065-safety-stack-test-freertos) | |
| [Provide feedback on this code example.](https://cypress.co1.qualtrics.com/jfe/form/SV_1NTns53sK2yiljn?Q_EED=eyJVbmlxdWUgRG9jIElkIjoiQ0UyNDAwNjUiLCJTcGVjIE51bWJlciI6IjAwMi00MDA2NSIsIkRvYyBUaXRsZSI6IkNsYXNzLUIgU2FmZXR5IFRlc3Q6IFN0YWNrIHRlc3QgKEZyZWVSVE9TKSIsInJpZCI6InNkYWsiLCJEb2MgdmVyc2lvbiI6IjEuMC4wIiwiRG9jIExhbmd1YWdlIjoiRW5nbGlzaCIsIkRvYyBEaXZpc2lvbiI6Ik1DRCIsIkRvYyBCVSI6IklDVyIsIkRvYyBGYW1pbHkiOiJQU09DIn0=) | |
| ## Requirements | |
| - [ModusToolbox™](https://www.infineon.com/modustoolbox) v3.2 or later (tested with v3.2) | |
| - Board support package (BSP) minimum required version: v4.2.0 | |
| - Programming language: C | |
| - Associated parts: [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), [XMC7000 MCU](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m) | |
| ## Supported toolchains (make variable 'TOOLCHAIN') | |
| - GNU Arm® Embedded Compiler v11.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™ 6 Wi-Fi Bluetooth® Pioneer Kit](https://www.infineon.com/CY8CKIT-062-WIFI-BT) (`CY8CKIT-062-WIFI-BT`) | |
| - [PSoC™ 6 Bluetooth® LE Pioneer Kit](https://www.infineon.com/CY8CKIT-062-BLE) (`CY8CKIT-062-BLE`) | |
| - [PSoC™ 6 Bluetooth® LE Prototyping Kit](https://www.infineon.com/CY8CPROTO-063-BLE) (`CY8CPROTO-063-BLE`) | |
| - [PSoC™ 62S2 Wi-Fi Bluetooth® Pioneer Kit](https://www.infineon.com/CY8CKIT-062S2-43012) (`CY8CKIT-062S2-43012`) | |
| - [PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit](https://www.infineon.com/CYW9P62S1-43438EVB-01) (`CYW9P62S1-43438EVB-01`) | |
| - [PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit](https://www.infineon.com/CYW9P62S1-43012EVB-01) (`CYW9P62S1-43012EVB-01`) | |
| - [PSoC™ 64 "Secure Boot" Wi-Fi Bluetooth® Pioneer Kit](https://www.infineon.com/CY8CKIT-064B0S2-4343W) (`CY8CKIT-064B0S2-4343W`) | |
| - [PSoC™ 62S4 Pioneer Kit](https://www.infineon.com/CY8CKIT-062S4) (`CY8CKIT-062S4`) | |
| - [PSoC™ 62S2 Evaluation Kit](https://www.infineon.com/CY8CEVAL-062S2) (`CY8CEVAL-062S2`, `CY8CEVAL-062S2-LAI-4373M2`, `CY8CEVAL-062S2-MUR-43439M2`, `CY8CEVAL-062S2-LAI-43439M2`, `CY8CEVAL-062S2-MUR-4373EM2`, `CY8CEVAL-062S2-MUR-4373M2`,`CY8CEVAL-062S2-CYW43022CUB`) | |
| - [XMC7200 Evaluation Kit](https://www.infineon.com/KIT_XMC72_EVK) (`KIT_XMC72_EVK`, `KIT_XMC72_EVK_MUR_43439M2`) | |
| - [PSoC™ 62S3 Wi-Fi Bluetooth® Prototyping Kit](https://www.infineon.com/CY8CPROTO-062S3-4343W) (`CY8CPROTO-062S3-4343W`) | |
| - [XMC7100 Evaluation Kit](https://www.infineon.com/KIT_XMC71_EVK_LITE_V1) (`KIT_XMC71_EVK_LITE_V1`,`KIT_XMC71_EVK_LITE_V2`) | |
| ## 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](https://github.com/Infineon/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 | |
| See the [ModusToolbox™ tools package installation guide](https://www.infineon.com/ModusToolboxInstallguide) for information about installing and configuring the tools package. | |
| Install a terminal emulator if you don't have one. Instructions in this document use [Tera Term](https://teratermproject.github.io/index-en.html). | |
| 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. | |
| <details><summary><b>Use Project Creator GUI</b></summary> | |
| 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. | |
| </details> | |
| <details><summary><b>Use Project Creator CLI</b></summary> | |
| 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 "[Class-B Safety Test: Stack test (FreeRTOS)](https://github.com/Infineon/mtb-example-ce240065-safety-stack-test-freertos)" application with the desired name "StackTestFreeRtos" 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-ce240065-safety-stack-test-freertos --user-app-name StackTestFreeRtos --target-dir "C:/mtb_projects" | |
| ``` | |
| The 'project-creator-cli' 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™ tools package user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf). | |
| </details> | |
| ### Open the project | |
| After the project has been created, you can open it in your preferred development environment. | |
| <details><summary><b>Eclipse IDE</b></summary> | |
| 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*). | |
| </details> | |
| <details><summary><b>Visual Studio (VS) Code</b></summary> | |
| 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*). | |
| </details> | |
| <details><summary><b>Command line</b></summary> | |
| 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*). | |
| </details> | |
| ## Operation | |
| If using a PSoC™ 64 "Secure" MCU kit (like CY8CKIT-064B0S2-4343W), the PSoC™ 64 device must be provisioned with keys and policies before being programmed. Follow the instructions in the ["Secure Boot" SDK user guide](https://www.infineon.com/dgdlac/Infineon-PSoC_64_Secure_MCU_Secure_Boot_SDK_User_Guide-Software-v07_00-EN.pdf?fileId=8ac78c8c7d0d8da4017d0f8c361a7666) to provision the device. If the kit is already provisioned, copy-paste the keys and policy folder to the application folder. | |
| 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</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>In other IDEs</b></summary> | |
| Follow the instructions in your preferred IDE. | |
| </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 **CAT1 class-B safety test: stack memory test FreeRTOS** is displayed on the UART terminal. | |
| **Figure 1. Terminal output on program startup** | |
|  | |
| 5. Press the user button to toggle the user LED. The serial terminal displays the result of the tests performed on the stack of the respective task. | |
| ## Debugging | |
| You can debug the example to step through the code. | |
| <details><summary><b>In Eclipse IDE</b></summary> | |
| 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™ user guide](https://www.infineon.com/MTBEclipseIDEUserGuide). | |
| > **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. | |
| </details> | |
| <details><summary><b>In other IDEs</b></summary> | |
| Follow the instructions in your preferred IDE. | |
| </details> | |
| ## Design and implementation | |
| This code example demonstrates the use of the Class-B Safety Test Library to test the stack overflow and stack underflow in a FreeRTOS environment for the PSoC™ 6 and XMC7000 MCUs. It utilizes the Class-B Safety Test Library to execute these tests. | |
| The example starts by initializing the BSP configuration according to the design configurations and setting up the retarget-io for debug prints. The firmware then uses FreeRTOS to execute the tasks required by this application. The following tasks are created: | |
| - **User button task**: Initializes the user button, processes the user button press, and sends a command to the LED task to toggle the LED. The task also acquires the task information of LED task and performs the stack memory test (stack underflow and overflow test) for the LED task before the context switch happens to LED task. | |
| - **LED task**: Initializes the user LED and toggles the LED based on the received command from the User button task. | |
| The code example executes the stack memory test for the stack of the Led task with the help of the Class-B Safety Test Library. | |
| ### Resources and settings | |
| **Table 1. Application resources** | |
| Resource | Alias/object | Purpose | |
| :-------- | :------------- | :------------ | |
| UART (HAL)| CYBSP_DEBUG_UART| UART HAL object used by retarget-IO for the debug UART port | |
| GPIO (HAL)| CYBSP_USER_LED |User LED to show visual output | |
| GPIO (HAL)| CYBSP_USER_BTN |User button for user input | |
| <br> | |
| ## Related resources | |
| Resources | Links | |
| -----------|---------------------------------- | |
| Application notes | [AN228571](https://www.infineon.com/AN228571) - Getting started with PSoC™ 6 MCU on ModusToolbox™ <br> [AN234334](https://www.infineon.com/dgdl/Infineon-AN234334_Getting_started_with_XMC7000_MCU_on_ModusToolbox_software-ApplicationNotes-v01_00-EN.pdf?fileId=8ac78c8c8412f8d301842d32c5765bfd) – Getting started with XMC7000 MCU on ModusToolbox™ | |
| Code examples | [Using ModusToolbox™](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software) on GitHub | |
| Device documentation | [PSoC™ 6 MCU datasheets](https://documentation.infineon.com/html/psoc6/bnm1651211483724.html) <br> [PSoC™ 6 technical reference manuals](https://documentation.infineon.com/html/psoc6/zrs1651212645947.html) <br> [XMC7000 MCU datasheets](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) <br> [XMC7000 technical reference manuals](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) | |
| Development kits | Select your kits from the [Evaluation board finder](https://www.infineon.com/cms/en/design-support/finder-selection-tools/product-finder/evaluation-board) | |
| Libraries on GitHub | [mtb-pdl-cat1](https://github.com/Infineon/mtb-pdl-cat1) – PSoC™ 6 Peripheral Driver Library (PDL) <br> [mtb-hal-cat1](https://github.com/Infineon/mtb-hal-cat1) – Hardware Abstraction Layer (HAL) library <br> [mtb-xmclib-cat3](https://github.com/Infineon/mtb-xmclib-cat3) – XMC™ Peripheral Driver Library (XMCLib) | |
| Middleware on GitHub | [mcu-middleware](https://github.com/Infineon/modustoolbox-software) – Links to all MCU middleware <br> [mtb-stl](https://github.com/Infineon/mtb-stl) - Safety Test Library (STL) | |
| Tools | [ModusToolbox™](https://www.infineon.com/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. | |
| <br> | |
| ## Other resources | |
| Infineon provides a wealth of data at [www.infineon.com](https://www.infineon.com) to help you select the right device, and quickly and effectively integrate it into your design. | |
| For XMC™ MCU devices, see [32-bit XMC™ industrial microcontroller based on Arm® Cortex®-M](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/). | |
| ## Document history | |
| Document title: *CE240065* - *Class-B Safety Test: Stack test (FreeRTOS)* | |
| Version | Description of change | |
| ------- | --------------------- | |
| 1.0.0 | New code example | |
| <br> | |
| 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, 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, 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. |