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

Manages the setup of TransportShmNotify instances

Create or open the TransportShmNotify for each pair of devices. [ more ... ]
C synopsis target-domain sourced in ti/sdo/ipc/transports/TransportShmNotifySetup.xdc
#include <ti/sdo/ipc/transports/TransportShmNotifySetup.h>
Functions common to all ITransportSetup modules
Int 
TransportShmNotifySetup_attach// Function that will be called in MessageQ_attach(UInt16 remoteProcId, Ptr sharedAddr);
Int 
TransportShmNotifySetup_detach// Function that will be called in MessageQ_detach(UInt16 remoteProcId);
Bool 
TransportShmNotifySetup_isRegistered// Determines if a transport has been registered to a remote processor(UInt16 remoteProcId);
SizeT 
TransportShmNotifySetup_sharedMemReq// Shared memory required(Ptr sharedAddr);
Functions common to all target modules
TransportShmNotifySetup_Module_getMask// Returns the diagnostics mask for this module, TransportShmNotifySetup_Module_hasMask// Test whether this module has a diagnostics mask, TransportShmNotifySetup_Module_heap// The heap from which this module allocates memory, TransportShmNotifySetup_Module_id// Get this module's unique id, TransportShmNotifySetup_Module_setMask// Set the diagnostics mask for this module, TransportShmNotifySetup_Module_startupDone// Test if this module has completed startup
Constants
extern const UInt 
TransportShmNotifySetup_priority// priority of the transport;
 
DETAILS
Create or open the TransportShmNotify for each pair of devices.
NOTE
This modules reflects upon the ti.sdo.utils.MultiProc.procAddrMode configuration parameter. Some internal data structure allocations are optimized for the given processor address mode.
 
config TransportShmNotifySetup_priority  // module-wide
index URL

priority of the transport

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

Function that will be called in MessageQ_attach

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

Function that will be called in MessageQ_detach

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

Determines if a transport has been registered to a remote processor

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

Shared memory required

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

C synopsis target-domain
Types_ModuleId TransportShmNotifySetup_Module_id();
// Get this module's unique id
 
Bool TransportShmNotifySetup_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle TransportShmNotifySetup_Module_heap();
// The heap from which this module allocates memory
 
Bool TransportShmNotifySetup_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 TransportShmNotifySetup_Module_getMask();
// Returns the diagnostics mask for this module
 
Void TransportShmNotifySetup_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/sdo/ipc/transports/TransportShmNotifySetup.xdc
var TransportShmNotifySetup = xdc.useModule('ti.sdo.ipc.transports.TransportShmNotifySetup');
module-wide config parameters
    TransportShmNotifySetup.priority// priority of the transport = UInt 0;
 
    TransportShmNotifySetup.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config TransportShmNotifySetup.priority  // module-wide
index URL

priority of the transport

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

Common module configuration parameters

Configuration settings
TransportShmNotifySetup.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 Fri, 21 Aug 2015 19:35:46 GMT