metaonly module ti.bios.LOG

LOG module

legacy module to support DSP/BIOS 5.x, see DSP/BIOS 5.x docs for more info
Configuration settings sourced in ti/bios/LOG.xdc
var LOG = xdc.useModule('ti.bios.LOG');
module-wide config parameters
per-instance config parameters
    var params = new LOG.Params// Instance config-params object;
        params.bufLen// The length of the log buffer (in words) = UInt 64;
        params.bufSeg//  = MEM.Instance null;
        params.comment// Type a comment to identify this object = String "<add comments here>";
        params.dataType// This property is no longer supported = String undefined;
        params.exitFlush// Flush buffer on exit = Bool false;
        params.format// This property is no longer supported = String undefined;
        params.logType// The type of the log = String "circular";
        params.name// Specify the name of the object = String "";
per-instance creation
    var inst = LOG.create// Create an instance-object(String name, params);
 
 
config LOG.OBJMEMSEG  // module-wide

The memory segment that contains the LOG objects

Configuration settings
LOG.OBJMEMSEG = MEM.Instance null;
 
 
config LOG.TS  // module-wide

This property is no longer supported

Configuration settings
LOG.TS = Bool undefined;
 
 
config LOG.enableFlush  // module-wide

If set to true, it will allow LOGs to be flushed

Configuration settings
LOG.enableFlush = Bool false;
 
Instance Config Parameters

Configuration settings
var params = new LOG.Params;
// Instance config-params object
    params.bufLen = UInt 64;
    // The length of the log buffer (in words)
    params.bufSeg = MEM.Instance null;
    // 
    params.comment = String "<add comments here>";
    // Type a comment to identify this object
    params.dataType = String undefined;
    // This property is no longer supported
    params.exitFlush = Bool false;
    // Flush buffer on exit
    params.format = String undefined;
    // This property is no longer supported
    params.logType = String "circular";
    // The type of the log
    params.name = String "";
    // Specify the name of the object
 
config LOG.bufLen  // instance

The length of the log buffer (in words)

Configuration settings
var params = new LOG.Params;
  ...
params.bufLen = UInt 64;
 
 
config LOG.bufSeg  // instance
Configuration settings
var params = new LOG.Params;
  ...
params.bufSeg = MEM.Instance null;
 
 
config LOG.comment  // instance

Type a comment to identify this object

Configuration settings
var params = new LOG.Params;
  ...
params.comment = String "<add comments here>";
 
 
config LOG.dataType  // instance

This property is no longer supported

Configuration settings
var params = new LOG.Params;
  ...
params.dataType = String undefined;
 
 
config LOG.exitFlush  // instance

Flush buffer on exit

Configuration settings
var params = new LOG.Params;
  ...
params.exitFlush = Bool false;
 
 
config LOG.format  // instance

This property is no longer supported

Configuration settings
var params = new LOG.Params;
  ...
params.format = String undefined;
 
 
config LOG.logType  // instance

The type of the log

Configuration settings
var params = new LOG.Params;
  ...
params.logType = String "circular";
 
 
config LOG.name  // instance

Specify the name of the object

Configuration settings
var params = new LOG.Params;
  ...
params.name = String "";
 
Instance Creation

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