ci skip clang/iar build for stm32n6

add stm32-tcpp0203 driver as dependency for h7rs and n6
This commit is contained in:
hathach
2025-06-12 15:08:46 +07:00
parent edec37c1a3
commit 76b7468c74
28 changed files with 25 additions and 6672 deletions

View File

@@ -41,7 +41,8 @@ family_list = {
"stm32f7": ["arm-gcc", "arm-clang", "arm-iar"],
"stm32g0 stm32g4 stm32h5": ["arm-gcc", "arm-clang", "arm-iar"],
"stm32h7 stm32h7rs": ["arm-gcc", "arm-clang", "arm-iar"],
"stm32l0 stm32l4 stm32n6": ["arm-gcc", "arm-clang", "arm-iar"],
"stm32l0 stm32l4": ["arm-gcc", "arm-clang", "arm-iar"],
"stm32n6": ["arm-gcc"],
"stm32u5 stm32wb": ["arm-gcc", "arm-clang", "arm-iar"],
"xmc4000": ["arm-gcc"],
"-bespressif_s2_devkitc": ["esp-idf"],

View File

@@ -6,19 +6,14 @@ set(LD_FILE_Clang ${LD_FILE_GNU})
set(LD_FILE_IAR ${CMAKE_CURRENT_LIST_DIR}/stm32h7s3xx_flash.icf)
function(update_board TARGET)
target_compile_definitions(${TARGET} PUBLIC
STM32H7S3xx
SEGGER_RTT_SECTION="noncacheable_buffer"
BUFFER_SIZE_UP=0x3000
)
target_sources(${TARGET} PUBLIC
# BSP
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/tcpp0203/tcpp0203.c
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/tcpp0203/tcpp0203_reg.c
${ST_TCPP0203}/tcpp0203.c
${ST_TCPP0203}/tcpp0203_reg.c
)
target_include_directories(${TARGET} PUBLIC
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/tcpp0203
${ST_TCPP0203}
)
endfunction()

View File

@@ -12,12 +12,8 @@ LD_FILE_GCC = $(BOARD_PATH)/stm32h7s3xx_flash.ld
LD_FILE_IAR = $(BOARD_PATH)/stm32h7s3xx_flash.icf
SRC_C += \
$(BOARD_PATH)/tcpp0203/tcpp0203.c \
$(BOARD_PATH)/tcpp0203/tcpp0203_reg.c \
$(ST_TCPP0203)/tcpp0203.c \
$(ST_TCPP0203)/tcpp0203_reg.c \
INC += \
$(TOP)/$(BOARD_PATH)/tcpp0203 \
CFLAGS += \
-DSEGGER_RTT_SECTION=\"noncacheable_buffer\" \
-DBUFFER_SIZE_UP=0x3000 \
$(TOP)/$(ST_TCPP0203) \

View File

@@ -1,6 +0,0 @@
This software component is provided to you as part of a software package and
applicable license terms are in the Package_license file. If you received this
software component outside of a package or without applicable license terms,
the terms of the BSD-3-Clause license shall apply.
You may obtain a copy of the BSD-3-Clause at:
https://opensource.org/licenses/BSD-3-Clause

View File

@@ -1,205 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Release Notes for TCPP0203 Component Driver</title>
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
<link rel="stylesheet" href="_htmresc/mini-st_2020.css" />
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
<link rel="icon" type="image/x-icon" href="_htmresc/favicon.png" />
</head>
<body>
<div class="row">
<div class="col-sm-12 col-lg-4">
<center>
<h1 id="release-notes-for-tcpp0203-component-driver">Release Notes for TCPP0203 Component Driver</h1>
<p>Copyright © 2020 STMicroelectronics<br />
</p>
<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo_2020.png" alt="ST logo" /></a>
</center>
<h1 id="purpose">Purpose</h1>
<p>This driver provides a set of functions needed to drive TCPP0203 Type-C Port Protection component</p>
</div>
<div class="col-sm-12 col-lg-8">
<h1 id="update-history">Update History</h1>
<div class="collapse">
<input type="checkbox" id="collapse-section6" checked aria-hidden="true"> <label for="collapse-section6" aria-hidden="true">v1.2.3 / 21-Jan-2023</label>
<div>
<h2 id="main-changes">Main Changes</h2>
<h3 id="maintenance-release">Maintenance release</h3>
<h2 id="contents">Contents</h2>
<table>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>MISRA Rule-81.13 correction on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="backward-compatibility">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section5" aria-hidden="true"> <label for="collapse-section5" aria-hidden="true">v1.2.2 / 21-Jan-2022</label>
<div>
<h2 id="main-changes-1">Main Changes</h2>
<h3 id="maintenance-release-1">Maintenance release</h3>
<h2 id="contents-1">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>MISRA corrections on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.8.0</li>
</ul>
<h2 id="backward-compatibility-1">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-1">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section4" aria-hidden="true"> <label for="collapse-section4" aria-hidden="true">v1.2.1 / 18-June-2021</label>
<div>
<h2 id="main-changes-2">Main Changes</h2>
<h3 id="maintenance-release-2">Maintenance release</h3>
<h2 id="contents-2">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>License updates</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations-1">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers-1">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.6.0</li>
</ul>
<h2 id="backward-compatibility-2">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-2">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section3" aria-hidden="true"> <label for="collapse-section3" aria-hidden="true">v1.2.0 / 06-Apr-2021</label>
<div>
<h2 id="main-changes-3">Main Changes</h2>
<h3 id="maintenance-release-3">Maintenance release</h3>
<h2 id="contents-3">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>CodeSpell correction on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations-2">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers-2">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.5.0</li>
</ul>
<h2 id="backward-compatibility-3">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-3">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section2" aria-hidden="true"> <label for="collapse-section2" aria-hidden="true">v1.1.0 / 12-Mar-2021</label>
<div>
<h2 id="main-changes-4">Main Changes</h2>
<h3 id="maintenance-release-4">Maintenance release</h3>
<h2 id="contents-4">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>MCUAstyle correction on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations-3">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers-3">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.5.0</li>
</ul>
<h2 id="backward-compatibility-4">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-4">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section1" aria-hidden="true"> <label for="collapse-section1" aria-hidden="true">v1.0.0 / 20-May-2020</label>
<div>
<h2 id="main-changes-5">Main Changes</h2>
<ul>
<li>First official release of <strong>TCPP0203</strong> Type-C port Protection Component drivers</li>
</ul>
</div>
</div>
</div>
</div>
<footer class="sticky">
<p>For complete documentation on STM32,visit: [<a href="http://www.st.com">www.st.com/stm32</a>]</p>
This release note uses up to date web standards and, for this reason, should not be opened with Internet Explorer but preferably with popular browsers such as Google Chrome, Mozilla Firefox, Opera or Microsoft Edge.
</footer>
</body>
</html>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

View File

@@ -1,886 +0,0 @@
/**
******************************************************************************
* @file tcpp0203.c
* @author MCD Application Team
* @brief This file provides the TCPP02/03 Type-C port protection driver.
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Includes ------------------------------------------------------------------*/
#include "tcpp0203.h"
#if defined(_TRACE)
#include "usbpd_core.h"
#include "usbpd_trace.h"
#include "string.h"
#include "stdio.h"
#endif /* _TRACE */
/** @addtogroup BSP
* @{
*/
/** @addtogroup Components
* @{
*/
/** @addtogroup TCPP0203
* @brief This file provides a set of functions needed to drive the
* TCPP02/03 Type-C port protection.
* @{
*/
/** @defgroup TCPP0203_Private_Constants Private Constants
* @{
*/
/* Compilation option in order to enable/disable a concistency check performed
after each I2C access into TCPP0203 registers : goal is to check that written value in Reg0
is properly reflected into reg1 register content.
To enable register consistency check, please uncomment below definition.
To disable it, comment below line */
/* #define TCPP0203_REGISTER_CONSISTENCY_CHECK */
/** @defgroup TCPP0203_Private_Types Private Types
* @{
*/
/* TCPP02/03 Type-C port protection driver structure initialization */
TCPP0203_Drv_t TCPP0203_Driver =
{
TCPP0203_Init,
TCPP0203_DeInit,
TCPP0203_Reset,
TCPP0203_SetVConnSwitch,
TCPP0203_SetGateDriverProvider,
TCPP0203_SetGateDriverConsumer,
TCPP0203_SetPowerMode,
TCPP0203_SetVBusDischarge,
TCPP0203_SetVConnDischarge,
TCPP0203_GetVConnSwitchAck,
TCPP0203_GetGateDriverProviderAck,
TCPP0203_GetGateDriverConsumerAck,
TCPP0203_GetPowerModeAck,
TCPP0203_GetVBusDischargeAck,
TCPP0203_GetVConnDischargeAck,
TCPP0203_GetOCPVConnFlag,
TCPP0203_GetOCPVBusFlag,
TCPP0203_GetOVPVBusFlag,
TCPP0203_GetOVPCCFlag,
TCPP0203_GetOTPFlag,
TCPP0203_GetVBusOkFlag,
TCPP0203_ReadTCPPType,
TCPP0203_ReadVCONNPower,
TCPP0203_WriteCtrlRegister,
TCPP0203_ReadAckRegister,
TCPP0203_ReadFlagRegister,
};
/**
* @}
*/
/** @defgroup TCPP0203_Private_Variables Private Variables
* @{
*/
static uint8_t TCPP0203_DeviceType = TCPP0203_DEVICE_TYPE_03;
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
static uint8_t Reg0_Expected_Value = 0x00;
static uint8_t Reg1_LastRead_Value = 0x00;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup TCPP0203_Private_Function_Prototypes TCPP0203 Private Function Prototypes
* @{
*/
static int32_t TCPP0203_ReadRegWrap(const void *handle, uint8_t Reg, uint8_t *Data, uint8_t Length);
static int32_t TCPP0203_WriteRegWrap(const void *handle, uint8_t Reg, uint8_t *Data, uint8_t Length);
static int32_t TCPP0203_ModifyReg0(TCPP0203_Object_t *pObj, uint8_t Value, uint8_t Mask);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
static int32_t TCPP0203_CheckReg0Reg1(TCPP0203_Object_t *pObj, uint8_t Reg0ExpectedValue);
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Functions TCPP0203 Exported Functions
* @{
*/
/**
* @brief Register Bus Io to component
* @param Component object pointer
* @retval Status of execution
*/
int32_t TCPP0203_RegisterBusIO(TCPP0203_Object_t *pObj, TCPP0203_IO_t *pIO)
{
int32_t ret;
if (pObj == NULL)
{
ret = TCPP0203_ERROR;
}
else
{
pObj->IO.Init = pIO->Init;
pObj->IO.DeInit = pIO->DeInit;
pObj->IO.Address = pIO->Address;
pObj->IO.WriteReg = pIO->WriteReg;
pObj->IO.ReadReg = pIO->ReadReg;
pObj->IO.GetTick = pIO->GetTick;
pObj->Ctx.ReadReg = TCPP0203_ReadRegWrap;
pObj->Ctx.WriteReg = TCPP0203_WriteRegWrap;
pObj->Ctx.handle = pObj;
if (pObj->IO.Init != NULL)
{
ret = pObj->IO.Init();
}
else
{
ret = TCPP0203_ERROR;
}
}
return ret;
}
/**
* @brief Initializes the TCPP0203 interface
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_Init(TCPP0203_Object_t *pObj)
{
int32_t ret = 0;
uint8_t tmp;
if (pObj->IsInitialized == 0U)
{
/* Read TCPP Device type */
ret += tcpp0203_read_reg(&pObj->Ctx, TCPP0203_READ_REG2, &tmp, 1);
if (ret == TCPP0203_OK)
{
TCPP0203_DeviceType = (tmp & TCPP0203_DEVICE_TYPE_MSK);
}
else
{
TCPP0203_DeviceType = TCPP0203_DEVICE_TYPE_02;
}
pObj->IsInitialized = 1U;
}
if (ret != TCPP0203_OK)
{
ret = TCPP0203_ERROR;
}
return ret;
}
/**
* @brief Deinitializes the TCPP0203 interface
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_DeInit(TCPP0203_Object_t *pObj)
{
if (pObj->IsInitialized == 1U)
{
/* De-Initialize IO BUS layer */
pObj->IO.DeInit();
pObj->IsInitialized = 0U;
}
return TCPP0203_OK;
}
/**
* @brief Resets TCPP0203 register (Reg0)
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_Reset(TCPP0203_Object_t *pObj)
{
int32_t ret = TCPP0203_OK;
uint8_t tmp = TCPP0203_REG0_RST_VALUE;
/* Write reset values in Reg0 register */
if (tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, &tmp, 1) != TCPP0203_OK)
{
ret = TCPP0203_ERROR;
}
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = TCPP0203_REG0_RST_VALUE;
Reg1_LastRead_Value = TCPP0203_REG0_RST_VALUE;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
/**
* @brief Configure TCPP0203 VConn Switch
* @param pObj Pointer to component object
* @param VConnSwitch VConn Switch requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VCONN_SWITCH_OPEN VConn switch open
* @arg TCPP0203_VCONN_SWITCH_CC1 VConn closed on CC1
* @arg TCPP0203_VCONN_SWITCH_CC2 VConn closed on CC2
* @retval Component status
*/
int32_t TCPP0203_SetVConnSwitch(TCPP0203_Object_t *pObj, uint8_t VConnSwitch)
{
int32_t ret = TCPP0203_OK;
if ((VConnSwitch != TCPP0203_VCONN_SWITCH_OPEN)
&& (VConnSwitch != TCPP0203_VCONN_SWITCH_CC1)
&& (VConnSwitch != TCPP0203_VCONN_SWITCH_CC2))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VConn switch setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VConnSwitch, TCPP0203_VCONN_SWITCH_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param GateDriverProvider GDP switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_GD_PROVIDER_SWITCH_OPEN GDP Switch Load Open
* @arg TCPP0203_GD_PROVIDER_SWITCH_CLOSED GDP Switch Load closed
* @retval Component status
*/
int32_t TCPP0203_SetGateDriverProvider(TCPP0203_Object_t *pObj, uint8_t GateDriverProvider)
{
int32_t ret = TCPP0203_OK;
if ((GateDriverProvider != TCPP0203_GD_PROVIDER_SWITCH_OPEN)
&& (GateDriverProvider != TCPP0203_GD_PROVIDER_SWITCH_CLOSED))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update GDP Switch Load setting in Writing register Reg0 */
if (GateDriverProvider == TCPP0203_GD_PROVIDER_SWITCH_CLOSED)
{
/* If Gate Driver Provider is to be closed, Gate Driver Consumer should be open */
ret += TCPP0203_ModifyReg0(pObj, (GateDriverProvider | TCPP0203_GD_CONSUMER_SWITCH_OPEN),
(TCPP0203_GD_PROVIDER_SWITCH_MSK | TCPP0203_GD_CONSUMER_SWITCH_MSK));
}
else
{
ret += TCPP0203_ModifyReg0(pObj, GateDriverProvider, TCPP0203_GD_PROVIDER_SWITCH_MSK);
}
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Consumer path
* @param pObj Pointer to component object
* @param GateDriverConsumer GDC switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_GD_CONSUMER_SWITCH_OPEN GDC Switch Load Open
* @arg TCPP0203_GD_CONSUMER_SWITCH_CLOSED GDC Switch Load closed
* @retval Component status
*/
int32_t TCPP0203_SetGateDriverConsumer(TCPP0203_Object_t *pObj, uint8_t GateDriverConsumer)
{
int32_t ret = TCPP0203_OK;
/* Check if TCPP type is TCPP03. Otherwise, return error */
if (TCPP0203_DeviceType != TCPP0203_DEVICE_TYPE_03)
{
return (TCPP0203_ERROR);
}
if ((GateDriverConsumer != TCPP0203_GD_CONSUMER_SWITCH_OPEN)
&& (GateDriverConsumer != TCPP0203_GD_CONSUMER_SWITCH_CLOSED))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update GDC Switch Load setting in Writing register Reg0 */
if (GateDriverConsumer == TCPP0203_GD_CONSUMER_SWITCH_CLOSED)
{
/* If Gate Driver Consumer is to be closed, Gate Driver Provider should be open */
ret += TCPP0203_ModifyReg0(pObj, (GateDriverConsumer | TCPP0203_GD_PROVIDER_SWITCH_OPEN),
(TCPP0203_GD_PROVIDER_SWITCH_MSK | TCPP0203_GD_CONSUMER_SWITCH_MSK));
}
else
{
ret += TCPP0203_ModifyReg0(pObj, GateDriverConsumer, TCPP0203_GD_CONSUMER_SWITCH_MSK);
}
}
return ret;
}
/**
* @brief Configure TCPP0203 Power Mode
* @param pObj Pointer to component object
* @param PowerMode Power mode requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_POWER_MODE_HIBERNATE Hibernate
* @arg TCPP0203_POWER_MODE_LOWPOWER Low Power
* @arg TCPP0203_POWER_MODE_NORMAL Normal
* @retval Component status
*/
int32_t TCPP0203_SetPowerMode(TCPP0203_Object_t *pObj, uint8_t PowerMode)
{
int32_t ret = TCPP0203_OK;
if ((PowerMode != TCPP0203_POWER_MODE_HIBERNATE)
&& (PowerMode != TCPP0203_POWER_MODE_LOWPOWER)
&& (PowerMode != TCPP0203_POWER_MODE_NORMAL))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update Power Mode setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, PowerMode, TCPP0203_POWER_MODE_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param VBusDischarge VBUS Discharge requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VBUS_DISCHARGE_OFF VBUS Discharge Off
* @arg TCPP0203_VBUS_DISCHARGE_ON VBUS Discharge On
* @retval Component status
*/
int32_t TCPP0203_SetVBusDischarge(TCPP0203_Object_t *pObj, uint8_t VBusDischarge)
{
int32_t ret = TCPP0203_OK;
if ((VBusDischarge != TCPP0203_VBUS_DISCHARGE_OFF)
&& (VBusDischarge != TCPP0203_VBUS_DISCHARGE_ON))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VBUS Discharge setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VBusDischarge, TCPP0203_VBUS_DISCHARGE_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param VConnDischarge GDP switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VCONN_DISCHARGE_OFF VConn Discharge Off
* @arg TCPP0203_VCONN_DISCHARGE_ON VConn Discharge On
* @retval Component status
*/
int32_t TCPP0203_SetVConnDischarge(TCPP0203_Object_t *pObj, uint8_t VConnDischarge)
{
int32_t ret = TCPP0203_OK;
if ((VConnDischarge != TCPP0203_VCONN_DISCHARGE_OFF)
&& (VConnDischarge != TCPP0203_VCONN_DISCHARGE_ON))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VConn Discharge setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VConnDischarge, TCPP0203_VCONN_DISCHARGE_MSK);
}
return ret;
}
/**
* @brief Get VConn switch Ack value
* @param pObj Pointer to component object
* @param pVConnSwitchAck Pointer on VConn switch Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VCONN_SWITCH_OPEN VConn switch open Ack
* @arg TCPP0203_VCONN_SWITCH_CC1 VConn closed on CC1 Ack
* @arg TCPP0203_VCONN_SWITCH_CC2 VConn closed on CC2 Ack
* @retval Component status
*/
int32_t TCPP0203_GetVConnSwitchAck(TCPP0203_Object_t *pObj, uint8_t *pVConnSwitchAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVConnSwitchAck = (tmp & TCPP0203_VCONN_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Gate Driver Provider Ack value
* @param pObj Pointer to component object
* @param pGateDriverProviderAck Pointer on Gate Driver Provider Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_GD_PROVIDER_SWITCH_ACK_OPEN Gate Driver Provider Open Ack
* @arg TCPP0203_GD_PROVIDER_SWITCH_ACK_CLOSED Gate Driver Provider Closed Ack
* @retval Component status
*/
int32_t TCPP0203_GetGateDriverProviderAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverProviderAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pGateDriverProviderAck = (tmp & TCPP0203_GD_PROVIDER_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Gate Driver Consumer Ack value
* @param pObj Pointer to component object
* @param pGateDriverConsumerAck Pointer on Gate Driver Consumer Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_GD_CONSUMER_SWITCH_ACK_OPEN Gate Driver Consumer Open Ack
* @arg TCPP0203_GD_CONSUMER_SWITCH_ACK_CLOSED Gate Driver Consumer Closed Ack
* @retval Component status
*/
int32_t TCPP0203_GetGateDriverConsumerAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverConsumerAck)
{
int32_t ret;
uint8_t tmp;
/* Check if TCPP type is TCPP03. Otherwise, return error */
if (TCPP0203_DeviceType != TCPP0203_DEVICE_TYPE_03)
{
return (TCPP0203_ERROR);
}
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pGateDriverConsumerAck = (tmp & TCPP0203_GD_CONSUMER_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Power Mode Ack value
* @param pObj Pointer to component object
* @param pPowerModeAck Pointer on Power Mode Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_POWER_MODE_ACK_HIBERNATE Power Mode Hibernate Ack
* @arg TCPP0203_POWER_MODE_ACK_LOWPOWER Power Mode Low Power Ack
* @arg TCPP0203_POWER_MODE_ACK_NORMAL Power Mode Normal Ack
* @retval Component status
*/
int32_t TCPP0203_GetPowerModeAck(TCPP0203_Object_t *pObj, uint8_t *pPowerModeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pPowerModeAck = (tmp & TCPP0203_POWER_MODE_ACK_MSK);
return ret;
}
/**
* @brief Get VBUS Discharge Ack value
* @param pObj Pointer to component object
* @param pVBusDischargeAck Pointer on VBUS Discharge Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VBUS_DISCHARGE_ACK_OFF VBUS Discharge Off Ack
* @arg TCPP0203_VBUS_DISCHARGE_ACK_ON VBUS Discharge On Ack
* @retval Component status
*/
int32_t TCPP0203_GetVBusDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVBusDischargeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVBusDischargeAck = (tmp & TCPP0203_VBUS_DISCHARGE_ACK_MSK);
return ret;
}
/**
* @brief Get VConn Discharge Ack value
* @param pObj Pointer to component object
* @param pVConnDischargeAck Pointer on VConn Discharge Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VCONN_DISCHARGE_ACK_OFF VConn Discharge Off Ack
* @arg TCPP0203_VCONN_DISCHARGE_ACK_ON VConn Discharge On Ack
* @retval Component status
*/
int32_t TCPP0203_GetVConnDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVConnDischargeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVConnDischargeAck = (tmp & TCPP0203_VCONN_DISCHARGE_ACK_MSK);
return ret;
}
/**
* @brief Get OCP VConn Flag value
* @param pObj Pointer to component object
* @param pOCPVConnFlag Pointer on OCP VConn Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OCP_VCONN_RESET OCP VConn flag not set
* @arg TCPP0203_FLAG_OCP_VCONN_SET OCP VConn flag set
* @retval Component status
*/
int32_t TCPP0203_GetOCPVConnFlag(TCPP0203_Object_t *pObj, uint8_t *pOCPVConnFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOCPVConnFlag = (tmp & TCPP0203_FLAG_OCP_VCONN_MSK);
return ret;
}
/**
* @brief Get OCP VBUS Flag value
* @param pObj Pointer to component object
* @param pGetOCPVBusFlag Pointer on OCP VBUS Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OCP_VBUS_RESET OCP VBUS flag not set
* @arg TCPP0203_FLAG_OCP_VBUS_SET OCP VBUS flag set
* @retval Component status
*/
int32_t TCPP0203_GetOCPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pGetOCPVBusFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pGetOCPVBusFlag = (tmp & TCPP0203_FLAG_OCP_VBUS_MSK);
return ret;
}
/**
* @brief Get OVP VBUS Flag value
* @param pObj Pointer to component object
* @param pOVPVBusFlag Pointer on OVP VBUS Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OVP_VBUS_RESET OVP VBUS flag not set
* @arg TCPP0203_FLAG_OVP_VBUS_SET OVP VBUS flag set
* @retval Component status
*/
int32_t TCPP0203_GetOVPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPVBusFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOVPVBusFlag = (tmp & TCPP0203_FLAG_OVP_VBUS_MSK);
return ret;
}
/**
* @brief Get OVP CC Flag value
* @param pObj Pointer to component object
* @param pOVPCCFlag Pointer on OVP CC Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OVP_CC_RESET OVP CC flag not set
* @arg TCPP0203_FLAG_OVP_CC_SET OVP CC flag set
* @retval Component status
*/
int32_t TCPP0203_GetOVPCCFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPCCFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOVPCCFlag = (tmp & TCPP0203_FLAG_OVP_CC_MSK);
return ret;
}
/**
* @brief Get Over Temperature Flag value
* @param pObj Pointer to component object
* @param pOTPFlag Pointer on Over Temperature Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OTP_RESET Over Temperature flag not set
* @arg TCPP0203_FLAG_OTP_SET Over Temperature flag set
* @retval Component status
*/
int32_t TCPP0203_GetOTPFlag(TCPP0203_Object_t *pObj, uint8_t *pOTPFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOTPFlag = (tmp & TCPP0203_FLAG_OTP_MSK);
return ret;
}
/**
* @brief Get VBUS OK Flag value
* @param pObj Pointer to component object
* @param pVBusOkFlag Pointer on VBUS OK Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_VBUS_OK_RESET VBUS OK flag not set
* @arg TCPP0203_FLAG_VBUS_OK_SET VBUS OK flag set
* @retval Component status
*/
int32_t TCPP0203_GetVBusOkFlag(TCPP0203_Object_t *pObj, uint8_t *pVBusOkFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pVBusOkFlag = (tmp & TCPP0203_FLAG_VBUS_OK_MSK);
return ret;
}
/**
* @brief Get TCPP0203 Device Type value
* @param pObj Pointer to component object
* @param pTCPPType Pointer on TCPP0203 Device Type value
* This output parameter can be one of the following values:
* @arg TCPP0203_DEVICE_TYPE_02 TCPP02 Type
* @arg TCPP0203_DEVICE_TYPE_03 TCPP03 Type
* @retval Component status
*/
int32_t TCPP0203_ReadTCPPType(TCPP0203_Object_t *pObj, uint8_t *pTCPPType)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pTCPPType = (tmp & TCPP0203_DEVICE_TYPE_MSK);
return ret;
}
/**
* @brief Get VConn Power value
* @param pObj Pointer to component object
* @param pVCONNPower Pointer on VConn Power value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_VCONN_PWR_1W OCP VConn flag not set
* @arg TCPP0203_FLAG_VCONN_PWR_0_1W OCP VConn flag set
* @retval Component status
*/
int32_t TCPP0203_ReadVCONNPower(TCPP0203_Object_t *pObj, uint8_t *pVCONNPower)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pVCONNPower = (tmp & TCPP0203_FLAG_VCONN_PWR_MSK);
return ret;
}
/**
* @brief Set complete Ctrl register value (Reg 0)
* @param pObj Pointer to component object
* @param pCtrlRegister Pointer on Ctrl register value
* @retval Component status
*/
int32_t TCPP0203_WriteCtrlRegister(TCPP0203_Object_t *pObj, uint8_t *pCtrlRegister)
{
int32_t ret;
/* Update value in writing register (reg0) */
ret = tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, pCtrlRegister, 1);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = *pCtrlRegister;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
/**
* @brief Get complete Ack register value
* @param pObj Pointer to component object
* @param pAckRegister Pointer on Ack register value
* @retval Component status
*/
int32_t TCPP0203_ReadAckRegister(TCPP0203_Object_t *pObj, uint8_t *pAckRegister)
{
int32_t ret;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, pAckRegister, 1);
return ret;
}
/**
* @brief Get complete Flag register value
* @param pObj Pointer to component object
* @param pFlagRegister Pointer on Flag register value
* @retval Component status
*/
int32_t TCPP0203_ReadFlagRegister(TCPP0203_Object_t *pObj, uint8_t *pFlagRegister)
{
int32_t ret;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, pFlagRegister, 1);
return ret;
}
/******************** Static functions ****************************************/
/**
* @brief Wrap TCPP0203 read function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to read
* @param pData Buffer where Target register value should be stored
* @param Length buffer size to be read
* @retval error status
*/
static int32_t TCPP0203_ReadRegWrap(const void *handle, uint8_t Reg, uint8_t *pData, uint8_t Length)
{
const TCPP0203_Object_t *pObj = (const TCPP0203_Object_t *)handle;
return pObj->IO.ReadReg(pObj->IO.Address, Reg, pData, Length);
}
/**
* @brief Wrap TCPP0203 write function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to write
* @param pData Target register value to be written
* @param Length Buffer size to be written
* @retval error status
*/
static int32_t TCPP0203_WriteRegWrap(const void *handle, uint8_t Reg, uint8_t *pData, uint8_t Length)
{
const TCPP0203_Object_t *pObj = (const TCPP0203_Object_t *)handle;
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = *pData;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return pObj->IO.WriteReg(pObj->IO.Address, Reg, pData, Length);
}
/**
* @brief TCPP0203 register update function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to write
* @param pData Target register value to be written
* @param Length Buffer size to be written
* @retval error status
*/
static int32_t TCPP0203_ModifyReg0(TCPP0203_Object_t *pObj, uint8_t Value, uint8_t Mask)
{
int32_t ret;
uint8_t tmp;
/* Read current content of ACK register (reflects content of bits set to 1 in Writing register Reg0) */
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
/* Update only the area dedicated to Mask */
tmp &= ~(Mask);
tmp |= (Value & Mask);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = tmp;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/* Update value in writing register (reg0) */
ret += tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, &tmp, 1);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
ret += TCPP0203_CheckReg0Reg1(pObj, Reg0_Expected_Value);
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
/**
* @brief TCPP0203 register control function between Reg0 and Reg1 value
* @param handle Component object handle
* @param Reg0ExpectedValue Value expected in Reg0 (built after all calls to write functions)
* @retval error status
*/
static int32_t TCPP0203_CheckReg0Reg1(TCPP0203_Object_t *pObj, uint8_t Reg0ExpectedValue)
{
int32_t ret;
/* Read current content of ACK register (expected to reflect content of bits set to 1 in Writing register Reg0) */
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &Reg1_LastRead_Value, 1);
#ifdef _TRACE
char str[12];
sprintf(str, "Exp0_0x%02x", Reg0ExpectedValue);
USBPD_TRACE_Add(USBPD_TRACE_DEBUG, 0U, 0U, (uint8_t *)str, sizeof(str) - 1U);
sprintf(str, "Reg1_0x%02x", Reg1_LastRead_Value);
USBPD_TRACE_Add(USBPD_TRACE_DEBUG, 0U, 0U, (uint8_t *)str, sizeof(str) - 1U);
#endif /* _TRACE */
/* Control if Reg1 value is same as Reg0 expected one */
if (Reg1_LastRead_Value != Reg0ExpectedValue)
{
while (1);
}
return ret;
}
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/

View File

@@ -1,353 +0,0 @@
/**
******************************************************************************
* @file tcpp0203.h
* @author MCD Application Team
* @brief This file contains all the functions prototypes for the
* tcpp0203.c driver.
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef TCPP0203_H
#define TCPP0203_H
/* Includes ------------------------------------------------------------------*/
#include "tcpp0203_reg.h"
#include <stddef.h>
/** @addtogroup BSP
* @{
*/
/** @addtogroup Component
* @{
*/
/** @addtogroup TCPP0203
* @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup TCPP0203_Exported_Types TCPP0203 Exported Types
* @{
*/
typedef int32_t (*TCPP0203_Init_Func)(void);
typedef int32_t (*TCPP0203_DeInit_Func)(void);
typedef int32_t (*TCPP0203_GetTick_Func)(void);
typedef int32_t (*TCPP0203_WriteReg_Func)(uint16_t, uint16_t, uint8_t *, uint16_t);
typedef int32_t (*TCPP0203_ReadReg_Func)(uint16_t, uint16_t, uint8_t *, uint16_t);
typedef struct
{
TCPP0203_Init_Func Init;
TCPP0203_DeInit_Func DeInit;
uint16_t Address;
TCPP0203_WriteReg_Func WriteReg;
TCPP0203_ReadReg_Func ReadReg;
TCPP0203_GetTick_Func GetTick;
} TCPP0203_IO_t;
typedef struct
{
TCPP0203_IO_t IO;
TCPP0203_ctx_t Ctx;
uint8_t IsInitialized;
} TCPP0203_Object_t;
typedef struct
{
int32_t (*Init)(TCPP0203_Object_t *);
int32_t (*DeInit)(TCPP0203_Object_t *);
int32_t (*Reset)(TCPP0203_Object_t *);
int32_t (*SetVConnSwitch)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetGateDriverProvider)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetGateDriverConsumer)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetPowerMode)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetVBusDischarge)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetVConnDischarge)(TCPP0203_Object_t *, uint8_t);
int32_t (*GetVConnSwitchAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetGateDriverProviderAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetGateDriverConsumerAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetPowerModeAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetVBusDischargeAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetVConnDischargeAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOCPVConnFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOCPVBusFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOVPVBusFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOVPCCFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOTPFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetVBusOkFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadTCPPType)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadVCONNPower)(TCPP0203_Object_t *, uint8_t *);
int32_t (*WriteCtrlRegister)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadAckRegister)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadFlagRegister)(TCPP0203_Object_t *, uint8_t *);
} TCPP0203_Drv_t;
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Constants TCPP0203 Exported Constants
* @{
*/
/**
* @brief TCPP0203 Driver Response codes
*/
#define TCPP0203_OK (0)
#define TCPP0203_ERROR (-1)
/**
* @brief TCPP0203 possible I2C Addresses
*/
#define TCPP0203_I2C_ADDRESS_X68 (0x68U)
#define TCPP0203_I2C_ADDRESS_X6A (0x6AU)
/**
* @brief TCPP0203 Reg0 Reset Value
*/
#define TCPP0203_REG0_RST_VALUE TCPP0203_GD_CONSUMER_SWITCH_CLOSED
/**
* @brief TCPP0203 VCONN Switch
*/
#define TCPP0203_VCONN_SWITCH_POS (0U)
#define TCPP0203_VCONN_SWITCH_MSK (0x03U << TCPP0203_VCONN_SWITCH_POS)
#define TCPP0203_VCONN_SWITCH_OPEN (0x00U)
#define TCPP0203_VCONN_SWITCH_CC1 (0x01U << TCPP0203_VCONN_SWITCH_POS)
#define TCPP0203_VCONN_SWITCH_CC2 (0x02U << TCPP0203_VCONN_SWITCH_POS)
/**
* @brief TCPP0203 Gate Driver Provider values
*/
#define TCPP0203_GD_PROVIDER_SWITCH_POS (2U)
#define TCPP0203_GD_PROVIDER_SWITCH_MSK (0x01U << TCPP0203_GD_PROVIDER_SWITCH_POS)
#define TCPP0203_GD_PROVIDER_SWITCH_OPEN (0x00U)
#define TCPP0203_GD_PROVIDER_SWITCH_CLOSED (TCPP0203_GD_PROVIDER_SWITCH_MSK)
/**
* @brief TCPP0203 Gate Driver Consumer values
*/
#define TCPP0203_GD_CONSUMER_SWITCH_POS (3U)
#define TCPP0203_GD_CONSUMER_SWITCH_MSK (0x01U << TCPP0203_GD_CONSUMER_SWITCH_POS)
#define TCPP0203_GD_CONSUMER_SWITCH_CLOSED (0x00U)
#define TCPP0203_GD_CONSUMER_SWITCH_OPEN (TCPP0203_GD_CONSUMER_SWITCH_MSK)
/**
* @brief TCPP0203 Power Mode values
*/
#define TCPP0203_POWER_MODE_POS (4U)
#define TCPP0203_POWER_MODE_MSK (0x03U << TCPP0203_POWER_MODE_POS)
#define TCPP0203_POWER_MODE_HIBERNATE (0x00U)
#define TCPP0203_POWER_MODE_LOWPOWER (0x02U << TCPP0203_POWER_MODE_POS)
#define TCPP0203_POWER_MODE_NORMAL (0x01U << TCPP0203_POWER_MODE_POS)
/**
* @brief TCPP0203 VBUS Discharge management
*/
#define TCPP0203_VBUS_DISCHARGE_POS (6U)
#define TCPP0203_VBUS_DISCHARGE_MSK (0x01U << TCPP0203_VBUS_DISCHARGE_POS)
#define TCPP0203_VBUS_DISCHARGE_OFF (0x00U)
#define TCPP0203_VBUS_DISCHARGE_ON (TCPP0203_VBUS_DISCHARGE_MSK)
/**
* @brief TCPP0203 VConn Discharge management
*/
#define TCPP0203_VCONN_DISCHARGE_POS (7U)
#define TCPP0203_VCONN_DISCHARGE_MSK (0x01U << TCPP0203_VCONN_DISCHARGE_POS)
#define TCPP0203_VCONN_DISCHARGE_OFF (0x00U)
#define TCPP0203_VCONN_DISCHARGE_ON (TCPP0203_VCONN_DISCHARGE_MSK)
/**
* @brief TCPP0203 VCONN Switch Acknowledge
*/
#define TCPP0203_VCONN_SWITCH_ACK_POS (0U)
#define TCPP0203_VCONN_SWITCH_ACK_MSK (0x03U << TCPP0203_VCONN_SWITCH_ACK_POS)
#define TCPP0203_VCONN_SWITCH_ACK_OPEN (0x00U)
#define TCPP0203_VCONN_SWITCH_ACK_CC1 (0x02U << TCPP0203_VCONN_SWITCH_ACK_POS)
#define TCPP0203_VCONN_SWITCH_ACK_CC2 (0x01U << TCPP0203_VCONN_SWITCH_ACK_POS)
/**
* @brief TCPP0203 Gate Driver Provider Acknowledge
*/
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_POS (2U)
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_MSK (0x01U << TCPP0203_GD_PROVIDER_SWITCH_ACK_POS)
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_OPEN (0x00U)
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_CLOSED (TCPP0203_GD_PROVIDER_SWITCH_ACK_MSK)
/**
* @brief TCPP0203 Gate Driver Consumer Acknowledge
*/
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_POS (3U)
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_MSK (0x01U << TCPP0203_GD_CONSUMER_SWITCH_ACK_POS)
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_CLOSED (0x00U)
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_OPEN (TCPP0203_GD_CONSUMER_SWITCH_ACK_MSK)
/**
* @brief TCPP0203 Power Mode Acknowledge
*/
#define TCPP0203_POWER_MODE_ACK_POS (4U)
#define TCPP0203_POWER_MODE_ACK_MSK (0x03U << TCPP0203_POWER_MODE_ACK_POS)
#define TCPP0203_POWER_MODE_ACK_HIBERNATE (0x00U)
#define TCPP0203_POWER_MODE_ACK_LOWPOWER (0x01U << TCPP0203_POWER_MODE_ACK_POS)
#define TCPP0203_POWER_MODE_ACK_NORMAL (0x02U << TCPP0203_POWER_MODE_ACK_POS)
/**
* @brief TCPP0203 VBUS Discharge Acknowledge
*/
#define TCPP0203_VBUS_DISCHARGE_ACK_POS (6U)
#define TCPP0203_VBUS_DISCHARGE_ACK_MSK (0x01U << TCPP0203_VBUS_DISCHARGE_ACK_POS)
#define TCPP0203_VBUS_DISCHARGE_ACK_OFF (0x00U)
#define TCPP0203_VBUS_DISCHARGE_ACK_ON (TCPP0203_VBUS_DISCHARGE_ACK_MSK)
/**
* @brief TCPP0203 VConn Discharge Acknowledge
*/
#define TCPP0203_VCONN_DISCHARGE_ACK_POS (7U)
#define TCPP0203_VCONN_DISCHARGE_ACK_MSK (0x01U << TCPP0203_VCONN_DISCHARGE_ACK_POS)
#define TCPP0203_VCONN_DISCHARGE_ACK_OFF (0x00U)
#define TCPP0203_VCONN_DISCHARGE_ACK_ON (TCPP0203_VCONN_DISCHARGE_ACK_MSK)
/**
* @brief TCPP0203 OCP Vconn Flag management
*/
#define TCPP0203_FLAG_OCP_VCONN_POS (0U)
#define TCPP0203_FLAG_OCP_VCONN_MSK (0x01U << TCPP0203_FLAG_OCP_VCONN_POS)
#define TCPP0203_FLAG_OCP_VCONN_SET (TCPP0203_FLAG_OCP_VCONN_MSK)
#define TCPP0203_FLAG_OCP_VCONN_RESET (0x00U)
/**
* @brief TCPP0203 OCP VBUS Flag management
*/
#define TCPP0203_FLAG_OCP_VBUS_POS (1U)
#define TCPP0203_FLAG_OCP_VBUS_MSK (0x01U << TCPP0203_FLAG_OCP_VBUS_POS)
#define TCPP0203_FLAG_OCP_VBUS_SET (TCPP0203_FLAG_OCP_VBUS_MSK)
#define TCPP0203_FLAG_OCP_VBUS_RESET (0x00U)
/**
* @brief TCPP0203 OVP VBUS Flag management
*/
#define TCPP0203_FLAG_OVP_VBUS_POS (2U)
#define TCPP0203_FLAG_OVP_VBUS_MSK (0x01U << TCPP0203_FLAG_OVP_VBUS_POS)
#define TCPP0203_FLAG_OVP_VBUS_SET (TCPP0203_FLAG_OVP_VBUS_MSK)
#define TCPP0203_FLAG_OVP_VBUS_RESET (0x00U)
/**
* @brief TCPP0203 OVP CC Flag management
*/
#define TCPP0203_FLAG_OVP_CC_POS (3U)
#define TCPP0203_FLAG_OVP_CC_MSK (0x01U << TCPP0203_FLAG_OVP_CC_POS)
#define TCPP0203_FLAG_OVP_CC_SET (TCPP0203_FLAG_OVP_CC_MSK)
#define TCPP0203_FLAG_OVP_CC_RESET (0x00U)
/**
* @brief TCPP0203 OTP Flag management
*/
#define TCPP0203_FLAG_OTP_POS (4U)
#define TCPP0203_FLAG_OTP_MSK (0x01U << TCPP0203_FLAG_OTP_POS)
#define TCPP0203_FLAG_OTP_SET (TCPP0203_FLAG_OTP_MSK)
#define TCPP0203_FLAG_OTP_RESET (0x00U)
/**
* @brief TCPP0203 VBUS OK Flag management
*/
#define TCPP0203_FLAG_VBUS_OK_POS (5U)
#define TCPP0203_FLAG_VBUS_OK_MSK (0x01U << TCPP0203_FLAG_VBUS_OK_POS)
#define TCPP0203_FLAG_VBUS_OK_SET (TCPP0203_FLAG_VBUS_OK_MSK)
#define TCPP0203_FLAG_VBUS_OK_RESET (0x00U)
/**
* @brief TCPP0203 VConn Power
*/
#define TCPP0203_FLAG_VCONN_PWR_POS (6U)
#define TCPP0203_FLAG_VCONN_PWR_MSK (0x01U << TCPP0203_FLAG_VCONN_PWR_POS)
#define TCPP0203_FLAG_VCONN_PWR_1W (TCPP0203_FLAG_VCONN_PWR_MSK)
#define TCPP0203_FLAG_VCONN_PWR_0_1W (0x00U)
/**
* @brief TCPP0203 Device Type
*/
#define TCPP0203_DEVICE_TYPE_POS (7U)
#define TCPP0203_DEVICE_TYPE_MSK (0x01U << TCPP0203_DEVICE_TYPE_POS)
#define TCPP0203_DEVICE_TYPE_02 (TCPP0203_DEVICE_TYPE_MSK)
#define TCPP0203_DEVICE_TYPE_03 (0x00U)
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Macros TCPP0203 Exported Macros
* @{
*/
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Functions TCPP0203 Exported Functions
* @{
*/
/*------------------------------------------------------------------------------
TCPP02/03 Type-C port protection functions
------------------------------------------------------------------------------*/
/* High Layer codec functions */
int32_t TCPP0203_RegisterBusIO(TCPP0203_Object_t *pObj, TCPP0203_IO_t *pIO);
int32_t TCPP0203_Init(TCPP0203_Object_t *pObj);
int32_t TCPP0203_DeInit(TCPP0203_Object_t *pObj);
int32_t TCPP0203_Reset(TCPP0203_Object_t *pObj);
int32_t TCPP0203_SetVConnSwitch(TCPP0203_Object_t *pObj, uint8_t VConnSwitch);
int32_t TCPP0203_SetGateDriverProvider(TCPP0203_Object_t *pObj, uint8_t GateDriverProvider);
int32_t TCPP0203_SetGateDriverConsumer(TCPP0203_Object_t *pObj, uint8_t GateDriverConsumer);
int32_t TCPP0203_SetPowerMode(TCPP0203_Object_t *pObj, uint8_t PowerMode);
int32_t TCPP0203_SetVBusDischarge(TCPP0203_Object_t *pObj, uint8_t VBusDischarge);
int32_t TCPP0203_SetVConnDischarge(TCPP0203_Object_t *pObj, uint8_t VConnDischarge);
int32_t TCPP0203_GetVConnSwitchAck(TCPP0203_Object_t *pObj, uint8_t *pVConnSwitchAck);
int32_t TCPP0203_GetGateDriverProviderAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverProviderAck);
int32_t TCPP0203_GetGateDriverConsumerAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverConsumerAck);
int32_t TCPP0203_GetPowerModeAck(TCPP0203_Object_t *pObj, uint8_t *pPowerModeAck);
int32_t TCPP0203_GetVBusDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVBusDischargeAck);
int32_t TCPP0203_GetVConnDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVConnDischargeAck);
int32_t TCPP0203_GetOCPVConnFlag(TCPP0203_Object_t *pObj, uint8_t *pOCPVConnFlag);
int32_t TCPP0203_GetOCPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pGetOCPVBusFlag);
int32_t TCPP0203_GetOVPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPVBusFlag);
int32_t TCPP0203_GetOVPCCFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPCCFlag);
int32_t TCPP0203_GetOTPFlag(TCPP0203_Object_t *pObj, uint8_t *pOTPFlag);
int32_t TCPP0203_GetVBusOkFlag(TCPP0203_Object_t *pObj, uint8_t *pVBusOkFlag);
int32_t TCPP0203_ReadTCPPType(TCPP0203_Object_t *pObj, uint8_t *pTCPPType);
int32_t TCPP0203_ReadVCONNPower(TCPP0203_Object_t *pObj, uint8_t *pVCONNPower);
int32_t TCPP0203_WriteCtrlRegister(TCPP0203_Object_t *pObj, uint8_t *pCtrlRegister);
int32_t TCPP0203_ReadAckRegister(TCPP0203_Object_t *pObj, uint8_t *pAckRegister);
int32_t TCPP0203_ReadFlagRegister(TCPP0203_Object_t *pObj, uint8_t *pFlagRegister);
/**
* @}
*/
/* TCPP02/03 Type-C port protection driver structure */
extern TCPP0203_Drv_t TCPP0203_Driver;
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
#endif /* TCPP0203_H */

