CY4501

CY4501 CCG1 Development Kit Guide Doc. No. 001-96785 Rev. *F Cypress Semiconductor 198 Champion Court San Jose, CA 95134-1709 www.cypress.com Copyrights Copyrights © Cypress Semiconductor Corporation, 2015-2017. The information contained herein is subject to change without notice. Cypress Semiconductor Corporation assumes no responsibility for the use of any circuitry other than circuitry embodied in a Cypress product. Nor does it convey or imply any license under patent or other rights. Cypress products are not warranted nor intended to be used for medical, life support, life saving, critical control or safety applications, unless pursuant to an express written agreement with Cypress. Furthermore, Cypress does not authorize its products for use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress products in life-support systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges. Trademarks PSoC is a registered trademark of Cypress Semiconductor Corp. All other trademarks or registered trademarks referenced herein are property of the respective corporations. Source Code Any Source Code (software and/or firmware) is owned by Cypress Semiconductor Corporation (Cypress) and is protected by and subject to worldwide patent protection (United States and foreign), United States copyright laws and international treaty provisions. Cypress hereby grants to licensee a personal, non-exclusive, non-transferable license to copy, use, modify, create derivative works of, and compile the Cypress Source Code and derivative works for the sole purpose of creating custom software and or firmware in support of licensee product to be used only in conjunction with a Cypress integrated circuit as specified in the applicable agreement. Any reproduction, modification, translation, compilation, or representation of this Source Code except as specified above is prohibited without the express written permission of Cypress. Disclaimer CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress reserves the right to make changes without further notice to the materials described herein. Cypress does not assume any liability arising out of the application or use of any product or circuit described herein. Cypress does not authorize its products for use as critical components in life-support systems where a malfunction or failure may reasonably be expected to result in significant injury to the user. The inclusion of Cypress’ product in a life-support systems application implies that the manufacturer assumes all risk of such use and in doing so indemnifies Cypress against all charges. Use may be limited by and subject to the applicable Cypress software license agreement. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 2 Contents 1. Introduction.................................................................................................................................................................... 5 1.1 1.2 1.3 2. Kit Installation ................................................................................................................................................................ 7 2.1 3. Block Diagram ..................................................................................................................................................... 21 Configurations and Jumper Settings .................................................................................................................... 22 5.2.1 SOP’ One-Chip/Cable Configuration ...................................................................................................... 23 5.2.2 SOP’ Two-Chip/Cable Configuration ...................................................................................................... 24 5.2.3 SOP’/SOP’’ Two-Chip/Cable Configuration ............................................................................................ 25 Kit Operation for SuperSpeed USB Demonstration ................................................................................................. 26 6.1 6.2 6.3 6.4 6.5 7. Block Diagram ..................................................................................................................................................... 16 Features .............................................................................................................................................................. 17 Connectors and Jumper Settings ........................................................................................................................ 18 Powering the Client Board ................................................................................................................................... 20 CCG1 EMCA Board ...................................................................................................................................................... 21 5.1 5.2 6. Block Diagram ..................................................................................................................................................... 11 Features .............................................................................................................................................................. 12 Connecting to Embedded Controller or Host Processor ...................................................................................... 12 Connectors and Jumper Settings ........................................................................................................................ 13 Powering the Host Board ..................................................................................................................................... 15 CCG1 Client Board ...................................................................................................................................................... 16 4.1 4.2 4.3 4.4 5. CY4501 CCG1 DVK Kit Software Installation ........................................................................................................ 7 CCG1 Host Board ........................................................................................................................................................ 11 3.1 3.2 3.3 3.4 3.5 4. Kit Contents ........................................................................................................................................................... 5 1.1.1 Hardware Not Included With Kit ................................................................................................................ 5 Getting Started ...................................................................................................................................................... 6 1.2.1 Configuring the CY4501 CCG1 DVK Host, Client, and EMCA Boards ..................................................... 6 List of Recommended Hardware ........................................................................................................................... 6 1.3.1 Recommended Cables ............................................................................................................................. 6 1.3.2 Recommended Power Adapter ................................................................................................................. 6 SuperSpeed USB Demo ...................................................................................................................................... 26 Boards, Cables, and Accessories Needed .......................................................................................................... 26 Running the SuperSpeed USB Demo ................................................................................................................. 26 Explanation of Functionality ................................................................................................................................. 30 Common Problems and Troubleshooting ............................................................................................................ 30 Kit Operation for DisplayPort Demonstration ........................................................................................................... 31 7.1 DisplayPort Alternate Mode Demo ...................................................................................................................... 31 CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 3 Contents 7.2 7.3 7.4 8. Kit Operation for Power Delivery Demonstration ..................................................................................................... 33 8.1 8.2 8.3 8.4 9. Power Delivery Demo .......................................................................................................................................... 33 Boards, Cables, and Accessories Needed .......................................................................................................... 33 Running the Power Delivery Demo...................................................................................................................... 33 Common Problems and Troubleshooting ............................................................................................................ 35 Programming CCG1 Devices on CY4501 CCG1 DVK Boards ................................................................................. 36 9.1 9.2 9.3 10. Boards, Cables, and Accessories Needed .......................................................................................................... 31 Running the DisplayPort Alternate Mode Demo .................................................................................................. 31 Common Problems and Troubleshooting ............................................................................................................ 32 Programming the CCG1 Device on CCG1 Host Board ....................................................................................... 36 Programming the CCG1 Device on CCG1 Client Board ...................................................................................... 38 Programming the CCG1 Devices on CCG1 EMCA Board ................................................................................... 39 Appendix A: Terminology ........................................................................................................................................... 41 Revision History ................................................................................................................................................................... 42 Document Revision History ........................................................................................................................................... 42 1. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 4 2. Introduction The CY4501 CCG1 Development Kit (DVK) is based on the CCG1 product family of Cypress’s USB microcontrollers. This DVK is primarily intended to be a development vehicle for USB host and client systems that house a Type-C connector as well as for EMCA cables. For USB Power Delivery (PD), the host and client boards available in this kit can be configured as a downstream facing port (DFP), an upstream facing port (UFP), or a dual role port (DRP). The kit also serves as a vehicle to evaluate several features for Type-C, using a SuperSpeed USB demo, a DisplayPort demo and a Power Delivery demo as examples. 2.1 Kit Contents The CY4501 CCG1 DVK consists of the following contents:  CCG1 host board  CCG1 client board  CCG1 Electronically Marked Cable Assembly (EMCA) board  SuperSpeed USB Type-A to Type-B cable  Two USB 2.0 Type-A to Mini-B cables  MiniProg3  Quick Start Guide 2.1.1 Hardware Not Included With Kit The CY4501 CCG1 DVK does not come with all of the hardware needed to perform the demonstrations documented in Kit Operation for SuperSpeed USB Demonstration, Kit Operation for DisplayPort Demonstration, and Kit Operation for Power Delivery Demonstration. The following items are not included:  USB drive needed for Kit Operation for SuperSpeed USB Demonstration and Kit Operation for DisplayPort Demonstration.  DisplayPort cables needed for Kit Operation for DisplayPort Demonstration. They are required to make connections from a PC to the CCG1 host board and from the CCG1 client board to the display monitor. If the PC has a miniDisplayPort, then a mini-DisplayPort to DisplayPort cable will be required.  A 24 V, 5A output capable Power Supply needed for Kit Operation for Power Delivery Demonstration. This is required to provide 24 V to the client board as an input to the Power Delivery demo.  A multimeter needed for Kit Operation for Power Delivery Demonstration. A standard multimeter is required to measure the output voltage on the client board to successfully demonstrate Power Delivery functionality. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 5 Introduction 2.2 Getting Started For instructions on how to run a quick demonstration and observe kit functionality, refer to Kit Operation for SuperSpeed USB Demonstration. 2.2.1 Configuring the CY4501 CCG1 DVK Host, Client, and EMCA Boards Refer to Kit Operation for SuperSpeed USB Demonstration for complete instructions on configuring the CY4501 CCG1 DVK host, client, and EMCA boards and to learn about configuring the DVK and connecting it to a PC. 2.3 List of Recommended Hardware 2.3.1 Recommended Cables See Table 2-1 to obtain a set of cables recommended to work with this kit. This kit is not shipped with these cables and they are required to operate the DisplayPort Alternate Mode Demo explained in the Kit Operation for DisplayPort Demonstration chapter. Table 2-1. List of Recommended Cables Description Manufacturer MPN Vendor Link DisplayPort to DisplayPort Cable (6”, gold plated) Cable Matters 102005-6 Amazon Link Mini DisplayPort to DisplayPort Cable (3”, gold plated) Cable Matters 101007-BLACK-3 Amazon Link Use item 1 in Table 2-1 if the PC being used has a DisplayPort connector. If the PC has a mini DisplayPort connector, use item 2 in Table 2-1. If the DisplayPort monitor has a regular DisplayPort connector, use item 1 in Table 2-1. Use item 2 in Table 2-1 if the DisplayPort monitor being used has a Mini DisplayPort connector. 2.3.2 Recommended Power Adapter The recommended power adapter to use when performing the demo described in Kit Operation for Power Delivery Demonstration is the AC/DC desktop adaptor (24 V, 120 W) from Phihong USA (MPN #: PSA120U-240V). The vendor link from Digikey can be found here. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 6 3. Kit Installation This chapter describes how to perform the installation steps for the CY4501 CCG1 DVK. 3.1 CY4501 CCG1 DVK Kit Software Installation To install the kit software, follow these steps: 1. Download the latest kit software setup “CY4501 CCG1 DVK COMPLETE SETUP” from the kit’s website: www.cypress.com/go/CY4501. This package contains the kit hardware files, user guide, quick start guide, and PSoC Programmer software. Double-click on the executable to start the installation. Click Next when the screen shown in Figure 3-1 appears. Figure 3-1. CY4501 CCG1 DVK Installer Screen 2. Select the required Installation Type and click the Next button to start the install (Figure 3-2). For first-time installation, it is recommended that you select “Typical” as the Installation Type. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 7 Kit Installation Figure 3-2. Installation Wizard 3. Accept the license agreement for the software components and click Next (Figure 3-3). Figure 3-3. License Agreement CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 8 Kit Installation 4. Figure 3-4 shows the installation progress. Figure 3-4. Installation Progress 5. Click Finish when complete (Figure 3-5). Figure 3-5. Software Installation Complete 6. When installation is complete, you have the option to Launch Cypress Update Manager (Figure 3-6) to ensure you have the latest software package. Click the Check for updates button at the bottom of the window. If “No Updates” CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 9 Kit Installation appears adjacent to the CY4501 CCG1 DVK, click the Exit button. If there are updates, click the Update button to download and install the latest kit package. Figure 3-6. Cypress Update Manager Note: You can launch the Update Manager at any time from Windows > Start > All Programs > Cypress > Cypress Update Manager. 7. After the installation is complete, the Directory>\CY4501 CCG1 DVK\1.0. contents are available at the following location: File Load. Browse to the location \CY4501 CCG1 DVK\1.0\Hex Files\ and select the file Host_DisplayPortDemo.hex. Note: The default Install Directory is C:\Program Files (x86)\Cypress for 64-bit Windows operating systems and is C:\Program Files\Cypress for 32-bit Windows operating systems. 7. Click the toggle power button in PSoC Programmer to ensure that the MiniProg3 device is delivering power to the target. The red LED on the MiniProg3 device should be turned on and Power should be seen in a green box at the bottom right corner of the PSoC Programmer window as shown in Figure 10-2. 8. Program the new firmware by choosing File > Program. 9. When programming is complete, the message “Programming Succeeded” will appear in the Actions/Results tab of PSoC Programmer. 10. Disconnect the MiniProg3 from the board and then change the CCG1 host board’s jumper J4’s settings such that pins 2 and 5 of jumper J4 are now shorted. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 37 Programming CCG1 Devices on CY4501 CCG1 DVK Boards 10.2 Programming the CCG1 Device on CCG1 Client Board The steps to update firmware running on the CCG1 device of the client board are as follows: 1. If the kit installation is not performed yet, or was not performed recently, install the latest version of PSoC Programmer software by downloading and installing the latest kit setup file CY4501 CCG1 DVK COMPLETE SETUP from website www.cypress.com/go/CY4501. 2. Ensure that pins 1 and 2 of jumper J11 on CCG1 client board are shorted. 3. Connect the USB Mini cable from the PC to the Mini-B receptacle on the MiniProg3 Rev*B device provided with the CY4501 CCG1 DVK as shown in Figure 10-3. Connect the 5-pin header of the MiniProg3 device to connector J8 of client board. Figure 10-3. Connecting MiniProg3 Rev*B Programmer to CCG1 Client Board 4. Open PSoC Programmer and note the enumeration of MiniProg3/xxxxx. In the Port Selection window, select the newly enumerated “MiniProg3.” A blue dot should appear, indicating the selection, as shown in Figure 10-2. 5. Check the following settings in the PSoC Programmer window. They should be the same as those shown in Figure 10-2. 6.  Programming Mode: Reset  Verification: On  AutoDetection: On  Protocol: SWD  Voltage: 5.0 V  Connector: 5p  Clock Speed: 1.6MHz (default) Load the new firmware (hex file) by choosing File > File Load. Browse to the location \CY4501 CCG1 DVK\1.0\Hex Files\ and select the file Client_DisplayPortDemo.hex. Note: The default Install Directory is C:\Program Files (x86)\Cypress for 64-bit Windows operating systems and is C:\Program Files\Cypress for 32-bit Windows operating systems. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 38 Programming CCG1 Devices on CY4501 CCG1 DVK Boards 7. Click the toggle power button in PSoC Programmer to ensure that the MiniProg3 device is delivering power to the target. The red LED on the MiniProg3 device should be turned on and Power should be seen in a green box at the bottom right corner of the PSoC Programmer window as shown in Figure 10-2. 8. Program the new firmware by choosing File > Program. 9. Once programming is complete, the message “Programming Succeeded” will appear in the Actions/Results tab of PSoC Programmer. 10. Disconnect the MiniProg3 from the board and then change the CCG1 client board’s jumper J11’s settings such that pins 2 and 4 of jumper J11 are now shorted. 10.3 Programming the CCG1 Devices on CCG1 EMCA Board The steps to update firmware running on the CCG1 devices of the EMCA board are as follows: 1. If the kit installation is not performed yet, or was not performed recently, install the latest version of PSoC Programmer software by downloading and installing the latest kit setup file CY4501 CCG1 DVK COMPLETE SETUP from the website: www.cypress.com/go/CY4501. 2. Connect the USB Mini cable from the PC to the Mini-B receptacle on the MiniProg3 Rev*B device provided with the CY4501 CCG1 DVK as shown in Figure 10-4. Connect the 5-pin header of the MiniProg3 device to connector J8 of EMCA cable board (this will program the CCG1 device U1). Figure 10-4. Connecting Miniprog3 Rev*B Programmer to CCG1 EMCA Board 3. Open PSoC Programmer and note the enumeration of MiniProg3/xxxxx. In the Port Selection window, select the newly enumerated “MiniProg3.” A blue dot should appear, indicating the selection, as shown in Figure 10-2. 4. Check the following settings in the PSoC Programmer window. They should be the same as those shown in Figure 10-2. 5.  Programming Mode: Reset  Verification: On  AutoDetection: On  Protocol: SWD  Voltage = 5.0 V  Connector: 5p  Clock Speed = 1.6 MHz (default) Load the new firmware (hex file) by choosing File > File Load. Browse to the location \CY4501 DVK\1.0\Hex Files\ and select the file EMCA_DisplayPortDemo.hex. Note: The default Install Directory is C:\Program Files (x86)\Cypress for 64-bit Windows operating systems and is C:\Program Files\Cypress for 32-bit Windows operating systems. 6. Click the toggle power button in PSoC Programmer to ensure that the MiniProg3 device is delivering power to the target. The red LED on the MiniProg3 device should be turned on and Power should be seen in a green box at the bottom right corner of the PSoC Programmer window as shown in Figure 10-2. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 39 Programming CCG1 Devices on CY4501 CCG1 DVK Boards 7. Program the new firmware by choosing File > Program. 8. Once programming is complete, the message “Programming Succeeded” will appear in the Actions/Results tab of PSoC Programmer. 9. To program the other CCG1 device U2, connect the MiniProg3 device to connector J9 of the CCG1 EMCA board and then repeat steps 4 to 8. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 40 11. Appendix A: Terminology This guide assumes that the user of the CCG1 board is familiar with the fundamentals of Type-C connectivity and the USB Power Delivery protocol.  Alternate Modes: A feature of a USB Type-C system whereby one or both of the SuperSpeed lanes may be repurposed for use with a different serial protocol such as a DisplayPort, eSATA, or Thunderbolt.  Client: A USB peripheral such as a hub, docking station, or monitor.  Configuration channel (CC): A USB Type-C bus wire used to transmit protocol signals. This is a half-duplex 300-kHz signal.  Consumer: A Type-C port that sinks power from VBUS.  DisplayPort: A digital display interface standard developed by the Video Electronics Standards Association. It is used primarily to connect a video source to a display such as a computer monitor.  Downstream facing port (DFP): A USB Type-C port on a host or a hub to which devices are connected.  Dp, Dn: USB Type-C bus wires used to transmit and receive USB 2.0 data.  Dual-role port (DRP): A USB Type-C port that can operate as either a DFP or a UFP.  Electronically Marked Cable Assembly (EMCA): A USB cable that includes an IC that reports cable characteristics (such as current rating) to the Type-C ports. USB3.0 Type-C Receptacle USB3.0 Type-C Plug GND RX1p RX1n VBUS SBU2 VCONN VBUS TX2n TX2p GND B12 B11 B10 B9 B8 B5 B4 B3 B2 B1 GND TX1p TX1n VBUS CC1 Dp1 Dn1 SBU1 VBUS RX2n RX2p GND A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 A11 A12 B12 B11 B10 B9 B8 B7 B6 B5 B4 B3 B2 B1 GND RX1p RX1n VBUS SBU2 Dn2 Dp2 CC2 VBUS TX2n TX2p GND 2.4mm A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 A11 A12 GND TX1p TX1n VBUS CC Dp Dn SBU1 VBUS RX2n RX2p GND 2.5mm  Host: A USB Host system such as a PC, notebook, laptop, and so on.  Provider: A Type-C port that sources power over VBUS.  Sideband use (SBU): A USB Type-C bus wire used for non-USB control signals, such as DisplayPort control signals.  Type-C Transceiver: A transmitter/receiver that communicates over the CC.  TX1p, TX1n, RX1p, RX1n, TX2p, TX2n, RX2p, and RX2n: USB Type-C bus wires used to transmit and receive SuperSpeed USB and PCIe or DisplayPort data.  Upstream facing port (UFP): A USB Type-C port on a device or a hub that connects to a host or the DFP of a hub.  USB Power Delivery (USB PD, PD): A new USB standard that increases maximum power delivery over USB from 7.5 W to 100 W.  USB Type-C (Type-C): A new standard with a slimmer USB connector and a reversible cable, capable of sourcing up to 100 W of power and supporting Alternate Modes.  VBUS: A USB Type-C bus wire used for power; initially 5 V, but increased up to 20 V on USB PD systems.  VCONN: A USB Type-C bus wire used to power the IC in the EMCA. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 41 Revision History Document Revision History Document Title: CY4501 CCG1 Development Kit Guide Document Number: 001-96785 Revision Issue Date Origin of Description of Change Change ** 04/24/2015 VGT New development kit guide. *A 05/07/2015 VGT Updated board images. *B 05/20/2015 VGT Updated jumper definitions for figures and tables in Chapters 3, 4, 5, Updated images for chapters 6,7,8 and 9, Deleted chapter 10. *C 05/28/2015 VGT Updated board images to Rev5 host and client boards for chapters 3 thru 9, incorporated OOB feedback from GJL, BHAT, closed documentation CDTs – 211468, 211566. *D 06/02/2015 VGT Updated Figure 9-2, removed errors in Table 5-1, fixed other miscalleneous errors thru the document. *E 04/01/2016 VGT Updated voltage from (5V,12V,13V or 20V ) to (5V,9V,15V or 20V) in pages 33 and 34. *F 05/24/2017 AESATMP9 Updated logo and copyright. CY4501 CCG1 Development Kit Guide, Doc. No. 001-96785 Rev. *F 42