Api Specification - Freescale Semiconductor DSP56800E User Manual

5.5.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* param);
Description: The ioctl call "changes" the modes of the SYS module or accesses the SYS
register(s).
Arguments:
pModuleBase
cmd
param
Items Separators Convention:
/ only one of the specified items is allowed
| consolidation of items is allowed ( item1 | item2 | item3 )
& intersection of items is allowed ( item1 & item2 & item3 )
Cmd
SYS_INIT
5-136
Table 5-98. SYS Driver Arguments - ioctl
in SYS module identifier. Use SYS.
Power Supervisor module identifier. Use LVI.
External Memory Interface module identifier. Use SEMI.
in Commands found in sys.h which are used to modify the
SYS/LVI/SEMI module status and control registers. See
Table 5-99.
in, inout Used to pass the relevant data to ioctl function call.
Table 5-99. ioctl commands
param
NULL
Targeting 56F8xxx Platform
Return Description
None Initializes SYS (SIM and LVI)
modules using the data from con-
figuration file (appconfig.h).
FREESCALE SEMICONDUCTOR