EZ-USB™ FX2G3: HID-CFU application

This code example demonstrates the implementation of an HID-based component firmware update (CFU) using the Microsoft CFU model alongside a USB echo device application.

This code example has two sub components, intended to be operated in a mutually exclusive manner:

CFU: This subcomponent demonstrates component binary update for the external SPI flash component available on the FPGA add-on board over an HID interface. It enables firmware updates to be delivered over USB to connected devices, ensuring secure and efficient updates
Echo device application: This subcomponent showcases the implementation of a vendor-specific USB device

View this README on GitHub.

Provide feedback on this code example.

Requirements

ModusToolbox™ v3.5 or later (tested with v3.5)
Board support package (BSP) minimum required version: 4.3.3
Programming language: C
Associated parts: EZ-USB™ FX2G3

Supported toolchains (make variable 'TOOLCHAIN')

GNU Arm® Embedded Compiler v14.2.1 (GCC_ARM) – Default value of TOOLCHAIN
Arm® Compiler v6.22 (ARM)

Supported kits (make variable 'TARGET')

EZ-USB™ FX2G3 DVK (KIT_FX2G3_104LGA) – Default value of TARGET

Hardware setup

This example uses the board's default configuration with the inclusion of the FPGA add-on board. See the kit user guide to ensure that the board is configured correctly.

Software setup

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

Install a terminal emulator if you do not have one. Instructions in this document use Tera Term.

Install the EZ-USB™ FX Control Center (Alpha) application from Infineon Developer Center.

See the CFU Resources README to install the Microsoft CFU Standalone Tool.

Optional software

EZ-USB™ GPIF III Designer - EZ-USB™ GPIF III Designer, a desktop application that guides the process of defining general programmable interface and state machine to generate C source header for FX device family.

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 "EZ-USB™ FX2G3: HID-CFU application" application with the desired name "FX2G3_HID-CFU" configured for the KIT_FX2G3_104LGA BSP into the specified working directory, C:/mtb_projects:

project-creator-cli --board-id KIT_FX2G3_104LGA --app-id mtb-example-fx2g3-hid-cfu --user-app-name FX2G3_HID_CFU --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).

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

Using this code example with specific products

By default, the code example builds for the CYUSB2318-BF104AXI product.

List of supported products

CYUSB2318-BF104AXI
CYUSB2317-BF104AXI

Setup for a different product

Perform the following steps to build this code example for a different, supported product:

Launch the BSP assistant tool:

a. Eclipse IDE: Launch the BSP Assistant tool by navigating to Quick Panel > Tools

b. Visual Studio Code: Select the ModusToolbox™ extension from the menu bar, and launch the BSP Assistant tool, available in the Application menu of the MODUSTOOLBOX TOOLS section from the left pane
In BSP Assistant, select Devices from the tree view on the left
Choose CYUSB231x-BF104AXI from the drop-down menu, on the right
Click Save

This closes the BSP Assistant tool.
Navigate the IDE's Explorer and delete the GeneratedSource folder (if available), at <bsp-root-folder>/bsps/TARGET_APP_KIT_FX2G3_104LGA/

Note: For products CYUSB2315-BF104AXI and CYUSB2316-BF104AXI, additionally delete the *.cyqspi file from the config/ directory
Launch the Device Configurator tool

a. Eclipse IDE: Select your project in the project explorer, and launch the Device Configurator tool by navigating to Quick Panel > Tools

b. Visual Studio Code: Select the ModusToolbox™ extension from the left menu bar, and launch the Device Configurator tool, available in the BSP menu of the MODUSTOOLBOX TOOLS section from the left pane
Correct the issues (if any) specified in the Errors section on the bottom

a. For a switch from the CYUSB2318-BF104AXI product to any other, a new upper limit of 100 MHz is imposed on the desired frequency that can originate from the PLL. Select this issue and change the desired frequency from 150 MHz to 75 MHz

b. The CLK_PERI clock, which is derived from this new source frequency, is also affected. To restore it to its original frequency, go to the System Clocks tab, select CLK_PERI, and set its divider to '1' (instead of '2')

Note: For the CYUSB2315-BF104AXI product, to enable UART logging through SCB, follow the steps below:
a. Set the USBFS_LOGS_ENABLE macro to 0 in the Makefile
b. In main.c, modify the SCB configuration by changing LOGGING_SCB from (SCB4) to (SCB0), LOGGING_SCB_IDX from (4) to (0) and the value of dbgCfg.dbgIntfce from CY_DEBUG_INTFCE_UART_SCB4 to CY_DEBUG_INTFCE_UART_SCB0
c. Launch the Device Configurator tool to disable SCB4, and enable SCB0 for UART. Set 921600 baud, 9 Oversample, and use the 16 bit Divider 0 clk clock

Operation

Note: This code example currently supports Windows hosts. Support for Linux and macOS will be added in upcoming releases.

Connect the board (J2) to your PC using the provided USB cable
Connect the USBFS port (J7) on the board to the PC for debug logs
Open a terminal program and select the Serial COM port. Set the serial port parameters to 8N1 and 921600 baud
Follow these steps to program the board using the EZ-USB™ FX Control Center (Alpha) application
1. Perform the following steps to enter into the Bootloader mode:
  
  a. Press and hold the PMODE (SW1) switch
  b. Press and release the RESET switch
  c. Release the PMODE switch
2. Open EZ-USB™ FX Control Center application The EZ-USB™ FX2G3 device displays as EZ-USB™ FX BOOTLOADER
3. Select the EZ-USB™ FX BOOTLOADER device in EZ-USB™ FX Control Center
4. Navigate to Program > Internal Flash
5. Navigate to the /build/APP_KIT_FX2G3_104LGA/Release folder within the CE directory and locate the .hex file and program
6. Confirm if the programming is successful in the log window of the EZ-USB™ FX Control Center application
After programming, the application starts automatically. Confirm that the following title is displayed on the UART terminal:

Figure 1. Terminal output on program startup
The device enumerates as a composite device with the following interfaces:
1. Vendor interface: Demonstrates echo device application
2. CFU (HID) interface: Demonstrates Component Firmware Update (CFU)
Figure 2. Device Manager View after enumeration
Follow these steps to use the vendor interface as an echo device application:
1. Open the EZ-USB™ FX Control Center (Alpha) application
2. Select the device and choose Data Loopback in the right pane
3. Choose a configuration and click Start
  
  This initiates data transfers between the selected endpoints in a loopback mode
Follow these steps to perform CFU:
1. Launch a terminal and navigate to the CFU_Resources directory available in this project
2. Place the desired input bitfile in this directory and run the following commands by replacing <bitfile_name> with the name of selected input bitfile, to generate the CFU offer and payload binaries:
  
  Note: Throughout the document, <bitfile_name> refers to the name of the initial input bitfile.
  - Clean:
```
rm -f <bitfile_name>.offer.bin <bitfile_name>.payload.bin
```
  - Generate CFU offer and payload binaries:
```
python cfu_generate_offer_and_payload.py <bitfile_name>
```
    This generates an offer file <bitfile_name>.offer.bin and a payload file <bitfile_name>.payload.bin.
    
    Note: If you wish to utilize specific CFU features with this application (such as forceIgnoreVersion), set the appropriate bits in the offer binary file by modifying the corresponding variables in the offer generation script. See Microsoft's CFU implementation guide for more details on writing a custom offer binary.
3. Use the CFU standalone tool executable (FwUpdateCfu.exe) with the following command to perform CFU on the device:
```
FwUpdateCfu.exe update protocolCfgExample_fx2g3.cfg <bitfile_name>.offer.bin <bitfile_name>.payload.bin
```
  Note: This executable is generated by building the Microsoft CFU Standalone Tool. See the CFU Resources README for build instructions. It is suggested to run this step through Windows Command Prompt. Make sure to include additional arguments (such as forceIgnoreVersion) if you plan to utilize specific CFU features with the application.

Debugging

By default, the USBFS port is enabled for debug logs.

To enable debug logs on UART, set the USBFS_LOGS_ENABLE compiler flag to '0u' in the Makefile file. SCB4 of the EZ-USB™ FX2G3 device is used as UART with a baud rate of 921,600 to send out log messages through the P11.0 pin.

Debug the code example by setting debug levels for the UART logs. Set the DEBUG_LEVEL macro in the main.c file with the following values for debugging:

Table 1. Debug values

Macro value	Description
1u	Enable only error messages
2u	Enable error and warning messages
3u	Enable error, warning, and info messages
4u	Enable all message types

Design and implementation

This code example demonstrates the implementation of the USB loopback and zero device functionalities, which can be used to test the USB 2.0 functionality and data transfer performance of the USB interface on EZ-USB™ FX2G3. This application uses various low-performance peripherals to interface with the system, such as:

Enable debug prints over CDC using USBFS block on EZ-USB™ FX2G3 device

Features of the application

USB specifications: USB 2.0 (both Hi-Speed and Full-Speed)

CFU features

Supports firmware updates over USB using the Microsoft CFU protocol
Supports firmware checksum verification
Supports version comparision against older firmware

Echo device application features

Supports two modes – Data Loopback and Data Source/Sink
Supports one configuration with one alternate settings, supporting one endpoint pairs
One pair of bulk endpoints is supported

Datapath

Component firmware update

The application supports the following operations:

Firmware offer: The host sends a firmware offer to the device, including the firmware version and other metadata
Firmware content: The host sends the firmware content in blocks, which are written onto the external SPI flash, along with supporting metadata
Firmware verification: The device calculates and verifies the incoming firmware checksum

Echo device application

The application supports two modes:
- Data Loopback: Data received on OUT endpoints is looped back onto the corresponding IN endpoints
- Data SRC-SNK: The IN endpoints serve as data sources, which continuously provide pre-defined data, while the OUT endpoints serve as data sinks, which continuously drain the received data
The application has a fixed set of endpoints in the Data Loopback mode. The OUT_1 endpoint is paired with the IN_1 endpoint
The Data SRC-SINK mode is performed using internal RAM buffers on the EZ-USB™ FX2G3 device, which holds the data received from the OUT endpoint and eventually discards the data, making the device ready for a new set of data. A predefined data pattern is sent to the host through the IN endpoints

Application workflow

The application flow involves three main steps:

Initialization
USB device enumeration
Data transfers

CFU can be performed after device enumeration.

Initialization

During initialization, the following steps are performed:

All required data structures are initialized
USBD and USB driver (CAL) layers are initialized
The application registers all descriptors supported by the function/application with the USBD layer
Application registers callback functions for different events, such as RESET, SUSPEND, RESUME, SET_CONFIGURATION, SET_INTERFACE, SET_FEATURE, and CLEAR_FEATURE. USBD calls the respective callback function when the corresponding events are detected
The data transfer state machines are initialized
The application registers handlers for all relevant interrupts
The application makes the USB device visible to the host by calling the Connect API

USB device enumeration

During USB device enumeration, the host requests for descriptors that are already registered with the USBD layer during the initialization phase
The host sends the SET_CONFIGURATION and SET_INTERFACE commands to activate the required function in the device
After the SET_CONFIGURATION and SET_INTERFACE commands, the application task takes control and enables the endpoints for data transfer

Component firmware update

The host sends a firmware offer to the device, including the firmware version and other metadata
The device processes this information, verifies the version against older the firmware, and accepts or rejects the offer accordingly
The host sends the firmware content in blocks, which are written onto the external SPI flash after a 24 Byte metadata section
The device calculates the checksum of the incoming firmware and verifies it against the checksum available in the hwVariantMask field of the CFU offer
On successful completion of CFU, metadata is updated to indicate the same

Echo device application

Incoming data (OUT transfer)

The application enables the DataWire DMA channels to read data from the endpoint memory (EPM) region into the RAM buffers allocated to each endpoint
The host sends data through the OUT transfer
The device controller stores the OUT data in the EPM memory and triggers the DataWire DMA channel
The DataWire channel takes data from EPM and stores it into the RAM buffers provided by the firmware

Outgoing data (IN transfer)

Application task configures the DataWire DMA channels to transfer data from the RAM buffers to EPM buffers in the USB block
When an IN packet comes from the host, the device controller returns the data stored in the EPM

Compile-time configurations

This application's functionality can be customized by setting variables in Makefile or by configuring them through make CLI arguments.

Run the make build command or build the project in your IDE to compile the application and generate a USB bootloader-compatible binary. This binary can be programmed onto the EZ-USB™ FX2G3 device using the EZ-USB™ FX Control Center application
Run the make build CORE=CM0P command or set the variable in Makefile to compile and generate the binary for the Cortex® M0+ core. By default, CORE is set as CM4 and the binary is compiled and generated for the Cortex® M4 core
Choose between the Arm® Compiler or the GNU Arm® Embedded Compiler build toolchains by setting the TOOLCHAIN variable in Makefile to ARM or GCC_ARM respectively. If you set it to ARM, ensure to set CY_ARM_COMPILER_DIR as a make variable or environment variable, pointing to the path of the compiler's root directory

By default, the application is configured for Data Loopback mode and to make a USBHS data connection. Additional settings can be configured through macros specified by the DEFINES variable in Makefile:

Table 2. Macro description

Flag name	Description	Allowed values
APP_SRC_SNK_EN	Select the application mode	1u for Data SRC-snk 0u for Data Loopback
USBFS_LOGS_ENABLE	Enable debug logs through the USBFS port	1u for debug logs over USBFS 0u for debug logs over UART (SCB4)
CUSTOM_CFU_SPI	Use SPI logic provided by COMPONENT_FX_CFU	1u for custom implementation 0u for default SPI logic

Application files

Table 3. Application file description

File	Description
COMPONENT_FX_CFU/cfu.c	C source file implementing the CFU logic
COMPONENT_FX_CFU/cfu.h	Header file with CFU data structures, macros, and function declarations
COMPONENT_FX_CFU/spi.c	C source file implementing Serial Peripheral Interface (SPI) communication logic
COMPONENT_FX_CFU/spi.h	Header file with SPI communication logic data structures, macros, and function declarations
usb_app_common.c	C source file implementing functions to configure USB endpoint and DMA resources for USB
usb_app_common.h	Header file with USB endpoint configuration and DMA resources for USB declaration
usb_echo_device.c	C source file implementing the data loopback and source/sink logic for the EZ-USB™ FX2G3 USB Echo Device application
usb_echo_device.h	Header file with data loopback and source/sink logic function declaration
usb_app.c	C source file implementing USB data handling part of the EZ-USB™ FX2G3 USB echo device application logic
usb_app.h	Header file for application data structures and functions declaration
usb_descriptors.c	C source file containing the USB descriptors
main.c	Source file for device initialization and ISRs, etc.
cm0_code.c	CM0 initialization code
Makefile	GNU make compliant build script for compiling this example

Related resources

Resources	Links
User guide	EZ-USB™ FX2G3 SDK user guide
Code examples	Using ModusToolbox™ on GitHub
Device documentation	EZ-USB™ FX2G3 datasheets
Development kits	Select your kits from the Evaluation board finder
Libraries on GitHub	mtb-pdl-cat1 – Peripheral Driver Library (PDL) and documents
Middleware on GitHub	usbfxstack – USBFXStack middleware library and documents
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

Compatibility information:

This code example uses the PDL layer for direct communication with device peripherals, without relying on HAL peripheral APIs
This code example relies on the USBFXStack middleware library for USBFS and does not support USBFS through the USB Device Middleware Library

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.

Document history

Document title: CE241074 – EZ-USB™ FX2G3: HID-CFU application

Version	Description of change
1.0.0	New code example

All referenced product or service names and trademarks are the property of their respective owners.

The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc., and any use of such marks by Infineon is under license.

PSOC™, formerly known as PSoC™, is a trademark of Infineon Technologies. Any references to PSoC™ in this document or others shall be deemed to refer to PSOC™.

© Cypress Semiconductor Corporation, 2025. 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, 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 www.infineon.com. Other names and brands may be claimed as property of their respective owners.

License

Infineon/mtb-example-fx2g3-hid-cfu

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages