infineon / mtb-example-hal-adc-basic

This example demonstrates use of the ADC (Analog to Digital Converter) HAL driver to perform voltage measurements.

HAL: ADC using HAL

This code example demonstrates the use of the ADC HAL driver to perform voltage measurements. In this example, the ADC HAL driver is configured to sample input voltage periodically and display the sampled voltage on the UART. By default, the ADC is configured to use one channel in single-ended mode.

This example also demonstrates the multichannel configuration of the ADC HAL driver, which performs asynchronous reads from multiple channels. In this case, two channels are used. The first channel is configured in single-ended mode and the second channel is configured in differential mode.

View this README on GitHub.

Provide feedback on this code example.

Requirements

• ModusToolbox™ software v3.0 or later (tested with v3.0)
• Board support package (BSP) minimum required version: 4.0.0
• Programming language: C
• Associated parts: All PSoC™ 6 MCU parts, AIROC™ CYW20735 Bluetooth® & Bluetooth® LE system on chip, AIROC™ CYW20819 Bluetooth® & Bluetooth® LE system on chip, AIROC™ CYW43012 Wi-Fi & Bluetooth® combo chip, AIROC™ CYW4343W Wi-Fi & Bluetooth® combo chip, AIROC™ CYW4373 Wi-Fi & Bluetooth® combo chip, AIROC™ CYW43439 Wi-Fi & Bluetooth® combo chip

Supported toolchains (make variable 'TOOLCHAIN')

• GNU Arm® embedded compiler v10.3.1 (GCC_ARM) - Default value of TOOLCHAIN
• Arm® compiler v6.16 (ARM)
• IAR C/C++ compiler v9.30.1 (IAR)

Supported kits (make variable 'TARGET')

• PSoC™ 6 Wi-Fi Bluetooth® prototyping kit (CY8CPROTO-062-4343W) – Default value of TARGET
• 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™ 62S1 Wi-Fi Bluetooth® pioneer kit (CYW9P62S1-43438EVB-01)
• PSoC™ 62S1 Wi-Fi Bluetooth® pioneer kit (CYW9P62S1-43012EVB-01)
• PSoC™ 62S2 Wi-Fi Bluetooth® pioneer kit (CY8CKIT-062S2-43012)
• PSoC™ 62S3 Wi-Fi Bluetooth® prototyping kit (CY8CPROTO-062S3-4343W)
• PSoC™ 64 "Secure Boot" Wi-Fi Bluetooth® pioneer kit (CY8CKIT-064B0S2-4343W)
• PSoC™ 64 Standard Secure - AWS Wi-Fi Bluetooth® pioneer kit (CY8CKIT-064S0S2-4343W)
• PSoC™ 64 "Secure Boot" prototyping kit (CY8CPROTO-064B0S3)
• PSoC™ 64 "Secure Boot" prototyping kit (CY8CPROTO-064S1-SB)
• PSoC™ 62S4 pioneer kit (CY8CKIT-062S4)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2, CY8CEVAL-062S2-LAI-4373M2, CY8CEVAL-062S2-MUR-43439M2)

Hardware setup

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

Table 1. Analog input pins configuration

Kit	Channel 0 input pin	Channel 1 input pin	Channel 1 voltage reference pin
CY8CPROTO-062-4343W	P10[0]	P10[4]	P10[5]
CY8CKIT-062-WIFI-BT	P10[0]	P10[4]	P10[5]
CY8CKIT-062-BLE	P10[0]	P10[4]	P10[5]
CY8CPROTO-063-BLE	P10[0]	P10[4]	P10[5]
CYW9P62S1-43438EVB-01	P10[0]	P10[4]	P10[5]
CYW9P62S1-43012EVB-01	P10[0]	P10[4]	P10[5]
CY8CKIT-062S2-43012	P10[0]	P10[4]	P10[5]
CY8CPROTO-062S3-4343W	P10[3]	P10[4]	P10[5]
CY8CKIT-064B0S2-4343W	P10[0]	P10[4]	P10[5]
CY8CKIT-064S0S2-4343W	P10[0]	P10[4]	P10[5]
CY8CPROTO-064B0S3	P10[3]	P10[4]	P10[5]
CY8CPROTO-064S1-SB	P10[0]	P10[4]	P10[5]
CY8CKIT-062S4	P10[0]	P10[1]	P10[2]
CY8CEVAL-062S2	P10[0]	P10[4]	P10[5]
CY8CEVAL-062S2-LAI-4373M2	P10[0]	P10[4]	P10[5]
CY8CEVAL-062S2-MUR-43439M2	P10[0]	P10[4]	P10[5]

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. The ModusToolbox™ software 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 and open it using one of the following:

In Eclipse IDE for ModusToolbox™ software

1. Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox™ Application). This launches the Project Creator 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 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 (locally available at {ModusToolbox™ software install directory}/docs_{version}/mtb_ide_user_guide.pdf).

In command-line interface (CLI)

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.

The "project-creator-cli" tool has the following arguments:

Argument	Description	Required/optional
--board-id	Defined in the <id> field of the BSP manifest	Required
--app-id	Defined in the <id> 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

