module ti.sdo.ipc.family.ti81xx.NotifyMbxSetup
index URL

Notify setup proxy for NotifyDriverMbx on TI81XX

This module creates and registers all drivers necessary for inter-processor notifications using ti.sdo.ipc.family.ti81xx.NotifyDriverMbx [ more ... ]
C synopsis target-domain sourced in ti/sdo/ipc/family/ti81xx/NotifyMbxSetup.xdc
#include <ti/sdo/ipc/family/ti81xx/NotifyMbxSetup.h>
Functions common to all INotifySetup modules
Int 
NotifyMbxSetup_attach// Function that will be called in Notify_attach(UInt16 remoteProcId, Ptr sharedAddr);
UInt16 
NotifyMbxSetup_numIntLines// Returns number of interrupt lines to the processor(UInt16 remoteProcId);
SizeT 
NotifyMbxSetup_sharedMemReq// Shared Memory Required for a single notification line(UInt16 remoteProcId, Ptr sharedAddr);
Functions common to all target modules
NotifyMbxSetup_Module_getMask// Returns the diagnostics mask for this module, NotifyMbxSetup_Module_hasMask// Test whether this module has a diagnostics mask, NotifyMbxSetup_Module_heap// The heap from which this module allocates memory, NotifyMbxSetup_Module_id// Get this module's unique id, NotifyMbxSetup_Module_setMask// Set the diagnostics mask for this module, NotifyMbxSetup_Module_startupDone// Test if this module has completed startup
Constants
extern const UInt 
NotifyMbxSetup_dspIntVectId// Interrupt vector id for the DSP core on TI81XX;
 
DETAILS
This module creates and registers all drivers necessary for inter-processor notifications using ti.sdo.ipc.family.ti81xx.NotifyDriverMbx
Configure the dspIntVectId module config to choose a non-default interrupt vector ID on the TI81XX DSP core.
 
config NotifyMbxSetup_dspIntVectId  // module-wide
index URL

Interrupt vector id for the DSP core on TI81XX

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

Function that will be called in Notify_attach

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

Returns number of interrupt lines to the processor

C synopsis target-domain
UInt16 NotifyMbxSetup_numIntLines(UInt16 remoteProcId);
 
 
NotifyMbxSetup_sharedMemReq()  // module-wide
index URL

Shared Memory Required for a single notification line

C synopsis target-domain
SizeT NotifyMbxSetup_sharedMemReq(UInt16 remoteProcId, Ptr sharedAddr);
 
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId NotifyMbxSetup_Module_id();
// Get this module's unique id
 
Bool NotifyMbxSetup_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle NotifyMbxSetup_Module_heap();
// The heap from which this module allocates memory
 
Bool NotifyMbxSetup_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 NotifyMbxSetup_Module_getMask();
// Returns the diagnostics mask for this module
 
Void NotifyMbxSetup_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/family/ti81xx/NotifyMbxSetup.xdc
var NotifyMbxSetup = xdc.useModule('ti.sdo.ipc.family.ti81xx.NotifyMbxSetup');
module-wide config parameters
    NotifyMbxSetup.dspIntVectId// Interrupt vector id for the DSP core on TI81XX = UInt 5;
 
    NotifyMbxSetup.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config NotifyMbxSetup.dspIntVectId  // module-wide
index URL

Interrupt vector id for the DSP core on TI81XX

XDCscript usage meta-domain
NotifyMbxSetup.dspIntVectId = UInt 5;
 
C SYNOPSIS
NotifyMbxSetup_dspIntVectId
 
metaonly config NotifyMbxSetup.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
NotifyMbxSetup.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:37:57 GMT