module ti.sdo.ipc.family.da830.InterruptArm

DA830 based Arm interrupt manager

XDCspec summary sourced in ti/sdo/ipc/family/da830/InterruptArm.xdc
module InterruptArm {  ...
    // inherits xdc.runtime.IModule
C synopsis target-domain
#include <ti/sdo/ipc/family/da830/InterruptArm.h>
module-wide constants & types
    typedef struct InterruptArm_IntInfo//  {
        UInt localIntId;
        UInt remoteIntId;
        UInt intVectorId;
module-wide functions
    UInt InterruptArm_intClear// Clear interrupt( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo );
    Void InterruptArm_intRegister// Register an interrupt line to a remote processor( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, Fxn func, UArg arg );
    Void InterruptArm_intSend// Send interrupt to the remote processor( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, UArg arg );
module-wide built-ins
 
XDCscript usage meta-domain
var InterruptArm = xdc.useModule('ti.sdo.ipc.family.da830.InterruptArm');
module-wide constants & types
    var obj = new InterruptArm.IntInfo// ;
        obj.localIntId = UInt  ...
        obj.remoteIntId = UInt  ...
        obj.intVectorId = UInt  ...
module-wide config parameters
 
XDCspec declarations sourced in ti/sdo/ipc/family/da830/InterruptArm.xdc
 
module InterruptArm inherits IInterrupt {
module-wide constants & types
    struct IntInfo//  {
        UInt localIntId;
        UInt remoteIntId;
        UInt intVectorId;
    };
module-wide config parameters
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 InterruptArm.IntInfo
XDCscript usage meta-domain
var obj = new InterruptArm.IntInfo;
 
    obj.localIntId = UInt  ...
    obj.remoteIntId = UInt  ...
    obj.intVectorId = UInt  ...
C synopsis target-domain
typedef struct InterruptArm_IntInfo {
    UInt localIntId;
    UInt remoteIntId;
    UInt intVectorId;
} InterruptArm_IntInfo;
 
 
metaonly config InterruptArm.common$  // module-wide

Common module configuration parameters

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

Clear interrupt

C synopsis target-domain
UInt InterruptArm_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
 
InterruptArm.intDisable( )  // module-wide

Disables the interrupt corresponding to intId

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

Enables the interrupt corresponding to intId

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

Register an interrupt line to a remote processor

C synopsis target-domain
Void InterruptArm_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
 
InterruptArm.intSend( )  // module-wide

Send interrupt to the remote processor

C synopsis target-domain
Void InterruptArm_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.
 
InterruptArm.intUnregister( )  // module-wide

Unregister an interrupt line to a remote processor

C synopsis target-domain
Void InterruptArm_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 InterruptArm_Module_id( );
// Get this module's unique id
 
Bool InterruptArm_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle InterruptArm_Module_heap( );
// The heap from which this module allocates memory
 
Bool InterruptArm_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 InterruptArm_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void InterruptArm_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
generated on Fri, 09 Apr 2010 01:41:07 GMT