README.md

# EZ-PD&trade; PMG1 MCU: USB PD Dual-Role Power (DRP) HPI

This code example demonstrates USB-C attach detection and USB Power Delivery contract negotiation using EZ-PD&trade; PMG1 MCU devices as a Dual-Role Power (DRP) controller. Additionally, supports the Host Processor Interface (HPI), allows to communicate with the host processor or embedded controller (EC).

[View this README on GitHub.](https://github.com/Infineon/mtb-example-pmg1-usbpd-drp-hpi)

[Provide feedback on this code example.](https://cypress.co1.qualtrics.com/jfe/form/SV_1NTns53sK2yiljn?Q_EED=eyJVbmlxdWUgRG9jIElkIjoiQ0UyMzczOTkiLCJTcGVjIE51bWJlciI6IjAwMi0zNzM5OSIsIkRvYyBUaXRsZSI6IkVaLVBEJnRyYWRlOyBQTUcxIE1DVTogVVNCIFBEIER1YWwtUm9sZSBQb3dlciAoRFJQKSBIUEkiLCJyaWQiOiJzaW1uIiwiRG9jIHZlcnNpb24iOiIxLjAuMCIsIkRvYyBMYW5ndWFnZSI6IkVuZ2xpc2giLCJEb2MgRGl2aXNpb24iOiJNQ0QiLCJEb2MgQlUiOiJXSVJFRCIsIkRvYyBGYW1pbHkiOiJUWVBFLUMifQ==)


## Requirements

- [ModusToolbox&trade;](https://www.infineon.com/modustoolbox) v3.3 or later (tested with v3.3)
- Board support package (BSP) minimum required version: 3.0.0
- Programming language: C
- Associated parts: [EZ-PD&trade; PMG1-Sx MCUs](https://www.infineon.com/PMG1)


## Supported toolchains (make variable 'TOOLCHAIN')

- GNU Arm&reg; Embedded Compiler v11.3.1 (`GCC_ARM`) – Default value of `TOOLCHAIN`
- Arm&reg; Compiler v6.22 (`ARM`)
- IAR C/C++ Compiler v9.50.2 (`IAR`)


## Supported kits (make variable 'TARGET')

- [EZ-PD&trade; PMG1-S0 Prototyping Kit](https://www.infineon.com/CY7110) (`PMG1-CY7110`) – Default value of `TARGET`
- [EZ-PD&trade; PMG1-S1 evaluation kit](https://www.infineon.com/EVAL_PMG1_S1_DRP) (`EVAL_PMG1_S1_DRP`)
- [EZ-PD&trade; PMG1-S2 Prototyping Kit](https://www.infineon.com/CY7112) (`PMG1-CY7112`)
- [EZ-PD&trade; PMG1-S3 Prototyping Kit](https://www.infineon.com/CY7113) (`PMG1-CY7113`)
- [EZ-PD&trade; PMG1-S3 evaluation kit](https://www.infineon.com/EVAL_PMG1_S3_DUALDRP) (`EVAL_PMG1_S3_DUALDRP`)


> **Note:** See [AN235644 – USB PD DRP (dual-role power) schematics using EZ-PD&trade; PMG1 MCUs](https://www.infineon.com/an235644) for more details.

## Hardware setup

1. Setup the hardware with MCU connections according to the USB PD DRP reference schematics mentioned in the [AN235644 – USB PD DRP (dual-role power) schematics using EZ-PD&trade; PMG1 MCUs](https://www.infineon.com/an235644).

2. Ensure that the connections from EZ-PDtrade; PMG1 MCU are according to the following tables:

   **Table 1. GPIO connections from PMG1-S0 device for DRP operation**

   PMG1-S0 | External device               | Description
   --------|------------------------------ | -------------------------------------------------
   P1.1    | Enable PIN of power regulator | To control the power regulator output
   P0.0    | I2C_SDA of HPI interface      | To communicate with host processor or EC
   P0.1    | I2C_SCL of HPI interface      | To communicate with host processor or EC
   P2.2    | Interrupt PIN of HPI interface| To signal the asynchronous event or status
   P2.0    | HPI I2C address config PIN    | To select the I2C slave address based on PIN drive mode

   <br>

   The PMG1-S0 DRP reference schematic design uses the SC8802 bidirectional buck-boost DC-DC converter to provide the output VBUS source.

   **Table 2. GPIO connections from PMG1-S1 device for DRP operation**

   PMG1-S1 | External device               | Description
   --------|------------------------------ | -------------------------------------------------
   P1.1    | I2C_SDA of power regulator    | To control the power regulator output
   P1.2    | I2C_SCL of power regulator    | To control the power regulator output
   P5.0    | I2C_SDA of HPI interface      | To communicate with host processor or EC
   P5.1    | I2C_SCL of HPI interface      | To communicate with host processor or EC
   P2.2    | Interrupt PIN of HPI interface| To signal the asynchronous event or status
   P3.2    | HPI I2C address config PIN    | To select the I2C slave address based on PIN drive mode

   <br>

   The PMG1-S1 DRP reference schematic design uses the NCP81239 buck-boost DC-DC converter as a variable output VBUS source. The voltage output of the regulator can be controlled using an I2C interface.

   **Table 3. GPIO connections from PMG1-S2 device for DRP operation**

   PMG1-S2 | External device                  | Description
   --------| -------------------------------- | -------------------------------------------------
   P0.1    | VSEL1 select line of 2x4 decoder | To control the power regulator output
   P0.0    | VSEL2 select line of 2x4 decoder | To control the power regulator output
   P3.4    | I2C_SDA of HPI interface         | To communicate with host processor or EC
   P3.5    | I2C_SCL of HPI interface         | To communicate with host processor or EC
   P3.2    | Interrupt PIN of HPI interface   | To signal the asynchronous event or status
   P2.1    | HPI I2C address config PIN       | To select the I2C slave address based on PIN drive mode

   <br>

   The PMG1-S2 DRP reference schematic design uses the NCP1034 buck converter as a variable output VBUS source. The voltage output of the regulator can be controlled using the analog feedback to the internal reference. The PMG1-S2 reference schematic is designed for VBUS output of 5 V, 9 V, 15 V, and 20 V options using GPIO control via a 2x4 decoder.

   **Table 4. GPIO connections from PMG1-S3 (single port) device for DRP operation**

   PMG1-S3 | External device                  | Description
   --------| -------------------------------- | -------------------------------------------------
   P2.2    | I2C_SDA of power regulator       | To control the power regulator output
   P2.3    | I2C_SCL of power regulator       | To control the power regulator output
   P2.1    | PFET gate control                | To control the PFET load switch in consumer path
   P4.1    | I2C_SDA of HPI interface         | To communicate with host processor or EC
   P4.0    | I2C_SCL of HPI interface         | To communicate with host processor or EC
   P3.6    | Interrupt PIN of HPI interface   | To signal the asynchronous event or status
   P3.5    | HPI I2C address config PIN       | To select the I2C slave address based on PIN drive mode

   <br>

   The PMG1-S3 DRP reference schematic design uses the NCP81239 buck-boost DC-DC converter as a variable output VBUS source. The voltage output of the regulator can be controlled using an I2C interface.

   **Table 5. GPIO connections from PMG1-S3 (dual port) device for DRP operation**

   PMG1-S3 | External device                  | Description
   --------| -------------------------------- | -------------------------------------------------
   P2.2    | I2C_SDA of power regulator       | To control the power regulator output
   P2.3    | I2C_SCL of power regulator       | To control the power regulator output
   P2.1    | PFET gate control Port-0         | To control the PFET load switch in consumer path
   P2.6    | PFET gate control Port-1         | To control the PFET load switch in consumer path
   P4.1    | I2C_SDA of HPI interface         | To communicate with host processor or EC
   P4.0    | I2C_SCL of HPI interface         | To communicate with host processor or EC
   P3.7    | Interrupt PIN of HPI interface   | To signal the asynchronous event or status
   P3.4    | HPI I2C address config PIN       | To select the I2C slave address based on PIN drive mode

   <br>

   The PMG1-S3 DRP reference schematic design uses the NCP81239 buck-boost DC-DC converter as a variable output VBUS source. The voltage output of the regulator can be controlled using an I2C interface.

3. Provide the 24 V, 5 A power to power up the PMG1-S1, PMG1-S2, and PMG1-S3 boards, and 12 V, 5 A power to power up the PMG1-S0 board in source mode.

4. Use the SWD programming header for flashing the MCU.


## Software setup

See the [ModusToolbox&trade; tools package installation guide](https://www.infineon.com/ModusToolboxInstallguide) for information about installing and configuring the tools package.

This code example does not need any additional software or tools. However, [EZ-PD&trade; Protocol Analyzer Utility](https://www.infineon.com/cms/en/product/evaluation-boards/cy4500) can be used to analyze and debug the USB PD communication on the Configuration Channel (CC) line.


## Using the code example


### Create the project

The ModusToolbox&trade; tools package provides the Project Creator as both a GUI tool and a command line tool.

<details><summary><b>Use Project Creator GUI</b></summary>

1. 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](https://www.infineon.com/ModusToolboxProjectCreator) (locally available at *{ModusToolbox&trade; install directory}/tools_{version}/project-creator/docs/project-creator.pdf*).

2. On the **Choose Board Support Package (BSP)** page, select a kit supported by this code example. See [Supported kits](#supported-kits-make-variable-target).

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

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

</details>


<details><summary><b>Use Project Creator CLI</b></summary>

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&trade; 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&trade; installation instead of a standard Windows command-line application. This shell provides access to all ModusToolbox&trade; 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 "[USBPD DRP](https://github.com/Infineon/mtb-example-pmg1-usbpd-drp-hpi)" application with the desired name "MyUsbPdDrpHpi " configured for the *PMG1-CY7113* BSP into the specified working directory, *C:/mtb_projects*:

   ```
   project-creator-cli --board-id PMG1-CY7113 --app-id mtb-example-pmg1-usbpd-drp-hpi --user-app-name MyUsbPdDrpHpi --target-dir "C:/mtb_projects"
   ```


The 'project-creator-cli' tool has the following arguments:

Argument | Description | Required/optional
---------|-------------|-----------
`--board-id` | Defined in the <id> field of the [BSP](https://github.com/Infineon?q=bsp-manifest&type=&language=&sort=) manifest | Required
`--app-id`   | Defined in the <id> field of the [CE](https://github.com/Infineon?q=ce-manifest&type=&language=&sort=) 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

<br>

> **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&trade; tools package user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at {ModusToolbox&trade; install directory}/docs_{version}/mtb_user_guide.pdf).

</details>


### Open the project

After the project has been created, you can open it in your preferred development environment.


<details><summary><b>Eclipse IDE</b></summary>

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&trade; user guide](https://www.infineon.com/MTBEclipseIDEUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_ide_user_guide.pdf*).

</details>


<details><summary><b>Visual Studio (VS) Code</b></summary>

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&trade; user guide](https://www.infineon.com/MTBVSCodeUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_vscode_user_guide.pdf*).

</details>


<details><summary><b>Keil µVision</b></summary>

Double-click the generated *{project-name}.cprj* file to launch the Keil µVision IDE.

For more details, see the [Keil µVision for ModusToolbox&trade; user guide](https://www.infineon.com/MTBuVisionUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_uvision_user_guide.pdf*).

</details>


<details><summary><b>IAR Embedded Workbench</b></summary>

Open IAR Embedded Workbench manually, and create a new project. Then select the generated *{project-name}.ipcf* file located in the project directory.

For more details, see the [IAR Embedded Workbench for ModusToolbox&trade; user guide](https://www.infineon.com/MTBIARUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mt_iar_user_guide.pdf*).

</details>


<details><summary><b>Command line</b></summary>

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&trade; tools package user guide](https://www.infineon.com/ModusToolboxUserGuide) (locally available at *{ModusToolbox&trade; install directory}/docs_{version}/mtb_user_guide.pdf*).

</details>


## Operation

1. Ensure that the steps listed in the [Hardware setup](#hardware-setup) section are completed.

2. Program the board using one of the following:

   <details><summary><b>Using Eclipse IDE</b></summary>

      1. Select the application project in the Project Explorer.

      2. In the **Quick Panel**, scroll down, and click **\<Application Name> Program (KitProg3_MiniProg4)**.
   </details>


   <details><summary><b>In other IDEs</b></summary>

   Follow the instructions in your preferred IDE.
   </details>


   <details><summary><b>Using CLI</b></summary>

     From the terminal, execute the `make program` command to build and program the application using the default toolchain to the default target. The default toolchain is specified in the application's Makefile but you can override this value manually:
      ```
      make program TOOLCHAIN=<toolchain>
      ```

      Example:
      ```
      make program TOOLCHAIN=GCC_ARM
      ```
   </details>

3. Connect a PD sink device and EZ-PD&trade; Protocol Analyzer on the USB PD port of the kit to confirm the PD source functionality. Observe the PD contract on the Protocol Analyzer connected in between.

4. Similarly, remove the 24 V power adapter and connect a PD source to the USB PD port of the DRP kit and confirm the PD sink functionality using the Protocol Analyzer, as in the former case. A multimeter can be used to measure the PD contract voltage at the sink output terminals.


## Debugging

You can debug the example to step through the code.


<details><summary><b>In Eclipse IDE</b></summary>

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&trade; user guide](https://www.infineon.com/MTBEclipseIDEUserGuide).


</details>


<details><summary><b>In other IDEs</b></summary>

Follow the instructions in your preferred IDE.

</details>


## Design and implementation

- Supports up to 100 watts as a power provider and power consumer
- Supports swapping of power and data roles

   **Table 6. Source PDOs**

   PMG1 device | Fixed PDOs                                   | SPR AVS PDOs
   -------------|----------------------------------------------|-----------------
   PMG1-S0     | 5 V at 3 A                                      | -
   PMG1-S1     | 5 V at 3 A, 9 V at 3 A, 15 V at 3 A, and 20 V at 5 A      | 15 V~20 V at 100 W
   PMG1-S2     | 5 V at 3 A, 9 V at 3 A, 15 V at 1.8 A, and 20 V at 1.35 A | -
   PMG1-S3     | 5 V at 3 A, 9 V at 3 A, 15 V at 3 A, and 20 V at 5 A      | 15 V~20 V at 100 W

   <br>

   **Table 7. Sink PDOs**

   PMG1 device | Fixed PDOs                                   | Variable PDOs
   -------------|----------------------------------------------|-----------------
   PMG1-S0     | 5 V at 0.9 A                                    | 7 V~21 V at 0.9 A
   PMG1-S1     | 5 V at 0.9 A                                    | 7 V~21 V at 0.9 A
   PMG1-S2     | 5 V at 0.9 A                                    | 7 V~21 V at 0.9 A
   PMG1-S3     | 5 V at 0.9 A                                    | 7 V~21 V at 0.9 A

   <br>

- Fault protection
   - VBUS overvoltage protection (OVP) in source and sink roles
   - VBUS overcurrent protection (OCP) in source role
   - VBUS reverse-current protection (RCP) in source role
   - VBUS short-circuit protection (SCP) in source role
   - VConn overcurrent protection (VConn OCP)
- Deep sleep operation
   - Places the PMG1 devices in low-power mode by entering into deep sleep when the system is idle state


The EZ-PDtrade; PMG1 MCU devices support a USBPD block that integrates Type-C terminations, comparators, and the Power Delivery transceiver required to detect the attachment of a partner device and negotiate power contracts with it.

On reset, the USBPD block is initialized with the following settings:

   - The receiver clock input of the block is connected to a 12 MHz PERI-derived clock.

   - The transmitter clock input of the block is connected to a 600 kHz PERI-derived clock.

   - The SAR ADC clock input of the block is connected to a 1 MHz PERI-derived clock.

   - The SAR ADC in the USBPD block is configured to measure the VBUS_TYPE-C voltage through an internal divider.

This application uses the PDStack middleware library in a DRP role.

**Figure 1. Firmware flowchart**

<img src = "images/usbpd_drp_flow.png" width = "400"/>
<br>

The PDStack middleware library configures the USBPD block on the EZ-PDtrade; PMG1 MCU device to detect Type-C connection state changes and USB PD messages, and notify the stack through callback functions. The callback function registers the pending tasks, which are then handled by PDStack through the `Cy_PdStack_Dpm_Task` function. This function is expected to be called at appropriate times from the main processing loop of the application.

The solution layer provides the necessary HPI context data structure and callbacks. These callbacks enable the HPI middleware library to perform solution-specific operations as needed. The `Cy_Hpi_Task` handles the register read and write operations, and it also asserts the interrupt GPIO to notify the host processor or EC upon receiving asynchronous PD events or responses. It is essential to call this function from the main processing loop of the application.

**Figure 2. PDStack task flowchart**

<img src = "images/pdstacktask.png" width = "600"/>

<br>

The PDStack middleware library implements the state machines defined in the [USB Type-C Cable and Connector](https://www.usb.org/document-library/usb-type-cr-cable-and-connector-specification-revision-20) and the [USB Power Delivery](https://www.usb.org/document-library/usb-power-delivery) specifications. PDStack consists of the following main modules:

- **Type-C Manager:** Responsible for detecting a Type-C connection and identifying the type of connection. It uses the configurable Rp/Rd terminations provided by the USBPD block and the internal line state comparators. The Type-C Manager implements the state machines defined in the [USB Type-C Cable and Connector](https://www.usb.org/document-library/usb-type-cr-cable-and-connector-specification-revision-20) specification and provides the following functionality:

    - **Manage CC terminations**: Applies Rp/Rd terminations according to the port role

    - **Attach detection**: Performs the required debounce and determine the type of device attached

    - **Detach detection**: Monitors the CC line and VBUS for detecting a device detach

- **Protocol Layer:** Forms the messages used to communicate between a pair of ports/cable plugs. It is responsible for forming capabilities messages, requests, responses, and acknowledgements. It receives inputs from the Policy Engine indicating which messages to send and relays the responses back to the policy engine.

- **Policy Engine:** Provides a mechanism to monitor and control the USB Power Delivery system within a particular consumer, provider, or cable plug. It implements the state machines defined in the *USB Power Delivery* specification and contains implementations of all PD Atomic Message Sequences (AMS). It interfaces with the protocol layer for PD message transmission/reception for controlling the reception of message types according to conditions such as the current state of the port. It also interfaces with the Type-C Manager for error conditions like Type-C error recovery.

- **Device Policy Manager (DPM):** Provides an interface to the application layer to initialize, monitor, and configure the PDStack middleware operation. The DPM provides the following functionality:

    - Initializes the Policy Engine and Type-C Manager

    - Starts the Type-C state machine followed by the Policy Engine state machine

    - Stops and disables the Type-C port

    - Allows entry/exit from deep sleep to achieve low power based on the port status

    - Provides APIs for the application to send PD/Type-C commands

    - Provides event callbacks to the application for application-specific handling

The PDStack library uses a set of callbacks registered by the application to perform board-specific tasks such as turning the consumer/provider power path ON/OFF and identifying the optimal source power profile to be used for charging. In this example, these functions are implemented using the appropriate APIs provided as part of the Peripheral Driver Library (PDL).

The stack also provides notification of various connections and PD policy state changes so that the rest of the system can be configured as required.

The application tries to keep the EZ-PDtrade; PMG1 MCU device in deep sleep, where all clocks are disabled and only limited hardware blocks are enabled, for most of its working time. Interrupts in the USBPD block are configured to detect any changes that happen while the device is in sleep, and wake it up for further processing.

An overvoltage (OV) comparator in the USBPD block is used to detect cases where the power source is supplying incorrect voltage levels and automatically shut down the power switches to protect the rest of the components on the board.

- **Host Processor Interface (HPI):** The HPI middleware implements the HPI transport, protocol, register, and Power Delivery (PD) message handling. It allows the host processor or EC to monitor the status of the USB PD ports, change configuration, perform firmware updates, and transparently interact with other connected PMG1 and CCGx USB PD devices. It provides the following key functionalities:
   - Firmware version identification
   - Firmware update capability
   - Reporting of Type-C and USB PD connection status
   - Interrupt-based event reporting when connection status changes
   - Control USB PD power profiles


### Flash memory map

The internal flash of PMG1 device is used to store a bootloader image, firmware images with their corresponding metadata.

**Figure 3. Flash layout**

<img src = "images/flash_memory_map.png" width = "800"/>
<br>

A fixed 7168 bytes of memory at the start of the flash space is allocated for the bootloader image and last two rows of the flash memory is allocated for the application metadata.
The remaining space is used by the application firmware.

The PMG1 devices PMG1-S0, PMG1-S1, and PMG1-S2 supports only single application firmware whereas the PMG1-S3 supports both single and dual application firmware architecture.


### Compile-time configurations

The EZ-PDtrade; PMG1 MCU USB PD DRP application functionality can be customized through a set of compile-time parameters that can be turned ON/OFF through the *config.h* and *Makefile*.

**Table 8. Macros and their descriptions**

Macro name          | Description                           | Allowed values
:------------------ | :------------------------------------ | :-------------
`CY_PD_SINK_ONLY`     | Specifies that the application supports only the USB PD sink (consumer) role | Set to 0u
`CY_PD_SOURCE_ONLY`   | Specifies that the application supports only the USBPD source (provider) role | Set to 0u
`NO_OF_TYPEC_PORTS`   | Specifies the number of USB-C ports supported | Set to 1u
`CY_PD_REV3_ENABLE`   | Enable USB PD Revision 3.2 support | 1u or 0u
`CY_PD_CBL_DISC_DISABLE` | Disable cable discovery | 0u
`VBUS_OVP_ENABLE` | Enable VBUS overvoltage fault detection | 1u or 0u
`VBUS_UVP_ENABLE` | Enable VBUS undervoltage fault detection | 0u
`VBUS_RCP_ENABLE` | Enable VBUS reverse current fault detection| 1u or 0u
`VBUS_SCP_ENABLE` | Enable VBUS short-circuit fault detection | 1u or 0u
`VCONN_OCP_ENABLE` | Enable VConn overcurrent fault detection | 1u or 0u
`VBUS_OCP_ENABLE` | Enable VBUS overcurrent fault detection | 1u or 0u
`CY_APP_PD_PDO_SEL_ALGO`     | Specifies the algorithm to be used while selecting the best source capability to power the board | 0u – Pick the source PDO delivering the maximum power <br> 1u – Pick the fixed source PDO delivering the maximum power <br>2u – Pick the fixed source PDO delivering the maximum current<br>3u – Pick the fixed source PDO delivering the maximum voltage
`SYS_DEEPSLEEP_ENABLE` | Enables device entry into deep sleep mode for power saving when the CPU is idle | 1u or 0u

<br>


### PDStack library selection

The USB Type-C Connection Manager, USB Power Delivery (USB PD) protocol layer, and USB PD device Policy Engine state machine implementations are provided in the form of pre-compiled libraries as part of the PDStack middleware library.

Multiple variants of the PDStack library with different feature sets are provided; you can choose the appropriate version based on the features required by the target application.

In this application, the *PMG1_PD3_DRP* library with support for USB PD Revision 3.2 messaging and DRP SPR operation is chosen for PMG1-S1, PMG1-S2, and PMG1-S3 devices whereas *PMG1_PD3_DRP_LITE* is chosen for PMG1-S0.


### USBPD port configuration

The properties of the USB-C port including the port role and the default response to various USBPD messages can be configured using the EZ-PD&trade; Configurator Utility.

These parameters have been set to the appropriate values for a Power Delivery DRP application by default. To view or change the configuration, click on the **EZ-PD&trade; Configurator 2.0** item under **Tools** in the Quick Panel to launch the configurator.

**Figure 4. USB Type-C port configuration using EZ-PD&trade; Configurator**

<img src = "images/ezpd_port_info.png" width = "800"/>

<br>

Properties of the USB-C port are configured using the *Port Information* section. Because this application supports the DRP role, the **Port Role** must be set as **Dual Role** and **DRP Toggle** must be enabled. Other parameters such as **Manufacturer Vendor ID** and **Manufacturer Product ID** can be set to the desired values.


**Figure 5. Sink capability configuration using EZ-PD&trade; Configurator**

<img src = "images/ezpd_sink_pdo.png" width = "800"/>

<br>

The power capabilities supported by the application in the sink role are specified using the *Sink PDO* section. See the [USB Power Delivery](https://www.usb.org/document-library/usb-power-delivery) specification for details on how to encode the various sink capabilities. A maximum of seven PDOs can be added using the configurator.

**Figure 6. Source capability configuration using EZ-PD&trade; Configurator**

<img src = "images/ezpd_source_pdo.png" width = "800"/>

<br>

The power capabilities supported by the application in the source role are specified using the *Source PDO* section. See the *USB Power Delivery* specification for details on how to encode the various source capabilities. A maximum of seven PDOs can be added using the configurator.

**Figure 7. Extended sink capability configuration using EZ-PD&trade; Configurator**

<img src = "images/ezpd_skedb_info.png" width = "800"/>

<br>

The *SKEDB* section is used to input the extended sink capabilities response that will be sent by the application when queried by the power source. See the Power Delivery specification for details on the extended sink capabilities format.

**Figure 8. Extended source capability configuration using EZ-PD&trade; Configurator**

<img src = "images/ezpd_scedb_info.png" width = "800"/>

<br>

The *SCEDB* section is used to provide the extended source capabilities to the power sink device. See the *USB Power Delivery* specification for details on the extended source capabilities format.

Once the parameters have been updated as desired, save the configuration and build the application.


### Resources and settings

**Table 9. Application resources**

Resource  | Alias/object   | Purpose
:-------  | :------------  | :------------------------------------
USBPD     | PD_PORT0       | USBPD block used for PD communication
SCB       | I2CM           | I2C interface to control the external power regulator
SCB       | I2CM           | I2C interface to communicate over HPI


<br>


### List of application files and their usage

**Table 10. Application files and their usage**

File                         | Purpose
:--------------------------- | :------------------------------------
*config.h*                   | Contains macro definitions enabling/disabling the application-specific features.
*hpi.c & .h*                 | Declares the variables and data structures and implements the functions required for the HPI interface.
*ncp_81239.c & .h*           | Defines function prototype and implements the NCP81239 buck-boost controller driver.

<br>


## Related resources

Resources | Links
-----------|------------------
Application notes |[AN232553](https://www.infineon.com/an232553) – Getting started with EZ-PD&trade; PMG1 MCU on ModusToolbox&trade; software <br> [AN232565](https://www.infineon.com/an232565) – EZ-PD&trade; PMG1 MCU hardware design guidelines and checklist <br> [AN235644](https://www.infineon.com/an235644) – USB PD DRP (dual-role power) schematics using EZ-PD&trade; PMG1 MCUs
Code examples | [Using ModusToolbox&trade;](https://github.com/Infineon?q=mtb-example-pmg1%20NOT%20Deprecated) on GitHub
Device documentation | [EZ-PD&trade; PMG1 MCU datasheets](https://www.infineon.com/PMG1DS)
Development kits | Select your kits from the [Evaluation board finder](https://www.infineon.com/cms/en/design-support/finder-selection-tools/product-finder/evaluation-board).
Libraries on GitHub | [mtb-pdl-cat2](https://github.com/Infineon/mtb-pdl-cat2) – Peripheral Driver Library (PDL) and docs
Middleware on GitHub  | [pdstack](https://github.com/Infineon/pdstack) – PDStack middleware library and docs <br> [pdutils](https://github.com/Infineon/pdutils) – PDUtils middleware library and docs <br> [pmg-app-common](https://github.com/Infineon/pmg-app-common) – PMG Application Common middleware library and docs <br> [hpi](https://github.com/Infineon/hpi) – HPI middleware library and docs
Tools  | [ModusToolbox&trade;](https://www.infineon.com/modustoolbox) – ModusToolbox&trade; 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&trade; Industrial/IoT MCUs, AIROC&trade; Wi-Fi and Bluetooth&reg; connectivity devices, XMC&trade; Industrial MCUs, and EZ-USB&trade;/EZ-PD&trade; wired connectivity controllers. ModusToolbox&trade; incorporates a comprehensive set of BSPs, HAL, libraries, configuration tools, and provides support for industry-standard IDEs to fast-track your embedded application development.

<br>


## Other resources

Infineon provides a wealth of data at [www.infineon.com](https://www.infineon.com) to help you select the right device, and quickly and effectively integrate it into your design.


## Document history

 Document title: *CE237399* – *EZ-PD&trade; PMG1 MCU: USB PD Dual-Role Power (DRP) HPI*

 Version | Description of change
 ------- | ---------------------
 1.0.0   | New code example

<br>


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

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


---------------------------------------------------------

© Cypress Semiconductor Corporation, 2024. 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.
<br>
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.
<br>
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.