STMicroelectronics STM32CubeMonitor-UCPD User Manual

UM2468

User manual

STM32CubeMonitor-UCPD software tool for USB Type-C™ Power Delivery port

management

Introduction

STM32CubeMonitor-UCPD (STM32CubeMonUCPD) is a software tool to configure and monitor the USB Type-C® Power Delivery (UCPD) ports on equipped STM32 boards. The configuring part allows the modification of the USB Type-C® Power

Delivery port default configuration. Checks of Power Delivery contract establishment and activity are possible with the monitoring tool.

UM2468 - Rev 2 - September 2020 For further information contact your local STMicroelectronics sales office.

www.st.com

1 Features

The main features of the STM32CubeMonitor-UCPD software tool are the following:

• Configures and monitors USB Type-C® Power Delivery (UCPD) ports of STMicroelectronics Type-C Power Delivery boards.

• Sends device policy manager (DPM) messages to the distant USB Type-C® Power Delivery port.

This software applies to STM32 Arm®-based microcontrollers.

Note: Arm is a registered trademark of Arm Limited (or its subsidiaries) in the US and/or elsewhere.

UM2468

Features

UM2468 - Rev 2

page 2/37

2 Getting started

2.1 Computer requirements

Supported operating systems and architectures

• Windows® 7, 8 and 10: 64-bit (x64)

• Linux® (tested on Red Hat®, Fedora®, and Ubuntu®, 64-bit)

• macOS® (minimum version OS X® Yosemite)

Note:

Note: Oracle and Java are registered trademarks of Oracle and/or its affiliates.

Red Hat® is a registered trademark of Red Hat, Inc.

Fedora® is a trademark of Red Hat, Inc.

macOS® is a trademark of Apple Inc. registered in the U.S. and other countries.

Ubuntu® is a registered trademark of Canonical Ltd.

Software requirements

For Linux®, Java™ runtime is required by the installer.

UM2468

Getting started

2.2 Hardware requirements

• One free USB2 or USB3 host port

• Mini-B or Micro-B cable depending on the target board to access the STM32 ST-LINK

• STMicroelectronics target board with USB Type-C® and a firmware (embedding the tracer or the cubemon_ucpd_emb module) latest version as described in STM32 STM application (UM2063), downloaded from STMicroelectronics website www.st.com) selecting X-CUBE-USB-PD, or built through STM32CubeMX.

2.3 Installing

2.3.1 Installing STM32CubeMonitor-UCPD

The user must have the administrator rights on the computer to perform the installation. The steps needed to install the STM32CubeMonitor-UCPD software tool are detailed below (all files can be

downloaded from the STMicroelectronics website www.st.com):

1. Download SetupSTM32CubeMonitor-UCPD.zip and unzip it in a temporary location.

2. Perform setup process associated with the environment (x.y.z represents STM32CubeMonitor-UCPD software version):

– Windows: launch SetupSTM32CubeMonitor-UCPD-x.y.z.exe and follow the instructions provided. – Linux: launch SetupSTM32CubeMonitor-UCPD-x.y.z.jar and follow the instructions provided. – macOS: launch SetupSTM32CubeMonitor-UCPD-x.y.z.dmg and, into the installer window, drag and

drop the STM32CubeMonitor-UCPD icon on the Applications icon.

If another version of STM32CubeMonitor-UCPD is already installed, the existing version must be uninstalled before installing the new version (see Section 2.4 for more details).

UM2468 - Rev 2

page 3/37

2.3.2 Installing the USB driver for ST-LINK

Note: This section is only applicable to Windows operating systems.

Follow the steps detailed below to install the USB driver for ST-LINK (all files can be downloaded from the STMicroelectronics website www.st.com):

1. Download the USB driver for ST-LINK (STSW-LINK009).

2. Go in the directory C:\Program Files (x86)\STMicroelectronics\Software\Virtual comport driver and launch the files listed below (depending on the operating system):

– Windows 7 64-bit: launch Win7/dpinst_amd64.exe. – Windows 8.x and Windows 10 64-bit: launch Win8/dpinst_amd64.exe.

3. Plug the board with the USB cable. Windows detects it as "STMicroelectronics ST-LINK Virtual COM port”, named COMxx.

Example: COM10.

2.4 Uninstalling STM32CubeMonitor-UCPD

The steps needed to uninstall STM32CubeMonitor-UCPD are detailed below for the various operating systems:

• Windows Two possible options:

1. Open the Windows Control panel. Select Programs and Features to display the list of programs

installed on the computer. Right-click on STM32CubeMonitor-UCPD from the STMicroelectronics publisher and select the uninstall function.

2. Go in the installation location (for example C:\Program Files\STMicroelectronics\ STM32CubeUCPD),

go in the Uninstaller folder and launch uninstaller.jar.

• Linux Go in the STM32CubeMonitor-UCPD installation location (example $HOME/STMicroelectronics/

STM32CubeMonitor-UCPD), go in the Uninstaller folder and launch uninstaller.jar.

• macOS Drag and drop the STM32CubeMonitor-UCPD application icon onto the Trash icon.

UM2468

Uninstalling STM32CubeMonitor-UCPD

2.5 Uninstalling the USB driver for ST-LINK

Note: This section is only needed for Windows operating systems.

Perform the following steps to uninstall the STMicroelectronics USB driver for ST-LINK:

1. Open the Windows Control panel.

2. Select Programs and Features to display the list of programs installed on the computer.

3. Right-click on Windows Driver Package - STMicroelectronics (WinUSB) STLinkWinUSB from the STMicroelectronics publisher and select the uninstall function.

UM2468 - Rev 2

page 4/37

3 Windows structure - main areas

Figure 1. Overview of all panels

UM2468

Windows structure - main areas

The main areas are the following (also shown in the figure above):

• Area 1: Application Title panel

• Area 2: Social panel, linked to STMicroelectronics social networks shown in the figure below

• Area 3: Ribbon panel, where the four main states are listed and accessible step after step:

1. Board selection

2. Port Selection

3. Port Configuration

4. Port Communication Chevron-right and chevron-left buttons in the Button panel allow navigation to the previous or next step.

• Area 4: Main panel content is state-dependent (see Section 4 How to use STM32CubeMonitor-UCPD).

• Area 5: Port Status panel gives a sum up of each board port (see Section 4.4 Port Status information).

• Area 6: Button panelists the actions.

• Area 7: Status bar panel displays the board version and the port selected when relevant.

• Area 8: Traces panel (see Section 5 Traces information)

UM2468 - Rev 2

page 5/37

Figure 2. Social network shortcut area

This area contains five shortcuts to social networks and web pages:

• The Facebook™ icon leads to the official STMicroelectronics Facebook page.

•

The YouTube™ icon leads to the official STMicroelectronics YouTube page.

•

The Twitter™ icon leads to the official STMicroelectronics Twitter page.

• The Share icon leads to the ST Community web site.

• The ST icon leads to the official STMicroelectronics web site.

UM2468

Windows structure - main areas

UM2468 - Rev 2

page 6/37

4 How to use STM32CubeMonitor-UCPD

4.1 Board detection and selection

The detection of a board is automatically launched when the application starts. If there is no board connected via USB to the computer, the application displays an invitation to connect the board

as shown in the figure below.

Figure 3. Invitation to connect the board

UM2468

How to use STM32CubeMonitor-UCPD

To see a new connected board, click on the button Refresh list of connected boards. The application sends a message to all devices, waiting for an appropriate response to distinguish ST-UCPD GUI capable boards from the other boards.

An ST-UCPD GUI capable board is a device that contains a firmware source code to communicate between STM32CubeMonitor-UCPD application and the device.

Note: If the GUI responder is not activated in the embedded firmware, but the debug trace is available (UART through

VCP of the STLINK and the compilation switch _TRACE activated) the user may still see the trace in UCPD monitor by clicking on the Trace button in the bottom right corner.

UM2468 - Rev 2

page 7/37

UM2468

Board detection and selection

All devices identified as ST-UCPD GUI capable are displayed in the Board Selection panel as shown in the figure below.

Figure 4. Board Selection window

Parameters for each board are the following:

• Communication port assigned to the device (ComPort)

• Hardware board version

• Power delivery type

• Firmware version

• Stack version

• Number of USB Type-C® ports on the board (NbPort)

If a board is disconnected, it is removed from the Board Selection panel. To select a board, move the mouse pointer on the corresponding line. The line is greyed out when selected. Then,

double click on the line or click on chevron-right. The board is selected and the application window moves to the Port Selection window.

UM2468 - Rev 2

page 8/37

4.2 Port Selection

When a board is selected, the Port Selection window is opened as shown in the figure below.

UM2468

Port Selection

Figure 5. Port Selection window

4.3

The following details are provided on this window:

1. Port Status information panel. Refer to Section 4.4.2 Port Status information - Selected port).

2. The board selected in the previous steps is reported here (PowerDeliveryType and ComPort boards parameters are described in Section 4.1 Board detection and selection).

3. List of USB Type-C® PD available on the selected board (two in this example), with the port number written on the board (PortNumber) and the PD specification revision supported by the port (PDSpecRevision).

4. Click on it to select the static parameters to display. Refer to the USB PD standards for further definition of these parameters on the USB web site.

Port selection can be performed in zone 1, or 3.

Port Selection action

The figure below shows the port parameters. On the Port Status panel, the port selected is highlighted in light blue (see next section for more details). In the Status bar, the selected port number is added, close to the selected board identification.

Figure 6. Port selected: Port Status panel, Button and Status bars

UM2468 - Rev 2

page 9/37

4.4 Port Status information

The Port Status panel is displayed as soon as a board is selected. This panel is available in the Port Selection, Port Communication and Port Configuration windows. Refer to the figure below.

This Port Status panel lists all the USB Type-C® with Power Delivery ports available on the board. Refer to the figure below.

UM2468

Port Status information

Figure 7. Port Selection ribbon

Figure 8. Port Status panel

For each port, the following characteristics are displayed:

• Contract: If this field is not NO, it means the port established a contract with a distant port and relevant characteristics of this contract are displayed in the next columns.

• Power Role: – If this field is SNK, the Selected SRC PDO is the PDO selected of the distant port. – If this field is SRC, the Selected SRC PDO is the PDO selected of the current port.

• Spec Revision and CC, Data Role, VconnON : characteristics defined in the norm (http://www.usb.org/ developers/powerdelivery)

• VBus and IBus: filled as soon as measurements are done (see Section 4.5.2 )

• Selected SRC PDO: selected PDO – If the current port is connected as Source, the Selected SRC PDO is its own PDO selected which is

displayed.

– If the current port is connected as Sink, the selected SRC PDO is the selected SRC PDO of the distant

port on which the port is connected.

When the user double clicks on a port in the Port Status panel, the selected port changes, and information in Port communication or port configuration is updated.

UM2468 - Rev 2

page 10/37

4.4.1 Port Status information update

When one of the parameters is updated, its value blinks for several seconds to draw attention. Updates can come from hard-cable disconnection or message sent which involved the contract cancellation or modification (see figure below).

Figure 9. Parameter blink when the update is done

UM2468

Port Communication

4.4.2 Port Status information - Selected port

As soon as the Port Communication or Port Configuration window is selected, the Port Status panel highlights the selected port in blue, as shown in the figure below.

Figure 10. Selected port highlighted

4.5 Port Communication

Click on the tab item Port Communication to see specific content, which can be useful only if the selected port is plugged to another device port.

UM2468 - Rev 2

page 11/37

The two following tabs are displayed:

• The General tab, including three panels shown in the figure below: – DISTANT CAPABILITIES: capabilities of the distant device port – MEASUREMENT: start/stop measures for this connection – MESSAGE SELECTOR: messages sent to the distant device port

Figure 11. General tab overview

UM2468

Port Communication

UM2468 - Rev 2

• The Measurement tab, which displays a full-screen view of the measurement graph (see figure below).

Figure 12. Measurement tab overview

page 12/37

+ 25 hidden pages