Api Specification - Freescale Semiconductor DSP56800E User Manual

Table 5-2. OCCS Configuration Items for appconfig.h (Continued)
SYMBOL
OCCS_PLLCR_INIT
OCCS_PLLDB_INIT
OCCS_OSCTL_INIT
only on MC56F802x/3x:
OCCS_PROT_INIT
OCCS_REQUIRED_LOCK_MODE
Devices equipped with internal relaxation oscillator:
USE_FACTORY_TRIM
RXOSC_RETRIM_CLK:
5.1.2.4

API Specification

This section briefly describes the API macros and functions.
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.
FREESCALE SEMICONDUCTOR
TYPE DESCRIPTION
UWord16 Initial value of the PLL Control
Register (PLLCR). PLL is set up
by the startup code if Postscaler
output is to be used as ZCLK.
UWord16 Initial value of the PLL Divide-by
Register (PLLDB).
UWord16 Initial value of the Oscillator Con-
trol Register (OSCTL).
UWord16 Initial value of the Protection Reg-
ister (PROT).
UWord16 Specifies the PLL lock state in
which the startup code considers
the PLL stable. The valid values
are:
0x20 - fine (LCK0 bit in PLLSR)
0x40 - coarse (LCK1 bit in PLLSR)
zero / When non-zero, the startup code
non-zero initializes the Oscillator Trimming
register with the factory-mea-
sured value.
UWord32 When USE_FACTORY_TRIM is
non-zero, this macro may specify
required oscillator frequency. The
startup code then tries to achieve
this frequency by calculating
proper trimming value.
Targeting 56F8xxx Platform
WHEN UNDEFINED
Reset value used.
PLL is not set up by the
startup code.
Reset value used.
Reset value used.
Reset value used.
0x40 used.
Same as false. Trimming
does not occur.
The value of 8000000 is
used. The default fac-
tory-measured Trimming
Value is used, making the
resulting 8 MHz oscillator
clock.
5-7