This code example demonstrates how to configure the USB block on EZ-PD™ PMG1 MCU as a vendor interface. When configured for vendor interface, the PMG1 MCU device enumerates as "Cypress FX3 USB BulkloopExample Device", which can be read and written using USB Control Center on a PC.
Provide feedback on this code example.
- ModusToolbox™ software v3.0 or later (tested with v3.0)
- Board support package (BSP) minimum required version: 3.0.0
- Programming language: C
- Associated parts: EZ-PD™ PMG1-S2 MCU and EZ-PD™ PMG1-S3 MCU
- GNU Arm® Embedded Compiler v10.3.1 (
GCC_ARM) - Default value ofTOOLCHAIN - Arm® Compiler v6.13 (
ARM) - IAR C/C++ Compiler v8.42.2 (
IAR)
- EZ-PD™ PMG1-S2 prototyping kit (
PMG1-CY7112) – Default value ofTARGET - EZ-PD™ PMG1-S3 prototyping kit (
PMG1-CY7113)
- If UART DEBUG PRINT messages are enabled, UART connection are needed. Pin connections for UART is as shown in the following table. For the following revisions of the PMG1 prototyping kits, connect the UART Tx and UART Rx lines from the PMG1 kit to J3.8 and J3.10 on KitProg3 respectively to establish a UART connection between KitProg3 and the PMG1 device.
Table 1. Pin connections for UART
| PMG1 kit | UART Tx | UART Rx |
|---|---|---|
| PMG1-CY7112 (revision 2 or lower) | J6.10 to J3.8 | J6.9 to J3.10 |
| PMG1-CY7113 (revision 3 or lower) | J6.10 to J3.8 | J6.9 to J3.10 |
Note: All PMG1 prototyping kits with a higher revision have UART pins internally connected. Therefore, external wiring is not required.See the kit user guide to ensure that the board is configured correctly.
- Connect the EZ-PD™ PMG1 MCU kit to your PC using a USB-C cable through the KitProg3 USB Type-C port (J1).
Install the following software to access the USB Control Center:
Note: To Run the USB Control Center, follow the below path:
Select EZ-USB FX3 SDK > 1.3 > application > c_sharp > controlcenter > bin > Release > CyControl.exe
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 clones the "USBFS Vendor interface" application with the desired name "MyUSBFSvendorinterface" configured for the PMG1-CY7112 BSP into the specified working directory, C:/mtb_projects:
project-creator-cli --board-id PMG1-CY7112 --app-id mtb-example-pmg1-usbfs-vendor-interface --user-app-name MyUSBFSvendorinterface --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 library-manager 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 |
The following example adds the PMG1-CY7112 BSP to the already created application and makes it the active BSP for the app:
~/ModusToolbox/tools_3.0/library-manager/library-manager-cli --project "C:/mtb_projects/MyUSBFSvendorinterface" --add-bsp-name PMG1-CY7112 --add-bsp-version "latest-v3.X" --add-bsp-location "local"
~/ModusToolbox/tools_3.0/library-manager/library-manager-cli --project "C:/mtb_projects/MyUSBFSvendorinterface" --set-active-bsp APP_PMG1-CY7112
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.
-
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).
-
Ensure that the steps listed in the Hardware setup section are completed.
-
Ensure that the jumper shunt on the power selection jumper (J5) is placed at positions 2-3 to enable programming.
-
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 TOOLCHAIN=<toolchain>Example:
make program TOOLCHAIN=GCC_ARM -
-
After programming the kit, disconnect the USB cable and change the position on the power selection jumper (J5) to 1-2 to power the kit through the PMG1 USB PD sink port (J10).
-
Connect the PMG1 MCU kit to the PC using a USB cable through the PMG1 USB PD sink port (J10).
-
On the PC, verify that a new USB device was enumerated as a "Cypress FX3 USB BulkloopExample Device".
Figure 1. Device Manager - Universal Serial Bus controllers
-
Run the USB Control Center program and do the following:
-
select Cypress FX3 USB BulkloopExample Device > Configuration 1 > Interface 0 > Alternate Setting 0 > Bulk Out endpoint(0x02).
-
Select the Data Transfer tab and then click Transfer Data-OUT.
-
Observe the following message: "BULK OUT transfer completed".
Figure 2. USB Control Center - Bulk Out
-
-
Receive the same data. Do the following:
-
Select Cypress FX3 USB BulkloopExample Device > Configuration 1 > Interface 0 > Alternate Setting 0 > Bulk In endpoint(0x81).
-
Select the Data Transfer tab and click Transfer Data-IN.
-
Observe the "BULK IN transfer completed" message as shown in Figure 3:
Figure 3. USB Control Center - Bulk In
-
Note: This example has only one 64-byte buffer allocated to receive data from the host. Any additional data transferred will overwrite the previous data with the new data.
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.
In the main firmware routine, the USB device block is configured to use the vendor class. After enumeration, the device constantly checks if any data received from the host. If any data is available, the application sends the same data back to the host.
Do the following to view the vendor descriptor:
-
Select the application project in the Project Explorer.
-
In the Quick Panel, select BSP Configurators and click Device Configurator.
-
In Peripherals, select Universal Serial Bus (USB) 0 to view the USB configuration fields as shown in the following figure. Note that the USB Peripheral personality is set as USBFS Device-1.0.
Figure 4. Universal Serial Bus (USB) 0 configuration using Device Configurator
-
Select the application project in the Project Explorer.
-
In the Quick Panel, select BSP Configurators and click USB Configurator.
-
Some of the descriptor configurations are shown in the following figures.
Figure 5. USB CDC device descriptor
Alternate settings
- bDeviceClass: Names the device class
- 0x02: Indicates that the device is a communications device
Figure 6. USB IN data endpoint descriptor
Endpoint descriptors
-
The two endpoint descriptors act as buffers storing the received data or data waiting to be transmitted.
-
The bEndpointAddress(7):direction is an important field in the endpoint descriptors. The endpoint is defined as IN and provides the data to send to the host while another endpoint is defined as OUT and stores data received from the host.
Figure 7. USB OUT data endpoint descriptor
The EZ-PD™ PMG1 USB FS vendor interface application functionality can be customized through the compile-time parameter that can be turned ON/OFF through the main.c file.
| Macro name | Description | Allowed values |
|---|---|---|
DEBUG_PRINT |
Debug print macro to enable UART print | 1u to enable 0u to disable |
Table 2. Application resources
| Resource | Alias/object | Purpose |
|---|---|---|
| UART (BSP) | CYBSP_UART | UART object used for Debug UART port |
| USB | CYBSP_USB | USB device configured with vendor class descriptor |
| Resources | Links |
|---|---|
| Application notes | AN232553 – Getting started with EZ-PD™ PMG1 MCU on ModusToolbox™ software AN232565 – EZ-PD™ PMG1 hardware design guidelines and checklist |
| Code examples | Using ModusToolbox™ software on GitHub |
| Device documentation | EZ-PD™ PMG1 MCU datasheets |
| Development kits | Select your kits from the Evaluation Board Finder page. |
| Libraries on GitHub | mtb-pdl-cat2 – Peripheral driver library (PDL) 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 & Bluetooth® combo 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.
Document title: CE235058 – EZ-PD™ PMG1 MCU: USBFS vendor interface
| Version | Description of change |
|---|---|
| 1.0.0 | New code example |
| 2.0.0 | Major update to support ModusToolbox™ v3.0. This version is not backward compatible with previous versions of ModusToolbox™ |
All other trademarks or registered trademarks referenced herein are the property of their respective owners.
© Cypress Semiconductor Corporation, 2022-2023. 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.