PIP Module
Application Program Interface
2-269
The following properties can be set for a PIP object in the PIP Object
Properties dialog of the DSP/BIOS Configuration Tool or in a Tconf script:
❏
comment
. Type a comment to identify this PIP object.
Tconf Name: comment
Type: String
Example:
myPip.comment = "my PIP";
❏
bufseg
. The memory segment that the buffer is allocated within; all
frames are allocated from a single contiguous buffer (of size
framesize x numframes).
Tconf Name: bufSeg
Type: Reference
Example:
myPip.bufSeg = prog.get("myMEM");
❏
bufalign
. The alignment (in words) of the buffer allocated within the
specified memory segment.
Tconf Name: bufAlign
Type: Int16
Example:
myPip.bufAlign = 1;
❏
framesize
. The length of each frame (in words)
Tconf Name: frameSize
Type: Int16
Example:
myPip.frameSize = 8;
❏
numframes
. The number of frames
Tconf Name: numFrames
Type: Int16
Example:
myPip.numFrames = 2;
❏
monitor
. The end of the pipe to be monitored by a hidden STS
object. Can be set to reader, writer, or nothing. In the Statistics View
analysis tool, your choice determines whether the STS display for
this pipe shows a count of the number of frames handled at the
reader or writer end of the pipe.
Tconf Name: monitor
Type: EnumString
Options:
"reader", "writer", "none"
Example:
myPip.monitor = "reader";
❏
notifyWriter
. The function to execute when a frame of free space is
available. 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