metaonly module ti.sdo.ce.ipc.bios.Ipc

BIOS ipc settings

XDCspec summary sourced in ti/sdo/ce/ipc/bios/Ipc.xdc
metaonly module Ipc {  ...
// inherits ti.sdo.ce.ipc.IIpc
XDCscript usage meta-domain
var Ipc = xdc.useModule('ti.sdo.ce.ipc.bios.Ipc');
module-wide constants & types
        const Ipc.BootAndLoadDsp;
        const Ipc.BootDspAutonomously;
        const Ipc.None;
 
        obj.memTable = IIpc.ArmDspLinkConfigMemTableEntry[string]  ...
        obj.doPowerControl = Bool  ...
        obj.dspManagement = IIpc.DspManagement  ...
 
        obj.addr = UInt32  ...
        obj.gppAddr = UInt32  ...
        obj.size = UInt32  ...
        obj.type = String  ...
module-wide config parameters
 
XDCspec declarations sourced in ti/sdo/ce/ipc/bios/Ipc.xdc
 
metaonly module Ipc inherits IIpc {
module-wide constants & types
        BootAndLoadDsp,
        BootDspAutonomously,
        None
    };
 
        IIpc.ArmDspLinkConfigMemTableEntry memTable[string];
        Bool doPowerControl;
        IIpc.DspManagement dspManagement;
    };
 
        UInt32 addr;
        UInt32 gppAddr;
        UInt32 size;
        String type;
    };
module-wide config parameters
    config Bool usePowerManagement// Enable power Management = false;
}
 
enum Ipc.DspManagement

Value for controlling DSP from ARM w/ DspLink

XDCscript usage meta-domain
values of type Ipc.DspManagement
    const Ipc.BootAndLoadDsp;
    const Ipc.BootDspAutonomously;
    const Ipc.None;
 
VALUES
BootAndLoadDsp — DspLink boots DSP and loads executable
BootDspAutonomously — DspLink boots DSP w/o loading executable
None — DspLink neither boots DSP nor loads executable
 
struct Ipc.ArmDspLinkConfig

Configuration for the DspLink on the Arm side

XDCscript usage meta-domain
var obj = new Ipc.ArmDspLinkConfig;
 
    obj.memTable = IIpc.ArmDspLinkConfigMemTableEntry[string]  ...
    obj.doPowerControl = Bool  ...
    obj.dspManagement = IIpc.DspManagement  ...
 
FIELDS
memTable — Memory table, describing all DSP segments. NOTE: segments "DDR2" (or whatever is the name of the main segment), "DSPLINKMEM", and "RESETCTRL" must be present
doPowerControl — Flag indicating if Link should implement power control of DSP.
dspManagement — Flag indicating how Link should boot/load DSP
DETAILS
Of the many fields that Link exposes for configuration, selected ones are exposed through this interface.
 
struct Ipc.ArmDspLinkConfigMemTableEntry

Description of one DSP memory segment entry

XDCscript usage meta-domain
var obj = new Ipc.ArmDspLinkConfigMemTableEntry;
 
    obj.addr = UInt32  ...
    obj.gppAddr = UInt32  ...
    obj.size = UInt32  ...
    obj.type = String  ...
 
FIELDS
addr — The beginning address of the segment
gppAddr — The GPP physical address of the segment (when needed)
size — Size of the segment in bytes
type — One of the following types: "main" -- main code/data segment (i.e. DDR2) "link" -- DSPLINKMEM segment "reset" -- RESETCTRL segment "poolmem" -- POOLMEM segment "code" -- dsp code/data, must map into GPP space "other" -- anything else
 
config Ipc.armCommMsgSize  // module-wide

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

XDCscript usage meta-domain
Ipc.armCommMsgSize = UInt32 4 * 1024;
 
DETAILS
Applies only to configurations where DSP Link is used.
 
config Ipc.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
Ipc.dspCommNumMsgQueues = UInt32 64;
 
DETAILS
Applies only to configurations where runtimeEnv == DSPBIOS or runtimeEnv == DSPLINK_BIOS
 
config Ipc.dspCommUseExactMatch  // module-wide

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

XDCscript usage meta-domain
Ipc.dspCommUseExactMatch = Bool true;
 
DETAILS
Applies only to configurations where DSP Link is used.
 
config Ipc.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
Ipc.dspConfigureMsgqAndPool = Bool true;
 
 
config Ipc.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
Ipc.dspUseMsgqAndPool = Bool true;
 
DETAILS
Must be set to true if DSP Link is used.
 
config Ipc.powerSaveMemoryBlockName  // module-wide

Memory segment name for context save/restore

XDCscript usage meta-domain
Ipc.powerSaveMemoryBlockName = String null;
 
DETAILS
The name of the segment to which power should be saved; if left null, will default to defaultMemSegId.
This feature may not be available on all devices.
 
config Ipc.usePowerManagement  // module-wide

Enable power Management

XDCscript usage meta-domain
Ipc.usePowerManagement = Bool false;
 
DETAILS
If set to true, will attempt to include power-management code where applicable.
This feature may not be available on all devices.
generated on Mon, 20 Sep 2010 23:50:20 GMT