metaonly module ti.bios.UDEV
index URL

UDEV Manager

Used to create User defined devices. [ more ... ]
XDCspec summary sourced in ti/bios/UDEV.xdc
metaonly module UDEV {  ...
instance:  ...
XDCscript usage meta-domain
var UDEV = xdc.useModule('ti.bios.UDEV');
per-instance config parameters
    var params = new UDEV.Params// Instance config-params object;
        params.comment// Comment to describe the user device = String null;
        params.deviceGlobalDataPtr// Global device data pointer = Ptr 0;
        params.deviceId// The device id = Ptr null;
        params.fxnTable// The name of the device functions table for the driver or mini-driver = String null;
        params.fxnTableType// Type of function table used by the driver to which this device interfaces = String "DEV_Fxns";
        params.initFxn// The function to run to initialize this device = String null;
        params.name// Name of the user device = String "";
        params.params// Additional params to the device = Ptr null;
        params.stackingDevice//  = Bool false;
per-instance creation
    var inst = UDEV.create// Create an instance-object( String name, params );
 
XDCspec declarations sourced in ti/bios/UDEV.xdc
package ti.bios;
 
metaonly module UDEV {
 
 
instance:
per-instance config parameters
    config String comment// Comment to describe the user device = null;
    config Ptr deviceGlobalDataPtr// Global device data pointer = 0;
    config Ptr deviceId// The device id = null;
    config String fxnTable// The name of the device functions table for the driver or mini-driver = null;
    config String fxnTableType// Type of function table used by the driver to which this device interfaces = "DEV_Fxns";
    config String initFxn// The function to run to initialize this device = null;
    config String name// Name of the user device = "";
    config Ptr params// Additional params to the device = null;
per-instance creation
    create// Create an instance-object( String name );
}
DETAILS
Used to create User defined devices.
legacy module to support BIOS 5.x, see BIOS 5.x docs for more info
 
per-instance config parameters
index URL

XDCscript usage meta-domain
var params = new UDEV.Params;
// Instance config-params object
    params.comment = String null;
    // Comment to describe the user device
    params.deviceGlobalDataPtr = Ptr 0;
    // Global device data pointer
    params.deviceId = Ptr null;
    // The device id
    params.fxnTable = String null;
    // The name of the device functions table for the driver or mini-driver
    params.fxnTableType = String "DEV_Fxns";
    // Type of function table used by the driver to which this device interfaces
    params.initFxn = String null;
    // The function to run to initialize this device
    params.name = String "";
    // Name of the user device
    params.params = Ptr null;
    // Additional params to the device
    params.stackingDevice = Bool false;
    // 
 
config UDEV.comment  // per-instance
index URL

Comment to describe the user device

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.comment = String null;
 
 
config UDEV.deviceGlobalDataPtr  // per-instance
index URL

Global device data pointer

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.deviceGlobalDataPtr = Ptr 0;
 
DETAILS
The purpose of such a value is driver-specific.
The default is NULL.
 
config UDEV.deviceId  // per-instance
index URL

The device id

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.deviceId = Ptr null;
 
DETAILS
The purpose of such a value is driver-specific.
The default is NULL.
 
config UDEV.fxnTable  // per-instance
index URL

The name of the device functions table for the driver or mini-driver

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.fxnTable = String null;
 
DETAILS
The default is NULL.
 
config UDEV.fxnTableType  // per-instance
index URL

Type of function table used by the driver to which this device interfaces

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.fxnTableType = String "DEV_Fxns";
 
DETAILS
The options are "DEV_Fxns" or "IOM_Fxns".
The default is "DEV_Fxns".
 
config UDEV.initFxn  // per-instance
index URL

The function to run to initialize this device

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.initFxn = String null;
 
DETAILS
The default is NULL.
 
config UDEV.name  // per-instance
index URL

Name of the user device

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.name = String "";
 
 
config UDEV.params  // per-instance
index URL

Additional params to the device

XDCscript usage meta-domain
var params = new UDEV.Params;
  ...
params.params = Ptr null;
 
DETAILS
The purpose of such a value is driver-specific.
The default is NULL.
 
per-instance creation
index URL

XDCscript usage meta-domain
var params = new UDEV.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = UDEV.create( String name, params );
// Create an instance-object
generated on Mon, 21 Dec 2009 19:43:46 GMT