GithubHelp home page GithubHelp logo

infineon / mtb-example-psoc6-csdidac Goto Github PK

View Code? Open in Web Editor NEW
0.0 14.0 0.0 287 KB

This code example demonstrates using the CSD hardware-block-based current digital-to-analog converter (CSDIDAC) as a current source and a current sink.

License: Other

Makefile 42.61% C 57.39%
cy8cproto-062-4343w cy8cproto-062s3-4343w cy8cproto-063-ble cyw9p62s1-43012evb-01 cyw9p62s1-43438evb-01 peripherals cy8ceval-062s2 cy8ceval-062s2-lai-4373m2 cy8ceval-062s2-mur-43439m2 cy8ckit-062-ble

mtb-example-psoc6-csdidac's Introduction

PSoC™ 6 MCU: CSD current output digital-to-analog converter (IDAC)

This code example demonstrates using the CSD hardware-block-based current digital-to-analog converter (CSDIDAC) as a current source and a current sink. CSDIDAC supports two channels - A and B. Channel A is configured as a current source. The current increases when a switch is pressed. Once the output reaches its maximum value, it resets to zero and starts to increase the value again. The last current output value is maintained when the switch is not pressed. UART displays the current value for which the CSDIDAC is configured. Channel B is configured for sinking current and used for driving an LED. The firmware enables or disables the IDAC channel to toggle the LED every second. This project uses CSDIDAC middleware library.

View this README on GitHub.

Provide feedback on this code example.

Requirements

Supported toolchains (make variable 'TOOLCHAIN')

  • GNU Arm® Embedded Compiler v11.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')

Hardware setup

This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly. Place a resistor across the pin mentioned in Table 1 and ground to measure the voltage across the resistor caused by the current output. To change the CSDIDAC pin, modify the CSDIDAC configuration.

Table 1. CSDIDAC pin

Kit CSDIDAC pin
CY8CPROTO-062-4343W P10 [0]
CY8CPROTO-062S2-43439 P10 [0]
CY8CKIT-062-WIFI-BT P10 [0]
CY8CKIT-062-BLE P10 [0]
CY8CPROTO-063-BLE P10 [0]
CYW9P62S1-43438EVB-01 P10 [0]
CYW9P62S1-43012EVB-01 P10 [0]
CY8CKIT-062S2-43012 P10 [0]
CY8CPROTO-062S3-4343W P9 [1]
CY8CKIT-064B0S2-4343W P10 [0]
CY8CPROTO-064B0S3 P9 [1]
CY8CPROTO-064S1-SB P10 [0]
CY8CKIT-062S4 P10 [0]
CY8CEVAL-062S2 P10 [0]
CY8CEVAL-062S2-LAI-4373M2 P10 [0]
CY8CEVAL-062S2-LAI-43439M2 P10 [0]
CY8CEVAL-062S2-MUR-43439M2 P10 [0]
CY8CEVAL-062S2-MUR-4373M2 P10 [0]
CY8CEVAL-062S2-MUR-4373EM2 P10 [0]

Note: For PSoC™ 62S3 Wi-Fi Bluetooth® prototyping kit (CY8CPROTO-062S3-4343W), PSoC™ 62S4 pioneer kit (CY8CKIT-062S4) and PSoC™ 64 "Secure Boot" prototyping kit (CY8CPROTO-064B0S3), channel B is not connected to the user LED. For CY8CPROTO-062S3-4343W and CY8CPROTO-064B0S3, channel B is connected to the P8 [1]. For CY8CKIT-062S4 , channel B is connected to the P9 [0]. If you want to connect channel B to the user LED, make the connection between the user LED and respective pin by using jumper.

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

    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 "Csdidac" application with the desired name "Csdidac" 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-psoc6-csdidac --user-app-name BasicDFU --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).

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

