Api Specification - Freescale Semiconductor DSP56800E User Manual

Hide thumbs Also See for DSP56800E:

Table of Contents

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.

ioctl call(s):

The ioctl call (macro) is generally represented in the following forms:

Word32 ioctl(const int *pModuleBase, void Cmd, void param);

Word16 ioctl(const int *pModuleBase, void Cmd, void param);

void ioctl(const int *pModuleBase, void Cmd, void param);

Description: The ioctl call "changes" IIC device modes or accesses the IIC register(s). Keep in

mind that ioctl is treated as macro that is in result mostly compiled to an optimal inline code.

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 )

IIC_SET_ADDRESS

FREESCALE SEMICONDUCTOR

Table 5-646. IIC Driver Arguments - ioctl

Table 5-647. IIC Module ioctl Commands

Targeting 56F8xxx Platform

IIC module identifier. Use IIC.

Command names found in iic.h. See

Table 5-647.

Used to pass the relevant data to ioctl

Initializes the IIC module using the

appconfig.h values.

Set the slave address of the IIC Bus

Table of Contents