PIP Module
Application Program Interface
2-265
2.17
PIP Module
Important Note:
The PIP module is being deprecated and will no
longer be supported in the next major release of DSP/BIOS. We
recommend that you use the SIO module instead. The PIP module is
still supported in DSP/BIOS 5.32 and will be supported in any patch
releases or minor enhancements to DSP/BIOS 5.32.
The PIP module is the buffered pipe manager.
Functions
❏
PIP_alloc. Get an empty frame from the pipe.
❏
PIP_free. Recycle a frame back to the pipe.
❏
PIP_get. Get a full frame from the pipe.
❏
PIP_getReaderAddr. Get the value of the readerAddr pointer of the
pipe.
❏
PIP_getReaderNumFrames. Get the number of pipe frames
available for reading.
❏
PIP_getReaderSize. Get the number of words of data in a pipe
frame.
❏
PIP_getWriterAddr. Get the value of the writerAddr pointer of the
pipe.
❏
PIP_getWriterNumFrames. Get the number of pipe frames available
to write to.
❏
PIP_getWriterSize. Get the number of words that can be written to a
pipe frame.
❏
PIP_peek. Get the pipe frame size and address without actually
claiming the pipe frame.
❏
PIP_put. Put a full frame into the pipe.
❏
PIP_reset. Reset all fields of a pipe object to their original values.
❏
PIP_setWriterSize. Set the number of valid words written to a pipe
frame.
PIP_Obj Structure
Members
❏
Ptr readerAddr
. Pointer to the address to begin reading from after
calling PIP_get.
❏
Uns readerSize
. Number of words of data in the frame read with
PIP_get.
❏
Uns readerNumFrames
. Number of frames available to be read.