PIP_free
Application Program Interface
2-273
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
PIP_free(pipe);
Parameters
PIP_Handle pipe;
/* pipe object handle */
Return Value
Void
Reentrant
no
Description
PIP_free releases a frame after you have read the frame with PIP_get.
The frame is recycled so that PIP_alloc can reuse it.
After PIP_free releases the frame, it runs the function specified by the
notifyWriter property of the PIP object. This function should notify (for
example, by calling SWI_andnHook) the object that writes to this pipe
that an empty frame is available. The notifyWriter function is performed
as part of the thread that called PIP_free or PIP_alloc. To avoid problems
with recursion, the notifyWriter function should not directly call any of the
PIP module functions for the same pipe.
Constraints and
Calling Context
❏
When called within an HWI, the code sequence calling PIP_free must
be either wrapped within an HWI_enter/HWI_exit pair or invoked by
the HWI dispatcher.
Example
See the example for PIP_alloc, page 2–271. The example for
HST_getpipe, page 2–147, also uses a pipe with host channel objects.
See Also
PIP_alloc
PIP_get
PIP_put
HST_getpipe
PIP_free
Recycle a frame that has been read to a pipe