background image

 

Getting Started with EZ-

PD™ CCG3 

www.cypress.com

 

Document No. 002-00210 Rev. *A 

10 

The I

2

C bootloader is used to upgrade the CCG3 application firmware. It is allocated in a fixed area. The  bootloader 

memory  area  can  only  be  written  using  the  SWD  interface.  This  I

2

C  bootloader  uses  5kB  of  memory.  The 

configuration  table  holds  the  PD  configuration  for  the  CCG3  application,  and  is  located  at  the  beginning  of  each 
firmware binary. The size of each configuration table is 1kB. A lot of configurations can be updated by modifying this 
table  using  the 

EZ-PD Configuration  Utility

.  An  overview  of  this  utility  is  provided  in  the 

EZ-PD Configuration  Utility

 

section.  The  CCG  firmware  areas  FW1  and  FW2  are  used  for  the  CCG3  firmware  application.  The  metadata  area 
holds the metadata about both firmware binaries. The firmware metadata follows the definition provided by the PSoC 
Creator bootloader component, and includes the firmware checksum, firmware size, and the start address. 

3.3 

Firmware Build Environment 

The tool used for CCG3 firmware development is PSoC Creator, which is a free, Windows-based Integrated Design 
Environment (IDE)

PSoC Creator 3.3 SP2 or later

 and the 

CCGx SDK

 are required to edit, compile, download, and 

debug the firmware for the CCG3 Notebook application, as shown in 

Figure 7

. The PSoC Creator compiler tool chain 

is  ARM  GCC  (build  493,  provided  along  with  the  PSoC  Creator  build).  Refer  to  the 

PSoC  Creator  User  Guide

  for 

more details on the PSoC Creator build environment. 

Visit  the 

PSoC Creator  product  page

  to  download  and install  the latest  version  of  PSoC Creator  (3.3  SP2  or later). 

This  web  page  also  contains  links  to  video  training  and  additional  documentation.  Within  the  PSoC  Creator  tool, 
additional help is available via the following documents: 

 

Quick Start Guide: 

Choose 

Help

 > 

Documentation

 > 

Quick Start Guide

. This guide gives you the basics for 

developing PSoC Creator projects. 

 

System Reference Guide:

 Choose 

Help

 > 

System Reference Guide

. This guide lists and describes the system 

functions provided by PSoC Creator. 

 

Document Manager:

 PSoC Creator provides a Document Manager to help you easily find and review document 

resources. To open the Document Manager, choose 

Help

 > 

Document Manager

Figure 7

.

 PSoC Creator IDE 

 

3 . 3 . 1  

C C G x   S D K  

The 

CCGx Software Development Kit

 (SDK) is a PSoC Creator project that allows users to harness the capabilities of 

Cypress’s  CCG  families  of  Type-C  Controllers.  It  provides a  Type-C  and  USB-PD specification  compliant  firmware 
stack  along  with  the  necessary  drivers  and  software  interfaces  required  to  implement  applications  using  CCG 
controllers.  The  CCGx  SDK  also  includes  reference  projects  implementing  standard  Type-C  applications  and 
documentation that guides users in customizing existing applications, or creating new ones.  For more information on 
the CCGx SDK, refer to the 

CCGx SDK User Guide

. 

Содержание AN200210

Страница 1: ... EZ PD Analyzer Utility 17 5 CCG3 Configuration Parameter Modification Example 18 5 1 Test CY4531 CCG3 EVK Setup with the Default Configuration and Type C Power Adapter 19 5 2 Modify Configuration Parameters Using EZ PD Configuration Utility 21 5 3 Program CCG3 Device with Updated Configuration Parameters Using the EZ PD Configuration Utility 26 5 4 Re test CY4531 CCG3 EVK Setup with Modified Conf...

Страница 2: ...modulators PWMs and up to 20 general purpose I Os GPIOs Four serial communication blocks SCBs for configurable master slave I2 C SPI or UART Integrated USB Billboard controller with Billboard Device Class support Integrated crypto engine with USB authentication support Integrated analog blocks 20 V operation Two VBUS gate drivers 2x2 Crossbar switch 1 2 CCG3 Block Diagram Figure 1 shows a block di...

Страница 3: ...of the design flow can be started in parallel The hardware flow includes building reference schematics based on the end application and doing the board design to get a few prototypes ready for the next phase These reference schematics can be based on the reference designs available on the Cypress CCG3 webpage The CY4531 EZ PD CCG3 Evaluation Kit EVK design can also be reused especially for Type C ...

Страница 4: ...figuration Table eg PDO changes Vendor ID etc Use EZ PD Configuration Utility to update the modified configuration table or program CCG3 device Start with CCGx SDK Make application specific modifications to the source project Successfully build the source project with these modifications to obtain firmware binary files NO YES Perform Test Validation Use CY4500 EZ PD Protocol Analyzer EZ PD Analyze...

Страница 5: ...development tool PSoC Programmer 3 24 2 or later firmware programming tool Debugging Tools CY4500 EZ PDTM Protocol Analyzer Includes EZ PD Analyzer Utility and documentation Videos USB Type C Essentials USB Type C 101 Video Training Series Other Collateral CCG3 specific Knowledge Base Articles Note A basic introduction to Type C and how to use Cypress Type C products can be found in the USB Type C...

Страница 6: ...ltage protection OVP and over current protection OCP circuitry for VBUS and supports EZ PD CCG3 device programming over SWD and I2 C interfaces The EVK supports PCs notebooks tablets and other applications that would host a Type C interface It is primarily intended as an evaluation vehicle for USB Host systems that house a Type C connector Refer to the CY4531 EZ PD CCG3 EVK Guide for in depth info...

Страница 7: ... many configuration settings can be changed without the need for modifying the base firmware using the SDK For a discussion of how the SDK fits into the CCG3 ecosystem see the CCG3 Design Flow section Table 2 Firmware Software Tools Their Purposes Tool Purpose Output and Its Use Described in CCGx SDK It is the build environment for CCGx firmware development It has application code with Type C and ...

Страница 8: ...age selection port role assignment and swap request handling o Alternate Modes This module implements the alternate mode handling for CCG as a DFP and UFP A fully tested implementation of the DisplayPort alternate mode with CCG as the DFP is provided The module also allows users to implement their own alternate mode support in both DFP and UFP modes o Low Power This module attempts to keep the CCG...

Страница 9: ...G3 Bootloader I2 C External HW Control FET Mux etc Solution Specific Tasks Firmware Hardware Type C USB PD Stack 3 2 Flash Memory Organization The CCG3 device has 128 KB of flash divided into two banks of 64 KB each which allows support for dual firmware images Dual firmware images enable firmware updates to be fail safe that is the firmware update does not interrupt the normal operation of the de...

Страница 10: ...chain is ARM GCC build 493 provided along with the PSoC Creator build Refer to the PSoC Creator User Guide for more details on the PSoC Creator build environment Visit the PSoC Creator product page to download and install the latest version of PSoC Creator 3 3 SP2 or later This web page also contains links to video training and additional documentation Within the PSoC Creator tool additional help ...

Страница 11: ...rmware API Reference Guide Release Notes 3 3 2 PSoC Creator Project Structure Overview The CCGx SDK includes a reference firmware project for a notebook application of the CCG3 device Figure 8 shows the PSoC Creator workspace file structure for a CCG3 device based notebook application PSoC Creator generates bootloadable cyacd files and a Cypress format hex file every time a project is successfully...

Страница 12: ...Getting Started with EZ PD CCG3 www cypress com Document No 002 00210 Rev A 12 Figure 8 PSoC Creator Workspace Structure for CCG3 Notebook Application ...

Страница 13: ...en if it is enabled here 1 for VBUS OVP enable 0 for VBUS OVP disable VBUS_OVP_AUTO_CONTROL_ENABLE Enable automatic FET control by hardware when an OVP event is detected 1 for automatic hardware cut off 0 for firmware cut off SYS_DEEPSLEEP_ENABLE Enable flag for the low power module which keeps CCG3 in deep sleep mode at all possible times 1 for low power enable 0 for low power disable DFP_ALT_MOD...

Страница 14: ...CE TASK MARK CURRENT FIRMWARE INVALID DEVICE RESET UART FORWARDING TASK ALTERNATE MODE TASK More details on the CCGx SDK firmware architecture firmware APIs and getting started with the CCG3 SDK can be found in the CCGx SDK User Guide The same guide can also be used for customizing the CCG3 firmware application that is modifying and updating the PSoC Creator project for a different hardware design...

Страница 15: ...ardware design Debugging tool for CCGx applications EZ PD Analyzer Utility The EZ PD Analyzer Utility along with a CY4500 EZ PD Protocol Analyzer is used to capture PD messages between the CCG3 device and an attached Type C device with the firmware application that is running An overview of its functionality is provided in the CY4500 EZ PD Protocol Analyzer section 4 1 EZ PD Configuration Utility ...

Страница 16: ...is completed in three stages 1 Create configuration Create a new configuration from the File menu of the utility or read an existing configuration to be modified 2 Select parameters Select the parameters available for the target application such as a notebook 3 Device configuration Program the device flash using the Configure Device option Refer to the EZ PD Configuration Utility User Manual for m...

Страница 17: ...nual 4 2 EZ PD Analyzer Utility The EZ PD Analyzer Utility is a software application that is run along with a CY4500 EZ PD Protocol Analyzer When this utility is run it shows PD messages over CC for example PR_SWAP DR_SWAP and PDOs as shown in Figure 12 while the CCG3 device is establishing a PD contract with the connected Type C device ...

Страница 18: ...the configuration parameters using the EZ PD Configuration Utility and how to verify the changes using the CY4500 EZ PDTM Protocol Analyzer Consider the example of a Type C power adapter connected to the CY4531 CCG3 EVK Assuming this Type C power adapter supports a custom PDO the power contract between it and the CCG3 device of CY4531 CCG3 EVK will be successfully established only if the CCG3 devi...

