rtcpsu
Xilinx SDK Drivers API Documentation
xrtcpsu_alarm_polled_example.c File Reference

Overview

This file contains an example using the XRtcPsu driver in polled mode.

This function sets alarm for a specified time from the current time.

Note
If the device does not work properly, the example may hang.

MODIFICATION HISTORY:

Ver   Who    Date     Changes


1.00 kvn 05/12/15 First Release

 

Functions

int RtcPsuAlarmPolledExample (u16 DeviceId)
 This function does a minimal Alarm test on the XRtcPsu device in polled mode. More...
 
int main (void)
 Main function to call the Rtc Alarm Polled mode example. More...
 

Function Documentation

int main ( void  )

Main function to call the Rtc Alarm Polled mode example.

Parameters
None
Returns
XST_SUCCESS if succesful, otherwise XST_FAILURE
Note
None

References RtcPsuAlarmPolledExample().

int RtcPsuAlarmPolledExample ( u16  DeviceId)

This function does a minimal Alarm test on the XRtcPsu device in polled mode.

This function sets one time alarm from the current time to a specified time.

Parameters
DeviceIdis the unique device id from hardware build.
Returns
XST_SUCCESS if successful, XST_FAILURE if unsuccessful
Note
This function polls the RTC, it may hang if the hardware is not working correctly.

References XRtcPsu_Config::BaseAddr, XRtcPsu_GetCurrentTime(), XRtcPsu_IsAlarmEventGenerated(), XRtcPsu_LookupConfig(), XRtcPsu_SecToDateTime(), XRtcPsu_SelfTest(), and XRtcPsu_SetAlarm().

Referenced by main().