Configuration Items - Freescale Semiconductor DSP56800E User Manual

5.26.2.2

Configuration Items

This section summarizes the symbols used in macro definitions for the static RTC module
configuration by the driver initialization routine. Configuration symbols are intended for the
application (project) specific configuration file appconfig.h.
RTC_RTCSC_INIT
RTC_RTCMOD_INIT
5.26.2.3 API Specification
This section specifies the exact usage for each API function.
Function arguments for each routine are described as in, out, or inout.
1. in argument means that the parameter value is an input only to the function.
2. out argument means that the parameter value is an output only from the function.
3. inout argument means that a parameter value is an input to the function, but the same
parameter is also an output from the function.
Note: inout parameters are typically input pointer variables in which the caller passes the address
of a pre-allocated data structure to a function. The function stores its results within that data
structure. The actual value of the inout pointer parameter is not changed.
ioctl call(s):
The ioctl call is generally represented by one of the following forms:
UWord16 ioctl(const int *pModuleBase, void cmd, UWord16 param);
UWord16 ioctl(const int *pModuleBase, void cmd, void* pParam);
Description: The ioctl call "changes" the RTC device modes or accesses the RTC register(s). The
third ioctl parameter is either a value or a pointer, depending on the type of cmd.
Arguments:
pModuleBase
cmd
param, pParam
5-1090
Table 5-926. RTC Configuration Items for appconfig.h
SYMBOL
Table 5-927. RTC Driver Arguments - ioctl
in
in
in, inout
Targeting 56F8xxx Platform
TYPE DESCRIPTION
UWord16 The initial value of the RTC Sta-
tus and Control Register
UWord16 Initial value of the RTC Modulo
Register
RTC module identifier. Use RTC.
Commands found in rtc.h which are used
to modify the RTC module status and con-
trol registers. See Table 5-928.
Used to pass the relevant data to ioctl
function call.
FREESCALE SEMICONDUCTOR