metaonly module ti.bios.PIP
index URL

PIP module

legacy module to support DSP/BIOS 5.x, see DSP/BIOS 5.x docs for more info
Configuration settings sourced in ti/bios/PIP.xdc
var PIP = xdc.useModule('ti.bios.PIP');
module-wide config parameters
    PIP.OBJMEMSEG// This property is no longer supported = MEM.Instance null;
per-instance config parameters
    var params = new PIP.Params// Instance config-params object;
        params.bufAlign// Buffer alignment = UInt 1;
        params.bufSeg// Segment for PIP buffers = MEM.Instance null;
        params.comment// This property is no longer supported = String undefined;
        params.frameSize// Frame size in minimum addressable units = UInt 0;
        params.monitor// This property is no longer supported = String undefined;
        params.notifyReaderArg0// Argument 1 for notifyReaderFxn = UArg 0;
        params.notifyReaderArg1// Argument 2 for notifyReaderFxn = UArg 0;
        params.notifyReaderFxn// Function to notify when a frame of data is available = String null;
        params.notifyWriterArg0// Argument 1 for notifyWriterFxn = UArg 0;
        params.notifyWriterArg1// Argument 2 for notifyWriterFxn = UArg 0;
        params.notifyWriterFxn// Function to execute when a frame of free space is available = String null;
        params.numFrames// Number of frames = UInt 2;
per-instance creation
    var inst = PIP.create// Create an instance-object(String name, params);
 
 
config PIP.OBJMEMSEG  // module-wide
index URL

This property is no longer supported

Configuration settings
PIP.OBJMEMSEG = MEM.Instance null;
 
Instance Config Parameters
index URL

Configuration settings
var params = new PIP.Params;
// Instance config-params object
    params.bufAlign = UInt 1;
    // Buffer alignment
    params.bufSeg = MEM.Instance null;
    // Segment for PIP buffers
    params.comment = String undefined;
    // This property is no longer supported
    params.frameSize = UInt 0;
    // Frame size in minimum addressable units
    params.monitor = String undefined;
    // This property is no longer supported
    params.notifyReaderArg0 = UArg 0;
    // Argument 1 for notifyReaderFxn
    params.notifyReaderArg1 = UArg 0;
    // Argument 2 for notifyReaderFxn
    params.notifyReaderFxn = String null;
    // Function to notify when a frame of data is available
    params.notifyWriterArg0 = UArg 0;
    // Argument 1 for notifyWriterFxn
    params.notifyWriterArg1 = UArg 0;
    // Argument 2 for notifyWriterFxn
    params.notifyWriterFxn = String null;
    // Function to execute when a frame of free space is available
    params.numFrames = UInt 2;
    // Number of frames
 
config PIP.bufAlign  // instance
index URL

Buffer alignment

Configuration settings
var params = new PIP.Params;
  ...
params.bufAlign = UInt 1;
 
 
config PIP.bufSeg  // instance
index URL

Segment for PIP buffers

Configuration settings
var params = new PIP.Params;
  ...
params.bufSeg = MEM.Instance null;
 
 
config PIP.comment  // instance
index URL

This property is no longer supported

Configuration settings
var params = new PIP.Params;
  ...
params.comment = String undefined;
 
 
config PIP.frameSize  // instance
index URL

Frame size in minimum addressable units

Configuration settings
var params = new PIP.Params;
  ...
params.frameSize = UInt 0;
 
 
config PIP.monitor  // instance
index URL

This property is no longer supported

Configuration settings
var params = new PIP.Params;
  ...
params.monitor = String undefined;
 
 
config PIP.notifyReaderArg0  // instance
index URL

Argument 1 for notifyReaderFxn

Configuration settings
var params = new PIP.Params;
  ...
params.notifyReaderArg0 = UArg 0;
 
 
config PIP.notifyReaderArg1  // instance
index URL

Argument 2 for notifyReaderFxn

Configuration settings
var params = new PIP.Params;
  ...
params.notifyReaderArg1 = UArg 0;
 
 
config PIP.notifyReaderFxn  // instance
index URL

Function to notify when a frame of data is available

Configuration settings
var params = new PIP.Params;
  ...
params.notifyReaderFxn = String null;
 
 
config PIP.notifyWriterArg0  // instance
index URL

Argument 1 for notifyWriterFxn

Configuration settings
var params = new PIP.Params;
  ...
params.notifyWriterArg0 = UArg 0;
 
 
config PIP.notifyWriterArg1  // instance
index URL

Argument 2 for notifyWriterFxn

Configuration settings
var params = new PIP.Params;
  ...
params.notifyWriterArg1 = UArg 0;
 
 
config PIP.notifyWriterFxn  // instance
index URL

Function to execute when a frame of free space is available

Configuration settings
var params = new PIP.Params;
  ...
params.notifyWriterFxn = String null;
 
 
config PIP.numFrames  // instance
index URL

Number of frames

Configuration settings
var params = new PIP.Params;
  ...
params.numFrames = UInt 2;
 
Instance Creation
index URL

Configuration settings
var params = new PIP.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = PIP.create(String name, params);
// Create an instance-object
generated on Sat, 11 May 2013 02:22:25 GMT