Adi_Rtc_Installcallback() - Analog Devices VisualDSP++ 5.0 Service Manual

RTC Service Application Programming Interface (API)

adi_rtc_InstallCallback()

Description
This function installs a callback for a real-time clock event.
Prototype
ADI_RTC_RESULT
ADI_RTC_EVENT_ID EventID,
void ClientHandle,
ADI_DCB_HANDLE DCBHandle,
ADI_DCB_CALLBACK_FN ClientCallback,
void *Value );
Arguments
The caller provides five parameters to the function, shown in
Table 11-1. Parameters for the InstallCallback Function
Data Type
ADI_RTC_EVENT_ID
void*
ADI_DCB_HANDLE
ADI_DCB_CALLBACK_FN
void*
11-22
= adi_rtc_InstallCallback(
Name
EventID
ClientHandle
DCBHandle
ClientCallback
Value
VisualDSP++ 5.0 Device Drivers and System
Services Manual for Blackfin Processors
Description
Enumerator value that uniquely identifies the
event for which the callback is being installed
Identifier defined and supplied by the applica-
tion. This value is passed to the callback func-
tion.
The handle returned from the DCB service if
callbacks are deferred. NULL when callbacks
are "live".
Name of client callback function
RTC service uses this info to install alarm call-
backs or stopwatch callbacks. It specifies num-
ber of seconds or date/time. For other
callbacks, it is not used.
Table 11-1.