EZ-PD Configurator Guide

Overview

The Easy Power Delivery (EZ-PD) Configurator provides a user-friendly tool for selecting the features and configuring parameters of the PDStack middleware. The tool generates configuration code in c language which can be referenced in the PDStack middleware.

image1

Supported Software

Name

Version

Link

Cypress PDStack Middleware Library

1.0.0

https://githubcom/cypresssemiconductorco/pdstack.

Definitions

  • USBPD – Universal Serial Bus Power Delivery (See USB Power Deliver Specification Revision 3.0)

  • PMG1 – Power Delivery Microcontroller Generation 1

  • PDO – Power Data Object

  • VDO – Vendor Data Object

  • SCEDB – Source Capabilities Extended Data Block

  • SKEDB – Sink Capabilities Extended Data Block

  • EPR – Extended Power Range

  • SVID – Standard or Vendor ID

  • BSP – Board Support Package

Launch the EZ-PD Configurator

You can launch the EZ-PD Configurator various ways: as a stand-alone tool, from the Device Configurator, from the Eclipse IDE for ModusToolbox or from the command line. Then, you can either use the generated source with an Eclipse IDE application, or use it in any software environment you choose.

As a Stand-Alone Tool

You can launch the EZ-PD Configurator as a stand-alone tool without the Eclipse IDE. By default, it is installed here:

<install_dir>/ModusToolbox/tools_<version>/ez-pd-configurator

On Windows, launch the tool from the Start menu.

For other operating systems, navigate to the install location and run the executable.

When opened this way, the EZ-PD Configurator opens with an untitled configuration file (*.mtbezpd). Save it as a new file and provide a file name, or open another existing *.mtbezpd file.

From the Eclipse IDE

If you are using the Eclipse IDE included with ModusToolbox, you can launch the EZ-PD Configurator by right clicking on a project in the Project Explorer and selecting ModusToolbox > EZ-PD Configurator. Or you can use the IDE Quick Panel. Refer to the Eclipse IDE for ModusToolbox User Guide for more details.

Launching the EZ-PD Configurator from the IDE opens the EZ-PD configuration file (design.mtbezpd) related to the selected application.

From the Command Line

You can run the ez-pd-configurator executable from the command line. There is also an ez-pd-configurator-cli executable, which re-generates the source code based on the configuration settings from a command-line prompt or from within batch files or shell scripts. The exit code for the ez-pd-configurator-cli executable is zero if the operation is successful, or non-zero if the operation encounters an error. To use the ez-pd-configurator -cli executable, you must provide at least the –config argument with a path to the configuration file.

For more information about the command-line options, run the ez-pd-configurator or ez-pd-configurator-cli executable using the -h option.

Quick Start

This section provides a simple workflow for how to use the EZ-PD Configurator.

  1. Launch the EZ-PD Configurator.

  2. Configure parameters as required.

  3. Save the configuration.

    When you save changes in the EZ-PD Configurator, it updates/generates a *.mtbezpd configuration file. The tool also updates/generates mtbcfg_ezpd.h and mtbcfg_ezpd.c files that contain configuration structures that can be used with the EZ-PD Middleware Library. The generated .h and .c files are located in the GeneratedSource folder next to the *. mtbezpd file.

    Refer to the EZ-PD Middleware Library for more information about this generated code.

GUI Description

Toolbar

The toolbar contains common commands from the File and Edit menus, such as New, Open, and Save. Use the check box under the View menu to show or hide the toolbar.

Parameter Categories

The left side of the EZ-PD Configurator shows several parameter categories, as follows:

Parameters and Values

When you select a parameter category, the right side of the EZ-PD Configurator displays that category’s individual parameters and values, as appropriate. The following sections describe the parameters available for each category.

Port Information

The Port Information node consists of the following parameters.

image2

Field Name

Valid Range

Manufacturer Vendor ID (0x)

0x0000 – 0xFFFF

Manufacturer Product ID (0x)

0x0000 – 0xFFFF

Manufacturer Name

Maximum 21 ASCII Characters

Port role

0 -> Sink

1 ->Source

2 -> Dual Role

Default port role

0 -> Sink

1 -> Source

Current level

0 -> 900 mA

1 -> 1.5 A

2 ->3A

Cable Discover count

0x00 – 0x14

DRP toggle enable

0 -> No

1 -> Yes

Rp supported

Bit Mask

Bit 0 -> 900 mA Rp

Bit 1 -> 1.5 A Rp

Bit 2 -> 3 A Rp

PD operation enable

0 -> No

1 -> Yes

Preferred Power role

0 -> No Try.Src or Try.Sink supported

1 -> Try.Src supported

2 -> Try.Sink supported

Port disable

0 -> No

1 -> Yes

Cable Discovery Enable

0 -> No

1 -> Yes

Dead battery support

0 -> No

1 -> Yes

Error recovery enable

0 -> No

1 -> Yes

FRS config

0 -> None

1 -> FRS receive enable

2 -> FRS transmit enable

VCONN retain

0 -> No

1 -> Yes

Accessory mode enable

0 -> No

1 -> Yes

Rp detach enable

0 -> No

1 -> Yes

Source PDO

Source PDO node consists of the following configuration parameters. For more information about Source PDO, refer to USB Power Delivery Specification Revision 3.

image3

  • Option to select Source PDO count. Maximum count value is 7.

  • Option to enable/disable each Source PDO.

  • Text box to enter 32-bit value for each Source PDO

Sink PDO

Sink PDO node consists of following configuration parameters. For more information about Sink PDO, refer to USB Power Delivery Specification Revision 3.

image4

  • Option to select Sink PDO count. Maximum count value is 7.

  • Option to enable/disable each Sink PDO.

  • Text box to enter 32-bit value for each Sink PDO

  • Text box to enter 16-bit Sink min/max current value for each PDO

SCEDB Configuration

The Source Capabilities Extended Data Block capabilities node configuration parameter is based on the USB Power Delivery Specification Revision 3, Section 6.5.1.

image5

SKEDB Configuration

The Sink Capabilities Extended Data Block capabilities node configuration parameter is based on the USB Power Delivery Specification Revision 3, Section 6.5.13.

image6

Notice List

The Notice List pane combines notices (errors, warnings, tasks, and notes) from many places in the configuration into a centralized list. If a notice shows a location, you can double-click the entry to edit the parameter. The Notice List pane contains the following columns:

  • Icon – Displays the icons for the error, warning, task, or note.

  • Fix – This may display a wrench icon that can be used to automatically address the required notice.

  • Description – Displays a brief description of the notice.

  • Location – Displays the specific tab of the message, when applicable.

For more information about the Notice List, refer to the Device Configurator Guide.

References

Refer to the following documents for more information, as needed:

Version Changes

This section lists and describes the changes for each version of this tool.

Version

Change Descriptions

Notes

1.0

New tool.