Class-B Safety Test: Communication protocol

This code example demonstrates the use of the Class-B Safety Test Library to test the communication protocol in embedded systems. The example conducts a communication test by configuring two SCB instances as UART and connecting their TX and RX pins to the corresponding RX and TX pins of other blocks. The objective is to detect any potential data corruption during transit.

View this README on GitHub.

Provide feedback on this code example.

Requirements

ModusToolbox™ v3.3 or later (tested with v3.3)
Board support package (BSP) minimum required version: v4.2.0
Programming language: C
Associated parts: PSoC™ 6 MCU, XMC7000 MCU

Supported toolchains (make variable 'TOOLCHAIN')

GNU Arm® Embedded Compiler v11.3.1 (GCC_ARM) – Default value of TOOLCHAIN
Arm® Compiler v6.22 (ARM)
IAR C/C++ Compiler v9.50.2 (IAR)

Supported kits (make variable 'TARGET')

PSoC™ 62S2 Wi-Fi Bluetooth® Prototyping Kit (CY8CPROTO-062S2-43439) – Default value of TARGET
PSoC™ 6 Wi-Fi Bluetooth® Prototyping Kit (CY8CPROTO-062-4343W)
PSoC™ 6 Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-062-WIFI-BT)
PSoC™ 6 Bluetooth® LE Pioneer Kit (CY8CKIT-062-BLE)
PSoC™ 6 Bluetooth® LE Prototyping Kit (CY8CPROTO-063-BLE)
PSoC™ 62S2 Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-062S2-43012)
PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit (CYW9P62S1-43438EVB-01)
PSoC™ 62S1 Wi-Fi Bluetooth® Pioneer Kit (CYW9P62S1-43012EVB-01)
PSoC™ 64 "Secure Boot" Wi-Fi Bluetooth® Pioneer Kit (CY8CKIT-064B0S2-4343W)
PSoC™ 62S4 Pioneer Kit (CY8CKIT-062S4)
PSoC™ 62S2 Evaluation Kit (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 (KIT_XMC72_EVK, KIT_XMC72_EVK_MUR_43439M2)
PSoC™ 62S3 Wi-Fi Bluetooth® Prototyping Kit (CY8CPROTO-062S3-4343W)
XMC7100 Evaluation Kit (KIT_XMC71_EVK_LITE_V1)

Hardware setup

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

Additionally, this code example enables two UART instances in the configurable design.modus file; a master and a slave.

To test the communication, external jumper connections are required between UART communication blocks. Here are the connections used for each BSP in this example:

BSP	TX-RX	RX-TX
CY8CPROTO-062-4343W	P12_1 to P5_4	P12_0 to P5_5
CY8CPROTO-062S2-43439	P12_1 to P5_4	P12_0 to P5_5
CY8CPROTO-063-BLE	P6_5 to P10_0	P6_4 to P10_1
CY8CKIT-062S2-43012	P12_1 to P5_4	P12_0 to P5_5
CY8CKIT-064B0S2-4343W	P12_1 to P5_4	P12_0 to P5_5
CY8CPROTO-062S3-4343W	P8_1 to P5_0	P8_0 to P5_1
CY8CEVAL-062S2	P12_1 to P5_4	P12_0 to P5_5
CY8CEVAL-062S2-LAI-4373M2	P12_1 to P5_4	P12_0 to P5_5
CY8CEVAL-062S2-MUR-43439M2	P12_1 to P5_4	P12_0 to P5_5
CY8CEVAL-062S2-LAI-43439M2	P12_1 to P5_4	P12_0 to P5_5
CY8CEVAL-062S2-MUR-4373EM2	P12_1 to P5_4	P12_0 to P5_5
CY8CEVAL-062S2-MUR-4373M2	P12_1 to P5_4	P12_0 to P5_5
CY8CEVAL-062S2-CYW43022CUB	P12_1 to P5_4	P12_0 to P5_5
CY8CKIT-062-BLE	P10_1 to P9_0	P10_0 to P9_1
CY8CKIT-062S2-43012	P12_1 to P5_4	P12_0 to P5_5
CY8CKIT-062S4	P2_1 to P0_2	P2_0 to P0_3
CY8CKIT-062-WIFI-BT	P10_1 to P9_0	P10_0 to P9_1
CYW9P62S1-43012EVB-01	P10_1 to P0_2	P10_0 to P0_3
CYW9P62S1-43438EVB-01	P9_1 to P10_0	P9_0 to P10_1
KIT_XMC71_EVK_LITE_V1	P0_1 to P14_0	P0_0 to P14_1
KIT_XMC72_EVK	P14_0 to P10_1	P10_0 to P14_1
KIT_XMC72_EVK_MUR_43439M2	P14_0 to P10_1	P10_0 to P14_1

Software setup

See the ModusToolbox™ tools package installation guide 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.

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

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 (locally available at {ModusToolbox™ install directory}/tools_{version}/project-creator/docs/project-creator.pdf).
On the Choose Board Support Package (BSP) page, select a kit supported by this code example. See Supported kits.

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.
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 "UART communication test" application with the desired name "CommunicationTest" configured for the CY8CPROTO-062-4343W BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id CY8CPROTO-062-4343W --app-id mtb-example-ce239682-safety-communication-test --user-app-name UARTCommunicationTest --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 manifest	Required
`--app-id`	Defined in the field of the CE 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 (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 (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 (locally available at {ModusToolbox™ install directory}/docs_{version}/mt_vscode_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 (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).

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 to provision the device. If the kit is already provisioned, copy-paste the keys and policy folder to the application folder.

Connect the board to your PC using the provided USB cable through the KitProg3 USB connector and connect the pins of the kit using the instructions in the Hardware setup section.
Open a terminal program and select the KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud.
Program the board using one of the following:
Using Eclipse IDE
1. Select the application project in the Project Explorer.
2. In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).
In other IDEs

Follow the instructions in your preferred IDE.
Using CLI

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
```
After programming, the application starts automatically. Confirm that Class-B Safety Test: Communication protocol is displayed on the UART terminal.

Figure 1. Terminal output on program startup
The serial terminal must display the result of the communication protocol test.

Debugging

You can debug the example to step through the code.

In Eclipse 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™ user guide.

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 to learn about this and for the workaround.

In other IDEs

Follow the instructions in your preferred IDE.

Design and implementation

The example configures two SCB instances as UART, with the TX and RX pins connected according to the instructions provided in the Hardware Setup section. The design configurations can be adjusted through the design.modus file of the test application.

In this communication protocol, one SCB acts as the master (A) and the other as the slave (B). The master SCB sends a request to the slave SCB, and the slave SCB responds to the request.

The communication between the SCBs follows a packet format, which consists of the following elements:

STX (start of text) - A unique byte (0x02) used to indicate the beginning of the packet.
ADDR (address) - A byte used to identify the intended recipient SCB.
DL (data length) - A byte indicating the length of the data (in bytes) that follows.
[Data] - A sequence of bytes containing the actual data being transferred.
CRCH (CRC High) - The most significant byte of a 16-bit cyclic redundancy check (CRC) code calculated over all bytes from ADDR to the last byte of data.
CRCL (CRC Low) - The least significant byte of the CRC code.

Packet format:

<STX><ADDR><DL><[Data bytes length equal DL]><CRCH><CRCL>

If any of the bytes in the packet (ADDR, DL, [Data], or [CRC]) is equal to the STX byte (0x02), it is replaced by a two-byte sequence <ESC><STX+1>. Similarly, if any of these bytes is equal to the ESC byte, it is replaced by a two-byte sequence <ESC><ESC+1>. This is done to avoid confusion with the STX and ESC bytes in the data.

The packet format is used for both the request and response packets exchanged between the master and slave SCBs. The master SCB sends a request packet to the slave SCB and waits for the response packet before proceeding with its operation.

The example starts by initializing the BSP configuration and setting up the retarget-io for debug prints. It then configures the UART blocks according to the master and slave configurations defined in the design files. To verify the communication, the example utilizes the API provided by the mtb-stl middleware to handle the request and response as explained earlier in this protocol.

The purpose of the test is to detect any potential data corruption during transmission between the two SCB devices.

Design and implementation

Resources and settings

Table 1. Application resources

Resource	Alias/object	Purpose
SCB->UART (PDL)	CYBSP_DUT_UART_MASTER	master resource for communication test
SCB->UART (PDL)	CYBSP_DUT_UART_SLAVE	slave resource for communication test
UART (HAL)	CYBSP_DEBUG_UART	UART HAL object used by Retarget-IO for the Debug UART port

Related resources

Resources	Links
Application notes	AN228571 - Getting started with PSoC™ 6 MCU on ModusToolbox™ AN234334 – Getting started with XMC7000 MCU on ModusToolbox™
Code examples	Using ModusToolbox™ on GitHub
Device documentation	PSoC™ 6 MCU datasheets PSoC™ 6 technical reference manuals XMC7000 MCU datasheets XMC7000 technical reference manuals
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
Middleware on GitHub	capsense - CAPSENSE™ library and documents mtb-stl - Safety Test Library (STL)
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.

Document history

Document title: CE239682 - Class-B Safety Test: Communication protocol

Version	Description of change
1.0.0	New code example
1.1.0	Added support for PSoC6 1M, PSoC 256K and XMC 7100 kit
1.2.0	Added support IAR and ARM compiler

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.
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.

License

Infineon/mtb-example-ce239682-safety-communication-test

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages