Configuration Items - Freescale Semiconductor DSP56800E User Manual

None
5.10.2.2

Configuration Items

This section summarizes the symbols used in macro definitions for the static ADC module
configuration by the driver initialization routine. ADC_x should be replaced by ADC_0 for the
ADC 0 module and ADC_1 for the ADC 1 module. Configuration symbols are intended for the
application (project) specific configuration file appconfig.h.
ADC_x_ADCSC1A_INIT
ADC_x_ADCSC1B_INIT
ADC_x_ADCSC2_INIT
ADC_x_ADCCFG_INIT
5.10.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 ADC device modes or accesses the ADC register(s).
The third ioctl parameter is either a value or a pointer, depending on the type of cmd.
5-434
Table 5-341. ADC Configuration Items for appconfig.h
SYMBOL
Targeting 56F8xxx Platform
TYPE DESCRIPTION
UWord16 The initial value of the ADC Sta-
tus and Control Register 1A.
UWord16 The initial value of the ADC Sta-
tus and Control Register 1B.
UWord16 The initial value of the ADC Sta-
tus and Control Register 2.
UWord16 The initial value of the ADC con-
figuration Register.
FREESCALE SEMICONDUCTOR