View File

@@ -1,73 +0,0 @@
/**
******************************************************************************
* @file tcpp0203_reg.c
* @author MCD Application Team
* @brief This file provides unitary register function to control the TCPP02-03
* Type-C port protection driver.
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Includes ------------------------------------------------------------------*/
#include "tcpp0203_reg.h"
/** @addtogroup BSP
* @{
*/
/** @addtogroup Components
* @{
*/
/** @addtogroup TCPP0203
* @brief This file provides a set of functions needed to drive the
* TCPP02/03 Type-C port protection codec.
* @{
*/
/************** Generic Function *******************/
/*******************************************************************************
* Function Name : tcpp0203_read_reg
* Description : Generic Reading function. It must be fulfilled with either
* I2C or SPI reading functions
* Input : Register Address, length of buffer
* Output : data Read
*******************************************************************************/
int32_t tcpp0203_read_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length)
{
return ctx->ReadReg(ctx->handle, reg, data, length);
}
/*******************************************************************************
* Function Name : tcpp0203_write_reg
* Description : Generic Writing function. It must be fulfilled with either
* I2C or SPI writing function
* Input : Register Address, data to be written, length of buffer
* Output : None
*******************************************************************************/
int32_t tcpp0203_write_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length)
{
return ctx->WriteReg(ctx->handle, reg, data, length);
}
/******************************************************************************/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/

View File

@@ -1,98 +0,0 @@
/**
******************************************************************************
* @file tcpp0203_reg.h
* @author MCD Application Team
* @brief Header of tcpp0203_reg.c
*
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef TCPP0203_REG_H
#define TCPP0203_REG_H
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/* Includes ------------------------------------------------------------------*/
/** @addtogroup BSP
* @{
*/
/** @addtogroup Component
* @{
*/
/** @addtogroup TCPP0203
* @{
*/
/** @defgroup TCPP0203_Exported_Constants TCPP0203 Exported Constants
* @{
*/
/******************************************************************************/
/****************************** REGISTER MAPPING ******************************/
/******************************************************************************/
#define TCPP0203_WRITE_REG 0x00U
#define TCPP0203_PROG_CTRL TCPP0203_WRITE_REG
#define TCPP0203_READ_REG1 0x01U
#define TCPP0203_ACK_REG TCPP0203_READ_REG1
#define TCPP0203_READ_REG2 0x02U
#define TCPP0203_FLAG_REG TCPP0203_READ_REG2
/**
* @}
*/
/************** Generic Function *******************/
typedef int32_t (*TCPP0203_Write_Func)(const void *, uint8_t, uint8_t *, uint8_t);
typedef int32_t (*TCPP0203_Read_Func)(const void *, uint8_t, uint8_t *, uint8_t);
typedef struct
{
TCPP0203_Write_Func WriteReg;
TCPP0203_Read_Func ReadReg;
void *handle;
} TCPP0203_ctx_t;
/*******************************************************************************
* Register : Generic - All
* Address : Generic - All
* Bit Group Name: None
* Permission : W
*******************************************************************************/
int32_t tcpp0203_write_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length);
int32_t tcpp0203_read_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length);
#ifdef __cplusplus
}
#endif
#endif /* TCPP0203_REG_H */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/

View File

@@ -5,6 +5,7 @@ set(ST_PREFIX stm32${ST_FAMILY}xx)
set(ST_HAL_DRIVER ${TOP}/hw/mcu/st/stm32${ST_FAMILY}xx_hal_driver)
set(ST_CMSIS ${TOP}/hw/mcu/st/cmsis_device_${ST_FAMILY})
set(ST_TCPP0203 ${TOP}/hw/mcu/st/stm32-tcpp0203)
set(CMSIS_5 ${TOP}/lib/CMSIS_5)
# include board specific
@@ -86,6 +87,8 @@ function(add_board_target BOARD_TARGET)
BOARD_TUD_MAX_SPEED=${RHPORT_DEVICE_SPEED}
BOARD_TUH_RHPORT=${RHPORT_HOST}
BOARD_TUH_MAX_SPEED=${RHPORT_HOST_SPEED}
SEGGER_RTT_SECTION="noncacheable_buffer"
BUFFER_SIZE_UP=0x3000
)
update_board(${BOARD_TARGET})

View File

@@ -2,6 +2,7 @@ ST_FAMILY = h7rs
ST_PREFIX = stm32${ST_FAMILY}xx
ST_CMSIS = hw/mcu/st/cmsis_device_$(ST_FAMILY)
ST_HAL_DRIVER = hw/mcu/st/${ST_PREFIX}_hal_driver
ST_TCPP0203 = hw/mcu/st/stm32-tcpp0203
UF2_FAMILY_ID = 0x6db66083
@@ -42,6 +43,8 @@ CFLAGS += \
-DBOARD_TUD_MAX_SPEED=${RHPORT_DEVICE_SPEED} \
-DBOARD_TUH_RHPORT=${RHPORT_HOST} \
-DBOARD_TUH_MAX_SPEED=${RHPORT_HOST_SPEED} \
-DSEGGER_RTT_SECTION=\"noncacheable_buffer\" \
-DBUFFER_SIZE_UP=0x3000 \
# GCC Flags
CFLAGS_GCC += \

View File

@@ -7,13 +7,11 @@ function(update_board TARGET)
target_compile_definitions(${TARGET} PUBLIC
STM32N657xx
)
target_sources(${TARGET} PUBLIC
# BSP
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/tcpp0203/tcpp0203.c
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/tcpp0203/tcpp0203_reg.c
${ST_TCPP0203}/tcpp0203.c
${ST_TCPP0203}/tcpp0203_reg.c
)
target_include_directories(${TARGET} PUBLIC
${CMAKE_CURRENT_FUNCTION_LIST_DIR}/tcpp0203
${ST_TCPP0203}
)
endfunction()

View File

@@ -10,8 +10,8 @@ flash: flash-stlink
PORT = 1
SRC_C += \
$(BOARD_PATH)/tcpp0203/tcpp0203.c \
$(BOARD_PATH)/tcpp0203/tcpp0203_reg.c \
$(ST_TCPP0203)/tcpp0203.c \
$(ST_TCPP0203)/tcpp0203_reg.c \
INC += \
$(TOP)/$(BOARD_PATH)/tcpp0203 \
$(TOP)/$(ST_TCPP0203) \

View File

@@ -1,6 +0,0 @@
This software component is provided to you as part of a software package and
applicable license terms are in the Package_license file. If you received this
software component outside of a package or without applicable license terms,
the terms of the BSD-3-Clause license shall apply.
You may obtain a copy of the BSD-3-Clause at:
https://opensource.org/licenses/BSD-3-Clause

View File

@@ -1,205 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Release Notes for TCPP0203 Component Driver</title>
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
<link rel="stylesheet" href="_htmresc/mini-st_2020.css" />
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
<link rel="icon" type="image/x-icon" href="_htmresc/favicon.png" />
</head>
<body>
<div class="row">
<div class="col-sm-12 col-lg-4">
<center>
<h1 id="release-notes-for-tcpp0203-component-driver">Release Notes for TCPP0203 Component Driver</h1>
<p>Copyright © 2020 STMicroelectronics<br />
</p>
<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo_2020.png" alt="ST logo" /></a>
</center>
<h1 id="purpose">Purpose</h1>
<p>This driver provides a set of functions needed to drive TCPP0203 Type-C Port Protection component</p>
</div>
<div class="col-sm-12 col-lg-8">
<h1 id="update-history">Update History</h1>
<div class="collapse">
<input type="checkbox" id="collapse-section6" checked aria-hidden="true"> <label for="collapse-section6" aria-hidden="true">v1.2.3 / 21-Jan-2023</label>
<div>
<h2 id="main-changes">Main Changes</h2>
<h3 id="maintenance-release">Maintenance release</h3>
<h2 id="contents">Contents</h2>
<table>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>MISRA Rule-81.13 correction on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="backward-compatibility">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section5" aria-hidden="true"> <label for="collapse-section5" aria-hidden="true">v1.2.2 / 21-Jan-2022</label>
<div>
<h2 id="main-changes-1">Main Changes</h2>
<h3 id="maintenance-release-1">Maintenance release</h3>
<h2 id="contents-1">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>MISRA corrections on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.8.0</li>
</ul>
<h2 id="backward-compatibility-1">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-1">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section4" aria-hidden="true"> <label for="collapse-section4" aria-hidden="true">v1.2.1 / 18-June-2021</label>
<div>
<h2 id="main-changes-2">Main Changes</h2>
<h3 id="maintenance-release-2">Maintenance release</h3>
<h2 id="contents-2">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>License updates</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations-1">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers-1">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.6.0</li>
</ul>
<h2 id="backward-compatibility-2">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-2">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section3" aria-hidden="true"> <label for="collapse-section3" aria-hidden="true">v1.2.0 / 06-Apr-2021</label>
<div>
<h2 id="main-changes-3">Main Changes</h2>
<h3 id="maintenance-release-3">Maintenance release</h3>
<h2 id="contents-3">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>CodeSpell correction on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations-2">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers-2">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.5.0</li>
</ul>
<h2 id="backward-compatibility-3">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-3">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section2" aria-hidden="true"> <label for="collapse-section2" aria-hidden="true">v1.1.0 / 12-Mar-2021</label>
<div>
<h2 id="main-changes-4">Main Changes</h2>
<h3 id="maintenance-release-4">Maintenance release</h3>
<h2 id="contents-4">Contents</h2>
<table>
<caption>Fixed bugs list</caption>
<thead>
<tr class="header">
<th>Headline</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>MCUAstyle correction on TCPP0203 component driver files</td>
</tr>
</tbody>
</table>
<h2 id="known-limitations-3">Known Limitations</h2>
<p>Outstanding bugs list : None</p>
<p>Requirements not met or planned in a forthcoming release : None</p>
<h2 id="development-toolchains-and-compilers-3">Development Toolchains and Compilers</h2>
<ul>
<li>IAR Embedded Workbench for ARM (EWARM) toolchain V8.32.3</li>
<li>RealView Microcontroller Development Kit (MDK-ARM) toolchain V5.27.1</li>
<li>STM32CubeIDE toolchain V1.5.0</li>
</ul>
<h2 id="backward-compatibility-4">Backward compatibility</h2>
<p>No compatibility break with previous version</p>
<h2 id="dependencies-4">Dependencies</h2>
</div>
</div>
<div class="collapse">
<input type="checkbox" id="collapse-section1" aria-hidden="true"> <label for="collapse-section1" aria-hidden="true">v1.0.0 / 20-May-2020</label>
<div>
<h2 id="main-changes-5">Main Changes</h2>
<ul>
<li>First official release of <strong>TCPP0203</strong> Type-C port Protection Component drivers</li>
</ul>
</div>
</div>
</div>
</div>
<footer class="sticky">
<p>For complete documentation on STM32,visit: [<a href="http://www.st.com">www.st.com/stm32</a>]</p>
This release note uses up to date web standards and, for this reason, should not be opened with Internet Explorer but preferably with popular browsers such as Google Chrome, Mozilla Firefox, Opera or Microsoft Edge.
</footer>
</body>
</html>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

View File

@@ -1,886 +0,0 @@
/**
******************************************************************************
* @file tcpp0203.c
* @author MCD Application Team
* @brief This file provides the TCPP02/03 Type-C port protection driver.
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Includes ------------------------------------------------------------------*/
#include "tcpp0203.h"
#if defined(_TRACE)
#include "usbpd_core.h"
#include "usbpd_trace.h"
#include "string.h"
#include "stdio.h"
#endif /* _TRACE */
/** @addtogroup BSP
* @{
*/
/** @addtogroup Components
* @{
*/
/** @addtogroup TCPP0203
* @brief This file provides a set of functions needed to drive the
* TCPP02/03 Type-C port protection.
* @{
*/
/** @defgroup TCPP0203_Private_Constants Private Constants
* @{
*/
/* Compilation option in order to enable/disable a concistency check performed
after each I2C access into TCPP0203 registers : goal is to check that written value in Reg0
is properly reflected into reg1 register content.
To enable register consistency check, please uncomment below definition.
To disable it, comment below line */
/* #define TCPP0203_REGISTER_CONSISTENCY_CHECK */
/** @defgroup TCPP0203_Private_Types Private Types
* @{
*/
/* TCPP02/03 Type-C port protection driver structure initialization */
TCPP0203_Drv_t TCPP0203_Driver =
{
TCPP0203_Init,
TCPP0203_DeInit,
TCPP0203_Reset,
TCPP0203_SetVConnSwitch,
TCPP0203_SetGateDriverProvider,
TCPP0203_SetGateDriverConsumer,
TCPP0203_SetPowerMode,
TCPP0203_SetVBusDischarge,
TCPP0203_SetVConnDischarge,
TCPP0203_GetVConnSwitchAck,
TCPP0203_GetGateDriverProviderAck,
TCPP0203_GetGateDriverConsumerAck,
TCPP0203_GetPowerModeAck,
TCPP0203_GetVBusDischargeAck,
TCPP0203_GetVConnDischargeAck,
TCPP0203_GetOCPVConnFlag,
TCPP0203_GetOCPVBusFlag,
TCPP0203_GetOVPVBusFlag,
TCPP0203_GetOVPCCFlag,
TCPP0203_GetOTPFlag,
TCPP0203_GetVBusOkFlag,
TCPP0203_ReadTCPPType,
TCPP0203_ReadVCONNPower,
TCPP0203_WriteCtrlRegister,
TCPP0203_ReadAckRegister,
TCPP0203_ReadFlagRegister,
};
/**
* @}
*/
/** @defgroup TCPP0203_Private_Variables Private Variables
* @{
*/
static uint8_t TCPP0203_DeviceType = TCPP0203_DEVICE_TYPE_03;
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
static uint8_t Reg0_Expected_Value = 0x00;
static uint8_t Reg1_LastRead_Value = 0x00;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup TCPP0203_Private_Function_Prototypes TCPP0203 Private Function Prototypes
* @{
*/
static int32_t TCPP0203_ReadRegWrap(const void *handle, uint8_t Reg, uint8_t *Data, uint8_t Length);
static int32_t TCPP0203_WriteRegWrap(const void *handle, uint8_t Reg, uint8_t *Data, uint8_t Length);
static int32_t TCPP0203_ModifyReg0(TCPP0203_Object_t *pObj, uint8_t Value, uint8_t Mask);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
static int32_t TCPP0203_CheckReg0Reg1(TCPP0203_Object_t *pObj, uint8_t Reg0ExpectedValue);
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Functions TCPP0203 Exported Functions
* @{
*/
/**
* @brief Register Bus Io to component
* @param Component object pointer
* @retval Status of execution
*/
int32_t TCPP0203_RegisterBusIO(TCPP0203_Object_t *pObj, TCPP0203_IO_t *pIO)
{
int32_t ret;
if (pObj == NULL)
{
ret = TCPP0203_ERROR;
}
else
{
pObj->IO.Init = pIO->Init;
pObj->IO.DeInit = pIO->DeInit;
pObj->IO.Address = pIO->Address;
pObj->IO.WriteReg = pIO->WriteReg;
pObj->IO.ReadReg = pIO->ReadReg;
pObj->IO.GetTick = pIO->GetTick;
pObj->Ctx.ReadReg = TCPP0203_ReadRegWrap;
pObj->Ctx.WriteReg = TCPP0203_WriteRegWrap;
pObj->Ctx.handle = pObj;
if (pObj->IO.Init != NULL)
{
ret = pObj->IO.Init();
}
else
{
ret = TCPP0203_ERROR;
}
}
return ret;
}
/**
* @brief Initializes the TCPP0203 interface
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_Init(TCPP0203_Object_t *pObj)
{
int32_t ret = 0;
uint8_t tmp;
if (pObj->IsInitialized == 0U)
{
/* Read TCPP Device type */
ret += tcpp0203_read_reg(&pObj->Ctx, TCPP0203_READ_REG2, &tmp, 1);
if (ret == TCPP0203_OK)
{
TCPP0203_DeviceType = (tmp & TCPP0203_DEVICE_TYPE_MSK);
}
else
{
TCPP0203_DeviceType = TCPP0203_DEVICE_TYPE_02;
}
pObj->IsInitialized = 1U;
}
if (ret != TCPP0203_OK)
{
ret = TCPP0203_ERROR;
}
return ret;
}
/**
* @brief Deinitializes the TCPP0203 interface
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_DeInit(TCPP0203_Object_t *pObj)
{
if (pObj->IsInitialized == 1U)
{
/* De-Initialize IO BUS layer */
pObj->IO.DeInit();
pObj->IsInitialized = 0U;
}
return TCPP0203_OK;
}
/**
* @brief Resets TCPP0203 register (Reg0)
* @param pObj Pointer to component object
* @retval Component status (TCPP0203_OK / TCPP0203_ERROR)
*/
int32_t TCPP0203_Reset(TCPP0203_Object_t *pObj)
{
int32_t ret = TCPP0203_OK;
uint8_t tmp = TCPP0203_REG0_RST_VALUE;
/* Write reset values in Reg0 register */
if (tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, &tmp, 1) != TCPP0203_OK)
{
ret = TCPP0203_ERROR;
}
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = TCPP0203_REG0_RST_VALUE;
Reg1_LastRead_Value = TCPP0203_REG0_RST_VALUE;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
/**
* @brief Configure TCPP0203 VConn Switch
* @param pObj Pointer to component object
* @param VConnSwitch VConn Switch requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VCONN_SWITCH_OPEN VConn switch open
* @arg TCPP0203_VCONN_SWITCH_CC1 VConn closed on CC1
* @arg TCPP0203_VCONN_SWITCH_CC2 VConn closed on CC2
* @retval Component status
*/
int32_t TCPP0203_SetVConnSwitch(TCPP0203_Object_t *pObj, uint8_t VConnSwitch)
{
int32_t ret = TCPP0203_OK;
if ((VConnSwitch != TCPP0203_VCONN_SWITCH_OPEN)
&& (VConnSwitch != TCPP0203_VCONN_SWITCH_CC1)
&& (VConnSwitch != TCPP0203_VCONN_SWITCH_CC2))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VConn switch setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VConnSwitch, TCPP0203_VCONN_SWITCH_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param GateDriverProvider GDP switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_GD_PROVIDER_SWITCH_OPEN GDP Switch Load Open
* @arg TCPP0203_GD_PROVIDER_SWITCH_CLOSED GDP Switch Load closed
* @retval Component status
*/
int32_t TCPP0203_SetGateDriverProvider(TCPP0203_Object_t *pObj, uint8_t GateDriverProvider)
{
int32_t ret = TCPP0203_OK;
if ((GateDriverProvider != TCPP0203_GD_PROVIDER_SWITCH_OPEN)
&& (GateDriverProvider != TCPP0203_GD_PROVIDER_SWITCH_CLOSED))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update GDP Switch Load setting in Writing register Reg0 */
if (GateDriverProvider == TCPP0203_GD_PROVIDER_SWITCH_CLOSED)
{
/* If Gate Driver Provider is to be closed, Gate Driver Consumer should be open */
ret += TCPP0203_ModifyReg0(pObj, (GateDriverProvider | TCPP0203_GD_CONSUMER_SWITCH_OPEN),
(TCPP0203_GD_PROVIDER_SWITCH_MSK | TCPP0203_GD_CONSUMER_SWITCH_MSK));
}
else
{
ret += TCPP0203_ModifyReg0(pObj, GateDriverProvider, TCPP0203_GD_PROVIDER_SWITCH_MSK);
}
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Consumer path
* @param pObj Pointer to component object
* @param GateDriverConsumer GDC switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_GD_CONSUMER_SWITCH_OPEN GDC Switch Load Open
* @arg TCPP0203_GD_CONSUMER_SWITCH_CLOSED GDC Switch Load closed
* @retval Component status
*/
int32_t TCPP0203_SetGateDriverConsumer(TCPP0203_Object_t *pObj, uint8_t GateDriverConsumer)
{
int32_t ret = TCPP0203_OK;
/* Check if TCPP type is TCPP03. Otherwise, return error */
if (TCPP0203_DeviceType != TCPP0203_DEVICE_TYPE_03)
{
return (TCPP0203_ERROR);
}
if ((GateDriverConsumer != TCPP0203_GD_CONSUMER_SWITCH_OPEN)
&& (GateDriverConsumer != TCPP0203_GD_CONSUMER_SWITCH_CLOSED))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update GDC Switch Load setting in Writing register Reg0 */
if (GateDriverConsumer == TCPP0203_GD_CONSUMER_SWITCH_CLOSED)
{
/* If Gate Driver Consumer is to be closed, Gate Driver Provider should be open */
ret += TCPP0203_ModifyReg0(pObj, (GateDriverConsumer | TCPP0203_GD_PROVIDER_SWITCH_OPEN),
(TCPP0203_GD_PROVIDER_SWITCH_MSK | TCPP0203_GD_CONSUMER_SWITCH_MSK));
}
else
{
ret += TCPP0203_ModifyReg0(pObj, GateDriverConsumer, TCPP0203_GD_CONSUMER_SWITCH_MSK);
}
}
return ret;
}
/**
* @brief Configure TCPP0203 Power Mode
* @param pObj Pointer to component object
* @param PowerMode Power mode requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_POWER_MODE_HIBERNATE Hibernate
* @arg TCPP0203_POWER_MODE_LOWPOWER Low Power
* @arg TCPP0203_POWER_MODE_NORMAL Normal
* @retval Component status
*/
int32_t TCPP0203_SetPowerMode(TCPP0203_Object_t *pObj, uint8_t PowerMode)
{
int32_t ret = TCPP0203_OK;
if ((PowerMode != TCPP0203_POWER_MODE_HIBERNATE)
&& (PowerMode != TCPP0203_POWER_MODE_LOWPOWER)
&& (PowerMode != TCPP0203_POWER_MODE_NORMAL))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update Power Mode setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, PowerMode, TCPP0203_POWER_MODE_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param VBusDischarge VBUS Discharge requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VBUS_DISCHARGE_OFF VBUS Discharge Off
* @arg TCPP0203_VBUS_DISCHARGE_ON VBUS Discharge On
* @retval Component status
*/
int32_t TCPP0203_SetVBusDischarge(TCPP0203_Object_t *pObj, uint8_t VBusDischarge)
{
int32_t ret = TCPP0203_OK;
if ((VBusDischarge != TCPP0203_VBUS_DISCHARGE_OFF)
&& (VBusDischarge != TCPP0203_VBUS_DISCHARGE_ON))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VBUS Discharge setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VBusDischarge, TCPP0203_VBUS_DISCHARGE_MSK);
}
return ret;
}
/**
* @brief Configure TCPP0203 Gate Driver for Provider path
* @param pObj Pointer to component object
* @param VConnDischarge GDP switch load requested setting
* This parameter can be one of the following values:
* @arg TCPP0203_VCONN_DISCHARGE_OFF VConn Discharge Off
* @arg TCPP0203_VCONN_DISCHARGE_ON VConn Discharge On
* @retval Component status
*/
int32_t TCPP0203_SetVConnDischarge(TCPP0203_Object_t *pObj, uint8_t VConnDischarge)
{
int32_t ret = TCPP0203_OK;
if ((VConnDischarge != TCPP0203_VCONN_DISCHARGE_OFF)
&& (VConnDischarge != TCPP0203_VCONN_DISCHARGE_ON))
{
ret = TCPP0203_ERROR;
}
else
{
/* Update VConn Discharge setting in Writing register Reg0 */
ret += TCPP0203_ModifyReg0(pObj, VConnDischarge, TCPP0203_VCONN_DISCHARGE_MSK);
}
return ret;
}
/**
* @brief Get VConn switch Ack value
* @param pObj Pointer to component object
* @param pVConnSwitchAck Pointer on VConn switch Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VCONN_SWITCH_OPEN VConn switch open Ack
* @arg TCPP0203_VCONN_SWITCH_CC1 VConn closed on CC1 Ack
* @arg TCPP0203_VCONN_SWITCH_CC2 VConn closed on CC2 Ack
* @retval Component status
*/
int32_t TCPP0203_GetVConnSwitchAck(TCPP0203_Object_t *pObj, uint8_t *pVConnSwitchAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVConnSwitchAck = (tmp & TCPP0203_VCONN_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Gate Driver Provider Ack value
* @param pObj Pointer to component object
* @param pGateDriverProviderAck Pointer on Gate Driver Provider Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_GD_PROVIDER_SWITCH_ACK_OPEN Gate Driver Provider Open Ack
* @arg TCPP0203_GD_PROVIDER_SWITCH_ACK_CLOSED Gate Driver Provider Closed Ack
* @retval Component status
*/
int32_t TCPP0203_GetGateDriverProviderAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverProviderAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pGateDriverProviderAck = (tmp & TCPP0203_GD_PROVIDER_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Gate Driver Consumer Ack value
* @param pObj Pointer to component object
* @param pGateDriverConsumerAck Pointer on Gate Driver Consumer Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_GD_CONSUMER_SWITCH_ACK_OPEN Gate Driver Consumer Open Ack
* @arg TCPP0203_GD_CONSUMER_SWITCH_ACK_CLOSED Gate Driver Consumer Closed Ack
* @retval Component status
*/
int32_t TCPP0203_GetGateDriverConsumerAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverConsumerAck)
{
int32_t ret;
uint8_t tmp;
/* Check if TCPP type is TCPP03. Otherwise, return error */
if (TCPP0203_DeviceType != TCPP0203_DEVICE_TYPE_03)
{
return (TCPP0203_ERROR);
}
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pGateDriverConsumerAck = (tmp & TCPP0203_GD_CONSUMER_SWITCH_ACK_MSK);
return ret;
}
/**
* @brief Get Power Mode Ack value
* @param pObj Pointer to component object
* @param pPowerModeAck Pointer on Power Mode Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_POWER_MODE_ACK_HIBERNATE Power Mode Hibernate Ack
* @arg TCPP0203_POWER_MODE_ACK_LOWPOWER Power Mode Low Power Ack
* @arg TCPP0203_POWER_MODE_ACK_NORMAL Power Mode Normal Ack
* @retval Component status
*/
int32_t TCPP0203_GetPowerModeAck(TCPP0203_Object_t *pObj, uint8_t *pPowerModeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pPowerModeAck = (tmp & TCPP0203_POWER_MODE_ACK_MSK);
return ret;
}
/**
* @brief Get VBUS Discharge Ack value
* @param pObj Pointer to component object
* @param pVBusDischargeAck Pointer on VBUS Discharge Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VBUS_DISCHARGE_ACK_OFF VBUS Discharge Off Ack
* @arg TCPP0203_VBUS_DISCHARGE_ACK_ON VBUS Discharge On Ack
* @retval Component status
*/
int32_t TCPP0203_GetVBusDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVBusDischargeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVBusDischargeAck = (tmp & TCPP0203_VBUS_DISCHARGE_ACK_MSK);
return ret;
}
/**
* @brief Get VConn Discharge Ack value
* @param pObj Pointer to component object
* @param pVConnDischargeAck Pointer on VConn Discharge Ack value
* This output parameter can be one of the following values:
* @arg TCPP0203_VCONN_DISCHARGE_ACK_OFF VConn Discharge Off Ack
* @arg TCPP0203_VCONN_DISCHARGE_ACK_ON VConn Discharge On Ack
* @retval Component status
*/
int32_t TCPP0203_GetVConnDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVConnDischargeAck)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
*pVConnDischargeAck = (tmp & TCPP0203_VCONN_DISCHARGE_ACK_MSK);
return ret;
}
/**
* @brief Get OCP VConn Flag value
* @param pObj Pointer to component object
* @param pOCPVConnFlag Pointer on OCP VConn Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OCP_VCONN_RESET OCP VConn flag not set
* @arg TCPP0203_FLAG_OCP_VCONN_SET OCP VConn flag set
* @retval Component status
*/
int32_t TCPP0203_GetOCPVConnFlag(TCPP0203_Object_t *pObj, uint8_t *pOCPVConnFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOCPVConnFlag = (tmp & TCPP0203_FLAG_OCP_VCONN_MSK);
return ret;
}
/**
* @brief Get OCP VBUS Flag value
* @param pObj Pointer to component object
* @param pGetOCPVBusFlag Pointer on OCP VBUS Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OCP_VBUS_RESET OCP VBUS flag not set
* @arg TCPP0203_FLAG_OCP_VBUS_SET OCP VBUS flag set
* @retval Component status
*/
int32_t TCPP0203_GetOCPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pGetOCPVBusFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pGetOCPVBusFlag = (tmp & TCPP0203_FLAG_OCP_VBUS_MSK);
return ret;
}
/**
* @brief Get OVP VBUS Flag value
* @param pObj Pointer to component object
* @param pOVPVBusFlag Pointer on OVP VBUS Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OVP_VBUS_RESET OVP VBUS flag not set
* @arg TCPP0203_FLAG_OVP_VBUS_SET OVP VBUS flag set
* @retval Component status
*/
int32_t TCPP0203_GetOVPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPVBusFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOVPVBusFlag = (tmp & TCPP0203_FLAG_OVP_VBUS_MSK);
return ret;
}
/**
* @brief Get OVP CC Flag value
* @param pObj Pointer to component object
* @param pOVPCCFlag Pointer on OVP CC Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OVP_CC_RESET OVP CC flag not set
* @arg TCPP0203_FLAG_OVP_CC_SET OVP CC flag set
* @retval Component status
*/
int32_t TCPP0203_GetOVPCCFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPCCFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOVPCCFlag = (tmp & TCPP0203_FLAG_OVP_CC_MSK);
return ret;
}
/**
* @brief Get Over Temperature Flag value
* @param pObj Pointer to component object
* @param pOTPFlag Pointer on Over Temperature Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_OTP_RESET Over Temperature flag not set
* @arg TCPP0203_FLAG_OTP_SET Over Temperature flag set
* @retval Component status
*/
int32_t TCPP0203_GetOTPFlag(TCPP0203_Object_t *pObj, uint8_t *pOTPFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pOTPFlag = (tmp & TCPP0203_FLAG_OTP_MSK);
return ret;
}
/**
* @brief Get VBUS OK Flag value
* @param pObj Pointer to component object
* @param pVBusOkFlag Pointer on VBUS OK Flag value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_VBUS_OK_RESET VBUS OK flag not set
* @arg TCPP0203_FLAG_VBUS_OK_SET VBUS OK flag set
* @retval Component status
*/
int32_t TCPP0203_GetVBusOkFlag(TCPP0203_Object_t *pObj, uint8_t *pVBusOkFlag)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pVBusOkFlag = (tmp & TCPP0203_FLAG_VBUS_OK_MSK);
return ret;
}
/**
* @brief Get TCPP0203 Device Type value
* @param pObj Pointer to component object
* @param pTCPPType Pointer on TCPP0203 Device Type value
* This output parameter can be one of the following values:
* @arg TCPP0203_DEVICE_TYPE_02 TCPP02 Type
* @arg TCPP0203_DEVICE_TYPE_03 TCPP03 Type
* @retval Component status
*/
int32_t TCPP0203_ReadTCPPType(TCPP0203_Object_t *pObj, uint8_t *pTCPPType)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pTCPPType = (tmp & TCPP0203_DEVICE_TYPE_MSK);
return ret;
}
/**
* @brief Get VConn Power value
* @param pObj Pointer to component object
* @param pVCONNPower Pointer on VConn Power value
* This output parameter can be one of the following values:
* @arg TCPP0203_FLAG_VCONN_PWR_1W OCP VConn flag not set
* @arg TCPP0203_FLAG_VCONN_PWR_0_1W OCP VConn flag set
* @retval Component status
*/
int32_t TCPP0203_ReadVCONNPower(TCPP0203_Object_t *pObj, uint8_t *pVCONNPower)
{
int32_t ret;
uint8_t tmp;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, &tmp, 1);
*pVCONNPower = (tmp & TCPP0203_FLAG_VCONN_PWR_MSK);
return ret;
}
/**
* @brief Set complete Ctrl register value (Reg 0)
* @param pObj Pointer to component object
* @param pCtrlRegister Pointer on Ctrl register value
* @retval Component status
*/
int32_t TCPP0203_WriteCtrlRegister(TCPP0203_Object_t *pObj, uint8_t *pCtrlRegister)
{
int32_t ret;
/* Update value in writing register (reg0) */
ret = tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, pCtrlRegister, 1);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = *pCtrlRegister;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
/**
* @brief Get complete Ack register value
* @param pObj Pointer to component object
* @param pAckRegister Pointer on Ack register value
* @retval Component status
*/
int32_t TCPP0203_ReadAckRegister(TCPP0203_Object_t *pObj, uint8_t *pAckRegister)
{
int32_t ret;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, pAckRegister, 1);
return ret;
}
/**
* @brief Get complete Flag register value
* @param pObj Pointer to component object
* @param pFlagRegister Pointer on Flag register value
* @retval Component status
*/
int32_t TCPP0203_ReadFlagRegister(TCPP0203_Object_t *pObj, uint8_t *pFlagRegister)
{
int32_t ret;
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_FLAG_REG, pFlagRegister, 1);
return ret;
}
/******************** Static functions ****************************************/
/**
* @brief Wrap TCPP0203 read function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to read
* @param pData Buffer where Target register value should be stored
* @param Length buffer size to be read
* @retval error status
*/
static int32_t TCPP0203_ReadRegWrap(const void *handle, uint8_t Reg, uint8_t *pData, uint8_t Length)
{
const TCPP0203_Object_t *pObj = (const TCPP0203_Object_t *)handle;
return pObj->IO.ReadReg(pObj->IO.Address, Reg, pData, Length);
}
/**
* @brief Wrap TCPP0203 write function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to write
* @param pData Target register value to be written
* @param Length Buffer size to be written
* @retval error status
*/
static int32_t TCPP0203_WriteRegWrap(const void *handle, uint8_t Reg, uint8_t *pData, uint8_t Length)
{
const TCPP0203_Object_t *pObj = (const TCPP0203_Object_t *)handle;
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = *pData;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return pObj->IO.WriteReg(pObj->IO.Address, Reg, pData, Length);
}
/**
* @brief TCPP0203 register update function to Bus IO function
* @param handle Component object handle
* @param Reg Target register address to write
* @param pData Target register value to be written
* @param Length Buffer size to be written
* @retval error status
*/
static int32_t TCPP0203_ModifyReg0(TCPP0203_Object_t *pObj, uint8_t Value, uint8_t Mask)
{
int32_t ret;
uint8_t tmp;
/* Read current content of ACK register (reflects content of bits set to 1 in Writing register Reg0) */
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &tmp, 1);
/* Update only the area dedicated to Mask */
tmp &= ~(Mask);
tmp |= (Value & Mask);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
Reg0_Expected_Value = tmp;
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/* Update value in writing register (reg0) */
ret += tcpp0203_write_reg(&pObj->Ctx, TCPP0203_PROG_CTRL, &tmp, 1);
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
ret += TCPP0203_CheckReg0Reg1(pObj, Reg0_Expected_Value);
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
return ret;
}
#if defined(TCPP0203_REGISTER_CONSISTENCY_CHECK)
/**
* @brief TCPP0203 register control function between Reg0 and Reg1 value
* @param handle Component object handle
* @param Reg0ExpectedValue Value expected in Reg0 (built after all calls to write functions)
* @retval error status
*/
static int32_t TCPP0203_CheckReg0Reg1(TCPP0203_Object_t *pObj, uint8_t Reg0ExpectedValue)
{
int32_t ret;
/* Read current content of ACK register (expected to reflect content of bits set to 1 in Writing register Reg0) */
ret = tcpp0203_read_reg(&pObj->Ctx, TCPP0203_ACK_REG, &Reg1_LastRead_Value, 1);
#ifdef _TRACE
char str[12];
sprintf(str, "Exp0_0x%02x", Reg0ExpectedValue);
USBPD_TRACE_Add(USBPD_TRACE_DEBUG, 0U, 0U, (uint8_t *)str, sizeof(str) - 1U);
sprintf(str, "Reg1_0x%02x", Reg1_LastRead_Value);
USBPD_TRACE_Add(USBPD_TRACE_DEBUG, 0U, 0U, (uint8_t *)str, sizeof(str) - 1U);
#endif /* _TRACE */
/* Control if Reg1 value is same as Reg0 expected one */
if (Reg1_LastRead_Value != Reg0ExpectedValue)
{
while (1);
}
return ret;
}
#endif /* TCPP0203_REGISTER_CONSISTENCY_CHECK */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/

