PDK API Guide for J721E
pmic_gpio.h File Reference

Introduction

PMIC Low Level Driver API/interface file for GPIO API.

Go to the source code of this file.

Data Structures

struct  Pmic_GpioCfg_t
 PMIC GPIO/NPWRON/ENABLE pin configuration structure. Note: validParams is input param for all Set and Get APIs. other params except validParams is input param for Set APIs and output param for Get APIs. More...
 

Macros

PMIC GPIO Pin Configuration Structure Param Bit shift values

Application can use below shifted values to set the validParams struct member defined in Pmic_GpioCfg_t structure

#define PMIC_GPIO_CFG_DIR_VALID_SHIFT   (0x01U << PMIC_GPIO_CFG_DIR_VALID)
 
#define PMIC_GPIO_CFG_OD_VALID_SHIFT   (0x01U << PMIC_GPIO_CFG_OD_VALID)
 
#define PMIC_GPIO_CFG_PULL_VALID_SHIFT   (0x01U << PMIC_GPIO_CFG_PULL_VALID)
 
#define PMIC_GPIO_CFG_DEGLITCH_VALID_SHIFT   (0x01U << PMIC_GPIO_CFG_DEGLITCH_VALID)
 
#define PMIC_GPIO_CFG_PINFUNC_VALID_SHIFT   (0x01U << PMIC_GPIO_CFG_PINFUNC_VALID)
 
#define PMIC_ENABLE_CFG_POLARITY_VALID_SHIFT   (1U << PMIC_ENABLE_CFG_POLARITY_VALID)
 
PMIC GPIO Deglitch Time Enable or Disable Configuration

#define PMIC_GPIO_DEGLITCH_DISABLE   (0U)
 
#define PMIC_GPIO_DEGLITCH_ENABLE   (1U)
 
PMIC GPIO signal direction

#define PMIC_GPIO_INPUT   (0U)
 
#define PMIC_GPIO_OUTPUT   (1U)
 
PMIC GPIO signal type when configured as output

#define PMIC_GPIO_PUSH_PULL_OUTPUT   (0U)
 
#define PMIC_GPIO_OPEN_DRAIN_OUTPUT   (1U)
 
PMIC GPIO/NPWRON/ENABLE signal level

#define PMIC_GPIO_LOW   (0U)
 
#define PMIC_GPIO_HIGH   (1U)
 
PMIC GPIO Pull-up/pull-down select

#define PMIC_GPIO_PD_SELECT   (0U)
 
#define PMIC_GPIO_PU_SELECT   (1U)
 
PMIC GPIO Pull-up/pull-down enable/disable

#define PMIC_GPIO_PU_PD_DISABLE   (0U)
 
#define PMIC_GPIO_PU_PD_ENABLE   (1U)
 
PMIC Pmic_GpioCfg_s member configuration type

#define PMIC_GPIO_CFG_DIR_VALID   (0x00U)
 validParams value used to set/get gpio pin Direction Valid only for GPIO pins only. Invalid for NPWRON/Enable More...
 
#define PMIC_GPIO_CFG_OD_VALID   (0x01U)
 validParams value used to set/get output signal type Valid only for GPIO pins only. Invalid for NPWRON/Enable More...
 
#define PMIC_GPIO_CFG_PULL_VALID   (0x02U)
 validParams value used to set/get pullup/pull down control More...
 
#define PMIC_GPIO_CFG_DEGLITCH_VALID   (0x03U)
 validParams value used to set/get signal deglitch time enable/disable More...
 
#define PMIC_GPIO_CFG_PINFUNC_VALID   (0x04U)
 validParams value used to set/get pin mux function More...
 
#define PMIC_ENABLE_CFG_POLARITY_VALID   (0x05U)
 validParams value used to set/get pin polarity Valid only for Enable pin for TPS6594x Leo and LP8764x Hera device Invalid for NPWRON pin for TPS6594x Leo device More...
 
PMIC GPIO pull up/pull down selectionn

#define PMIC_GPIO_PULL_DISABLED   (0x0U)
 
#define PMIC_GPIO_PULL_DOWN   (0x1U)
 
#define PMIC_GPIO_PULL_UP   (0x2U)
 
PMIC GPIO Interrupt selection

#define PMIC_GPIO_FALL_INTERRUPT   (0U)
 
#define PMIC_GPIO_RISE_INTERRUPT   (1U)
 
#define PMIC_GPIO_FALL_RISE_INTERRUPT   (2U)
 
#define PMIC_GPIO_DISABLE_INTERRUPT   (3U)
 
PMIC GPIO Interrupt Polarity selection

#define PMIC_GPIO_POL_LOW   (0U)
 
#define PMIC_GPIO_POL_HIGH   (1U)
 

Functions

int32_t Pmic_gpioSetConfiguration (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t pin, const Pmic_GpioCfg_t gpioCfg)
 API to set PMIC GPIO configuration. More...
 
int32_t Pmic_gpioGetConfiguration (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t pin, Pmic_GpioCfg_t *pGpioCfg)
 API to get PMIC GPIO configuration. More...
 
int32_t Pmic_gpioSetValue (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t pin, const uint8_t pinValue)
 API to set PMIC GPIO value. More...
 
int32_t Pmic_gpioGetValue (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t pin, uint8_t *pPinValue)
 API to get PMIC GPIO value. More...
 
int32_t Pmic_gpioSetIntr (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t pin, const uint8_t intrType, const uint8_t maskPol)
 API to enable/disable GPIO interrupt. More...
 
int32_t Pmic_gpioSetNPwronEnablePinConfiguration (Pmic_CoreHandle_t *pPmicCoreHandle, const Pmic_GpioCfg_t gpioCfg)
 API to set configuration for NPWRON/Enable pin. More...
 
int32_t Pmic_gpioGetNPwronEnablePinConfiguration (Pmic_CoreHandle_t *pPmicCoreHandle, Pmic_GpioCfg_t *pGpioCfg)
 API to get configuration for NPWRON/Enable pin. More...