module ti.sdo.ipc.family.c647x.Interrupt

c6472 based interrupt manager

XDCspec summary sourced in ti/sdo/ipc/family/c647x/Interrupt.xdc
module Interrupt {  ...
    // inherits xdc.runtime.IModule
C synopsis target-domain
#include <ti/sdo/ipc/family/c647x/Interrupt.h>
module-wide constants & types
    typedef struct Interrupt_IntInfo//  {
        UInt localIntId;
        UInt remoteIntId;
        UInt intVectorId;
    } Interrupt_IntInfo;
module-wide config parameters
    extern const Ptr Interrupt_IPCAR0// ;
    extern const Ptr Interrupt_IPCGR0// ;
    extern const UInt Interrupt_numCores// Number of cores;
module-wide functions
    UInt Interrupt_intClear// Clear interrupt( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo );
    Void Interrupt_intRegister// Register an interrupt line to a remote processor( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, Fxn func, UArg arg );
    Void Interrupt_intSend// Send interrupt to the remote processor( UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, UArg arg );
module-wide built-ins
 
XDCscript usage meta-domain
var Interrupt = xdc.useModule('ti.sdo.ipc.family.c647x.Interrupt');
module-wide constants & types
    var obj = new Interrupt.IntInfo// ;
        obj.localIntId = UInt  ...
        obj.remoteIntId = UInt  ...
        obj.intVectorId = UInt  ...
module-wide config parameters
    Interrupt.IPCAR0//  = Ptr undefined;
    Interrupt.IPCGR0//  = Ptr undefined;
    Interrupt.numCores// Number of cores = UInt undefined;
 
 
XDCspec declarations sourced in ti/sdo/ipc/family/c647x/Interrupt.xdc
 
module Interrupt inherits IInterrupt {
module-wide constants & types
    struct IntInfo//  {
        UInt localIntId;
        UInt remoteIntId;
        UInt intVectorId;
    };
module-wide config parameters
    config Ptr IPCAR0// ;
    config Ptr IPCGR0// ;
    config UInt numCores// Number of cores;
 
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 Interrupt.IntInfo
XDCscript usage meta-domain
var obj = new Interrupt.IntInfo;
 
    obj.localIntId = UInt  ...
    obj.remoteIntId = UInt  ...
    obj.intVectorId = UInt  ...
C synopsis target-domain
typedef struct Interrupt_IntInfo {
    UInt localIntId;
    UInt remoteIntId;
    UInt intVectorId;
} Interrupt_IntInfo;
 
 
config Interrupt.INTERDSPINT  // module-wide

Inter-processor interrupt id

XDCscript usage meta-domain
Interrupt.INTERDSPINT = UInt undefined;
C synopsis target-domain
extern const UInt Interrupt_INTERDSPINT;
 
 
config Interrupt.IPCAR0  // module-wide
XDCscript usage meta-domain
Interrupt.IPCAR0 = Ptr undefined;
C synopsis target-domain
extern const Ptr Interrupt_IPCAR0;
 
 
config Interrupt.IPCGR0  // module-wide
XDCscript usage meta-domain
Interrupt.IPCGR0 = Ptr undefined;
C synopsis target-domain
extern const Ptr Interrupt_IPCGR0;
 
 
config Interrupt.numCores  // module-wide

Number of cores

XDCscript usage meta-domain
Interrupt.numCores = UInt undefined;
C synopsis target-domain
extern const UInt Interrupt_numCores;
 
 
metaonly config Interrupt.common$  // module-wide

Common module configuration parameters

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

Clear interrupt

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

Disables the interrupt corresponding to intId

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

Enables the interrupt corresponding to intId

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

Register an interrupt line to a remote processor

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

Send interrupt to the remote processor

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

Unregister an interrupt line to a remote processor

C synopsis target-domain
Void Interrupt_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 Interrupt_Module_id( );
// Get this module's unique id
 
Bool Interrupt_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle Interrupt_Module_heap( );
// The heap from which this module allocates memory
 
Bool Interrupt_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 Interrupt_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void Interrupt_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
generated on Fri, 09 Apr 2010 01:41:06 GMT