module ti.sdo.ipc.family.arctic.NotifySetup
index URL

Notify setup proxy for ARP32

This module creates and registers all drivers necessary for inter-processor notification on ARP32.
C synopsis target-domain sourced in ti/sdo/ipc/family/arctic/NotifySetup.xdc
#include <ti/sdo/ipc/family/arctic/NotifySetup.h>
Functions common to all INotifySetup modules
Int 
NotifySetup_attach// Function that will be called in Notify_attach(UInt16 remoteProcId, Ptr sharedAddr);
UInt16 
NotifySetup_numIntLines// Returns number of interrupt lines to the processor(UInt16 remoteProcId);
SizeT 
NotifySetup_sharedMemReq// Shared Memory Required for a single notification line(UInt16 remoteProcId, Ptr sharedAddr);
Functions common to all target modules
NotifySetup_Module_getMask// Returns the diagnostics mask for this module, NotifySetup_Module_hasMask// Test whether this module has a diagnostics mask, NotifySetup_Module_heap// The heap from which this module allocates memory, NotifySetup_Module_id// Get this module's unique id, NotifySetup_Module_setMask// Set the diagnostics mask for this module, NotifySetup_Module_startupDone// Test if this module has completed startup
Constants
extern const UInt 
NotifySetup_arp32IntVectId// Interrupt vector id for ARP32;
extern const UInt 
NotifySetup_dspIntVectId// Interrupt vector id for DSP;
 
 
config NotifySetup_arp32IntVectId  // module-wide
index URL

Interrupt vector id for ARP32

C synopsis target-domain
extern const UInt NotifySetup_arp32IntVectId;
 
 
config NotifySetup_dspIntVectId  // module-wide
index URL

Interrupt vector id for DSP

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

Function that will be called in Notify_attach

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

Returns number of interrupt lines to the processor

C synopsis target-domain
UInt16 NotifySetup_numIntLines(UInt16 remoteProcId);
 
 
NotifySetup_sharedMemReq()  // module-wide
index URL

Shared Memory Required for a single notification line

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

C synopsis target-domain
Types_ModuleId NotifySetup_Module_id();
// Get this module's unique id
 
Bool NotifySetup_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle NotifySetup_Module_heap();
// The heap from which this module allocates memory
 
Bool NotifySetup_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 NotifySetup_Module_getMask();
// Returns the diagnostics mask for this module
 
Void NotifySetup_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/family/arctic/NotifySetup.xdc
var NotifySetup = xdc.useModule('ti.sdo.ipc.family.arctic.NotifySetup');
module-wide config parameters
    NotifySetup.arp32IntVectId// Interrupt vector id for ARP32 = UInt 4;
    NotifySetup.dspIntVectId// Interrupt vector id for DSP = UInt 5;
 
    NotifySetup.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config NotifySetup.arp32IntVectId  // module-wide
index URL

Interrupt vector id for ARP32

XDCscript usage meta-domain
NotifySetup.arp32IntVectId = UInt 4;
 
C SYNOPSIS
NotifySetup_arp32IntVectId
 
config NotifySetup.dspIntVectId  // module-wide
index URL

Interrupt vector id for DSP

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

Common module configuration parameters

XDCscript usage meta-domain
NotifySetup.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:47 GMT