# Release Notes for STM32 USB-C Power Delivery Graphical User Interface (GUI_INTERFACE)

Copyright © 2018 STMicroelectronics

# License

This software component is licensed by ST under BSD 3-Clause license, the “License”; You may not use this component except in compliance with the License. You may obtain a copy of the License at:

http://www.opensource.org/licenses/BSD-3-Clause

# Purpose

This driver is used in a STM32 application (embedded side) communicating with STM32CubeMonitor-UCPD.

The application can be found in ST website:

https://www.st.com/en/development-tools/stm32cubemonucpd.html

# Update History

V1.12.0 / 16-Oct.-2020

## Main Changes

### Maintenance release

## Contents

Fixed bugs list

Headline
[Codespell] minor typo corrections
Ticket 93706 - Errors occurred with GUI_API
Ticket 93830 - Not possible to modify parameters Responds_to_discov and Attempts_disco
Ticket 92751 - Add applications for STM32G0C1E-EV board

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.26
- STM32CubeIDE v1.2.0

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

This version should be used after TRACER_EMB version V1.4.0 due to a remove of the prototype TRACER_EMB_WakeUpProcess

## Dependencies

V1.11.0 / 12-June-2020

## Main Changes

### Maintenance release

## Contents

Fixed bugs list

Headline
Increase stack size linked to issue during tests
Ticket 86356 - Correct misspelled words
Ticket 87173 - Add a mechanism to check that GUI FLASH area is not corrupted
Remove few parameters not used in NO_PD config
Add “usbpd_def.h” include in gui_api.h (usbpd_def.h types used in gui_api.h)
GUI_PARAM_NB_TAG value not correct
Remove wakeup trace (TRACER_EMB_WakeUpProcess prototype has been removed from TRACER_EMB)

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.26
- STM32CubeIDE v1.2.0

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

This version should be used after TRACER_EMB version V1.4.0 due to a remove of the prototype TRACER_EMB_WakeUpProcess

## Dependencies

V1.10.2 / 13-May-2020

## Main Changes

### Maintenance release

## Contents

Fixed bugs list Headline ——– Add “usbpd_def.h” include in gui_api.h (usbpd_def.h types used in gui_api.h)

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.26
- STM32CubeIDE v1.2.0

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

No compatibility break with previous version

## Dependencies

V1.10.1 / 14-Apr.-2020

## Main Changes

### Maintenance release

## Contents

Fixed bugs list Headline ——– User functions for VDM display port should be under switch VDM only

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.26
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

No compatibility break with previous version

## Dependencies

V1.10.0 / 07-Apr.-2020

## Main Changes

### Maintenance release

## Contents

Fixed bugs list Headline ——– Move TASK ID from Core/inc/usbpd_task.h yo applications/inc/utilities_conf.h Add switch USE_STM32_UTILITY_OS to integrate SEQUENCER utility - bis Add switch USE_STM32_UTILITY_OS to integrate SEQUENCER utility Ticket 81002 - unwanted include file in gui_api.h integration of the new utilities SEQ to handle GUI task in non RTOS mode

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.26
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

No compatibility break with previous version

## Dependencies

V1.9.0 / 15-Nov-2019

## Main Changes

### Maintenance release

## Contents

Fixed bugs list Headline ——– Ticket 74534 - clean code linked to USBPD_CORE_DATATYPE_REQUEST_DO Ticket 71492 - PE_Dataswap parameter needs to be duplicated in gui_api Ticket 74120 - Compilation issue in case of GUI_INTERFACE use without FreeRTOS Ticket 73678 - Initialize CAD_tDRP & CAD_dcSRC_DRP at GUI initialization Ticket 73064 - SNK_extended_cap must be answered while SNK or DRP Remove warning in NRTOS mode Remove dependence with USBPD internal variable

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.26
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

No compatibility break with previous version

## Dependencies

V1.8.0 / 06-Sept-2019

## Main Changes

### Maintenance release

## Contents

Fixed bugs list Headline ——– [USBPD][GUI] Increase GUI_STACK_SIZE_ADDON_FOR_CMSIS in case of CMSIS OS V2. [USBPD][GUI] Ticket 66690 - [FOSS-Audit] SLA0044 headers in Utilities files [USBPD][GUI] Ticket 71488 - project settings (and also behavior) differs vs _Gui_Interface switch activation [USBPD][GUI] Remove useless include file + use of Nb ports define for USBPD_NbPDO initialisation [USBPD][GUI] Update in template of usbpd_gui_memmap_template.h [USBPD][GUI] Ticket 70835 - PE_Dataswap parameter needs to be duplicated in gui_api [USBPD][GUI] Update in Flash erase function to be able to address F0/G0/G4 and L5 Dual bank flashes [USBPD][GUI]rename GUI_NbPDO to USBPD_NbPDO [USBPD][GUI] All the DPM_User_Settings should be initialized to be able to pass MQP tests [USBPD][GUI] Set DataRoleSwap as TRUE when GUI is enabled [USBPD][GUI] Move PE_DataSwap & PE_VconnSwap in the USBPD_USER_SettingsTypeDef for integration in cubeMX [USBPD][GUI] Ticket 67078 - Use common defines for XID, VID & PID [USBPD][GUI] Ticket 66284 - [CubeMx-UBSPD] Update generated code to make it compatible with CMSIS-RTOS v2

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.26
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

No compatibility break with previous version

## Dependencies

V1.7.0 / 23-May-2019

## Main Changes

### Maintenance release

## Contents

Fixed bugs list Headline ——– Ticket 62471 - Solve Hard Fault called from usage of UCPD voltage calculation using FPU for UCPD Ticket 66412 - Allow communication with CubeMonitor-UCPD from CubeMx generated examples (from CubeMx 5.2.1) Ticket 66638 - SLA0044 headers in files updated to BSD-3-Clause Ticket 67146 - Add memory mapping template in GUI utility (template to be used in user code)

## Known Limitations

Outstanding bugs list : None

Requirements not met or planned in a forthcoming release : None

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

All STM32xx devices implementing a USBPD application able to communicate with CubeMonitor_UCPD

## Backward compatibility

No compatibility break with previous version

## Dependencies

V1.6.0 / 10-April-2019

## Main Changes

### Maintenance release

## Contents

Fixed bugs list Headline ——– Update to wakeup the TX send Ticket 62412 - Sink request using GUI seems not coherent with registered SNKPDOs (GUI impact) Ticket 62344 - [GUI] Display a warning message in GUI in case of information comes from previous saving done by user Remove sModesInfo as no more used Re-enable IT when FreeRTOS is used Renable SYSTICK after calling FreeRTOS function Ticket 61311 - [MB1303] integration of GUI interface Add Free text outside _VDM switch GUI regression after moving GUI from DPM - use GUIMsgBox instead of DPMMsgBox GUIMsgBox used only in case of _RTOS Remove dependencies with GUI in DPM USER code Manage Free Text Ticket 60213 - STM32G071B-DISCO_Demonstrations_USBPD_Analyzer_SW4STM32_Compilation Warnings Add include for G4

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.5.0 / 28-Jan-2019

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– Ticket 60213 - STM32G071B-DISCO_Demonstrations_USBPD_Analyzer_SW4STM32_Compilation Warnings. Modifications in GUI_INTERFACE module for solving compilation warnings under SW4STM32 (Gcc)

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.4.0 / 19-Dec-2018

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– correction link with renaming toogle toggle Ticket 57478 - SKEDB not implemented Remove extern GUI_Flag variable from application

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.3.0 / 10-Dec-2018

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– Ticket 57478 - SKEDB not implemented Remove extern GUI_Flag variable from application

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.2.0 / 15-Nov-2018

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– rename DPM_User_Params to GUI_User_Params add a link with TRACER_EMB solve compilation issue

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.1.2 / 25-Sept.-2018

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– Update License information Solve compilation issue when using IAR V8.30.1 Add ping feature

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.1.1 / 10-Sept.-2018

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– Remove compilation warning

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.1.0 / 06-Sept.-2018

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– Add cable information management Update around the VDM data (SVID, SVDM modes, … )

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies

V1.0.0 / 19-Jun-2018

## Main Changes

### Maintenance release

Maintenance release

## Contents

Fixed bugs list Headline ——– First official version for STM32 USB-PD GUI Interface utility. This utility enables communication between USB-PD device (controlled on STM32 side) and USB-PD PC tool

## known limitations

## Development Toolchains and Compilers

- IAR Embedded Workbench for ARM (EWARM) toolchain V8.20.2
- RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.25
- System Workbench STM32 (SW4STM32) toolchain V2.7.2

## Supported Devices and boards

## backward compatibility

## Dependencies