module ti.sdo.ipc.transports.TransportShmCircSetup

Manages the setup of TransportShmCirc instances

create or open the TransportShmCirc for each pair of devices.
C synopsis target-domain sourced in ti/sdo/ipc/transports/TransportShmCircSetup.xdc
 
config TransportShmCircSetup_priority  // module-wide

priority of the transport

C synopsis target-domain
extern const UInt TransportShmCircSetup_priority;
 
 
TransportShmCircSetup_attach()  // module-wide

Function that will be called in MessageQ_attach

C synopsis target-domain
Int TransportShmCircSetup_attach(UInt16 remoteProcId, Ptr sharedAddr);
 
 
TransportShmCircSetup_detach()  // module-wide

Function that will be called in MessageQ_detach

C synopsis target-domain
Int TransportShmCircSetup_detach(UInt16 remoteProcId);
 
 
TransportShmCircSetup_isRegistered()  // module-wide

Determines if a transport has been registered to a remote processor

C synopsis target-domain
Bool TransportShmCircSetup_isRegistered(UInt16 remoteProcId);
 
 
TransportShmCircSetup_sharedMemReq()  // module-wide

Shared memory required

C synopsis target-domain
SizeT TransportShmCircSetup_sharedMemReq(Ptr sharedAddr);
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId TransportShmCircSetup_Module_id();
// Get this module's unique id
 
Bool TransportShmCircSetup_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle TransportShmCircSetup_Module_heap();
// The heap from which this module allocates memory
 
Bool TransportShmCircSetup_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 TransportShmCircSetup_Module_getMask();
// Returns the diagnostics mask for this module
 
Void TransportShmCircSetup_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/transports/TransportShmCircSetup.xdc
var TransportShmCircSetup = xdc.useModule('ti.sdo.ipc.transports.TransportShmCircSetup');
module-wide config parameters
 
 
 
config TransportShmCircSetup.priority  // module-wide

priority of the transport

XDCscript usage meta-domain
TransportShmCircSetup.priority = UInt 0;
 
C SYNOPSIS
 
metaonly config TransportShmCircSetup.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
TransportShmCircSetup.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 Sat, 11 Feb 2012 00:38:12 GMT