Api Specification - Freescale Semiconductor DSP56800E User Manual

Hide thumbs Also See for DSP56800E:

Table of Contents

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 IIC device modes or accesses the IIC register(s). The

third ioctl parameter is either a value or a pointer, depending on the type of cmd.

param, pParam

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 )

FREESCALE SEMICONDUCTOR

Table 5-686. IIC Driver Arguments - ioctl

Table 5-687. ioctl commands

Targeting 56F8xxx Platform

IIC module identifier. Use IIC.

Commands found in iic.h which are used

to modify the IIC module status and con-

trol registers. See Table 5-687.

Used to pass the relevant data to ioctl

function call.

Initializes IIC module by data from

configuration file (appconfig.h).

Enables or disables IIC device.

Table of Contents