module ti.sdo.ipc.transports.TransportShmSetup

Manages the setup of TransportShm instances

create() or open() the TransportShm for each pair of devices.
C synopsis target-domain sourced in ti/sdo/ipc/transports/TransportShmSetup.xdc
 
config TransportShmSetup_priority  // module-wide

priority of the transport

C synopsis target-domain
extern const UInt TransportShmSetup_priority;
 
 
TransportShmSetup_attach()  // module-wide

Function that will be called in MessageQ_attach

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

Function that will be called in MessageQ_detach

C synopsis target-domain
Int TransportShmSetup_detach(UInt16 remoteProcId);
 
 
TransportShmSetup_isRegistered()  // module-wide

Determines if a transport has been registered to a remote processor

C synopsis target-domain
Bool TransportShmSetup_isRegistered(UInt16 remoteProcId);
 
 
TransportShmSetup_sharedMemReq()  // module-wide

Shared memory required

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

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

priority of the transport

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

Common module configuration parameters

XDCscript usage meta-domain
TransportShmSetup.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