XMC™ MCU: Flash program

This code example demonstrates how to erase a sector of the flash, write data to the sector, and check the data for correctness.

View this README on GitHub.

Provide feedback on this code example.

Requirements

ModusToolbox™ software v3.0
SEGGER J-Link software
Programming language: C
Associated parts: All XMC™ MCU 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')

XMC4700 relax kit (KIT_XMC47_RELAX_V1) - Default value of TARGET
XMC1100 boot kit (KIT_XMC11_BOOT_001)
XMC1200 boot kit (KIT_XMC12_BOOT_001)
XMC1300 boot kit (KIT_XMC13_BOOT_001)
XMC1400 boot kit (KIT_XMC14_BOOT_001)
XMC4200 Platform2Go XTREME kit (KIT_XMC_PLT2GO_XMC4200)
XMC4300 relax EtherCAT kit (KIT_XMC43_RELAX_ECAT_V1)
XMC4400 Platform2Go XTREME kit (KIT_XMC_PLT2GO_XMC4400)
XMC4500 relax kit (KIT_XMC45_RELAX_V1)
XMC4800 relax EtherCAT kit (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.

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

Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox™ Application). This launches the Project Creator tool.
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.
In the Project Creator - Select Application dialog, choose the example by enabling the checkbox.
(Optional) Change the suggested New Application Name.
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.
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}/mt_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 "Flash program" application with the desired name "Flash_program" 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-xmc-flash-program --user-app-name Flash_program --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 KIT_XMC48_RELAX_ECAT_V1 BSP to the already created application and makes it the active BSP for the app:

library-manager-cli --project "C:/mtb_projects/Flash_program" --add-bsp-name KIT_XMC48_RELAX_ECAT_V1 --add-bsp-version "latest-v4.X" --add-bsp-location "local"

library-manager-cli --project "C:/mtb_projects/Flash_program" --set-active-bsp APP_KIT_XMC48_RELAX_ECAT_V1

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

Connect the board to your PC using a micro-USB cable through the debug USB connector.
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).
The LED will be turned on before start of programming. Programming is executed in three steps:
1. Erase a sector inside the flash.
2. Program the first page (256 bytes) of the sector with the data.
3. Compare the data to confirm its correctness. If correct, toggle the LED.
Check whether the LED toggles, which confirms the correct programming of the flash.

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.

Design and implementation

The code consists of two parts:

Part 1: Defines the data [XMC_FLASH_WORDS_PER_PAGE] array. This array contains 256 bytes of data, which should be programmed into the flash memory. For all the kits, it also defines the starting address of the flash page from where the programming starts. This starting address is saved in the variable XMC_SECTOR_ADDR, which contains different addresses depending on the selected kit. GPIO pins are also defined for LED toggling using the 'pin 1.0' personality. The pins are accessed using their labels: CYBSP_USER_LED_PORT and CYBSP_USER_LED_PIN. Finally, the LED is turned ON when the output is set to HIGH.
Part 2: Erases the sector using the XMC_FLASH_EraseSector() function. This requires an address pointer to the starting address of the flash page from where the erase starts (XMC_SECTOR_ADDR). Next, data[XMC_FLASH_WORDS_PER_PAGE] will be programmed into the flash using the XMC_FLASH_ProgramPage() function, which requires the starting address and a pointer to the source address (data[XMC_FLASH_WORDS_PER_PAGE]) where the targeted data is located. Finally, the flash process is verified by comparing all elements of the data[XMC_FLASH_WORDS_PER_PAGE] array stored in the RAM and the same elements programmed in the flash. The LED will be turned OFF after the flash programming is complete.

Related resources

Resources	Links
Code examples	Using ModusToolbox™ software on GitHub
Device documentation	XMC1000 family datasheets XMC4000 family datasheets XMC1000 family technical reference manuals XMC4000 family technical reference manuals
Development kits	XMC™ MCU eval boards
Libraries on GitHub	mtb-xmclib-cat3 – XMC™ MCU peripheral library (XMCLib)
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.

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.

Document history

Document title: CE232570 - XMC™ MCU: Flash program

Version	Description of change
1.0.0	New code example
1.0.1	Updated README
1.1.0	Added support for new kits
2.0.0	Updated to support ModusToolbox™ software v3.0. This CE is not backward compatible with previous version of ModusToolbox™ software.
2.1.0	Added support for new kits

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

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.

infineon / mtb-example-xmc-flash-program Goto Github PK

mtb-example-xmc-flash-program's Introduction

XMC™ MCU: Flash program

Requirements

Supported toolchains (make variable 'TOOLCHAIN')

Supported kits (make variable 'TARGET')

Hardware setup

Software setup

Using the code example

Operation

Debugging

Design and implementation

Related resources

Other resources

Document history

Legal disclaimer

Information

Warnings

mtb-example-xmc-flash-program's People

Contributors

Stargazers

Watchers

Recommend Projects

Recommend Topics

Recommend Org