XMC™ MCU: SCU Hibernate

This code example demonstrates a SCU Hibernate feature. In Active mode LED is ON for 5 Seconds and enter the internal hibernate mode and LED is OFF, RTC is configured to interrupt after 30 seconds to wake up the device from hibernate mode. Additionaly the HIB_IO_0 butto n can be used to wake up the device before expiring the 30s on the XMC™ MCU evaluation kits.

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')

• XMC4200 Platform2GO XTREME kit (KIT_XMC_PLT2GO_XMC4200) - Default value of TARGET
• XMC4400 Platform2GO XTREME kit (KIT_XMC_PLT2GO_XMC4400)

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:

In Eclipse IDE for ModusToolbox™ software

1. Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox™ Application). This launches the Project Creator 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 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 (locally available at {ModusToolbox™ software install directory}/ide_{version}/docs/mtb_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.

This 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 will clone the "SCU_Hibernate" application with the desired name "SCU_Hibernate" configured for the KIT_XMC_PLT2GO_XMC4400 BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id KIT_XMC_PLT2GO_XMC4400 --app-id mtb-example-xmc-scu-hibernate --user-app-name SCU_Hibernate --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).

In third-party IDEs

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 (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.

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. Confirm that the kit LED is ON for approximately for 5secs and OFF after 5secs. The RTC is configured to generate an alarm after 30 seconds.

4. Confirm that the kit reset after 30 seconds.

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™ user guide.

Design and implementation

The code consists of the following steps:

• Step 1: Initializes the RTC module with the rtc_config structure containing the alarm time and the clock divider.

• Step 2: Initializes the SCU Hibernate domain with the appropriate clock source in standby and Active mode.

• Step 3: Enable the event source to wake up the device and enable trigger event along with LED and wait for 5 seconds.

• Step 4: Start the RTC and Call the hibernate API to enter hibernate mode and enter into infinite loop. After entring the hibernate mode LED is OFF. RTC is configured for the 30 seconds will wake up the device from hibernate mode by reseting device.

• Step 5: After device reset check if hibernate domain is enabled and clear trigger event status Otherwise repeat from the Step 1:.

Related resources

Resources	Links
Code examples	Using ModusToolbox™ software on GitHub
Device documentation	XMC4000 family datasheets
Libraries on GitHub	mtb-xmclib-cat3 – XMC™ peripheral driver library (XMCLib)and docs
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: CE236887 - XMC™ MCU: SCU Hibernate

Version	Description of change
1.0.0	New code example

---

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.

---