Operation

  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:

    Using Eclipse IDE for ModusToolbox™
    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. Confirm that the UART terminal displays the following.

    Figure 1. Terminal output

  5. Press the user button. The terminal should show the new current value for which the IDAC current source is configured, as shown in Figure 2. Calculate the current by measuring the voltage across the resistor connected between P10[0] and the ground (GND). The current value should match the value shown on the terminal.

    Figure 2. Terminal output when button pressed

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

CSDIDAC supports two channels (A and B) IDAC with 7-bit resolution. Configure both channels independently for sourcing or sinking current. See CSDIDAC middleware library for more details. In this code example, channel A is configured for sourcing current; firmware controls the current value. Channel B is configured for sinking current and used for driving the LED. The CSDIDAC could be configured by the ModusToolbox™ CSD personality. See the Configuration considerations section in the API reference guide for configuring the CSDIDAC.

The CSDIDAC is not enabled in the default board configuration provided by the BSP. This example overrides the BSP_DESIGN_MODUS component provided with the BSP to enable and configure the CSDIDAC. See the "Overriding the BSP Configuration files" section of the ModusToolbox™ user guide: {ModusToolbox™ install directory}/ide_{version}/docs/mtb_user_guide.pdf

The design.modus file containing the custom device configuration used in this application is present under the respective kit's folder: <application_folder>/templates/TARGET_<BSP-NAME>/config/design.modus.

Enabling the CSDIDAC functionality