Страница 19: ...K will be able to establish a power contract with the power adapter as it is configured for custom PDOs supported by this Type C power adapter Due to this the power adapter will provide 14 8V which is the established power configuration This can be verified by measuring the voltage on the power output header J7 of the CCG baseboard using a multimeter The output voltage on this header will be about...

Страница 20: ...pe C receptacle of the CY4500 EZ PD Protocol Analyzer see Figure 15 Observe that the PD traffic is being captured on the EZ PD Analyzer Utility The utility running on the host PC should look similar to that in Figure 16 Figure 15 Connecting CY4500 EZ PD Protocol Analyzer to CY4531 CCG3 EVK Start Capturing Micro USB cable Type C Power Adapter USB 2 0 port HOST PC Jumper Setting J4 2 3 J3 1 2 ...

Страница 21: ...lish a power contract for 14 8 V it requests the PDO object at position 2 which corresponds to the 14 8V PDO Refer to USB Power Delivery PD Spec Revision 2 0 Version 1 1 for more details on PD messages 12 Looking at the Vbus column in Figure 16 and as mentioned in step 9 it can be seen that the VBUS voltage is set to 14 8V at the end of the power contract negotiation This confirms that at the init...

Страница 22: ...patcle on backside of CCG3 Daughter Card USB Do not connect to this Mini B connector X Jumper Setting J3 2 3 J4 2 3 3 Launch the EZ PD Configuration Utility from Windows All Programs Cypress EZ PD Configuration Utility EZ PD Configuration Utility If the device driver binding is successful the GUI should report one device connected on the status bar of the GUI as shown in Figure 18 Figure 18 EZ PD ...

Страница 23: ... be FW2 The version that is running does not matter in this case the CCG device automatically runs whichever one was updated most recently Figure 19 Reading the Existing Configuration Table of the CCG3 Device of CY4531 CCG3 EVK 5 The existing configuration will now be read and will be displayed in the utility in a tree under CCGx Configuration in the left panel as shown in Figure 20 Device configu...

Страница 24: ...corresponds to the Type C port of the CCG3 EVK It can be seen that the CCG3 supports five sink PDOs listed as Sink PDO 0 4 as shown in Figure 21 and the window on the right will show the values of voltage and current corresponding to the selected PDO For example clicking on Sink PDO 2 will show the corresponding power profile of 14 8V 900mA expressed in units of 50mV 10mA in the main window That i...

Страница 25: ...emove button to delete it 8 Click on the Save As icon to save the modified configuration as shown in Figure 22 The modified configuration is saved as an XML file A cyacd and a c file will be saved in the same location For more details on the functionality related to the EZ PD Configuration Utility refer to its user manual by clicking here You can also open the user manual by choosing Help User Man...

Страница 26: ...EZ PD Configuration Utility section are successfully completed 2 Select Tools Configure Device as shown in Figure 23 A new window Configure Device opens where the target device to be programmed can be selected Select Notebook as the target device select the appropriate cyacd file to be programmed and then click on the Program button as shown in Figure 24 Note that since the Normal Flashing option ...

Страница 27: ...ng EZ PD Configuration Utility 3 The successful programming of the new configuration file will be indicated by a message box with the message Flashing Configuration Succeeded Click OK The Message window at the bottom of the utility also shows progress during the update process as shown in Figure 25 This shows that the configuration table of the CCG3 device of the CY4531 CCG3 EVK is successfully up...

Страница 28: ...mware is being executed Hence it updates FW1 in this example After the flash configuration is updated successfully and the device is reset the CCG3 device bootloader is designed in such a way that the last updated firmware image becomes the running firmware Hence when the configuration table is read back as shown in Figure 26 with the Bootloader Read option selected the FW1 image will be read whic...

Страница 29: ...ress com Document No 002 00210 Rev A 29 Figure 26 Reading back Updated Configuration Table of CCG3 Device using EZ PD Configuration Utility Figure 27 Verifying the Updated Configuration Table in CCG3 device using EZ PD Configuration Utility ...

Страница 30: ...to the Type C receptacle of the CY4500 EZ PD Protocol Analyzer as shown in Figure 15 Observe that the PD traffic is being captured on the EZ PD Analyzer Utility 5 From analyzing the CC traffic and looking at the VBUS voltage at the end of the captured data as shown in Figure 28 it can be seen that a successful PD contract is established at 5V this time with the Type C power adapter providing 5V to...

Страница 31: ...to the Type C port of the CY4531 CCG3 EVK In order to restore the CY4531 CCG3 EVK back to the default configuration parameters follow the steps described in section Programming the CCG3 Device on CY4531 CCG3 EVK of the CY4531 EZ PD CCG3 EVK Guide Once completed the steps described in the Test CY4531 CCG3 EVK Setup with the Default Configuration and Type C Power Adapter section can be repeated to v...

Страница 32: ... Rev A 32 Document History Document Title AN200210 Getting Started with EZ PD CCG3 Document Number 002 00210 Revision ECN Orig of Change Submission Date Description of Change 5320774 VGT 06 23 2016 New application note A 5857634 HARA 08 18 2017 Updated logo and copyright ...

Страница 33: ... 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 O...

Отзывы: