Macros
#define	XSYSMONPSV_H_
	< prevent circular inclusions More...

#define	XSysMonPsv_GetAlarmMask(InstancePtr, Supply) Mask = 1U << (InstancePtr->Supply_List[Supply] / 32U)
	This macro returns the XSYSMONPSV_NEW_ALARMn_MASK for a configured supply. More...

Enumerations

enum	XSysMonPsv_Threshold { XSYSMONPSV_TH_LOWER, XSYSMONPSV_TH_UPPER }
	This typedef defines Threshold types. More...


enum	XSysMonPsv_Val { XSYSMONPSV_VAL, XSYSMONPSV_VAL_MIN, XSYSMONPSV_VAL_MAX, XSYSMONPSV_VAL_VREF_MIN, XSYSMONPSV_VAL_VREF_MAX }
	This typedef defines value types for voltage readings. More...


enum	XSysMonPsv_VoltageScale { XSYSMONPSV_1V_UNIPOLAR, XSYSMONPSV_2V_UNIPOLAR, XSYSMONPSV_4V_UNIPOLAR, XSYSMONPSV_1V_BIPOLAR }
	This typedef defines types of supply values. More...

Functions
s64	XSysMonPsv_CfgInitialize (XSysMonPsv InstancePtr, XSysMonPsv_Config CfgPtr)
	Initializes XSysMonPsv device/instance. More...

void	XSysMonPsv_SystemReset (XSysMonPsv *InstancePtr)
	Resets the SystemMonitor. More...

void	XSysMonPsv_EnRegGate (XSysMonPsv *InstancePtr, u8 Enable)
	Gates the register outputs. More...

void	XSysMonPsv_SetPMBusAddress (XSysMonPsv *InstancePtr, u8 Address)
	Sets the PMBus address for the System Monitor. More...

void	XSysMonPsv_PMBusEnable (XSysMonPsv *InstancePtr, u8 Enable)
	Enables/disbles the PMBus on the System Monitor. More...

void	XSysMonPsv_PMBusEnableCmd (XSysMonPsv *InstancePtr, u8 Enable)
	Restricts or de-restrict all PMBs commands. More...

void	XSysMonPsv_SelectExtInterface (XSysMonPsv *InstancePtr, u8 Interface)
	Selects I2C or PMBus interface to which traffic from SMBus is routed. More...

void	XSysMonPsv_StatusReset (XSysMonPsv *InstancePtr, u8 ResetSupply, u8 ResetTemperature)
	Resets the Min and Max values of supplies and temperature to negative and positive saturation respectively. More...

u16	XSysMonPsv_ReadDevTempThreshold (XSysMonPsv *InstancePtr, XSysMonPsv_Threshold ThresholdType)
	Returns the device temperature threshold for min and max values in signed Q8.7 format. More...

void	XSysMonPsv_SetDevTempThreshold (XSysMonPsv *InstancePtr, XSysMonPsv_Threshold ThresholdType, u16 Value)
	Sets Device Temperature Threshold values. More...

u16	XSysMonPsv_ReadOTTempThreshold (XSysMonPsv *InstancePtr, XSysMonPsv_Threshold ThresholdType)
	Returns the OT temperature threshold for min and max values in signed Q8.7 format. More...

void	XSysMonPsv_SetOTTempThreshold (XSysMonPsv *InstancePtr, XSysMonPsv_Threshold ThresholdType, u16 Value)
	Sets OT Temperature Threshold values. More...

u32	XSysMonPsv_ReadDeviceTemp (XSysMonPsv *InstancePtr, XSysMonPsv_Val Value)
	Returns the temperature values for the device in signed Q8.7 format. More...

u32	XSysMonPsv_ReadSupplyThreshold (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply, XSysMonPsv_Threshold ThresholdType)
	Reads the raw value for Supply Threshold. More...

u32	XSysMonPsv_ReadSupplyValue (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply, XSysMonPsv_Val Value)
	Reads the raw supply value for requested. More...

u32	XSysMonPsv_IsNewData (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply)
	Checks if new data is available for a supply. More...

