UM2051 User manual. Getting started with the STM32 Nucleo pack for USB Type-C and Power Delivery. Introduction

Transcription

1 User manual Getting started with the STM32 Nucleo pack for USB Type-C and Power Delivery Introduction The STM32 Nucleo pack for USB Type-C and Power Delivery (P-NUCLEO-USB001) is a kit based on a NUCLEO-F072RB board and on a USB Type-C Power Delivery expansion board (MB1257). The expansion board features two Dual-Role-Power USB Type-C ports with a discrete Analog-Front-End PHY for USB Type-C configuration and management. A complete and certified USB Power Delivery middleware stack, compliant with the USB Type-C 1.2 and the Power Delivery 2.0 specifications, running on the STM32F072 MCU, provides the means to control the two USB Type-C ports and allows the communication over CC lines using the Power Delivery communication protocol (for all the details refer to the USB Type-C Power Delivery on STM32F0 Series embedded software expansion for STM32Cube databrief (DB2957) at the website).this document describes the hardware environment to build the system and to run an application based on the P-NUCLEO-USB001 pack. Figure 1. P-NUCLEO-USB Picture is not contractual. February 2017 DocID Rev 2 1/17 1

2 Contents UM2051 Contents 1 Getting started System architecture MB1257 board versions The P-NUCLEO-USB001 demonstration Configuration setup Standalone demonstration Other demonstration with external hardware Command Line Interface Revision history /17 DocID Rev 2

3 List of tables List of tables Table 1. Description of connectors, jumpers and LEDs Table 2. Description of the CLI commands Table 3. Document revision history DocID Rev 2 3/17 3

4 List of figures UM2051 List of figures Figure 1. P-NUCLEO-USB Figure 2. P-NUCLEO-USB001 system architecture Figure 3. MB1257 USB Type-C and Power Delivery expansion board and NUCLEO-F072RB assembled Figure 4. Connectors, jumpers and LEDs of the MB1257 expansion board Figure 5. Screenshot of the CLI and list of available commands Figure 6. CLI when no cable is plugged on a port Figure 7. CLI when PORT_0 is connected with PORT_ Figure 8. CLI when a port is connected to an external Consumer Figure 9. CLI when a PD port is connected to an external Provider Figure 10. CLI after a request to change the power profile /17 DocID Rev 2

5 Getting started 1 Getting started 1.1 System architecture Note: The STM32 Nucleo pack for USB Type-C and Power Delivery is composed of two main blocks (see Figure 2): A control block: the NUCLEO-F072RB board where the stack is running A Type-C interface: the MB1257 expansion board A certified USB Type-C full-featured cable is provided in the kit. 1.2 MB1257 board versions Note: The MB1257 expansion board is today available in two revisions: MB1257 Revision B or MB1257B MB1257 Revision C or MB1257C MB1257C replaces MB1257B that is not produced anymore. Main differences are related to minor hardware changes, done to improve performances and compliances to the latest certification rules. User may encounter some differences running one of the available versions of X-CUBE-USB-PD middleware stack on these platforms. For more details refer to the STM32 Nucleo pack for USB Type-C and Power Delivery with the NUCLEO-F072RB board User manual (UM2050) available at the website. In this document JP500/J500 identifies the same jumper present on both boards. This jumper is called JP500 on MB1257C while it is called J500 on MB1257B and it is used for the same purpose. DocID Rev 2 5/17 16

6 Getting started UM2051 Figure 2. P-NUCLEO-USB001 system architecture Expansion Board ST morpho connectors User LEDs CC AFE and V CONN Switch Port 1 CC AFE and V CONN Switch Port 0 Local Power Management Extension Connector Port 1 V BUS Current/Voltage sensing Port 1 Type-C Receptacle Port 1 V BUS Port 1 Switch and discharge Extension Connector Port 0 V BUS Current/Voltage sensing Port 0 Type-C Receptacle Port 0 V BUS Port 0 Switch and discharge Port 0 connectors and circuitry Port 1 connectors and circuitry Connector for V BUS Load Port 1 Connector for V BUS Load Port 0 Device Policy Manager Policy Engine Protocol Layer Physical Layer (4b5b, CRC, SOP, BMC) NUCLEO-F072RB 6/17 DocID Rev 2

7 Getting started 1.3 The P-NUCLEO-USB001 demonstration The P-NUCLEO-USB001 is a complete hardware development platform to learn and develop solutions based on USB Type-C and USB Power Delivery technologies. The middleware stack (X-CUBE-USB-PD) offers a set of dedicated API and configuration templates to cover different topologies (Provider, Consumer, DRP,...) and customizations to easily develop Type-C and Power Delivery applications. For more details refer to the STM32 Nucleo pack for USB Type-C and Power Delivery with the NUCLEO-F072RB board User manual (UM2050) at the website. Thanks to the two Type-C ports available on the USB-C Power Delivery expansion board, the firmware example embedded in the STM32F072RBT6 MCU of the NUCLEO-F072RB board, provides a simple demonstration that the user can run without any additional material. This demonstration shows the flexibility of the USB Type-C with its reversible plug orientation, cable direction, and the role assumed by each port. User can build other demonstrations with external tools, using the same firmware embedded in the STM32F072RBT6 MCU of the NUCLEO-F072RB board. 1.4 Configuration setup To run the embedded demonstration, follow the hardware configuration steps shown below: 1. The MB1257 exapnsion board must be stacked on a NUCLEO-F072RB board through the ST morpho connector. There is only one position allowed for this connection: the one where the stacked board MB1257 does not cover the two blue and black pushbuttons on the NUCLEO-F072RB board (see the blue button B1 and black button B2 in the Figure 3). DocID Rev 2 7/17 16

8 Getting started UM2051 Figure 3. MB1257 USB Type-C and Power Delivery expansion board and NUCLEO-F072RB assembled 8/17 DocID Rev 2

9 Getting started The NUCLEO-F072RB board included in the pack, has a different configuration comparing to the default one. The main differences are listed below: Solder bridges SB48, SB49, SB62, SB63 are closed Solder bridges SB13, SB14, SB15, SB21 are open 0 Ω resistors R34, R36 are removed 2. On NUCLEO-F072RB board, verify jumper settings: JP1 must be open, JP5 (PWR) must be closed on U5V and JP6 must be closed (IDD). 3. On the MB1257 expansion board, verify jumper settings: JP500/J500 (JP500 on MB1257C or J500 on MB1257B) and JP501 must be closed. Refer to Figure Connect the NUCLEO-F072RB board to a PC with a USB Type-A to Mini-B cable (not provided) to power the system and to interact with the demonstration Refer to Table 1 for the description of connectors, jumpers and LEDs of the expansion board. Figure 4. Connectors, jumpers and LEDs of the MB1257 expansion board morpho connectors CN7 User LEDs CN10 CN2 CN3 JP501 J 500 JP100 Type-C PORT_ 1 Connector for V BUS Load PORT_1 Type-C PORT_0 Connector for V BUS Load PORT_0 Port 0 connectors and circuitry Port 1 connectors and circuitry Table 1. Description of connectors, jumpers and LEDs Part reference CN7 CN10 CN2 CN3 CN4 CN11 Description ST morpho connector ST morpho connector I 2 C connector UART connector Power connector (on bottom side) V BUS Load PORT_0 DocID Rev 2 9/17 16

10 Getting started UM2051 Table 1. Description of connectors, jumpers and LEDs (continued) Part reference Description CN12 V BUS Load PORT_1 JP100 Supply V BUS selection only for consumer role JP500/J500 (1) V BUS source for PORT_0 (2) JP0 (3) V CONN source for PORT_0 (4) JP1 (3) V CONN source for PORT_1 (4) JP501 V BUS source for PORT_1 (2) D200 (Blue LED) D201 (Green LED) D202 (Orange LED) D203 (Blue LED) D204 (Green LED) D205 (Orange LED) D206 (Blue LED) Role indication for PORT_1 V BUS indication for PORT_1 CC line indication for PORT_1 Role indication for PORT_0 V BUS indication for PORT_0 CC line indication for PORT_0 3.3 V power 1. This jumper is called JP500 on MB1257C expansion board while it is called J500 on MB1257B expansion board. 2. It is allowed to use the 5 V from NUCLEO-F072 as V BUS, when no external power supply is available and only for Provider role. It is used mainly for demonstration purpose. If an external power supply is connected the jumper must be left open. 3. JP0 and JP1 are available only on Rev C boards. 4. It is allowed to use the 5 V from NUCLEO-F072 as V CONN (close pins 1 and 2) when no external power supply is available. It is used mainly for demonstration purpose. If an external power supply is connected a jumper must close pins 2 and 3. Note: The value of the integrated resistor Rp is 4.7 kω at 3.3 V to advertise current capability of 3 A at 5 V. User has to change it according to his power supply capabilities. Using the board without a dedicated external power supply, the only power supplied is coming from the PC through the USB Type-A to Mini-B cable. For more details refer to STM32 Nucleo pack for USB Type-C and Power Delivery with the Nucleo-F072RB board User manual (UM2050) at the website Standalone demonstration The two ports are configured as Dual Role Port, DRP. The role is highlighted at startup by the blue LEDs D203 and D200 blinking three times. Once the two Type-C ports of the expansion board are connected together by the Type-C to Type-C cable, the demonstration shows the role, cable attachment/detachment operation and orientation mechanism by LEDs blinking. After the procedure described in the previous section, the following actions must be accomplished to run the embedded demonstration: 10/17 DocID Rev 2

11 Getting started 1. Connect the two Type-C receptacles on the expansion board using the USB Type-C cable (provided). 2. Blue LEDs, D203 and D200 for PORT_0 and PORT_1 respectively, blink once or twice accordingly to the role the port has assumed. They blink once when the port is working as Provider, while they blink twice when the port is working as Consumer. 3. The two orange LEDs, D205 and D202 for PORT_0 and PORT_1 respectively, blink once or twice indicating the CC line used, once for CC1 or twice for CC2. Changing the cable insertion, the LEDs blink according to the cable orientation. 4. Green LEDs, D204 and D201 for PORT_0 and PORT_1 respectively, blink when the port, working as Provider, is supplying the Port Partner or, working as Consumer, is sinking power. Green LEDs is lighted on when the two partners have successfully reached an explicit contract. They are off if no power is provided or sunk on the port. 5. The user interacts with the application by means of a serial communication tool as explained in Section When an explicit contract has been established, PORT_0 is allowed to request a Power Role Swap pressing the blue user button B1 of the NUCLEO-F072RB board Other demonstration with external hardware When connecting one of the two ports to an external Port Partner, the user sees the cable attachment/detachment, the orientation and the role configuration. Take care that in case of Provider role the exposed power profiles are dummy ones. After execution of the procedure described in Section 1.4: Configuration setup, the two blue LEDs D203 and D200 blink three times; the following actions must be accomplished to run the demonstration: 1. Connect CN3 of NUCLEO-F072RB with CN3 of MB1257 expansion board through the two female wires included in the package, respecting the numeration (CN3_1 - CN3_RX, CN3_2 - CN3_TX). 2. Insert one plug of the included Type-C to Type-C cable on one of the two port of the expansion board that, as stated before, are configured as DRP. 3. Connect the other plug of the USB Type-C Cable to an external Port Partner. 4. The blue LED (D203 for PORT_0 or D200 for PORT_1) blinks once when the associated port is working as Provider, it blinks twice when it is working as Consumer. 5. The orange LED (D205 for PORT_0 or D202 for PORT_1) blinks according to the connected CC line, once for CC1 and twice for CC2. 6. The green LED (D204 for PORT_0 or D201 for PORT_1) blinks when the port, working as Provider, is supplying the Port Partner or when the port, working as Consumer, is sinking power. Whichever role has the port, this LED lights on whenever an explicit contract has been negotiated. 7. In case of Provider role, after providing the 5 V on V BUS, the port starts to advertise source capabilities related to four dummy profiles (5 V, 9 V, 15 V and 20 V). 8. The user interacts with the application by means of a serial communication tool as explained in Section 1.5. DocID Rev 2 11/17 16

12 Getting started UM Command Line Interface The Command Line Interface (CLI) allows the user to get the status of the Power Delivery application and to act on it through a serial communication. When connecting through the two female wires included in the package, CN3 of NUCLEO- F072RB board with CN3 of the MB1257 expansion board, respecting the numeration (CN3_1 - CN3_RX, CN3_2 - CN3_TX), user can connect the NUCLEO-F072RB board to the PC using the virtual COM port with a standard serial terminal software. The configuration shall be: Baudrate: Data bit: 8 Parity: none Stop bit: 1 Hardware Flow Control: None Through a set of commands, CLI allows the user to know the status and the available profiles on each port and, only when the port is acting as Consumer, to request a different profile if available. At the startup of the board a "welcome message" is shown in the terminal (pressing the reset button on the NUCLEO-F072RB board, this message is shown again). By typing "help" user gets the list of the supported commands (see Table 2 and Figure 5). Figure 5. Screenshot of the CLI and list of available commands Table 2. Description of the CLI commands Command Parameter 1 Parameter 2 Description help None None To show the list of the available commands. welcome None None To print out the welcome message and copyright information. 12/17 DocID Rev 2

13 Getting started Table 2. Description of the CLI commands (continued) Command Parameter 1 Parameter 2 Description profiles Port Number None To show the available power profiles. status Port Number None To retrieve information about a port and its status. request Port Number Profile number To change the power profile on PD port (in case of Consumer). prswap Port Number None Start a power role swap for the specified port. The profiles command, when no cable is plugged, shows the available power profiles for Provider or DRP role (the demo has four dummy power profiles). The status command indicates if the cable is plugged and the current role of the port. (see Figure 6). Figure 6. CLI when no cable is plugged on a port Connecting PORT_0 to PORT_1 and typing again the status command, the user gets information about the cable orientation (CC1 or CC2) and contract status as shown in Figure 7. DocID Rev 2 13/17 16

14 Getting started UM2051 Figure 7. CLI when PORT_0 is connected with PORT_1 If an external USB Type-C and Power Delivery consumer is plugged in one of the two ports, the P-NUCLEO-USB001 acts as Provider and sends the source capabilities according to the four dummy power profiles (5 V at 3 A, 9 V, 15 V and 20 V at 2 A). The status command shows the dummy power profiles requested by the Consumer and the cable orientation, as shown in Figure 8. Figure 8. CLI when a port is connected to an external Consumer If an external USB Type-C and Power Delivery Provider is plugged in one of the two ports, the P-NUCLEO-USB001 acts as Consumer. The profiles command shows the list of the power profiles received from the Port Partner and the status command shows the requested power profile and the cable orientation (see Figure 9). 14/17 DocID Rev 2

15 Getting started Figure 9. CLI when a PD port is connected to an external Provider The request command changes the power profile according to the specified parameter and start again the negotiation between the Consumer and the Provider for the selected power, as shown in Figure 10. Figure 10. CLI after a request to change the power profile DocID Rev 2 15/17 16

16 Revision history UM Revision history Table 3. Document revision history Date Revision Changes 02-Jun Initial release. 15-Feb Updated sections: Introduction, Section 1.3: The P-NUCLEO-USB001 demonstration, Section 1.4: Configuration setup, Section 1.5: Command Line Interface added Section 1.2: MB1257 board versions updated tables: Table 1: Description of connectors, jumpers and LEDs, Table 2: Description of the CLI commands updated figures: Figure 2, Figure 3, Figure 4, Figure 5, Figure 6, Figure 7, Figure 8, Figure 9, Figure 10 to add the two revisions of the expansion board MB /17 DocID Rev 2

17 IMPORTANT NOTICE PLEASE READ CAREFULLY STMicroelectronics NV and its subsidiaries ( ST ) reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST s terms and conditions of sale in place at the time of order acknowledgement. Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of Purchasers products. No license, express or implied, to any intellectual property right is granted by ST herein. Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product. ST and the ST logo are trademarks of ST. All other product or service names are the property of their respective owners. Information in this document supersedes and replaces information previously supplied in any prior versions of this document STMicroelectronics All rights reserved DocID Rev 2 17/17 17