PIP_getWriterSize
2-280
Important Note:
This API 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.
C Interface
Syntax
num = PIP_getWriterSize(pipe);
Parameters
PIP_Handle pipe;
/* pipe object handle*/
Return Value
Uns
num;
/* num of words to be written in empty frame */
Reentrant
yes
Description
PIP_getWriterSize is a C function that returns the value of the writerSize
element of a pipe object.
As a function writes to a pipe, it can use PIP_getWriterSize to determine
the maximum number words that can be written to a pipe frame.
Example
if (PIP_getWriterNumFrames(rxPipe) > 0) {
PIP_alloc(rxPipe);
DSS_rxPtr = PIP_getWriterAddr(rxPipe);
DSS_rxCnt = PIP_getWriterSize(rxPipe);
}
PIP_getWriterSize
Get the number of words that can be written to a pipe frame