u32	XSysMonPsv_IsAlarmCondition (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply)
	Checks if the supply value has exceeded the set threshold values. More...

u32	XSysMonPsv_SetSupplyUpperThreshold (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply, u32 Value)
	Sets the raw value for upper supply threshold. More...

u32	XSysMonPsv_SetSupplyLowerThreshold (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply, u32 Value)
	Sets the raw value for Lower Supply Threshold. More...

void	XSysMonPsv_SetTempMode (XSysMonPsv *InstancePtr, u32 Mode)
	Sets the alarm mode for temperature alarms. More...

void	XSysMonPsv_SetOTMode (XSysMonPsv *InstancePtr, u32 Mode)
	Sets the alarm mode for OT alarm. More...

u32	XSysMonPsv_ReadAlarmConfig (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply)
	Reads the current supply Alarm Configuration. More...

u32	XSysMonPsv_SetAlarmConfig (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply, u32 Config)
	Sets the Alarm configuration for a supply. More...

int	XSysMonPsv_ReadTempProcessed (XSysMonPsv InstancePtr, XSysMonPsv_TempType Type, float Val)
	Reads the temperature and returns value in degree celsius. More...

int	XSysMonPsv_ReadTempRaw (XSysMonPsv InstancePtr, XSysMonPsv_TempType Type, u32 Val)
	Reads the temperature and returns value in raw format. More...

int	XSysMonPsv_ReadTempProcessedSat (XSysMonPsv InstancePtr, int SatId, float Val)
	Reads the temperature of each satellite in degree celsius. More...

int	XSysMonPsv_ReadTempRawSat (XSysMonPsv InstancePtr, int SatId, u32 Val)
	Reads the temperature of each satellite in raw format. More...

int	XSysMonPsv_SetTempThresholdUpper (XSysMonPsv *InstancePtr, XSysMonPsv_TempEvt Event, u32 Val)
	Sets the temperature upper threshold. More...

int	XSysMonPsv_SetTempThresholdLower (XSysMonPsv *InstancePtr, XSysMonPsv_TempEvt Event, u32 Val)
	Sets the temperature lower threshold. More...

int	XSysMonPsv_GetTempThresholdUpper (XSysMonPsv InstancePtr, XSysMonPsv_TempEvt Event, u32 Val)
	Gets the temperature upper threshold. More...

int	XSysMonPsv_GetTempThresholdLower (XSysMonPsv InstancePtr, XSysMonPsv_TempEvt Event, u32 Val)
	Gets the temperature lower threshold. More...

int	XSysMonPsv_ReadSupplyProcessed (XSysMonPsv InstancePtr, int Supply, float Val)
	Reads the voltage for the supply. More...

int	XSysMonPsv_ReadSupplyRaw (XSysMonPsv InstancePtr, u32 Supply, u32 Val)
	Reads the voltage for the supply in raw. More...

int	XSysMonPsv_SetSupplyThresholdUpper (XSysMonPsv *InstancePtr, u32 Supply, u32 Val)
	Sets the upper threshold voltage for the supply. More...

int	XSysMonPsv_SetSupplyThresholdLower (XSysMonPsv *InstancePtr, int Supply, u32 Val)
	Sets loser threshold voltage for the supply. More...

int	XSysMonPsv_GetSupplyThresholdUpper (XSysMonPsv InstancePtr, u32 Supply, u32 Val)
	Gets the upper threshold voltage for the supply. More...

int	XSysMonPsv_GetSupplyThresholdLower (XSysMonPsv InstancePtr, u32 Supply, u32 Val)
	Gets the lower threshold voltage for the supply. More...

void	XSysMonPsv_EnableTempAverage (XSysMonPsv *InstancePtr, int SatId, u8 Enable)
	Enables or Disables temperature satellites averaging. More...

void	XSysMonPsv_SetTempAverageRate (XSysMonPsv *InstancePtr, u8 AverageRate)
	Sets temperature satellites average sampling rate value. More...

