module ti.sdo.ipc.family.da830.NotifySetup

Manages setup of the default Notify driver handles

Creates the default notify drivers for each pair of processors.
XDCspec summary sourced in ti/sdo/ipc/family/da830/NotifySetup.xdc
module NotifySetup {  ...
    // inherits xdc.runtime.IModule
C synopsis target-domain
#include <ti/sdo/ipc/family/da830/NotifySetup.h>
module-wide constants & types
        NotifySetup_ARM_INT0,
        NotifySetup_ARM_INT1
    } NotifySetup_ARM_INT;
 
        NotifySetup_DSP_INT0,
        NotifySetup_DSP_INT1
    } NotifySetup_DSP_INT;
module-wide config parameters
module-wide functions
    Int NotifySetup_attach// Function that will be called in Notify_attach( UInt16 remoteProcId, Ptr sharedAddr );
    SizeT NotifySetup_sharedMemReq// Shared Memory Required for a single notification line( UInt16 remoteProcId, Ptr sharedAddr );
module-wide built-ins
 
XDCscript usage meta-domain
XDCspec declarations sourced in ti/sdo/ipc/family/da830/NotifySetup.xdc
 
module NotifySetup inherits INotifySetup {
module-wide constants & types
        ARM_INT0,
        ARM_INT1
    };
 
        DSP_INT0,
        DSP_INT1
    };
module-wide config parameters
 
module-wide functions
    Int attach// Function that will be called in Notify_attach( UInt16 remoteProcId, Ptr sharedAddr );
    SizeT sharedMemReq// Shared Memory Required for a single notification line( UInt16 remoteProcId, Ptr sharedAddr );
}
 
enum NotifySetup.ARM_INT

Possible incoming interrupt IDs for ARM

XDCscript usage meta-domain
values of type NotifySetup.ARM_INT
    const NotifySetup.ARM_INT0;
    const NotifySetup.ARM_INT1;
C synopsis target-domain
typedef enum NotifySetup_ARM_INT {
    NotifySetup_ARM_INT0,
    NotifySetup_ARM_INT1
} NotifySetup_ARM_INT;
 
 
enum NotifySetup.DSP_INT

Possible incoming interrupt IDs for DSP

XDCscript usage meta-domain
values of type NotifySetup.DSP_INT
    const NotifySetup.DSP_INT0;
    const NotifySetup.DSP_INT1;
C synopsis target-domain
typedef enum NotifySetup_DSP_INT {
    NotifySetup_DSP_INT0,
    NotifySetup_DSP_INT1
} NotifySetup_DSP_INT;
 
 
config NotifySetup.armRecvIntId0  // module-wide

Incoming interrupt ID for line #0 line on ARM

XDCscript usage meta-domain
NotifySetup.armRecvIntId0 = UInt NotifySetup.ARM_INT0;
C synopsis target-domain
extern const UInt NotifySetup_armRecvIntId0;
 
DETAILS
See ARM_INT for possible values.
 
config NotifySetup.armRecvIntId1  // module-wide

Incoming interrupt ID for line #1 line on ARM

XDCscript usage meta-domain
NotifySetup.armRecvIntId1 = UInt NotifySetup.ARM_INT1;
C synopsis target-domain
extern const UInt NotifySetup_armRecvIntId1;
 
DETAILS
See ARM_INT for possible values.
 
config NotifySetup.dspIntVectId0  // module-wide

Vector ID to use on DSP for line #1

XDCscript usage meta-domain
NotifySetup.dspIntVectId0 = UInt 5;
C synopsis target-domain
extern const UInt NotifySetup_dspIntVectId0;
 
 
config NotifySetup.dspIntVectId1  // module-wide

Vector ID to use on DSP for line #1

XDCscript usage meta-domain
NotifySetup.dspIntVectId1 = UInt 6;
C synopsis target-domain
extern const UInt NotifySetup_dspIntVectId1;
 
 
config NotifySetup.dspRecvIntId0  // module-wide

Incoming interrupt ID for line #0 line on DSP

XDCscript usage meta-domain
NotifySetup.dspRecvIntId0 = UInt NotifySetup.DSP_INT0;
C synopsis target-domain
extern const UInt NotifySetup_dspRecvIntId0;
 
DETAILS
See DSP_INT for possible values.
 
config NotifySetup.dspRecvIntId1  // module-wide

Incoming interrupt ID for line #1 line on DSP

XDCscript usage meta-domain
NotifySetup.dspRecvIntId1 = UInt NotifySetup.DSP_INT1;
C synopsis target-domain
extern const UInt NotifySetup_dspRecvIntId1;
 
DETAILS
See DSP_INT for possible values.
 
config NotifySetup.useSecondLine  // module-wide

Enable the second interrupt line

XDCscript usage meta-domain
NotifySetup.useSecondLine = Bool false;
C synopsis target-domain
extern const Bool NotifySetup_useSecondLine;
 
 
metaonly config NotifySetup.common$  // module-wide

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.
 
NotifySetup.attach( )  // module-wide

Function that will be called in Notify_attach

C synopsis target-domain
Int NotifySetup_attach( UInt16 remoteProcId, Ptr sharedAddr );
 
 
NotifySetup.intLineAvailable( )  // module-wide

Returns whether there is an interrupt line available to the processor

C synopsis target-domain
Bool NotifySetup_intLineAvailable( UInt16 remoteProcId );
 
 
NotifySetup.sharedMemReq( )  // module-wide

Shared Memory Required for a single notification line

C synopsis target-domain
SizeT NotifySetup_sharedMemReq( UInt16 remoteProcId, Ptr sharedAddr );
 
 
module-wide built-ins

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
generated on Fri, 09 Apr 2010 01:41:07 GMT