module ti.uia.runtime.MultiCoreTypes
C synopsis target-domain sourced in ti/uia/runtime/MultiCoreTypes.xdc
 
const MultiCoreTypes_MASTERNAME

Master's message queue names

C synopsis target-domain
#define MultiCoreTypes_MASTERNAME (String)"uiaMaster"
 
 
const MultiCoreTypes_MASTERSTARTED

Master's Started message queue names

C synopsis target-domain
#define MultiCoreTypes_MASTERSTARTED (String)"uiaStarted"
 
 
const MultiCoreTypes_SLAVENAME

Prefix for slave's message queue names

C synopsis target-domain
#define MultiCoreTypes_SLAVENAME (String)"uiaSlave"
 
 
enum MultiCoreTypes_Action

The different Actions for router MessageQ

C synopsis target-domain
typedef enum MultiCoreTypes_Action {
    MultiCoreTypes_Action_TOHOST,
    MultiCoreTypes_Action_FROMHOST,
    MultiCoreTypes_Action_REGISTER,
    MultiCoreTypes_Action_STOP,
    MultiCoreTypes_Action_STOPACK
} MultiCoreTypes_Action;
 
 
struct MultiCoreTypes_RegisterMsg

Internal register function

C synopsis target-domain
typedef struct MultiCoreTypes_RegisterMsg {
    Char msgHdr[32];
    UInt32 remoteMQ;
} MultiCoreTypes_RegisterMsg;
 
 
struct MultiCoreTypes_ServiceHdr
C synopsis target-domain
typedef struct MultiCoreTypes_ServiceHdr {
    Char msgHdr[32];
    UIAPacket_Hdr packet;
} MultiCoreTypes_ServiceHdr;
 
 
config MultiCoreTypes_A_invalidHdrType  // module-wide

Assert raised an invalid HdrType is specified

C synopsis target-domain
extern const Assert_Id MultiCoreTypes_A_invalidHdrType;
 
 
config MultiCoreTypes_A_ipcFailed  // module-wide

Assert raised when a MessageQ call fails

C synopsis target-domain
extern const Assert_Id MultiCoreTypes_A_ipcFailed;
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId MultiCoreTypes_Module_id();
// Get this module's unique id
 
Bool MultiCoreTypes_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle MultiCoreTypes_Module_heap();
// The heap from which this module allocates memory
 
Bool MultiCoreTypes_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 MultiCoreTypes_Module_getMask();
// Returns the diagnostics mask for this module
 
Void MultiCoreTypes_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/uia/runtime/MultiCoreTypes.xdc
var MultiCoreTypes = xdc.useModule('ti.uia.runtime.MultiCoreTypes');
module-wide constants & types
 
        const MultiCoreTypes.Action_TOHOST;
        const MultiCoreTypes.Action_FROMHOST;
        const MultiCoreTypes.Action_REGISTER;
        const MultiCoreTypes.Action_STOP;
        const MultiCoreTypes.Action_STOPACK;
 
        obj.msgHdr = Char[32]  ...
        obj.remoteMQ = UInt32  ...
 
    var obj = new MultiCoreTypes.ServiceHdr// ;
        obj.msgHdr = Char[32]  ...
        obj.packet = UIAPacket.Hdr  ...
module-wide config parameters
        msg: "A_invalidHdrType: Invalid HdrType specified"
    };
        msg: "A_ipcFailed: Unexpected MessageQ failed"
    };
 
 
 
const MultiCoreTypes.MASTERNAME

Master's message queue names

XDCscript usage meta-domain
const MultiCoreTypes.MASTERNAME = "uiaMaster";
 
C SYNOPSIS
 
const MultiCoreTypes.MASTERSTARTED

Master's Started message queue names

XDCscript usage meta-domain
const MultiCoreTypes.MASTERSTARTED = "uiaStarted";
 
C SYNOPSIS
 
const MultiCoreTypes.SLAVENAME

Prefix for slave's message queue names

XDCscript usage meta-domain
const MultiCoreTypes.SLAVENAME = "uiaSlave";
 
C SYNOPSIS
 
enum MultiCoreTypes.Action

The different Actions for router MessageQ

XDCscript usage meta-domain
values of type MultiCoreTypes.Action
    const MultiCoreTypes.Action_TOHOST;
    const MultiCoreTypes.Action_FROMHOST;
    const MultiCoreTypes.Action_REGISTER;
    const MultiCoreTypes.Action_STOP;
    const MultiCoreTypes.Action_STOPACK;
 
C SYNOPSIS
 
struct MultiCoreTypes.RegisterMsg

Internal register function

XDCscript usage meta-domain
var obj = new MultiCoreTypes.RegisterMsg;
 
    obj.msgHdr = Char[32]  ...
    obj.remoteMQ = UInt32  ...
 
C SYNOPSIS
 
struct MultiCoreTypes.ServiceHdr
XDCscript usage meta-domain
var obj = new MultiCoreTypes.ServiceHdr;
 
    obj.msgHdr = Char[32]  ...
    obj.packet = UIAPacket.Hdr  ...
 
C SYNOPSIS
 
config MultiCoreTypes.A_invalidHdrType  // module-wide

Assert raised an invalid HdrType is specified

XDCscript usage meta-domain
MultiCoreTypes.A_invalidHdrType = Assert.Desc {
    msg: "A_invalidHdrType: Invalid HdrType specified"
};
 
C SYNOPSIS
 
config MultiCoreTypes.A_ipcFailed  // module-wide

Assert raised when a MessageQ call fails

XDCscript usage meta-domain
MultiCoreTypes.A_ipcFailed = Assert.Desc {
    msg: "A_ipcFailed: Unexpected MessageQ failed"
};
 
C SYNOPSIS
 
metaonly config MultiCoreTypes.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
MultiCoreTypes.common$ = Types.Common$ undefined;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
generated on Mon, 28 Jan 2013 17:45:45 GMT