int	XSysMonPsv_GetTempAverageRate (XSysMonPsv InstancePtr, u8 AverageRate)
	Gets temperature satellites average sampling rate value. More...

int	XSysMonPsv_EnableSupplyAverage (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply, u8 Enable)
	Enables or Disables voltage supplies averaging. More...

void	XSysMonPsv_SetSupplyAverageRate (XSysMonPsv *InstancePtr, u8 AverageRate)
	Sets voltage supplies average sampling rate value. More...

int	XSysMonPsv_GetSupplyAverageRate (XSysMonPsv InstancePtr, u8 AverageRate)
	Gets voltage supplies average sampling rate value. More...

void	XSysMonPsv_IntrEnable (XSysMonPsv *InstancePtr, u32 Mask, u8 IntrNum)
	Enables the specified interrupts in the device. More...

void	XSysMonPsv_IntrDisable (XSysMonPsv *InstancePtr, u32 Mask, u8 IntrNum)
	Disables the specified interrupts in the device. More...

u32	XSysMonPsv_IntrGetEnabled (XSysMonPsv *InstancePtr, u8 IntrNum)
	Returns the enabled interrupts read from the Interrupt Mask Register (IMR). More...

u32	XSysMonPsv_IntrGetStatus (XSysMonPsv *InstancePtr)
	Returns the interrupt status read from Interrupt Status Register(ISR). More...

void	XSysMonPsv_IntrClear (XSysMonPsv *InstancePtr, u32 Mask)
	Clears the specified interrupts in the Interrupt Status Register (ISR). More...

void	XSysMonPsv_SetNewDataIntSrc (XSysMonPsv *InstancePtr, XSysMonPsv_Supply Supply, u32 Mask)
	Sets a supply as a source new data interrupt. More...

XSysMonPsv_Config *	XSysMonPsv_LookupConfig (void)
	Looks for the device configuration based on the unique device ID. More...

Variables
This array contains the names of the supplies
const char *	XSysMonPsv_Supply_Arr []
	Names of the supplies enabled in the design. More...

Macro Definition Documentation

#define XSysMonPsv_GetAlarmMask	(	InstancePtr,
		Supply
	)	Mask = 1U << (InstancePtr->Supply_List[Supply] / 32U)

This macro returns the XSYSMONPSV_NEW_ALARMn_MASK for a configured supply.

Parameters

InstancePtr	Instance of sysmon driver
Supply	Type enum of supply enabled

Returns: A 32 bit mask to be used for configuring interrupts

Enumeration Type Documentation

enum XSysMonPsv_Threshold

This typedef defines Threshold types.

Enumerator
XSYSMONPSV_TH_LOWER	Lower Threshold.
XSYSMONPSV_TH_UPPER	Upper Threshold.

enum XSysMonPsv_Val

This typedef defines value types for voltage readings.

Enumerator
XSYSMONPSV_VAL	Current Value for temperature (for production silicon only) and supply.
XSYSMONPSV_VAL_MIN	Minimum Value reached since reset.
XSYSMONPSV_VAL_MAX	Maximum Value reached since reset.
XSYSMONPSV_VAL_VREF_MIN	Minimum value reached for a temperature since last VRef.
XSYSMONPSV_VAL_VREF_MAX	Maximum value reached for a temperature since last VRef.

enum XSysMonPsv_VoltageScale

This typedef defines types of supply values.

Enumerator
XSYSMONPSV_1V_UNIPOLAR	1V unipolar fmt
XSYSMONPSV_2V_UNIPOLAR	2V unipolar fmt
XSYSMONPSV_4V_UNIPOLAR	4V unipolar fmt
XSYSMONPSV_1V_BIPOLAR	1V bipolar fmt

Variable Documentation

const char* XSysMonPsv_Supply_Arr[]

Names of the supplies enabled in the design.

Referenced by SysMonPsvIntrExample(), and SysMonPsvPolledExample().

Macros

Enumerations

Functions

Variables

Macro Definition Documentation

Enumeration Type Documentation

Variable Documentation