module ti.sdo.ipc.family.dm740.InterruptDsp

DM740/DSP interrupt manager

XDCspec summary sourced in ti/sdo/ipc/family/dm740/InterruptDsp.xdc
module InterruptDsp {  ...
    // inherits xdc.runtime.IModule
C synopsis target-domain
#include <ti/sdo/ipc/family/dm740/InterruptDsp.h>
module-wide constants & types
    typedef struct InterruptDsp_IntInfo//  {
        UInt localIntId;
        UInt remoteIntId;
        UInt intVectorId;
module-wide config parameters
    extern const UInt32 InterruptDsp_mailboxBaseAddr// ;
module-wide functions
    UInt InterruptDsp_intClear// Clear interrupt( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo );
    Void InterruptDsp_intRegister// Register an interrupt line to a remote processor( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, Fxn func, UArg arg );
    Void InterruptDsp_intSend// Send interrupt to the remote processor( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, UArg arg );
module-wide built-ins
 
XDCscript usage meta-domain
var InterruptDsp = xdc.useModule('ti.sdo.ipc.family.dm740.InterruptDsp');
module-wide constants & types
    var obj = new InterruptDsp.IntInfo// ;
        obj.localIntId = UInt  ...
        obj.remoteIntId = UInt  ...
        obj.intVectorId = UInt  ...
module-wide config parameters
    InterruptDsp.mailboxBaseAddr//  = UInt32 0x080C8000;
 
 
XDCspec declarations sourced in ti/sdo/ipc/family/dm740/InterruptDsp.xdc
 
module InterruptDsp inherits IInterrupt {
module-wide constants & types
    struct IntInfo//  {
        UInt localIntId;
        UInt remoteIntId;
        UInt intVectorId;
    };
module-wide config parameters
    config UInt32 mailboxBaseAddr//  = 0x080C8000;
 
module-wide functions
    UInt intClear// Clear interrupt( UInt16 remoteProcId, IInterrupt.IntInfo *intInfo );
    Void intDisable// Disables the interrupt corresponding to intId( UInt16 remoteProcId, IInterrupt.IntInfo *intInfo );
    Void intEnable// Enables the interrupt corresponding to intId( UInt16 remoteProcId, IInterrupt.IntInfo *intInfo );
    Void intRegister// Register an interrupt line to a remote processor( UInt16 remoteProcId, IInterrupt.IntInfo *intInfo, Fxn func, UArg arg );
    Void intSend// Send interrupt to the remote processor( UInt16 remoteProcId, IInterrupt.IntInfo *intInfo, UArg arg );
}
 
struct InterruptDsp.IntInfo
XDCscript usage meta-domain
var obj = new InterruptDsp.IntInfo;
 
    obj.localIntId = UInt  ...
    obj.remoteIntId = UInt  ...
    obj.intVectorId = UInt  ...
C synopsis target-domain
typedef struct InterruptDsp_IntInfo {
    UInt localIntId;
    UInt remoteIntId;
    UInt intVectorId;
} InterruptDsp_IntInfo;
 
 
config InterruptDsp.mailboxBaseAddr  // module-wide
XDCscript usage meta-domain
InterruptDsp.mailboxBaseAddr = UInt32 0x080C8000;
C synopsis target-domain
extern const UInt32 InterruptDsp_mailboxBaseAddr;
 
 
metaonly config InterruptDsp.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
InterruptDsp.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.
 
InterruptDsp.intClear( )  // module-wide

Clear interrupt

C synopsis target-domain
UInt InterruptDsp_intClear( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo );
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
RETURNS
Value (if any) of the interrupt before it was cleared
 
InterruptDsp.intDisable( )  // module-wide

Disables the interrupt corresponding to intId

C synopsis target-domain
Void InterruptDsp_intDisable( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo );
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
 
InterruptDsp.intEnable( )  // module-wide

Enables the interrupt corresponding to intId

C synopsis target-domain
Void InterruptDsp_intEnable( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo );
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
 
InterruptDsp.intRegister( )  // module-wide

Register an interrupt line to a remote processor

C synopsis target-domain
Void InterruptDsp_intRegister( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, Fxn func, UArg arg );
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
func — Function to register.
arg — Argument that will be passed to func
 
InterruptDsp.intSend( )  // module-wide

Send interrupt to the remote processor

C synopsis target-domain
Void InterruptDsp_intSend( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, UArg arg );
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
arg — Argument for sending interrupt.
 
InterruptDsp.intUnregister( )  // module-wide

Unregister an interrupt line to a remote processor

C synopsis target-domain
Void InterruptDsp_intUnregister( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo );
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
 
module-wide built-ins

C synopsis target-domain
Types_ModuleId InterruptDsp_Module_id( );
// Get this module's unique id
 
Bool InterruptDsp_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle InterruptDsp_Module_heap( );
// The heap from which this module allocates memory
 
Bool InterruptDsp_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 InterruptDsp_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void InterruptDsp_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
generated on Fri, 09 Apr 2010 01:41:06 GMT