metaonly module ti.bios.PIP
index URL

PIP module

legacy module to support BIOS 5.x, see BIOS 5.x docs for more info
XDCspec summary sourced in ti/bios/PIP.xdc
metaonly module PIP {  ...
instance:  ...
XDCscript usage meta-domain
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.name//  = String "";
        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 );
 
XDCspec declarations sourced in ti/bios/PIP.xdc
package ti.bios;
 
metaonly module PIP {
module-wide config parameters
    config MEM.Instance OBJMEMSEG// This property is no longer supported = null;
 
 
instance:
per-instance config parameters
    config UInt bufAlign// Buffer alignment = 1;
    config MEM.Instance bufSeg// Segment for PIP buffers = null;
    config String comment// This property is no longer supported;
    config UInt frameSize// Frame size in minimum addressable units = 0;
    config String monitor// This property is no longer supported;
    config UArg notifyReaderArg0// Argument 1 for notifyReaderFxn = 0;
    config UArg notifyReaderArg1// Argument 2 for notifyReaderFxn = 0;
    config String notifyReaderFxn// Function to notify when a frame of data is available = null;
    config UArg notifyWriterArg0// Argument 1 for notifyWriterFxn = 0;
    config UArg notifyWriterArg1// Argument 2 for notifyWriterFxn = 0;
    config String notifyWriterFxn// Function to execute when a frame of free space is available = null;
    config UInt numFrames// Number of frames = 2;
per-instance creation
    create// Create an instance-object( String name );
}
 
config PIP.OBJMEMSEG  // module-wide
index URL

This property is no longer supported

XDCscript usage meta-domain
PIP.OBJMEMSEG = MEM.Instance null;
 
 
per-instance config parameters
index URL

XDCscript usage meta-domain
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.name = String "";
    // 
    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  // per-instance
index URL

Buffer alignment

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.bufAlign = UInt 1;
 
 
config PIP.bufSeg  // per-instance
index URL

Segment for PIP buffers

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.bufSeg = MEM.Instance null;
 
 
config PIP.comment  // per-instance
index URL

This property is no longer supported

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.comment = String undefined;
 
 
config PIP.frameSize  // per-instance
index URL

Frame size in minimum addressable units

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.frameSize = UInt 0;
 
 
config PIP.monitor  // per-instance
index URL

This property is no longer supported

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.monitor = String undefined;
 
 
config PIP.notifyReaderArg0  // per-instance
index URL

Argument 1 for notifyReaderFxn

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.notifyReaderArg0 = UArg 0;
 
 
config PIP.notifyReaderArg1  // per-instance
index URL

Argument 2 for notifyReaderFxn

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.notifyReaderArg1 = UArg 0;
 
 
config PIP.notifyReaderFxn  // per-instance
index URL

Function to notify when a frame of data is available

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.notifyReaderFxn = String null;
 
 
config PIP.notifyWriterArg0  // per-instance
index URL

Argument 1 for notifyWriterFxn

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.notifyWriterArg0 = UArg 0;
 
 
config PIP.notifyWriterArg1  // per-instance
index URL

Argument 2 for notifyWriterFxn

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.notifyWriterArg1 = UArg 0;
 
 
config PIP.notifyWriterFxn  // per-instance
index URL

Function to execute when a frame of free space is available

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.notifyWriterFxn = String null;
 
 
config PIP.numFrames  // per-instance
index URL

Number of frames

XDCscript usage meta-domain
var params = new PIP.Params;
  ...
params.numFrames = UInt 2;
 
 
per-instance creation
index URL

XDCscript usage meta-domain
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 Tue, 01 Sep 2009 00:36:03 GMT