The following example clones the "mtb-example-hal-adc-basic" application with the desired name "AdcBasic" 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-hal-adc-basic --user-app-name AdcBasic --target-dir "C:/mtb_projects"

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 (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 to choose the BSP for the supported kit. You can invoke the Library Manager GUI tool from the terminal using make library-manager 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

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/AdcBasic" --add-bsp-name CY8CPROTO-062-4343W --add-bsp-version "latest-v4.X" --add-bsp-location "local"

library-manager-cli --project "C:/mtb_projects/AdcBasic" --set-active-bsp APP_CY8CPROTO-062-4343W

In third-party IDEs

Use one of the following options:

• Use the standalone Project Creator 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.

• Use command-line interface (CLI):

  1. Follow the instructions from the In command-line interface (CLI) section to create the application.

  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 (locally available at {ModusToolbox™ software 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.

1. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.

   Note: By default, this application uses the single-channel configuration. In this configuration, one ADC channel is configured in single-ended mode and the channel input is configured to channel 0 input pin which is mentioned in Table 1. This application also supports multichannel configuration where two channels are configured; one channel is configured in single-ended mode with input from channel 0 input pin and the second channel is configured in differential mode with the two inputs Vplus and Vref mapped to channel 1 input pin and channel 1 voltage reference input pin respectively, pins are mentioned in Table 1. To use the multichannel configuration, by changing the ADC_EXAMPLE_MODE macro from SINGLE_CHANNEL to MULTI_CHANNEL.

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:

   Using Eclipse IDE for ModusToolbox™ software

   1. Select the application project in the Project Explorer.

   2. In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).

   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
   

4. After programming, the application starts automatically. Ensure that input voltage is provided at Channel 0 input pin which is mentioned in Table 1 if a single channel configuration is chosen. Confirm that "HAL: ADC using HAL" and the input voltage are displayed on the UART terminal.

   Figure 1. Terminal output with single-channel configuration

   

5. If the multichannel configuration is chosen, ensure that the input voltages are provided at the Channel 0 input pin and Channel 1 input pin, pins are mentioned in Table 1. Provide a reference voltage at Channel 1 reference voltage input pin, which is mentioned in Table 1. Confirm that "PSoC™ 6 MCU: ADC using HAL" and the input voltages from the two channels are displayed on the UART terminal.

   Figure 2. Terminal output with multichannel configuration

   

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.

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.

Design and implementation

In this example, the ADC is configured with a 12-bit resolution; by default, one channel with a 0-VDDA range is configured using HAL. The input voltage is sampled every 200 ms by calling cyhal_adc_read_uv; the measured input voltage is displayed on the UART terminal.

This example also supports multichannel configuration. Multichannel configuration can be used by changing the ADC_EXAMPLE_MODE macro to MULTI_CHANNEL. The ADC is configured to use two channels; Channel 0 is configured in single-ended mode, while Channel 1 is configured in differential mode. The cyhal_adc_read_async_uv API function is used to read the results from the two channels asynchronously.

This code example uses a delay of 200 ms between reads for demonstration purposes to print the sampled results on the UART. To achieve sampling at higher rates, remove the delay and use the cyhal_adc_set_sample_rate API function to configure the number of samples per second.

PSoC™ 6 HAL currently restricts the mapping of any GPIO pins as input to the ADC. Only pins that have a direct connection to the ADC can be used as inputs to the ADC. On all the supported boards, P10_x are the preferred GPIO pins as the input for the ADC because they directly connect to the ADC; therefore, Channel 0 input pin is used as the input for the first channel. Channel 1 input pin and Channel 1 voltage reference input pin are used for the second channel, pins are mentioned in Table 1.

Resources and settings

The following resources are used in this example.

Table 2. Application resources

Resource	Alias/object	Purpose
ADC (HAL)	adc_obj	Analog-to-digital converter driver
UART (HAL)	cy_retarget_io_uart_obj	UART HAL object used by retarget-io for debug UART port

Related resources

Resources	Links
Application notes	AN228571 – Getting started with PSoC™ 6 MCU on ModusToolbox™ software AN215656 – PSoC™ 6 MCU: Dual-CPU system design AN221774 – Getting started with PSoC™ 6 MCU on PSoC™ Creator AN210781 – Getting Started with PSoC™ 6 MCU with Bluetooth® Low Energy connectivity on PSoC™ Creator
Code examples	Using ModusToolbox™ software on GitHub Using PSoC™ Creator
Device documentation	PSoC™ 6 MCU datasheets PSoC™ 6 technical reference manuals
Development kits	Select your kits from the Evaluation board finder page.
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	capsense – CAPSENSE™ library and documents psoc6-middleware – Links to all PSoC™ 6 MCU middleware
Tools	Eclipse IDE for ModusToolbox™ software – ModusToolbox™ software is a collection of easy-to-use software and tools enabling rapid development with Infineon MCUs, covering applications from embedded sense and control to wireless and cloud-connected systems using AIROC™ Wi-Fi and Bluetooth® connectivity devices.. PSoC™ Creator – IDE for PSoC™ and FM0+ MCU 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: CE231451 - PSoC™ 6 MCU: ADC using HAL

Version	Description of change
1.0.0	New code example
1.1.0	Added support for new kits
2.0.0	Major update to support ModusToolbox™ v3.0. This version is not backward compatible with previous versions of ModusToolbox™
2.1.0	Added support for CY8CKIT-062S4, CY8CEVAL-062S2, CY8CEVAL-062S2-LAI-4373M2, CY8CEVAL-062S2-MUR-43439M2, CY8CPROTO-064B0S3, and CY8CPROTO-064S1-SB

---

© Cypress Semiconductor Corporation, 2020-2022. 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, 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.