Api Specification - Freescale Semiconductor DSP56800E User Manual

Table 5-856. MSCAN Configuration Items for appconfig.h (Continued)
SYMBOL
MSCAN_CANIDMR0_INIT
MSCAN_CANIDMR1_INIT
MSCAN_CANIDMR2_INIT
MSCAN_CANIDMR3_INIT
MSCAN_CANIDMR4_INIT
MSCAN_CANIDMR5_INIT
MSCAN_CANIDMR6_INIT
MSCAN_CANIDMR7_INIT
5.25.2.5

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 MSCAN device modes or accesses the MSCAN
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-1014
TYPE
UWord16 The initial values of the MSCAN Identifier Mask Registers
0-7.
Table 5-857. MSCAN Driver Arguments - ioctl
in
in
in, inout
Targeting 56F8xxx Platform
DESCRIPTION
MSCAN module identifier. Use MSCAN.
Commands found in mscan.h which are
used to modify the MSCAN module status
and control registers. See Table 5-858.
Used to pass the relevant data to ioctl
function call.
FREESCALE SEMICONDUCTOR