metaonly module ti.sdo.ce.osal.Global

Global OS Abstract Layer Configuration

XDCspec summary sourced in ti/sdo/ce/osal/Global.xdc
metaonly module Global {  ...
XDCscript usage meta-domain
var Global = xdc.useModule('ti.sdo.ce.osal.Global');
module-wide constants & types
        const Global.DSPBIOS// DSP/BIOS;
        const Global.LINUX// Linux;
        const Global.WINCE// Windows CE;
module-wide config parameters
    Global.logName// Name of buffer used for capturing benchmarking data = String "ti_sdo_ce_osal_LOG_Buffer";
 
XDCspec declarations sourced in ti/sdo/ce/osal/Global.xdc
package ti.sdo.ce.osal;
 
metaonly module Global {
module-wide constants & types
        DSPBIOS// DSP/BIOS,
        LINUX// Linux,
        WINCE// Windows CE,
    };
module-wide config parameters
    config String logName// Name of buffer used for capturing benchmarking data = "ti_sdo_ce_osal_LOG_Buffer";
}
 
enum Global.RuntimeEnv

All runtime OSs that are abstracted by this package

XDCscript usage meta-domain
values of type Global.RuntimeEnv
    const Global.NONE;
    // no OS; threads are not truly supported
    const Global.DSPBIOS;
    // DSP/BIOS
    const Global.LINUX;
    // Linux
    const Global.DSPLINK_BIOS;
    // DSPLINK + BIOS (DSP)
    const Global.DSPLINK_LINUX;
    // DSPLINK + Linux (Arm)
    const Global.WINCE;
    // Windows CE
    const Global.DSPLINK_WINCE;
    // DSPLINK + Windows CE (Arm)
 
SEE
 
config Global.armCommMsgSize  // module-wide

Default size for the Arm-DSP communication messages (MSGQ messages)

XDCscript usage meta-domain
Global.armCommMsgSize = UInt32 4 * 1024;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPLINK_LINUX
 
config Global.armCommNumMsgs  // module-wide

Number of <commMsgSize>-sized messages used for Arm-DSP communication

XDCscript usage meta-domain
Global.armCommNumMsgs = UInt32 64;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPLINK_LINUX
 
config Global.commLocateRetries  // module-wide

Number of times to retry Comm_locate() -- to find DSP server's MSGQ -- before giving up

XDCscript usage meta-domain
Global.commLocateRetries = Int 20;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPLINK_LINUX
 
config Global.defaultMemSegId  // module-wide

Default ID of the memory segment from which to allocate space (for Memory_alloc/free() calls, as opposed to Memory_segAlloc/Free()). Typically it's the segment where all other code and data go

XDCscript usage meta-domain
Global.defaultMemSegId = String null;
 
DETAILS
If left as "null", the system will try to find a BIOS segment named "DDR" or "DDR2" and assign its name to this field. In the future this auto-find feature may be removed, so it's best that user .cfg script set this value directly to what they know is appropriate segment.
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.dspCommNumMsgQueues  // module-wide

Number of message queues (that can receive and store messages) on the DSP side. Each DSP node (task) needs one message queue

XDCscript usage meta-domain
Global.dspCommNumMsgQueues = UInt32 64;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.dspCommUseExactMatch  // module-wide

Indicates that "exact match" must be used for comm messages allocated on the DSP side

XDCscript usage meta-domain
Global.dspCommUseExactMatch = Bool true;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPLINK_BIOS
 
config Global.dspConfigureMsgqAndPool  // module-wide

Set to true by default, instructs this module to generate code that configures BIOS MSGQ and POOL modules: symbols MSGQ_config and POOL_config. If set to false, and if BIOS is configured to use MSGQ, user application must define these symbols

XDCscript usage meta-domain
Global.dspConfigureMsgqAndPool = Bool true;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.dspUseMsgqAndPool  // module-wide

If set to false, instructs Codecs Engine to cut out MSGQ and POOL references completely from the final image

XDCscript usage meta-domain
Global.dspUseMsgqAndPool = Bool true;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPBIOS.
 
config Global.embedBuildInfo  // module-wide

Indication whether to embed build info (packages and their directories) into the generated executable for debugging/diagnostic purposes. Setting this to 'false' may reduce the static data size by around 1K. Applies to all configurations

XDCscript usage meta-domain
Global.embedBuildInfo = Bool true;
 
 
config Global.enableLogging  // module-wide

If set to true, enable data generation necessary for CE benchmarking analysis

XDCscript usage meta-domain
Global.enableLogging = Bool true;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.logName  // module-wide

Name of buffer used for capturing benchmarking data

XDCscript usage meta-domain
Global.logName = String "ti_sdo_ce_osal_LOG_Buffer";
 
DETAILS
In BIOS environments, this is the name of the BIOS LOG.
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.logSeg  // module-wide

Memory segment for the buffer used for capturing benchmarking data

XDCscript usage meta-domain
Global.logSeg = String null;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.logSize  // module-wide

Size of buffer used for capturing benchmarking data

XDCscript usage meta-domain
Global.logSize = Int 256;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.logType  // module-wide

Type of buffer used for capturing benchmarking data

XDCscript usage meta-domain
Global.logType = String "circular";
 
DETAILS
This can be either "fixed" or "circular".
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.os  // module-wide

A specific OSAL implementations "Settings" module, for example, ti.sdo.ce.osal.bios.Settings or ti.sdo.ce.osal.linux.Settings. To set the OS of the executable to BIOS, set Global.os to: xdc.useModule('ti.sdo.ce.osal.bios.Settings')

XDCscript usage meta-domain
Global.os = IOsal.Module undefined;
 
DETAILS
When this config param is used, the {@ link ti.sdo.ce.ipc.Settings#ipc config param must also be set.
This should only be used to explicitly configure the OSAL to a package not provided with Codec Engine. To use an OSAL provided by Codec Engine, it's recommended to configure the OSAL using the runtimeEnv config param instead of this one.
See {@ link http://wiki.davincidsp.com/index.php?title=CE_Config_Updates for more details}
SEE
 
config Global.powerSaveMemoryBlockName  // module-wide

The name of the segment to which power should be saved; if left null, will default to defaultMemSegId

XDCscript usage meta-domain
Global.powerSaveMemoryBlockName = String null;
 
DETAILS
This feature may not be available on all devices.
 
config Global.runtimeEnv  // module-wide

The runtime OS used to implement the abstractions provided by this package

XDCscript usage meta-domain
Global.runtimeEnv = Global.RuntimeEnv undefined;
 
SEE
 
config Global.traceBufferSize  // module-wide

Size of the server trace buffer, in MAUs

XDCscript usage meta-domain
Global.traceBufferSize = Int 32768;
 
DETAILS
The server trace buffer is a circular buffer of characters written to by clients of ti.sdo.ce.osal.Trace (and ti.sdo.utils.trace.GT) and read by the Engine_*Trace() methods.
All the trace data in the target memory is stored into a globally visible character buffer Char Global_traceBuffer[ <traceBufferSize> ];
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Global.useLinkArbiter  // module-wide

Control flag to indicate if Codec Engine should use the Link Arbiter Daemon (LAD) to arbitrate DSPLINK APIs that need arbitration. Set to false means LAD should not be used; set to true means LAD should be used

XDCscript usage meta-domain
Global.useLinkArbiter = Bool false;
 
DETAILS
This feature may not be available on all devices.
Applies only to configurations where runtimeEnv == DSPLINK_LINUX
generated on Mon, 20 Sep 2010 23:50:21 GMT