Rtc Service Application Programming Interface (Api); Notation And Naming Conventions - Analog Devices VisualDSP++ 5.0 Service Manual

RTC Service Application Programming Interface (API)

RTC Service Application Programming
Interface (API)
This section provides the details of the data structures and functions
within the RTC service application program interface (API).

Notation and Naming Conventions

To safeguard against conflicts with other software libraries provided by
Analog Devices (or other sources), the real-time clock service uses an
unambiguous naming convention in which enumeration values and
statements use the
def
use the lowercase
Each function within the real-time clock service API returns an error code
of the type
ADI_RTC_RESULT
zero (
0=ADI_RTC_RESULT_SUCCESS
the function call. Any nonzero value indicates the specific type of error
that occurred. The error codes for the real-time clock service, unique from
those of other system services, are defined in the
the cause of the error can be determined from looking up the error code in
that file.
The reference pages for the API functions use the following format:
Name – Name and purpose of the function
Description – Function specification
Prototype – Required header file and functional prototype
Arguments – Description of function arguments
Return Value – Description of function return values
11-16
ADI_RTC_ prefix
adi_rtc_ equivalent
. Like other system services, a return value of
) indicates that no error occurred during
VisualDSP++ 5.0 Device Drivers and System
Services Manual for Blackfin Processors
. Functions and global variables
.
adi_rtc.h
type-
include file, so