module ti.sdo.ipc.transports.TransportShmSetup
index URL

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
#include <ti/sdo/ipc/transports/TransportShmSetup.h>
Functions common to all ITransportSetup modules
Int 
TransportShmSetup_attach// Function that will be called in MessageQ_attach(UInt16 remoteProcId, Ptr sharedAddr);
Int 
TransportShmSetup_detach// Function that will be called in MessageQ_detach(UInt16 remoteProcId);
Bool 
TransportShmSetup_isRegistered// Determines if a transport has been registered to a remote processor(UInt16 remoteProcId);
SizeT 
TransportShmSetup_sharedMemReq// Shared memory required(Ptr sharedAddr);
Functions common to all target modules
TransportShmSetup_Module_getMask// Returns the diagnostics mask for this module, TransportShmSetup_Module_hasMask// Test whether this module has a diagnostics mask, TransportShmSetup_Module_heap// The heap from which this module allocates memory, TransportShmSetup_Module_id// Get this module's unique id, TransportShmSetup_Module_setMask// Set the diagnostics mask for this module, TransportShmSetup_Module_startupDone// Test if this module has completed startup
Constants
extern const UInt 
TransportShmSetup_priority// priority of the transport;
 
 
config TransportShmSetup_priority  // module-wide
index URL

priority of the transport

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

Function that will be called in MessageQ_attach

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

Function that will be called in MessageQ_detach

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

Determines if a transport has been registered to a remote processor

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

Shared memory required

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

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
 
Configuration settings sourced in ti/sdo/ipc/transports/TransportShmSetup.xdc
var TransportShmSetup = xdc.useModule('ti.sdo.ipc.transports.TransportShmSetup');
module-wide config parameters
    TransportShmSetup.priority// priority of the transport = UInt 0;
 
    TransportShmSetup.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config TransportShmSetup.priority  // module-wide
index URL

priority of the transport

Configuration settings
TransportShmSetup.priority = UInt 0;
 
C SYNOPSIS
TransportShmSetup_priority
 
metaonly config TransportShmSetup.common$  // module-wide
index URL

Common module configuration parameters

Configuration settings
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 Thu, 29 Jan 2015 19:16:35 GMT