This example demonstrates how to transition the MCU to the Active, Sleep, DeepSleep, and Hibernate power states, and how to wake up and return to Active state. This multi-core application has the main function running on the CM4 core.
This code example shows how to transition the MCU to Active, Sleep, and DeepSleep power states. After transitioning to Sleep, DeepSleep, or Hibernate power state, the example also shows how to wake up and return to Active state.
The project uses a kit button to change the power state. Figure 1 shows the state machine implemented in the firmware to execute the transitions.
Figure 1. Power modes state machine
The project also uses an LED to indicate the selected power state. Table 1 shows the state of the LED for each mode.
Table 1. LED states in various power states
| Power/MCU states | LED state |
|---|---|
| Active | Blinks |
| Sleep | Turned ON and dimmed |
| DeepSleep | Turned OFF |
| Hibernate | Turned OFF |
- ModusToolbox™ software v3.0 or later (tested with v3.1)
- Programming language: C
- Associated parts: TRAVEO™ T2G Body Entry MCU
- GNU Arm® embedded compiler v11.3 (
GCC_ARM) - Default value ofTOOLCHAIN - Arm® compiler v6.16 (
ARM) - IAR C/C++ compiler v9.30.1 (
IAR)
- TRAVEO™ T2G body entry evaluation kit (
KIT_T2G-B-E_LITE) - Default value ofTARGET
This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly.
The example does not require any additional hardware to run. However, you can connect an ammeter to measure the current consumed by the MCU device. See the kit guide to learn how to measure the current. It might require changes in the hardware.
Install a terminal emulator if you don't have one. Instructions in this document use Tera Term.
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 will clone the "mtb-t2g-lite-example-switching-power-modes" application with the desired name "MyPowerModes" configured for the KIT_T2G-B-E_LITE BSP into the specified working directory, C:/mtb_projects:
project-creator-cli --board-id KIT_T2G-B-E_LITE --app-id mtb-t2g-lite-example-switching-power-modes --user-app-name MyPowerModes --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 modlibs 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 |
In third-party IDEs
Use one of the following options:
-
Use the standalone Project Creator tool:
-
Launch Project Creator from the Windows Start menu or from {ModusToolbox™ software install directory}/tools_{version}/project-creator/project-creator.exe.
-
In the initial Choose Board Support Package screen, select the BSP, and click Next.
-
In the Select Application screen, select the appropriate IDE from the Target IDE drop-down menu.
-
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):
-
Follow the instructions from the In command-line interface (CLI) section to create the application, and then import the libraries using the
make getlibscommand. -
Export the application to a supported IDE using the
make <ide>command. -
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).
-
Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.
-
Open a terminal program and select the KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud.
-
Program the board using one of the following:
Using Eclipse IDE for ModusToolbox™ software
-
Select the application project in the Project Explorer.
-
In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3_MiniProg4).
Using CLI
From the terminal, execute the
make programcommand to build and program the application using the default toolchain to the default target. The default toolchain and target are specified in the application's Makefile but you can override those values manually:make program TARGET=<BSP> TOOLCHAIN=<toolchain>Example:
make program TARGET=KIT_T2G-B-E_LITE TOOLCHAIN=GCC_ARM -
-
After programming, the application starts automatically. Confirm that kit LED blinks at 3 Hz (approximately). Take note of the current consumption. The device is in the Active state at this moment.
-
Quickly press the kit button to transition the device into Sleep power state. Observe that the LED is ON and dimmed. Confirm that the current consumption drops to dozens of milliamperes. The CPU is in the Sleep state at this moment.
-
Quickly press the kit button to return to Active state. Observe that the LED blinks again.
-
Press the kit button for approximately one second and release it. Observe that the LED is OFF and that the current consumption has dropped to over a hundred microamperes. The device is in DeepSleep state at this moment.
-
Quickly press the kit button to return to Active power state. Observe that the LED blinks again and that the current consumption has increased to the same level measured before.
-
Press the kit button for at least two seconds and release it. Observe that the LED is OFF and that the current consumption has dropped to approximately ten microamperes. The device is in Hibernate state at this moment. After steps 4 - 9, the terminal application displays the message as follows:
Figure 2. Terminal output
-
Quickly press the kit button to wake up from Hibernate power state, and then MCU reset. Observe that the LED is blinking again. When woken up from Hibernate mode, the terminal application displays the message as follows:
Figure 3. Hibernate wakeup terminal output
You can debug the example to step through the code. In the 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™ software user guide.
This example configures the PWM to blink, dim, and turn ON/OFF the LED. The firmware implements the state machine shown in the Overview section and controls the duty cycle of the PWM block. The device wakes up when a switch press is detected.
Power management callback functions are registered as PWM callbacks. Table 2 shows the actions of callback function for every power state. For more information on power callbacks, see the HAL driver - System Power Management.
Table 2. Transition actions
| Callback | Power state | CHECK_READY | CHECK_FAIL | BEFORE_TRANSITION | AFTER_TRANSITION |
|---|---|---|---|---|---|
| PWM callback | Sleep | Nothing | Nothing | Dim the LED. | Blink the LED. |
| PWM callback | DeepSleep | Nothing | Nothing | Stop PWM | Re-enable the PWM block. Blink the LED. |
| PWM callback | Hibernate | Nothing | Nothing | Stop PWM | Nothing |
Table 3. Application resources
| Resource | Alias/object | Purpose |
|---|---|---|
| PWM (HAL) | pwm | Used to control the LED |
| GPIO (HAL) | CYBSP_USER_BTN | Used to wake up the device and change power states |
| UART (HAL) | cy_retarget_io_uart_obj | UART HAL object used by Retarget-IO for Debug UART port |
| Resources | Links |
|---|---|
| Application notes | AN235305 - GETTING STARTED WITH TRAVEO™ T2G FAMILY MCUS IN MODUSTOOLBOX™ AN220222 -Low-power mode procedure in TRAVEO™ T2G family |
| Training | Traveo™ II Power Modes |
| Code examples | TRAVEO™ T2G MCU examples on GitHub |
| Device documentation | Device datasheet for CYT2BL Architecture Technical reference manuals (TRM) for TRAVEO™ T2G body entry series |
| Libraries on GitHub | mtb-pdl-cat1 – Peripheral driver library (PDL) mtb-hal-cat1 – Hardware abstraction layer (HAL) library retarget-io – Utility library to retarget STDIO messages to a UART port |
| Middleware on GitHub | mcu-middleware – Links to all MCU middleware |
| 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. |
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 TRAVEO™ T2G body entry MCU devices, see TRAVEO™ T2G CYT2BL Series
| Version | Description of change |
|---|---|
| 1.0.0 | New code example. |
© Cypress Semiconductor Corporation, 2022. This document is the property of Cypress Semiconductor Corporation, an Infineon Technologies company, and its affiliates ("Cypress"). This document, including any software or firmware included or referenced in this document ("Software"), is owned by Cypress under the intellectual property laws and treaties of the United States and other countries worldwide. Cypress reserves all rights under such laws and treaties and does not, except as specifically stated in this paragraph, grant any license under its patents, copyrights, trademarks, or other intellectual property rights. If the Software is not accompanied by a license agreement and you do not otherwise have a written agreement with Cypress governing the use of the Software, then Cypress hereby grants you a personal, non-exclusive, nontransferable license (without the right to sublicense) (1) under its copyright rights in the Software (a) for Software provided in source code form, to modify and reproduce the Software solely for use with Cypress hardware products, only internally within your organization, and (b) to distribute the Software in binary code form externally to end users (either directly or indirectly through resellers and distributors), solely for use on Cypress hardware product units, and (2) under those claims of Cypress’s patents that are infringed by the Software (as provided by Cypress, unmodified) to make, use, distribute, and import the Software solely for use with Cypress hardware products. Any other use, reproduction, modification, translation, or compilation of the Software is prohibited.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS DOCUMENT OR ANY SOFTWARE OR ACCOMPANYING HARDWARE, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. No computing device can be absolutely secure. Therefore, despite security measures implemented in Cypress hardware or software products, Cypress shall have no liability arising out of any security breach, such as unauthorized access to or use of a Cypress product. CYPRESS DOES NOT REPRESENT, WARRANT, OR GUARANTEE THAT CYPRESS PRODUCTS, OR SYSTEMS CREATED USING CYPRESS PRODUCTS, WILL BE FREE FROM CORRUPTION, ATTACK, VIRUSES, INTERFERENCE, HACKING, DATA LOSS OR THEFT, OR OTHER SECURITY INTRUSION (collectively, "Security Breach"). Cypress disclaims any liability relating to any Security Breach, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any Security Breach. In addition, the products described in these materials may contain design defects or errors known as errata which may cause the product to deviate from published specifications. To the extent permitted by applicable law, Cypress reserves the right to make changes to this document without further notice. Cypress does not assume any liability arising out of the application or use of any product or circuit described in this document. Any information provided in this document, including any sample design information or programming code, is provided only for reference purposes. It is the responsibility of the user of this document to properly design, program, and test the functionality and safety of any application made of this information and any resulting product. "High-Risk Device" means any device or system whose failure could cause personal injury, death, or property damage. Examples of High-Risk Devices are weapons, nuclear installations, surgical implants, and other medical devices. "Critical Component" means any component of a High-Risk Device whose failure to perform can be reasonably expected to cause, directly or indirectly, the failure of the High-Risk Device, or to affect its safety or effectiveness. Cypress is not liable, in whole or in part, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any use of a Cypress product as a Critical Component in a High-Risk Device. You shall indemnify and hold Cypress, including its affiliates, and its directors, officers, employees, agents, distributors, and assigns harmless from and against all claims, costs, damages, and expenses, arising out of any claim, including claims for product liability, personal injury or death, or property damage arising from any use of a Cypress product as a Critical Component in a High-Risk Device. Cypress products are not intended or authorized for use as a Critical Component in any High-Risk Device except to the limited extent that (i) Cypress’s published data sheet for the product explicitly states Cypress has qualified the product for use in a specific High-Risk Device, or (ii) Cypress has given you advance written authorization to use the product as a Critical Component in the specific High-Risk Device and you have signed a separate indemnification agreement.
Cypress, the Cypress logo, and combinations thereof, WICED, ModusToolbox, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress or a subsidiary of Cypress in the United States or in other countries. For a more complete list of Cypress trademarks, visit cypress.com. Other names and brands may be claimed as property of their respective owners.