Overview

This file contains a design example using the driver functions of the System Monitor driver.

The example here shows the driver/device in polled mode to check the on-chip temperature and voltages.

Note

The values of the on-chip temperature and the on-chip Vccaux voltage are read from the device and then the alarm thresholds are set in such a manner that the alarms occur.

MODIFICATION HISTORY:

Ver   Who    Date     Changes



1.00a xd/sv  05/22/07 First release
2.00a sdm    09/26/08 Added code to return temperature value to the main
                function. TestappPeripheral prints the temperature
4.00a ktn    10/22/09 Updated the example to use macros that have been
                renamed to remove _m from the name of the macro.
5.03a bss    04/25/13 Modified SysMonPolledExample function to set
                Sequencer Mode as Safe mode instead of Single
                channel mode before configuring Sequencer registers.
                CR #703729
7.3   ms   01/23/17 Added xil_printf statement in main function to
                    ensure that "Successfully ran" and "Failed" strings
                    are available in all examples. This is a fix for
                    CR-965028.
7.8   cog  07/20/23 Added support for SDT flow

Functions
int	SysMonPolledExample (u16 SysMonDeviceId, int *Temp)
	This function runs a test on the System Monitor/ADC device using the driver APIs. More...

int	main (void)
	Main function that invokes the polled example in this file. More...

Function Documentation

int main ( void )

Main function that invokes the polled example in this file.

Parameters

None.

Returns

XST_SUCCESS if the example has completed successfully.
XST_FAILURE if the example has failed.

Note: None.

References SysMonPolledExample().

int SysMonPolledExample	(	u16	SysMonDeviceId,
		int *	Temp
	)

This function runs a test on the System Monitor/ADC device using the driver APIs.

This function does the following tasks:

Initiate the System Monitor device driver instance
Run self-test on the device
Setup alarms for on-chip temperature and VCCAUX
Setup the sequence registers to continuously monitor on-chip temperature and VCCAUX
Setup configuration registers to start the sequence
Read latest on-chip temperature and VCCAUX, as well as their maximum and minimum values. Also check if alarm(s) are set

Parameters

SysMonDeviceId	is the XPAR_<SYSMON_ADC_instance>_DEVICE_ID value from xparameters.h.
Temp	is an output parameter, it is a pointer through which the current temperature value is returned to the main function.

Returns

XST_SUCCESS if the example has completed successfully.
XST_FAILURE if the example has failed.

Note: None

References XSysMon_Config::BaseAddress, XSM_AOR_TEMP_MASK, XSM_AOR_VCCAUX_MASK, XSM_ATR_TEMP_LOWER, XSM_ATR_TEMP_UPPER, XSM_ATR_VCCAUX_LOWER, XSM_ATR_VCCAUX_UPPER, XSM_AVG_16_SAMPLES, XSM_CFR1_ALM_TEMP_MASK, XSM_CFR1_ALM_VCCAUX_MASK, XSM_CH_TEMP, XSM_CH_VCCAUX, XSM_MAX_TEMP, XSM_MAX_VCCAUX, XSM_MIN_TEMP, XSM_MIN_VCCAUX, XSM_SEQ_CH_AUX00, XSM_SEQ_CH_AUX15, XSM_SEQ_CH_TEMP, XSM_SEQ_CH_VCCAUX, XSM_SEQ_MODE_CONTINPASS, XSM_SEQ_MODE_SAFE, XSM_SR_EOS_MASK, XSysMon_CfgInitialize(), XSysMon_GetAdcData(), XSysMon_GetAlarmOutputStatus(), XSysMon_GetMinMaxMeasurement(), XSysMon_GetStatus(), XSysMon_LookupConfig(), XSysMon_RawToTemperature, XSysMon_SelfTest(), XSysMon_SetAdcClkDivisor(), XSysMon_SetAlarmEnables(), XSysMon_SetAlarmThreshold(), XSysMon_SetAvg(), XSysMon_SetSeqAcqTime(), XSysMon_SetSeqAvgEnables(), XSysMon_SetSeqChEnables(), XSysMon_SetSeqInputMode(), and XSysMon_SetSequencerMode().

Referenced by main().

Overview

Functions

Function Documentation