Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/infineon/mtb-example-xmc-uart-shell

This code example demonstrates implementation of a shell on the UART communication interface including commands to toggle a LED using XMC MCU.
https://github.com/infineon/mtb-example-xmc-uart-shell

kit-xmc-plt2go-xmc4200 kit-xmc-plt2go-xmc4400 kit-xmc11-boot-001 kit-xmc12-boot-001 kit-xmc13-boot-001 kit-xmc14-boot-001 kit-xmc43-relax-ecat-v1 kit-xmc45-relax-v1 kit-xmc47-relax-v1 kit-xmc48-relax-ecat-v1 peripherals

Last synced: 9 months ago
JSON representation

This code example demonstrates implementation of a shell on the UART communication interface including commands to toggle a LED using XMC MCU.

Awesome Lists containing this project

README 

          
# XMC™ MCU: UART shell



This code example demonstrates the implementation of a command shell on the UART communication interface including commands to toggle an LED using XMC™ MCU devices.



## Requirements



- [ModusToolbox™](https://www.infineon.com/modustoolbox) v3.0 or later (tested with v3.3)

- [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 v11.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`

- [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`)

- [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`)

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



Install a terminal emulator if you don't have one. Instructions in this document use [Tera Term](https://teratermproject.github.io/index-en.html).



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](https://www.infineon.com/ModusToolboxProjectCreator) (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](#supported-kits-make-variable-target).



   > **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 "[UART Shell](https://github.com/Infineon/mtb-example-xmc-uart-shell)" application with the desired name "UARTShell" configured for the *KIT_XMC47_RELAX_V1* BSP into the specified working directory, *C:/mtb_projects*:



   ```

   project-creator-cli --board-id KIT_XMC47_RELAX_V1 --app-id mtb-example-uart-shell --user-app-name UARTShell --target-dir "C:/mtb_projects"

   ```



Update the above paragraph and commands to match your CE.



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



Argument | Description | Required/optional

---------|-------------|-----------

`--board-id` | Defined in the  field of the [BSP](https://github.com/Infineon?q=bsp-manifest&type=&language=&sort=) manifest | Required

`--app-id`   | Defined in the  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



> **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](https://www.infineon.com/ModusToolboxUserGuide) (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](https://www.infineon.com/MTBEclipseIDEUserGuide) (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](https://www.infineon.com/MTBVSCodeUserGuide) (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](https://www.infineon.com/MTBuVisionUserGuide) (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](https://www.infineon.com/MTBIARUserGuide) (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](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox™ install directory}/docs_{version}/mtb_user_guide.pdf*).



## Operation



1. Connect the board to your PC using a micro-USB cable through the debug USB connector.



2. Open a terminal program and select the *JLINK CDC UART COM port*. Configure the terminal with a baud rate of 115200, data bits of 8, stop bit of 1, and with parity and flow control set to none.



3. Program the board using one of the following:



   Using Eclipse IDE



      1. Select the application project in the Project Explorer.



      2. In the **Quick Panel**, scroll down, and click **\ Program (JLink)**.

   



   In other IDEs



   Follow the instructions in your preferred IDE.

   



   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=

      ```



      Example:

      ```

      make program TOOLCHAIN=GCC_ARM

      ```

   



4. After programming, the application starts automatically. Confirm that "Shell Application" is displayed on the UART terminal.



   **Figure 1. Shell application in Terminal**



   ![](images/terminal-shell-application.png)



5. Type `help` and press **Enter** to check for available commands.



6. Type `ledport low` and press **Enter** to switch the LED port from HIGH level (default after reset) to LOW level.



7. Type `ledport high` and press **Enter** to switch the LED port back to HIGH level.



8. Verify that the LED state toggles on steps 6 and 7.



## Debugging



You can debug the example to step through the code.



In Eclipse IDE



Use the **\ Debug (JLink)** configuration in the **Quick Panel**. For details, see the "Program and debug" section in the [Eclipse IDE for ModusToolbox™ user guide](https://www.infineon.com/MTBEclipseIDEUserGuide).



In other IDEs



Follow the instructions in your preferred IDE.



## Design and implementation



The implementation is realized by using a UART resource. UART is configured by “uart 1.0” personality in **Device Configurator**, where UART features such as baud rate, data bits, and frame length are set.



A shell facilitates interaction with the user allowing the user to control the output of the LED pin. The `cmd_table[]` array provides the set of commands consisting of `help_cmd()` and `led_cmd()` functions.



The `help_cmd()` function calls the default command shell help function.



The `led_cmd()` function sets the GPIO output to HIGH or LOW depending on the input.



In the main loop, the `shell_state_machine()` function is executed.



### 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**



![](images/uart_shell_personality.png)







**Figure 3. UART Tx pin settings**



![](images/uart_shell_config1.png)







**Figure 4.  UART Tx pin settings**



![](images/uart_shell_config2.png)



## 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) 
 [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) 
 [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) 
 [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™ MCU peripheral library (XMCLib) and docs

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.



## 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: *CE231961* - *XMC™ MCU: UART Shell*



 Version | Description of change |

 ------- | ---------------------

 0.5.0   | New code example |

 1.0.0   | Updated to support ModusToolbox™ software v2.3 |

 1.0.1   | Updated README |

 1.1.0   | Added support for new kits |

 2.0.0   | Updated to support ModusToolbox™ software v3.0; CE will not be backward compatible with previous versions of ModusToolbox™ software |

 2.1.0   | Added support for new kits |

 2.1.1   | Updated README |        

 2.2.0   | Updated code to use retarget-io-cat3 middleware for shell operations |

------



All other trademarks or registered trademarks referenced herein are the property of their respective owners.



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



-------------------------------------------------------------------------------