infineon / mtb-example-xmc-posif-hall

This code example demonstrates a position interface (POSIF) module in Hall sensor mode and uses the capture and compare unit 4 (CCU40) module to determine the speed of rotation of the motor.

XMC™ MCU: POSIF hall

This code example demonstrates a position interface (POSIF) module in hall sensor mode and uses the capture and compare unit 4 (CCU40) module to determine the speed of rotation of the motor. An interrupt is generated everytime, a correct or incorrect hall event is detected. The SysTick timer is used to display the timing between the two correct hall events and incorrect hall event occurrence on the terminal. Instead of physically connecting the motor, the example demonstrates the use of the POSIF_HALL module using simulation via the PWM signals (CCU80).

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

• XMC1300 boot kit (KIT_XMC13_BOOT_001)
• XMC1400 boot kit (KIT_XMC14_BOOT_001) - Default value of TARGET
• XMC4200 Platform2Go kit (KIT_XMC_PLT2GO_XMC4200)
• XMC4400 Platform2Go kit (KIT_XMC_PLT2GO_XMC4400)
• XMC4500 relax kit (KIT_XMC45_RELAX_V1)
• XMC4700 relax kit (KIT_XMC47_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.

Table 1 through Table 3 show the hall input and output signal connections to ports. Each input signal should be connected to the corresponding output signal.

Table 1. Input and output connections in XMC1300 kit

Input signal	Ports	Output signal	Ports
Hall input 1	Port P0.13	Hall output 1	Port P2_10
Hall input 2	Port P1.1	Hall output 2	Port P0_2
Hall input 3	Port P1.0	Hall output 3	Port P1_4

Table 2. Input and output connections in XMC1400 kit

Input signal	Ports	Output signal	Ports
Hall input 1	Port P0.13	Hall output 1	Port P0_0
Hall input 2	Port P1.1	Hall output 2	Port P0_2
Hall input 3	Port P1.0	Hall output 3	Port P0_12

Table 3. Input and output connections in XMC4200, XMC4400, XMC4500, XMC4700 and XMC4800 kits

Input signal	Ports	Output signal	Ports
Hall input 1	Port P14_7	Hall output 1	Port P0_5
Hall input 2	Port P14_6	Hall output 2	Port P0_4
Hall input 3	Port P14_5	Hall output 3	Port P0_3

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

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. (Optional) Change the suggested New Application Name.

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

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}/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 "POSIF HALL" application with the desired name "PosifHall" configured for the KIT_XMC14_BOOT_001 BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id KIT_XMC14_BOOT_001 --app-id mtb-example-xmc-posif-hall --user-app-name PosifHall --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

Following example adds the KIT_XMC47_RELAX_V1 BSP to the already created application and makes it the active BSP for the app:

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

library-manager-cli --project "C:/mtb_projects/PosifHall" --set-active-bsp APP_KIT_XMC47_RELAX_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

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 KitProg3 COM port. Set the serial port parameters to 8N1 and 115200 baud.

3. 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).

4. Connect hall input signals to posif module input pins as mentioned in hardware setup section.

5. Confirm that each time a correct hall event is detected, an interrupt is generated and the timing between the two correct hall events is displayed on the UART terminal.

   Figure 1. Terminal output

   

6. Confirm that each time an incorrect hall event is detected, an interrupt is generated and displayed on the UART terminal.

   Figure 2. Terminal output

   

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 application uses the 'CYBSP_DEBUG_UART' resource to print messages in a UART terminal emulator. This resource is configured by the ModusToolbox™ software UART personality. The retargeting of the standard I/O to the CYBSP_DEBUG_UART port is included in the example. After using retarget_io_init, messages can be printed on the terminal by simply using printf commands.

The POSIF module is configured in hall sensor mode. Hall input signals are connected to the POSIF module input ports.

The application uses a CCU4 slice configured using the CCU4 personality. The CAPTURE_0 CCU4 slice is configured in capture mode. It will capture the timer value on the rising edge of the POSIF0.OUT1 signal. The DELAY_0 CCU4 slice is configured in compare mode. It starts a timer that is configured in single-shot mode. The status signal is connected to POSIF.HSDA to delay the input sampling to reject noise that might appear at those positions.

The POSIF module checks for the hall sequence 1 -> 3 -> 2 -> 6 -> 4 -> 5. Each time a correct Hall event is detected, an interrupt is generated and the timing between the two correct hall events is displayed on the terminal. It also checks for the occurrence of an incorrect hall event interrupt and displays it on the terminal.

Resources and settings

The project uses a custom design.modus file because the following settings were modified in the default design.modus file.

Figure 3. USIC (UART) configuration for XMC4700 relax kit

Figure 4. CCU40 delay timer configuration for XMC4700 relax kit

Figure 5. CCU40 delay timer configuration for XMC4700 relax kit

Figure 6. CCU40 speed timer configuration for XMC4700 relax kit

Figure 7. CCU40 speed timer configuration for XMC4700 relax kit

Figure 8. CCU80 hall 1 configuration for XMC4700 relax kit

Figure 9. CCU80 hall 2 configuration for XMC4700 relax kit

Figure 10. CCU80 hall 3 configuration for XMC4700 relax kit

Figure 11. POSIF0 hall configuration for XMC4700 relax kit

Figure 12. Hall input pins settings for XMC4700 relax kit

Related resources

Resources	Links
Code examples	Using ModusToolbox™ software on GitHub
Device documentation	XMC1000 MCU family datasheets XMC1000 MCU family technical reference manuals XMC4000 MCU family datasheets XMC4000 MCU family technical reference manuals
Development kits	XMC MCU eval boards
Libraries on GitHub	mtb-xmclib-cat3 – XMC™ MCU peripheral driver 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: CE232706 – XMC™ MCU: POSIF hall

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 will not be backwards compatible with previous versions of ModusToolbox™ software.
2.1.0	Added support for POSIF personality

---

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.

---