View File

@@ -1,353 +0,0 @@
/**
******************************************************************************
* @file tcpp0203.h
* @author MCD Application Team
* @brief This file contains all the functions prototypes for the
* tcpp0203.c driver.
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef TCPP0203_H
#define TCPP0203_H
/* Includes ------------------------------------------------------------------*/
#include "tcpp0203_reg.h"
#include <stddef.h>
/** @addtogroup BSP
* @{
*/
/** @addtogroup Component
* @{
*/
/** @addtogroup TCPP0203
* @{
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup TCPP0203_Exported_Types TCPP0203 Exported Types
* @{
*/
typedef int32_t (*TCPP0203_Init_Func)(void);
typedef int32_t (*TCPP0203_DeInit_Func)(void);
typedef int32_t (*TCPP0203_GetTick_Func)(void);
typedef int32_t (*TCPP0203_WriteReg_Func)(uint16_t, uint16_t, uint8_t *, uint16_t);
typedef int32_t (*TCPP0203_ReadReg_Func)(uint16_t, uint16_t, uint8_t *, uint16_t);
typedef struct
{
TCPP0203_Init_Func Init;
TCPP0203_DeInit_Func DeInit;
uint16_t Address;
TCPP0203_WriteReg_Func WriteReg;
TCPP0203_ReadReg_Func ReadReg;
TCPP0203_GetTick_Func GetTick;
} TCPP0203_IO_t;
typedef struct
{
TCPP0203_IO_t IO;
TCPP0203_ctx_t Ctx;
uint8_t IsInitialized;
} TCPP0203_Object_t;
typedef struct
{
int32_t (*Init)(TCPP0203_Object_t *);
int32_t (*DeInit)(TCPP0203_Object_t *);
int32_t (*Reset)(TCPP0203_Object_t *);
int32_t (*SetVConnSwitch)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetGateDriverProvider)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetGateDriverConsumer)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetPowerMode)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetVBusDischarge)(TCPP0203_Object_t *, uint8_t);
int32_t (*SetVConnDischarge)(TCPP0203_Object_t *, uint8_t);
int32_t (*GetVConnSwitchAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetGateDriverProviderAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetGateDriverConsumerAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetPowerModeAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetVBusDischargeAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetVConnDischargeAck)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOCPVConnFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOCPVBusFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOVPVBusFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOVPCCFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetOTPFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*GetVBusOkFlag)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadTCPPType)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadVCONNPower)(TCPP0203_Object_t *, uint8_t *);
int32_t (*WriteCtrlRegister)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadAckRegister)(TCPP0203_Object_t *, uint8_t *);
int32_t (*ReadFlagRegister)(TCPP0203_Object_t *, uint8_t *);
} TCPP0203_Drv_t;
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Constants TCPP0203 Exported Constants
* @{
*/
/**
* @brief TCPP0203 Driver Response codes
*/
#define TCPP0203_OK (0)
#define TCPP0203_ERROR (-1)
/**
* @brief TCPP0203 possible I2C Addresses
*/
#define TCPP0203_I2C_ADDRESS_X68 (0x68U)
#define TCPP0203_I2C_ADDRESS_X6A (0x6AU)
/**
* @brief TCPP0203 Reg0 Reset Value
*/
#define TCPP0203_REG0_RST_VALUE TCPP0203_GD_CONSUMER_SWITCH_CLOSED
/**
* @brief TCPP0203 VCONN Switch
*/
#define TCPP0203_VCONN_SWITCH_POS (0U)
#define TCPP0203_VCONN_SWITCH_MSK (0x03U << TCPP0203_VCONN_SWITCH_POS)
#define TCPP0203_VCONN_SWITCH_OPEN (0x00U)
#define TCPP0203_VCONN_SWITCH_CC1 (0x01U << TCPP0203_VCONN_SWITCH_POS)
#define TCPP0203_VCONN_SWITCH_CC2 (0x02U << TCPP0203_VCONN_SWITCH_POS)
/**
* @brief TCPP0203 Gate Driver Provider values
*/
#define TCPP0203_GD_PROVIDER_SWITCH_POS (2U)
#define TCPP0203_GD_PROVIDER_SWITCH_MSK (0x01U << TCPP0203_GD_PROVIDER_SWITCH_POS)
#define TCPP0203_GD_PROVIDER_SWITCH_OPEN (0x00U)
#define TCPP0203_GD_PROVIDER_SWITCH_CLOSED (TCPP0203_GD_PROVIDER_SWITCH_MSK)
/**
* @brief TCPP0203 Gate Driver Consumer values
*/
#define TCPP0203_GD_CONSUMER_SWITCH_POS (3U)
#define TCPP0203_GD_CONSUMER_SWITCH_MSK (0x01U << TCPP0203_GD_CONSUMER_SWITCH_POS)
#define TCPP0203_GD_CONSUMER_SWITCH_CLOSED (0x00U)
#define TCPP0203_GD_CONSUMER_SWITCH_OPEN (TCPP0203_GD_CONSUMER_SWITCH_MSK)
/**
* @brief TCPP0203 Power Mode values
*/
#define TCPP0203_POWER_MODE_POS (4U)
#define TCPP0203_POWER_MODE_MSK (0x03U << TCPP0203_POWER_MODE_POS)
#define TCPP0203_POWER_MODE_HIBERNATE (0x00U)
#define TCPP0203_POWER_MODE_LOWPOWER (0x02U << TCPP0203_POWER_MODE_POS)
#define TCPP0203_POWER_MODE_NORMAL (0x01U << TCPP0203_POWER_MODE_POS)
/**
* @brief TCPP0203 VBUS Discharge management
*/
#define TCPP0203_VBUS_DISCHARGE_POS (6U)
#define TCPP0203_VBUS_DISCHARGE_MSK (0x01U << TCPP0203_VBUS_DISCHARGE_POS)
#define TCPP0203_VBUS_DISCHARGE_OFF (0x00U)
#define TCPP0203_VBUS_DISCHARGE_ON (TCPP0203_VBUS_DISCHARGE_MSK)
/**
* @brief TCPP0203 VConn Discharge management
*/
#define TCPP0203_VCONN_DISCHARGE_POS (7U)
#define TCPP0203_VCONN_DISCHARGE_MSK (0x01U << TCPP0203_VCONN_DISCHARGE_POS)
#define TCPP0203_VCONN_DISCHARGE_OFF (0x00U)
#define TCPP0203_VCONN_DISCHARGE_ON (TCPP0203_VCONN_DISCHARGE_MSK)
/**
* @brief TCPP0203 VCONN Switch Acknowledge
*/
#define TCPP0203_VCONN_SWITCH_ACK_POS (0U)
#define TCPP0203_VCONN_SWITCH_ACK_MSK (0x03U << TCPP0203_VCONN_SWITCH_ACK_POS)
#define TCPP0203_VCONN_SWITCH_ACK_OPEN (0x00U)
#define TCPP0203_VCONN_SWITCH_ACK_CC1 (0x02U << TCPP0203_VCONN_SWITCH_ACK_POS)
#define TCPP0203_VCONN_SWITCH_ACK_CC2 (0x01U << TCPP0203_VCONN_SWITCH_ACK_POS)
/**
* @brief TCPP0203 Gate Driver Provider Acknowledge
*/
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_POS (2U)
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_MSK (0x01U << TCPP0203_GD_PROVIDER_SWITCH_ACK_POS)
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_OPEN (0x00U)
#define TCPP0203_GD_PROVIDER_SWITCH_ACK_CLOSED (TCPP0203_GD_PROVIDER_SWITCH_ACK_MSK)
/**
* @brief TCPP0203 Gate Driver Consumer Acknowledge
*/
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_POS (3U)
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_MSK (0x01U << TCPP0203_GD_CONSUMER_SWITCH_ACK_POS)
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_CLOSED (0x00U)
#define TCPP0203_GD_CONSUMER_SWITCH_ACK_OPEN (TCPP0203_GD_CONSUMER_SWITCH_ACK_MSK)
/**
* @brief TCPP0203 Power Mode Acknowledge
*/
#define TCPP0203_POWER_MODE_ACK_POS (4U)
#define TCPP0203_POWER_MODE_ACK_MSK (0x03U << TCPP0203_POWER_MODE_ACK_POS)
#define TCPP0203_POWER_MODE_ACK_HIBERNATE (0x00U)
#define TCPP0203_POWER_MODE_ACK_LOWPOWER (0x01U << TCPP0203_POWER_MODE_ACK_POS)
#define TCPP0203_POWER_MODE_ACK_NORMAL (0x02U << TCPP0203_POWER_MODE_ACK_POS)
/**
* @brief TCPP0203 VBUS Discharge Acknowledge
*/
#define TCPP0203_VBUS_DISCHARGE_ACK_POS (6U)
#define TCPP0203_VBUS_DISCHARGE_ACK_MSK (0x01U << TCPP0203_VBUS_DISCHARGE_ACK_POS)
#define TCPP0203_VBUS_DISCHARGE_ACK_OFF (0x00U)
#define TCPP0203_VBUS_DISCHARGE_ACK_ON (TCPP0203_VBUS_DISCHARGE_ACK_MSK)
/**
* @brief TCPP0203 VConn Discharge Acknowledge
*/
#define TCPP0203_VCONN_DISCHARGE_ACK_POS (7U)
#define TCPP0203_VCONN_DISCHARGE_ACK_MSK (0x01U << TCPP0203_VCONN_DISCHARGE_ACK_POS)
#define TCPP0203_VCONN_DISCHARGE_ACK_OFF (0x00U)
#define TCPP0203_VCONN_DISCHARGE_ACK_ON (TCPP0203_VCONN_DISCHARGE_ACK_MSK)
/**
* @brief TCPP0203 OCP Vconn Flag management
*/
#define TCPP0203_FLAG_OCP_VCONN_POS (0U)
#define TCPP0203_FLAG_OCP_VCONN_MSK (0x01U << TCPP0203_FLAG_OCP_VCONN_POS)
#define TCPP0203_FLAG_OCP_VCONN_SET (TCPP0203_FLAG_OCP_VCONN_MSK)
#define TCPP0203_FLAG_OCP_VCONN_RESET (0x00U)
/**
* @brief TCPP0203 OCP VBUS Flag management
*/
#define TCPP0203_FLAG_OCP_VBUS_POS (1U)
#define TCPP0203_FLAG_OCP_VBUS_MSK (0x01U << TCPP0203_FLAG_OCP_VBUS_POS)
#define TCPP0203_FLAG_OCP_VBUS_SET (TCPP0203_FLAG_OCP_VBUS_MSK)
#define TCPP0203_FLAG_OCP_VBUS_RESET (0x00U)
/**
* @brief TCPP0203 OVP VBUS Flag management
*/
#define TCPP0203_FLAG_OVP_VBUS_POS (2U)
#define TCPP0203_FLAG_OVP_VBUS_MSK (0x01U << TCPP0203_FLAG_OVP_VBUS_POS)
#define TCPP0203_FLAG_OVP_VBUS_SET (TCPP0203_FLAG_OVP_VBUS_MSK)
#define TCPP0203_FLAG_OVP_VBUS_RESET (0x00U)
/**
* @brief TCPP0203 OVP CC Flag management
*/
#define TCPP0203_FLAG_OVP_CC_POS (3U)
#define TCPP0203_FLAG_OVP_CC_MSK (0x01U << TCPP0203_FLAG_OVP_CC_POS)
#define TCPP0203_FLAG_OVP_CC_SET (TCPP0203_FLAG_OVP_CC_MSK)
#define TCPP0203_FLAG_OVP_CC_RESET (0x00U)
/**
* @brief TCPP0203 OTP Flag management
*/
#define TCPP0203_FLAG_OTP_POS (4U)
#define TCPP0203_FLAG_OTP_MSK (0x01U << TCPP0203_FLAG_OTP_POS)
#define TCPP0203_FLAG_OTP_SET (TCPP0203_FLAG_OTP_MSK)
#define TCPP0203_FLAG_OTP_RESET (0x00U)
/**
* @brief TCPP0203 VBUS OK Flag management
*/
#define TCPP0203_FLAG_VBUS_OK_POS (5U)
#define TCPP0203_FLAG_VBUS_OK_MSK (0x01U << TCPP0203_FLAG_VBUS_OK_POS)
#define TCPP0203_FLAG_VBUS_OK_SET (TCPP0203_FLAG_VBUS_OK_MSK)
#define TCPP0203_FLAG_VBUS_OK_RESET (0x00U)
/**
* @brief TCPP0203 VConn Power
*/
#define TCPP0203_FLAG_VCONN_PWR_POS (6U)
#define TCPP0203_FLAG_VCONN_PWR_MSK (0x01U << TCPP0203_FLAG_VCONN_PWR_POS)
#define TCPP0203_FLAG_VCONN_PWR_1W (TCPP0203_FLAG_VCONN_PWR_MSK)
#define TCPP0203_FLAG_VCONN_PWR_0_1W (0x00U)
/**
* @brief TCPP0203 Device Type
*/
#define TCPP0203_DEVICE_TYPE_POS (7U)
#define TCPP0203_DEVICE_TYPE_MSK (0x01U << TCPP0203_DEVICE_TYPE_POS)
#define TCPP0203_DEVICE_TYPE_02 (TCPP0203_DEVICE_TYPE_MSK)
#define TCPP0203_DEVICE_TYPE_03 (0x00U)
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Macros TCPP0203 Exported Macros
* @{
*/
/**
* @}
*/
/** @defgroup TCPP0203_Exported_Functions TCPP0203 Exported Functions
* @{
*/
/*------------------------------------------------------------------------------
TCPP02/03 Type-C port protection functions
------------------------------------------------------------------------------*/
/* High Layer codec functions */
int32_t TCPP0203_RegisterBusIO(TCPP0203_Object_t *pObj, TCPP0203_IO_t *pIO);
int32_t TCPP0203_Init(TCPP0203_Object_t *pObj);
int32_t TCPP0203_DeInit(TCPP0203_Object_t *pObj);
int32_t TCPP0203_Reset(TCPP0203_Object_t *pObj);
int32_t TCPP0203_SetVConnSwitch(TCPP0203_Object_t *pObj, uint8_t VConnSwitch);
int32_t TCPP0203_SetGateDriverProvider(TCPP0203_Object_t *pObj, uint8_t GateDriverProvider);
int32_t TCPP0203_SetGateDriverConsumer(TCPP0203_Object_t *pObj, uint8_t GateDriverConsumer);
int32_t TCPP0203_SetPowerMode(TCPP0203_Object_t *pObj, uint8_t PowerMode);
int32_t TCPP0203_SetVBusDischarge(TCPP0203_Object_t *pObj, uint8_t VBusDischarge);
int32_t TCPP0203_SetVConnDischarge(TCPP0203_Object_t *pObj, uint8_t VConnDischarge);
int32_t TCPP0203_GetVConnSwitchAck(TCPP0203_Object_t *pObj, uint8_t *pVConnSwitchAck);
int32_t TCPP0203_GetGateDriverProviderAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverProviderAck);
int32_t TCPP0203_GetGateDriverConsumerAck(TCPP0203_Object_t *pObj, uint8_t *pGateDriverConsumerAck);
int32_t TCPP0203_GetPowerModeAck(TCPP0203_Object_t *pObj, uint8_t *pPowerModeAck);
int32_t TCPP0203_GetVBusDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVBusDischargeAck);
int32_t TCPP0203_GetVConnDischargeAck(TCPP0203_Object_t *pObj, uint8_t *pVConnDischargeAck);
int32_t TCPP0203_GetOCPVConnFlag(TCPP0203_Object_t *pObj, uint8_t *pOCPVConnFlag);
int32_t TCPP0203_GetOCPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pGetOCPVBusFlag);
int32_t TCPP0203_GetOVPVBusFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPVBusFlag);
int32_t TCPP0203_GetOVPCCFlag(TCPP0203_Object_t *pObj, uint8_t *pOVPCCFlag);
int32_t TCPP0203_GetOTPFlag(TCPP0203_Object_t *pObj, uint8_t *pOTPFlag);
int32_t TCPP0203_GetVBusOkFlag(TCPP0203_Object_t *pObj, uint8_t *pVBusOkFlag);
int32_t TCPP0203_ReadTCPPType(TCPP0203_Object_t *pObj, uint8_t *pTCPPType);
int32_t TCPP0203_ReadVCONNPower(TCPP0203_Object_t *pObj, uint8_t *pVCONNPower);
int32_t TCPP0203_WriteCtrlRegister(TCPP0203_Object_t *pObj, uint8_t *pCtrlRegister);
int32_t TCPP0203_ReadAckRegister(TCPP0203_Object_t *pObj, uint8_t *pAckRegister);
int32_t TCPP0203_ReadFlagRegister(TCPP0203_Object_t *pObj, uint8_t *pFlagRegister);
/**
* @}
*/
/* TCPP02/03 Type-C port protection driver structure */
extern TCPP0203_Drv_t TCPP0203_Driver;
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
#endif /* TCPP0203_H */