This section guides how to set up the CSDIDAC middleware for the CSDIDAC operation using ModusToolbox™.

  1. Launch the Device configurator tool from the Quick Panel of the IDE. This opens the design.modus file located in <application_folder>/templates/TARGET_<BSP-NAME>/config/design.modus.

  2. On the System tab, configure the CLK_PERI frequency to achieve the desired frequency. This is the clock input to the CSDIDAC.

  3. On the Peripherals tab (#1 in Figure 2), enable the CSD personality under System (#2 in Figure 3) and enter the Alias (#3 in Figure 3).

  4. Go to the Parameters pane and configure the CSD personality:

    1. Assign the peripheral clock divider by using the Clock combo box (#4 in Figure 3). Any free divider can be used.

    2. Set the Enable CSDIDAC check box (#5 in Figure 3).

    3. Configure the CSDIDAC parameters (#5 in Figure 3).

    4. Assign the CSDIDAC channels to pins (#6 in Figure 3).

  5. Select File > Save to generate the initialization code. This is executed as part of the init_cycfg_all() function, which is called by cybsp_init().

    Figure 3. Settings to enable CSDIDAC functionality

Operation at a custom power supply voltage

The application is configured to work with the default operating voltage of the kit. Table 2 lists the power supply voltages supported by each kit along with the default operating voltage.

Table 2. Operating voltages supported by the kits

Kit Supported operating voltages Default operating voltage
CY8CPROTO-062-4343W 3.3 V / 1.8 V 3.3 V
CY8CPROTO-062S2-43439 3.3 V / 1.8 V 3.3 V
CY8CKIT-062-WiFi-BT 3.3 V / 1.8 V 3.3 V
CY8CKIT-062-BLE 3.3 V / 1.8 V 3.3 V
CY8CPROTO-063-BLE 3.3 V / 1.8 V 3.3 V
CYW9P62S1-43438EVB-01 3.3 V only 3.3 V
CYW9P62S1-43012EVB-01 1.8 V only 1.8 V
CY8CKIT-062S2-43012 3.3 V / 1.8 V 3.3 V
CY8CPROTO-062S3-4343W 3.3 V / 1.8 V 3.3 V
CY8CKIT-064B0S2-4343W 3.3 V / 1.8 V 3.3 V
CY8CPROTO-064B0S3 3.3 V / 1.8 V / 2.5 V 3.3 V
CY8CPROTO-064S1-SB 3.3 V / 1.8 V / 2.5 V 3.3 V
CY8CKIT-062S4 3.3 V / 1.8 V 3.3 V
CY8CEVAL-062S2 3.3 V / 1.8 V 3.3 V
CY8CEVAL-062S2-LAI-4373M2 3.3 V / 1.8 V 3.3 V
CY8CEVAL-062S2-LAI-43439M2 3.3 V / 1.8 V 3.3 V
CY8CEVAL-062S2-MUR-43439M2 3.3 V / 1.8 V 3.3 V
CY8CEVAL-062S2-MUR-4373M2 3.3 V / 1.8 V 3.3 V
CY8CEVAL-062S2-MUR-4373EM2 3.3 V / 1.8 V 3.3 V

For kits that support multiple operating voltages, do the following to work at a custom power supply, such as 1.8 V:

  1. Launch the Device configurator tool from the quick panel of the IDE. This opens the design.modus file located in <application_folder>/templates/TARGET_<BSP-NAME>/config/design.modus.

  2. Update the operating conditions as shown in Figure 3 and select File > Save.

    Figure 4. Power setting to work with 1.8 V

  3. Change the jumper/switch setting as listed in Table 3.

Table 3. Jumper/switch position for 1.8 V operation

Kit Jumper/switch position
CY8CPROTO-062-4343W J3 (1-2)
CY8CPROTO-062S2-43439 J3 (1-2)
CY8CKIT-062-WiFi-BT SW5 (1-2)
CY8CKIT-062-BLE SW5 (1-2)
CY8CPROTO-063-BLE Populate 0 Ω register at R41
CYW9P62S1-43438EVB-01 J14 (1-2)
CYW9P62S1-43012EVB-01 J14 (1-2)
CY8CKIT-062S2-43012 J14 (1-2)
CY8CPROTO-062S3-4343W J3 (1-2)
CY8CKIT-064B0S2-4343W J14 (1-2)
CY8CPROTO-064B0S3 J3 NC (No connection)
CY8CPROTO-064S1-SB J3 (1-2)
CY8CKIT-062S4 J12 (1-2)
CY8CEVAL-062S2 J18 (1-3)
CY8CEVAL-062S2-LAI-4373M2 J18 (1-3)
CY8CEVAL-062S2-LAI-43439M2 J18 (1-3)
CY8CEVAL-062S2-MUR-43439M2 J18 (1-3)
CY8CEVAL-062S2-MUR-4373M2 J18 (1-3)
CY8CEVAL-062S2-MUR-4373EM2 J18 (1-3)

Resources and settings

The following resources are used in this example.

Table 1. Application resources

Resource Alias/object Purpose
CSDIDAC (Middleware) csdidac_context CSDIDAC middleware instance that provides an IDAC solution using the CSD HW block for measurements
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™
AN215656 – PSoC™ 6 MCU: Dual-CPU system design
AN79953 – Getting started with PSoC™ 4
AN85951 – PSoC™ 4 and PSoC™ 6 MCU CAPSENSE™ design guide
Code examples Using ModusToolbox™ on GitHub
Using PSoC™ Creator
Device documentation PSoC™ 6 MCU datasheets
PSoC™ 6 technical reference manuals
PSoC™ 4 datasheets
PSoC™ 4 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
retarget-io – Utility library to retarget STDIO messages to a UART port
mtb-pdl-cat2 – PSoC™ 4 peripheral driver library (PDL)
mtb-hal-cat2 – Hardware abstraction layer (HAL) library
Middleware on GitHub capsense – CAPSENSE™ library and documents
psoc6-middleware – Links to all PSoC™ 6 MCU middleware
Tools Eclipse IDE for ModusToolbox™ – ModusToolbox™ 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: CE227252 - PSoC™ 6 MCU: CSD current output digital-to-analog converter (IDAC)

Version Description of change
1.0.0 New code example
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, CY8CKIT-064B0S2-4343W, CY8CPROTO-064B0S3, CY8CPROTO-064S1-SB and CY8CEVAL-062S2-LAI-43439M2
2.2.0 Added support for new kits


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

mtb-example-psoc6-csdidac's People

Contributors

cy-msur avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.