This code example demonstrates the usage of the Class B safety test library (STL) to test the analog peripherals, such as comparator, opamp, and analog-to-digital converter (ADC) in the PSOC™ 4 MCU. The example verifies the proper operation and accuracy of these peripherals.
Provide feedback on this code example.
- ModusToolbox™ v3.5 or later (tested with v3.5)
- Board support package (BSP) minimum required version: 3.2.0
- Programming language: C
- Associated parts: PSOC™ 4000S, PSOC™ 4100S, PSOC™ 4100S Plus, PSOC™ 4500S, PSOC™ 4100S Max, PSOC™ 4100T Plus
- GNU Arm® Embedded Compiler v11.3.1 (
GCC_ARM) – Default value ofTOOLCHAIN - Arm® Compiler v6.22 (
ARM) - IAR C/C++ Compiler v9.50.2 (
IAR)
- PSOC™ 4100S Max Pioneer Kit (
CY8CKIT-041S-MAX) – Default value ofTARGET - PSOC™ 4500S Pioneer Kit (
CY8CKIT-045S) - PSOC™ 4100S Plus Prototyping Kit (
CY8CKIT-149) - PSOC™ 4100T Plus CAPSENSE™ Prototyping Kit (
CY8CPROTO-041TP) - PSOC™ 4000S CAPSENSE™ Prototyping Kit (
CY8CKIT-145-40XX) - PSOC™ 4100S CAPSENSE™ Pioneer Kit (
CY8CKIT-041-41XX)
This example requires minor hardware modifications in default BSP based on the test modes supported. See the kit user guide to ensure that the board is configured correctly.
Three analog peripherals are tested in this code example and the hardware modifications for each are as follows:
-
ADC test: The ADC is tested against two reference voltages: VDD/3 and 2VDD/3. In the default configuration, connect VDDA/3 to the pin that is configured as an analog pin. To test for 2VDD/3, enable the
ADC_REF_VOLTAGE2macro in the self_test.h file, and connect 2VDDA/3 to the analog pinTable 1. Jumper connections for ADC test
BSP Analog pin CY8CKIT-041S-MAX P2.1 CY8CKIT-045S P2.0 CY8CKIT-149 P2.1 CY8CPROTO-041TP P2.0 CY8CKIT-041-41XX P2.1
-
Comparator test: Connect a higher voltage (VDD) to the 'CYBSP_EXT_HIGH_PIN' pin and a lower voltage (GND) to the 'CYBSP_EXT_LOW_PIN' pin
Table 2. Jumper connections for the comparator test
BSP CYBSP_EXT_LOW_PIN pin CYBSP_EXT_HIGH_PIN pin CY8CKIT-041S-MAX P1.2 P1.3 CY8CKIT-045S P2.2 P2.3 CY8CKIT-149 P2.2 P2.3 CY8CKIT-041-41XX P2.2 P2.3 CY8CKIT-145-40XX P1.2 P1.3
-
Opamp test: The opamp is tested against two reference voltages: VDD/3 and 2VDD/3. In the default configuration, connect VDDA/3 to the pin, configured as the Vplus input pin. To test for 2VDD/3, enable the
ADC_REF_VOLTAGE2macro in the self_test.h file and connect 2VDDA/3 to the Vplus input pinTable 3. Jumper connections for opamp test
BSP Opamp pin CY8CKIT-041S-MAX P1.5 CY8CKIT-045S P1.7 CY8CKIT-149 P1.7 CY8CKIT-041-41XX P1.7
See the ModusToolbox™ tools package installation guide for information about installing and configuring the tools package.
Install a terminal emulator if you do not have one. Instructions in this document use Tera Term.
This example requires no additional software or tools.
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 "mtb-example-psoc4-safety-analog-test" application with the desired name "AnalogTest" configured for the CY8CKIT-041S-MAX BSP into the specified working directory, C:/mtb_projects:
project-creator-cli --board-id CY8CKIT-041S-MAX --app-id mtb-example-psoc4-safety-analog-test --user-app-name AnalogTest --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 cloneandmake getlibscommands 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).
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).
Arm® Keil® µVision®
Double-click the generated {project-name}.cprj file to launch the Keil® µVision® IDE.
For more details, see the Arm® Keil® µVision® for ModusToolbox™ user guide (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 (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 (locally available at {ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf).
-
Connect the pins of the PSOC™ 4 kits according to the instructions given in the Hardware setup section
-
Connect the board to your PC using the provided USB cable through the KitProg3 USB connector
-
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
-
Select the application project in the Project Explorer
-
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 programcommand 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: Analog peripheral is displayed on the UART terminal along with the available commands
Figure 1. Terminal output on program startup
-
To run the self-test commands, enter the following:
- 1: For ADC peripheral
- 2: For comparator
- 3: For opamp
-
Based on the commands entered in the previous step, the serial terminal displays the result of the tests performed on the respective peripheral
Note: Comparator and opamp are not supported by the
CY8CPROTO-041TPkit.
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.
In other IDEs
Follow the instructions in your preferred IDE.
The example demonstrates an analog test for three key analog peripherals: the comparator, opamp, and ADC in the PSOC™ 4 MCU. It utilizes the Class B safety test library to execute these tests. The example supports both internal and external hardware voltage references depending on the selected test modes: Dual MSC, external, and CSD IDAC. See the Hardware setup section for detailed connection instructions.
The implementation proceeds as follows:
-
The example starts by initializing the BSP configuration as per the design configurations and setting up retarget-io for debug prints
-
The code then saves your SARSEQ ADC routing and initializes the ADC, enabling it
-
Two GPIO pins are initialized as analog inputs and connected to AMUXBUS A and AMUXBUS B. The AMUXBUS routing is configured according to the application requirements
-
The voltage reference configurations are set based on the requirements and selected test mode
-
The code then proceeds to perform the following tests:
-
Comparator test:
- This test focuses on the analog comparator. It connects the comparator to the GPIO pins, enabling the selection of two voltage references on AMUXBUS A and AMUXBUS B
- The test verifies if the comparator output aligns with the expected result. A non-zero value indicates that the positive input voltage is anticipated to be greater than the negative input voltage
-
Opamp test:
- The opamp test examines the operational amplifier functionality. It connects the opamp to the ADC and utilizes GPIO pins as a multiplexer to choose various voltage references on AMUXBUS A and AMUXBUS B
- By comparing the measured voltage against the anticipated outcome within a defined accuracy range, this test ensures that the opamp operates correctly and generates the expected output voltage
-
ADC test:
- The ADC test focuses on the ADC and offers flexibility in choosing between internal and external voltage references
- By measuring the voltage on a specific channel and comparing it against the expected result within a defined accuracy range, this test validates the accuracy and functionality of the ADC in converting analog signals to digital values
-
-
Once the tests are completed, the code restores your SAR ADC configurations.
Ensure that you include the necessary header files, function declarations, and adjust the configuration structures and hardware instances to suit your specific platform and requirements
Table 4. Application resources
| Resource | Alias/object | Purpose |
|---|---|---|
| LPCOMP1 (PDL) | CYBSP_DUT_LPCOMP | LPCOMP resource used for the comparator test |
| ADC0 (PDL) | CYBSP_DUT_SAR_ADC | SAR ADC resource used for the ADC test |
| CTB 0 opamp (PDL) | CYBSP_DUT_OPAMP | CTB OPAMP resource used for the opamp test |
| SCB->UART (PDL) | CYBSP_UART | UART PDL resource used for the Debug UART port |
| Resources | Links |
|---|---|
| Application notes | AN79953 – Getting started with PSOC™ 4 MCU |
| Code examples | Using ModusToolbox™ on GitHub |
| Device documentation | PSOC™ 4 datasheets PSOC™ 4 technical reference manuals |
| Development kits | Select your kits from the Evaluation board finder. |
| Libraries on GitHub | mtb-pdl-cat2 – PSOC™ 4 Peripheral Driver Library (PDL) |
| 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. |
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 title: CE238030 – PSOC™ 4 Class B safety test: Analog peripherals
| Version | Description of change |
|---|---|
| 0.1.0 | Preliminary alpha release |
| 1.0.0 | Updated to support mtb-stl v3.x |
| 1.1.0 | Added support for CY8CKIT-149 and Arm® Compiler |
| 1.2.0 | Added support for CY8CPROTO-041TP |
| 1.3.0 | Added support for CY8CKIT-145-40XX and CY8CKIT-041-41XX |
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.
PSOC™, formerly known as PSoC™, is a trademark of Infineon Technologies. Any references to PSoC™ in this document or others shall be deemed to refer to PSOC™.
© Cypress Semiconductor Corporation, 2025. 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.