XMC™ MCU: SPI DMA

This code example demonstrates how to use the DMA driver to transfer data from the RAM to the SPI buffer freeing the CPU for other tasks.

View this README on GitHub.

Provide feedback on this code example.

Requirements

ModusToolbox™ v3.1 (tested with v3.2)
SEGGER J-Link software
Programming language: C
Associated parts: All XMC™ MCU parts

Supported toolchains (make variable 'TOOLCHAIN')

GNU Arm® Embedded Compiler v11.3.1 (GCC_ARM) – Default value of TOOLCHAIN

Supported kits (make variable 'TARGET')

XMC4700 relax kit (KIT_XMC47_RELAX_V1) – Default value of TARGET
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. An external jumper wire is required to connect between MOSI and MISO.

Table 1. Board connections

Development board	Signal name	Pin
KIT_XMC_PLT2GO_XMC4200	MOSI	P1_9
	MISO	P0_0
KIT_XMC43_RELAX_ECAT_V1	MOSI	P0_5
	MISO	P2_2
KIT_XMC_PLT2GO_XMC4400	MOSI	P1_9
	MISO	P0_0
KIT_XMC45_RELAX_V1	MOSI	P0_5
	MISO	P0_4
KIT_XMC47_RELAX_V1	MOSI	P0_5
	MISO	P0_4
KIT_XMC48_RELAX_ECAT_V1	MOSI	P0_5
	MISO	P0_4

Software setup

See the ModusToolbox™ tools package installation guide for information about installing and configuring the tools package.

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

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).
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.
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 "mtb-example-xmc-spi-dma" application with the desired name "SPI_DMA" 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-spi-dma --user-app-name SPI_DMA --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

Externally connect the jumper wire between MOSI and MISO pins.
Connect the board to your PC using a Micro-USB cable through the debug USB connector.
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 <Application Name> 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=<toolchain>
```
Example:
```
make program TOOLCHAIN=GCC_ARM
```
After programming, the application starts automatically.
Observe LED1 blinking which indicates successful data transfer using SPI.
To illustrate a transfer error, remove the external connection made in Step 1 and observe the LED2 glow.

Note: Only KIT_XMC_PLT2GO_XMC4200 does not have two LEDs. The illustration of a transfer error will be the same as in Step 6 with LED1 constantly glowing.

The macro ENABLE_XMC_DEBUG_PRINT in main.c is disabled by default. When this macro is enabled, code execution logs can be seen in an UART terminal such as TeraTerm, Putty etc.

Note: Code execution logs can be seen for all BSPs except KIT_XMC_PLT2GO_XMC4400. This is because the SPI channel and UART channel that are supported on the kit hardware belong to the same USIC block. Therefore, SPI and UART cannot be enabled at the same time.

Debugging

You can debug the example to step through the code.

In Eclipse 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.

In other IDEs

Follow the instructions in your preferred IDE.

Design and implementation

In this example project, SPI is configured so that a data buffer (src) is transferred through the SPI MOSI pin to the MISO pin of the same SPI component. After the transfer, the received data is compared with the transmitted data. If the transfer is successful, the data received is the same as the data transmitted. The LEDs indicate the success or failure of the data transfer.

DMA helps in offloading the data transfer from the CPU, allowing it to perform other tasks. The role of DMA in this code example is to place the firmware data buffer (src) on the SPI output FIFO and also to read the data buffer (dst) from the SPI input FIFO after the transfer.

Related resources

Resources	Links
Code examples	Using ModusToolbox™ software on GitHub
Device documentation	XMC4000 family datasheets XMC4000 family technical reference manuals
Development kits	XMC™ MCU eval boards
Libraries on GitHub	mtb-xmclib-cat3 – XMC™ MCU peripheral library (XMCLib)
Tools	ModusToolbox™ – ModusToolbox™ software is a collection of easy-to-use libraries and tools enabling rapid development with Infineon MCUs for applications ranging from wireless and cloud-connected systems, edge AI/ML, embedded sense and control, to wired USB connectivity using PSoC™ Industrial/IoT MCUs, AIROC™ Wi-Fi and Bluetooth® connectivity devices, XMC™ Industrial MCUs, and EZ-USB™/EZ-PD™ wired connectivity controllers. ModusToolbox™ incorporates a comprehensive set of BSPs, HAL, libraries, configuration tools, and provides support for industry-standard IDEs to fast-track your embedded application 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 XMC™ MCU devices, see 32-bit XMC™ Industrial microcontroller based on Arm® Cortex®-M.

Document history

Document title: CE232726 – XMC™ MCU: SPI DMA

Version	Description of change
1.0.0	New code example
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 SPI and DMA personalities
2.1.1	Updated README
2.2.0	Removed the UART debug logs for KIT_XMC_PLT2GO_XMC4400

All referenced product or service names and trademarks 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.

License

Infineon/mtb-example-xmc-spi-dma

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages