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-empty-app/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.
156 lines (90 sloc)
11.7 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: Empty application template | |
| This is a minimal starter application template for XMC™ MCU devices. | |
| ## 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` | |
| - Arm® compiler v6.16 (`ARM`) | |
| - IAR C/C++ compiler v9.30.1 (`IAR`) | |
| ## Supported Kits (make variable 'TARGET') | |
| - [XMC1100 boot kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc11_boot_001/) (`KIT_XMC11_BOOT_001`) | |
| - [XMC1200 boot kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc12_boot_001/) (`KIT_XMC12_BOOT_001`) | |
| - [XMC1300 boot kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc13_boot_001/) (`KIT_XMC13_BOOT_001`) | |
| - [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. (Optionally) change the suggested **New Application Name**. | |
| 5. Enter the local path in the **Application(s) Root Path** field to indicate where the application needs to be created. | |
| Applications that can share libraries can be placed 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/mtb_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. | |
| Alternatively, you can manually create the application using the following steps: | |
| 1. Download and unzip this repository onto your local machine, or clone the repository. | |
| 2. Open a CLI terminal and navigate to the application folder. | |
| On Linux and macOS, you can use any terminal application. On Windows, open the **modus-shell** app from the Start menu. | |
| **Note:** The cloned application contains a default BSP file (*TARGET_xxx.mtb*) in the *deps* folder. Use the [Library Manager](https://www.infineon.com/ModusToolboxLibraryManager) (`make modlibs` command) to select and download a different BSP file, if required. If the selected kit does not have the required resources or is not [supported](#supported-kits-make-variable-target), the application may not work. | |
| 3. Import the required libraries by executing the `make getlibs` command. | |
| Various CLI tools include a `-h` option that prints help information to the terminal screen about that tool. For more details, see 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> | |
| ## Related resources | |
| Resources | Links | |
| --------------------|---------------------- | |
| Code examples | [Using ModusToolbox™ software](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software) on GitHub| | |
| Kit guides| [XMC4700/XMC4800 relax kit series-V1](https://www.infineon.com/dgdl/Infineon-Board_User_Manual_XMC4700_XMC4800_Relax_Kit_Series-UM-v01_02-EN.pdf?fileId=5546d46250cc1fdf01513f8e052d07fc) – Board user‘s manual. Describes the schematic and hardware of the XMC4700/XMC4800 relax kit series-V1, equipped with XMC™ microcontroller based on Arm® Cortex®-M4 from Infineon.<br> [XMC1400 boot kit](https://www.infineon.com/dgdl/Infineon-Board_Users_Manual_XMC1400_Boot_Kit.pdf-UM-v01_00-EN.pdf?fileId=5546d462525dbac401527815f9a073fd) – Board user‘s manual. Describes the schematic and hardware of XMC1400 boot kit for application code development on the XMC1404-Q064X0200 device. | |
| 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) | [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 | Buy at www.infineon.com<br>[KIT_XMC14_BOOT_001](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_boot_001/) – Boot kit XMC1400 <br> [KIT_XMC47_RELAX_V1](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_v1/) – XMC4700 relax kit | | |
| Libraries on GitHub | [mtb-xmclib-cat3](https://github.com/Infineon/mtb-xmclib-cat3) – XMC™ peripheral driver library (XMCLib)and docs | |
| Tools | [Eclipse IDE for ModusToolbox™ software](https://www.infineon.com) – 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. | |
| ## 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 XMC™ MCU devices, see [32-bit XMC™ Industrial microcontroller based on Arm® Cortex®-M](https://www.infineon.com/cms/en/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/). | |
| ## Document history | |
| Document title: *CE231919* - *XMC™ MCU: Empty application template* | |
| | Version | Description of change | | |
| | ------- | --------------------- | | |
| | 0.5.0 | New code example | | |
| | 1.0.0 | Updated to support ModusToolbox™ software v2.3 | | |
| | 2.0.0 | Updated to support ModusToolbox™ software v3.0; CE will not be backwards compatible with previous versions of ModusToolbox™ software. | | |
| | 2.1.0 | Updated to support more kits | | |
| ------ | |
| All other trademarks or registered trademarks referenced herein are the property of their respective owners. | |
| © 2022 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. | |
| ------------------------------------------------------------------------------- |