/* USER CODE BEGIN Header */ /** ****************************************************************************** * @file usbpd_pwr_user.h * @author MCD Application Team * @brief Header file for usbpd_pwr_user.c file ****************************************************************************** * @attention * * Copyright (c) 2026 STMicroelectronics. * All rights reserved. * * This software is licensed under terms that can be found in the LICENSE file * in the root directory of this software component. * If no LICENSE file comes with this software, it is provided AS-IS. * ****************************************************************************** */ /* USER CODE END Header */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef USBPD_PWR_USER_H_ #define USBPD_PWR_USER_H_ #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ #include "stm32g4xx.h" /** @addtogroup BSP * @{ */ /** @addtogroup POWER * @{ */ /** @defgroup POWER_Exported_Types Exported Types * @{ */ /** * @brief Power role */ typedef enum { POWER_ROLE_SOURCE = 0, POWER_ROLE_SINK, POWER_ROLE_DUAL } USBPD_PWR_PowerRoleTypeDef; /** * @brief Voltage control mode */ typedef enum { DCDC_CTRL_MODE_UNKNOWN = 0, DCDC_CTRL_MODE_GPIO, DCDC_CTRL_MODE_PWM, } USBPD_PWR_DCDCCtrlModeTypeDef; /** * @brief Low Power Mode of TypeC ports */ typedef enum { USBPD_PWR_MODE_OFF = 0, USBPD_PWR_MODE_HIBERNATE, USBPD_PWR_MODE_LOWPOWER, USBPD_PWR_MODE_NORMAL } USBPD_PWR_PowerModeTypeDef; /** * @brief VBUS connection status */ typedef enum { VBUS_CONNECTED = 0, VBUS_NOT_CONNECTED } USBPD_PWR_VBUSConnectionStatusTypeDef; /** * @brief VBUS Detection Callback */ typedef void USBPD_PWR_VBUSDetectCallbackFunc(uint32_t Instance, USBPD_PWR_VBUSConnectionStatusTypeDef VBUSConnectionStatus); /** * @} */ /** @defgroup POWER_Exported_Constants Exported Constants * @{ */ /* Common Error codes */ #define BSP_ERROR_NONE 0 #define BSP_ERROR_NO_INIT -1 #define BSP_ERROR_WRONG_PARAM -2 #define BSP_ERROR_BUSY -3 #define BSP_ERROR_PERIPH_FAILURE -4 #define BSP_ERROR_COMPONENT_FAILURE -5 #define BSP_ERROR_UNKNOWN_FAILURE -6 #define BSP_ERROR_UNKNOWN_COMPONENT -7 #define BSP_ERROR_BUS_FAILURE -8 #define BSP_ERROR_CLOCK_FAILURE -9 #define BSP_ERROR_MSP_FAILURE -10 #define BSP_ERROR_FEATURE_NOT_SUPPORTED -11 /** * @brief Number of TypeC ports */ #define USBPD_PWR_INSTANCES_NBR (1U) /** * @brief Type-C port identifier */ #define USBPD_PWR_TYPE_C_PORT_1 (0U) /** * @brief CC pin identifier */ #define USBPD_PWR_TYPE_C_CC1 (1U) #define USBPD_PWR_TYPE_C_CC2 (2U) /** * @brief VBUS disconnection threshold values (in mV) */ #define USBPD_PWR_HIGH_VBUS_THRESHOLD (2800U) #define USBPD_PWR_LOW_VBUS_THRESHOLD (750U) #define USBPD_PWR_VBUS_THRESHOLD_5V (2150U) #define USBPD_PWR_VBUS_THRESHOLD_9V (7000U) #define USBPD_PWR_VBUS_THRESHOLD_15V (12500U) #define USBPD_PWR_VBUS_THRESHOLD_20V (17000U) #define USBPD_PWR_VBUS_THRESHOLD_APDO (2150U) /** * @brief VBUS discharge parameters */ #define USBPD_PWR_DISCHARGE_MARGIN (500U) #define USBPD_PWR_DISCHARGE_TIME (6U) /** * @brief Calibration settings */ #define USBPD_PWR_DCDC_PRECISION (40U) /* DCDC output precision set to 40mV (Noise)*/ #define USBPD_PWR_CALIBRATION_ENABLED (1U) #define USBPD_PWR_CALIBRATION_DISABLED (0U) /** * @brief Standard VBUS voltage levels */ #define USBPD_PWR_VBUS_5V 5000U #define USBPD_PWR_VBUS_9V 9000U #define USBPD_PWR_VBUS_15V 15000U /** * @brief power timeout */ #define USBPD_PWR_TIMEOUT_PDO 250U /* Timeout for PDO to PDO or PDO to APDO at 250ms*/ #define USBPD_PWR_TIMEOUT_APDO 25U /* Timeout for APDO to APDO at 25ms*/ /** * @brief Invalid value set during issue with voltage setting */ #define USBPD_PWR_INVALID_VALUE 0xFFFFFFFFU /** * @} */ /** @defgroup POWER_Exported_Functions Exported Functions * @{ */ /* Common functions */ int32_t BSP_USBPD_PWR_Init(uint32_t Instance); int32_t BSP_USBPD_PWR_Deinit(uint32_t Instance); int32_t BSP_USBPD_PWR_SetRole(uint32_t Instance, USBPD_PWR_PowerRoleTypeDef Role); int32_t BSP_USBPD_PWR_SetPowerMode(uint32_t Instance, USBPD_PWR_PowerModeTypeDef PwrMode); int32_t BSP_USBPD_PWR_GetPowerMode(uint32_t Instance, USBPD_PWR_PowerModeTypeDef *PwrMode); int32_t BSP_USBPD_PWR_VBUSInit(uint32_t Instance); int32_t BSP_USBPD_PWR_VBUSDeInit(uint32_t Instance); int32_t BSP_USBPD_PWR_VBUSOn(uint32_t Instance); int32_t BSP_USBPD_PWR_VBUSOff(uint32_t Instance); int32_t BSP_USBPD_PWR_VBUSSetVoltage_Fixed(uint32_t Instance, uint32_t VbusTargetInmv, uint32_t OperatingCurrent, uint32_t MaxOperatingCurrent); int32_t BSP_USBPD_PWR_VBUSSetVoltage_Variable(uint32_t Instance, uint32_t VbusTargetMaxInmv, uint32_t VbusTargetMinInmv, uint32_t OperatingCurrent, uint32_t MaxOperatingCurrent); int32_t BSP_USBPD_PWR_VBUSSetVoltage_Battery(uint32_t Instance, uint32_t VbusTargetMin, uint32_t VbusTargetMax, uint32_t OperatingPower, uint32_t MaxOperatingPower); int32_t BSP_USBPD_PWR_VBUSSetVoltage_APDO(uint32_t Instance, uint32_t VbusTargetInmv, uint32_t OperatingCurrent, int32_t Delta); int32_t BSP_USBPD_PWR_VBUSGetVoltage(uint32_t Instance, uint32_t *pVoltage); int32_t BSP_USBPD_PWR_VBUSGetCurrent(uint32_t Instance, int32_t *pCurrent); int32_t BSP_USBPD_PWR_VCONNInit(uint32_t Instance, uint32_t CCPinId); int32_t BSP_USBPD_PWR_VCONNDeInit(uint32_t Instance, uint32_t CCPinId); int32_t BSP_USBPD_PWR_VCONNOn(uint32_t Instance, uint32_t CCPinId); int32_t BSP_USBPD_PWR_VCONNOff(uint32_t Instance, uint32_t CCPinId); int32_t BSP_USBPD_PWR_SetVBUSDisconnectionThreshold(uint32_t Instance, uint32_t VoltageThreshold); int32_t BSP_USBPD_PWR_RegisterVBUSDetectCallback(uint32_t Instance, USBPD_PWR_VBUSDetectCallbackFunc *pfnVBUSDetectCallback); int32_t BSP_USBPD_PWR_VBUSIsOn(uint32_t Instance, uint8_t *pState); int32_t BSP_USBPD_PWR_VCONNIsOn(uint32_t Instance, uint32_t CCPinId, uint8_t *pState); int32_t BSP_USBPD_PWR_VCCSetState(uint32_t Instance, uint32_t State); void BSP_USBPD_PWR_EventCallback(uint32_t Instance); /** * @} */ /** * @} */ /** * @} */ /** * @} */ #ifdef __cplusplus } #endif #endif /* USBPD_PWR_USER_H_ */