View File

@@ -1,73 +0,0 @@
/**
******************************************************************************
* @file tcpp0203_reg.c
* @author MCD Application Team
* @brief This file provides unitary register function to control the TCPP02-03
* Type-C port protection driver.
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Includes ------------------------------------------------------------------*/
#include "tcpp0203_reg.h"
/** @addtogroup BSP
* @{
*/
/** @addtogroup Components
* @{
*/
/** @addtogroup TCPP0203
* @brief This file provides a set of functions needed to drive the
* TCPP02/03 Type-C port protection codec.
* @{
*/
/************** Generic Function *******************/
/*******************************************************************************
* Function Name : tcpp0203_read_reg
* Description : Generic Reading function. It must be fulfilled with either
* I2C or SPI reading functions
* Input : Register Address, length of buffer
* Output : data Read
*******************************************************************************/
int32_t tcpp0203_read_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length)
{
return ctx->ReadReg(ctx->handle, reg, data, length);
}
/*******************************************************************************
* Function Name : tcpp0203_write_reg
* Description : Generic Writing function. It must be fulfilled with either
* I2C or SPI writing function
* Input : Register Address, data to be written, length of buffer
* Output : None
*******************************************************************************/
int32_t tcpp0203_write_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length)
{
return ctx->WriteReg(ctx->handle, reg, data, length);
}
/******************************************************************************/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/

View File

@@ -1,98 +0,0 @@
/**
******************************************************************************
* @file tcpp0203_reg.h
* @author MCD Application Team
* @brief Header of tcpp0203_reg.c
*
******************************************************************************
* @attention
*
* Copyright (c) 2021 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.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef TCPP0203_REG_H
#define TCPP0203_REG_H
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/* Includes ------------------------------------------------------------------*/
/** @addtogroup BSP
* @{
*/
/** @addtogroup Component
* @{
*/
/** @addtogroup TCPP0203
* @{
*/
/** @defgroup TCPP0203_Exported_Constants TCPP0203 Exported Constants
* @{
*/
/******************************************************************************/
/****************************** REGISTER MAPPING ******************************/
/******************************************************************************/
#define TCPP0203_WRITE_REG 0x00U
#define TCPP0203_PROG_CTRL TCPP0203_WRITE_REG
#define TCPP0203_READ_REG1 0x01U
#define TCPP0203_ACK_REG TCPP0203_READ_REG1
#define TCPP0203_READ_REG2 0x02U
#define TCPP0203_FLAG_REG TCPP0203_READ_REG2
/**
* @}
*/
/************** Generic Function *******************/
typedef int32_t (*TCPP0203_Write_Func)(const void *, uint8_t, uint8_t *, uint8_t);
typedef int32_t (*TCPP0203_Read_Func)(const void *, uint8_t, uint8_t *, uint8_t);
typedef struct
{
TCPP0203_Write_Func WriteReg;
TCPP0203_Read_Func ReadReg;
void *handle;
} TCPP0203_ctx_t;
/*******************************************************************************
* Register : Generic - All
* Address : Generic - All
* Bit Group Name: None
* Permission : W
*******************************************************************************/
int32_t tcpp0203_write_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length);
int32_t tcpp0203_read_reg(const TCPP0203_ctx_t *ctx, uint8_t reg, uint8_t *data, uint8_t length);
#ifdef __cplusplus
}
#endif
#endif /* TCPP0203_REG_H */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/

View File

@@ -6,6 +6,7 @@ set(ST_PREFIX stm32${ST_FAMILY}xx)
set(ST_HAL_DRIVER ${TOP}/hw/mcu/st/stm32${ST_FAMILY}xx_hal_driver)
set(ST_CMSIS ${TOP}/hw/mcu/st/cmsis_device_${ST_FAMILY})
set(CMSIS_5 ${TOP}/lib/CMSIS_5)
set(ST_TCPP0203 ${TOP}/hw/mcu/st/stm32-tcpp0203)
# include board specific
include(${CMAKE_CURRENT_LIST_DIR}/boards/${BOARD}/board.cmake)

View File

@@ -2,6 +2,7 @@ ST_FAMILY = n6
ST_PREFIX = stm32${ST_FAMILY}xx
ST_CMSIS = hw/mcu/st/cmsis_device_$(ST_FAMILY)
ST_HAL_DRIVER = hw/mcu/st/${ST_PREFIX}_hal_driver
ST_TCPP0203 = hw/mcu/st/stm32-tcpp0203
UF2_FAMILY_ID = 0x6db66083

View File

@@ -133,6 +133,9 @@ deps_optional = {
'hw/mcu/st/stm32-mfxstm32l152': ['https://github.com/STMicroelectronics/stm32-mfxstm32l152.git',
'7f4389efee9c6a655b55e5df3fceef5586b35f9b',
'stm32h7'],
'hw/mcu/st/stm32-tcpp0203': ['https://github.com/STMicroelectronics/stm32-tcpp0203.git',
'9918655bff176ac3046ccf378b5c7bbbc6a38d15',
'stm32h7rs stm32n6'],
'hw/mcu/st/stm32c0xx_hal_driver': ['https://github.com/STMicroelectronics/stm32c0xx_hal_driver.git',
'41253e2f1d7ae4a4d0c379cf63f5bcf71fcf8eb3',
'stm32c0'],