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-xmc-ccu8-triggered-vadc-measurement/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.
208 lines (116 sloc)
13.6 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
| # XMC™ MCU: CCU8 triggered VADC measurement | |
| This example demonstrates the working of VADC triggered by CCU8 peripheral on every period match event. The CCU8 peripheral is configured to give periodic interrupts every 0.5 seconds. The event is routed via the service request line to trigger VADC to measure the voltage from the analog input pin. The main file has the custom logic to turn on the LED when the VADC measurement is above the value of 2047 and turn off the LED when the VADC measurement is below the value of 2047. The output of the VADC is printed via debug UART which can be verified with a serial monitor. | |
| ## Requirements | |
| - [ModusToolbox™ software](https://www.infineon.com/modustoolbox) v3.0 | |
| - [SEGGER J-Link software](https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack) | |
| - Programming language: C | |
| - Associated parts: All [XMC™ MCU](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) parts | |
| ## Supported toolchains (make variable 'TOOLCHAIN') | |
| - GNU Arm® embedded compiler v10.3.1 (`GCC_ARM`) - Default value of `TOOLCHAIN` | |
| ## Supported kits (make variable 'TARGET') | |
| - [XMC1400 boot kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_boot_001/) (`KIT_XMC14_BOOT_001`) - Default value of `TARGET` | |
| - [XMC4200 Platform2GO XTREME kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/) (`KIT_XMC_PLT2GO_XMC4200`) | |
| - [XMC4300 relax EtherCAT kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc43_relax_ecat_v1/) (`KIT_XMC43_RELAX_ECAT_V1`) | |
| - [XMC4400 Platform2GO XTREME kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/) (`KIT_XMC_PLT2GO_XMC4400`) | |
| - [XMC4500 relax kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc45_relax_v1/) (`KIT_XMC45_RELAX_V1`) | |
| - [XMC4700 relax kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_v1/) (`KIT_XMC47_RELAX_V1`) | |
| - [XMC4800 relax EtherCAT kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc48_relax_ecat_v1/) (`KIT_XMC48_RELAX_ECAT_V1`) | |
| ## Hardware setup | |
| This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly. | |
| ## Software setup | |
| This example requires no additional software or tools. | |
| ## Using the code example | |
| Create the project and open it using one of the following: | |
| <details open><summary><b>In Eclipse IDE for ModusToolbox™ software</b></summary> | |
| 1. Click the **New Application** link in the **Quick Panel** (or, use **File** > **New** > **ModusToolbox™ Application**). This launches the [Project Creator](https://www.infineon.com/ModusToolboxProjectCreator) 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](https://www.infineon.com/ModusToolboxLibraryManager) 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](https://www.infineon.com/MTBEclipseIDEUserGuide) (locally available at *{ModusToolbox™ software install directory}/ide_{version}/docs/mt_ide_user_guide.pdf*). | |
| </details> | |
| <details open><summary><b>In command-line interface (CLI)</b></summary> | |
| 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. | |
| This 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> | |
| The following example will clone the "[CCU8 triggered VADC measurement](https://github.com/Infineon/mtb-example-xmc-ccu8-triggered-vadc-measurement)" application with the desired name "VADC_CCU8" configured for the *KIT_XMC14_BOOT_001* BSP into the specified working directory, *C:/mtb_projects*: | |
| ``` | |
| project-creator-cli --board-id KIT_XMC14_BOOT_001 --app-id mtb-example-xmc-ccu8-triggered-vadc-measurement --user-app-name VADC_CCU8 --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](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*). | |
| </details> | |
| <details open><summary><b>In third-party IDEs</b></summary> | |
| **Note:** Only VS Code is supported. | |
| 1. Follow the instructions from the **In command-line interface (CLI)** section to create the application, and import the libraries using the `make getlibs` command. | |
| 2. Export the application to a supported IDE using the `make <ide>` command. | |
| For a list of supported IDEs and more details, see the "Exporting to IDEs" section of the [ModusToolbox™ software user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox™ software install directory}/docs_{version}/mtb_user_guide.pdf*). | |
| 3. Follow the instructions displayed in the terminal to create or import the application as an IDE project. | |
| </details> | |
| ## Operation | |
| 1. Connect the board to your PC using a micro-USB cable through the debug USB connector. | |
| 2. Program the board 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 (JLink)**. | |
| 3. Turn the onboard potentiometer or press Button 1 from the kit to change the voltage of the configured ADC channel. | |
| **Note:** | |
| 1. For KIT_XMC14_BOOT_001, KIT_XMC_PLT2GO_XMC4200, and KIT_XMC_PLT2GO_XMC4400, use the onboard potentiometer to change the VADC values. | |
| 2. For KIT_XMC43_RELAX_ECAT_V1, KIT_XMC45_RELAX_V1, KIT_XMC47_RELAX_V1, and KIT_XMC48_RELAX_ECAT_V1 use a jumper wire to connect P14(0) to GND and the LED turns OFF. Connect P14(0) to VDD and the LED turns ON. | |
| 4. Monitor the `adc_result` variable for the VADC result. | |
| 5. Confirm that the LED glows when the VADC result is more than 2047 counts. | |
| 6. Confirm that the ADC result values are displayed on the UART terminal. | |
| **Figure 1. ADC result value on the terminal** | |
|  | |
| ## Debugging | |
| You can debug the example to step through the code. In the IDE, use the **\<Application Name> Debug (JLink)** configuration in the **Quick Panel**. For more details, see the "Program and debug" section in the [Eclipse IDE for ModusToolbox™ software user guide](https://www.infineon.com/MTBEclipseIDEUserGuide). | |
| ## Design and implementation | |
| VADC triggered by CCU8 peripheral on every period match event. The CCU8 peripheral is configured to give periodic interrupts every 0.5 seconds. | |
| The event is routed via the service request line to trigger VADC to measure the voltage from the analog input pin. | |
| The main file has the custom logic to turn on the LED when the VADC measurement is above the value of 2047 and turn off the LED when the VADC measurement is below the value of 2047. | |
| The output of the VADC is printed via debug UART which can be verified with a serial monitor. | |
| ### Resources and settings | |
| The project uses a custom *design.modus* file because the following settings were modified in the default *design.modus* file. | |
| **Figure 2. USIC (UART) settings** | |
|  | |
| **Figure 3. UART Tx pin settings** | |
|  | |
| **Figure 4. UART Rx pin settings** | |
|  | |
| <br> | |
| ## Related resources | |
| Resources | Links | |
| -----------|---------------------------------- | |
| Code examples | [Using ModusToolbox™ software](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software) on GitHub | |
| Device documentation | [XMC1000 family datasheets](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/32-bit-xmc1000-industrial-microcontroller-arm-cortex-m0/#document-group-myInfineon-49) <br> [XMC1000 family technical reference manuals](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/32-bit-xmc1000-industrial-microcontroller-arm-cortex-m0/#document-group-myInfineon-44) <br> [XMC4000 family datasheets](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/32-bit-xmc4000-industrial-microcontroller-arm-cortex-m4/#document-group-myInfineon-49) <br> [XMC4000 family technical reference manuals](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/32-bit-xmc4000-industrial-microcontroller-arm-cortex-m4/#document-group-myInfineon-44) | |
| Development kits | [XMC™ eval boards](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/#boards) | |
| Libraries on GitHub | [mtb-xmclib-cat3](https://github.com/Infineon/mtb-xmclib-cat3) – XMC™ peripheral driver library (XMCLib) | |
| Tools | [Eclipse IDE for ModusToolbox™ software](https://www.infineon.com/modustoolbox) – 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. | |
| <br> | |
| ## Document history | |
| Document title: *CE237945* - *XMC™ MCU: CCU8 triggered VADC measurement* | |
| Version | Description of change | |
| ------- | --------------------- | |
| 1.0.0 | New code example | |
| <br> | |
| ------ | |
| All other trademarks or registered trademarks referenced herein are the property of their respective owners. | |
| © 2023 Infineon Technologies AG | |
| All Rights Reserved. | |
| ### Legal disclaimer | |
| The information given in this document shall in no event be regarded as a guarantee of conditions or characteristics. With respect to any examples or hints given herein, any typical values stated herein and/or any information regarding the application of the device, Infineon Technologies hereby disclaims any and all warranties and liabilities of any kind, including without limitation, warranties of non-infringement of intellectual property rights of any third party. | |
| ### Information | |
| For further information on technology, delivery terms and conditions and prices, please contact the nearest Infineon Technologies Office (www.infineon.com). | |
| ### Warnings | |
| Due to technical requirements, components may contain dangerous substances. For information on the types in question, please contact the nearest Infineon Technologies Office. | |
| Infineon Technologies components may be used in life-support devices or systems only with the express written approval of Infineon Technologies, if a failure of such components can reasonably be expected to cause the failure of that life-support device or system or to affect the safety or effectiveness of that device or system. Life support devices or systems are intended to be implanted in the human body or to support and/or maintain and sustain and/or protect human life. If they fail, it is reasonable to assume that the health of the user or other persons may be endangered. | |
| ------------------------------------------------------------------------------- |