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

C647x/C667x based interrupt manager

C synopsis target-domain sourced in ti/sdo/ipc/family/c647x/Interrupt.xdc
#include <ti/sdo/ipc/family/c647x/Interrupt.h>
Functions common to all IInterrupt modules
UInt 
Interrupt_intClear// Clear interrupt(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
Interrupt_intDisable// Disables the interrupt corresponding to intId(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
Interrupt_intEnable// Enables the interrupt corresponding to intId(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);
Void 
Interrupt_intUnregister// Unregister an interrupt line to a remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Functions common to all target modules
Interrupt_Module_getMask// Returns the diagnostics mask for this module, Interrupt_Module_hasMask// Test whether this module has a diagnostics mask, Interrupt_Module_heap// The heap from which this module allocates memory, Interrupt_Module_id// Get this module's unique id, Interrupt_Module_setMask// Set the diagnostics mask for this module, Interrupt_Module_startupDone// Test if this module has completed startup
Typedefs
typedef struct
Interrupt_IntInfo//  ...
Constants
extern const Bool 
Interrupt_enableKick// If set to 'true' IPC will unlock the KICK registers on C66x devices;
 
 
struct Interrupt_IntInfo
index URL
C synopsis target-domain
typedef struct Interrupt_IntInfo {
    UInt localIntId;
    UInt remoteIntId;
    UInt intVectorId;
} Interrupt_IntInfo;
 
 
config Interrupt_enableKick  // module-wide
index URL

If set to 'true' IPC will unlock the KICK registers on C66x devices

C synopsis target-domain
extern const Bool Interrupt_enableKick;
 
DETAILS
IPC unlocks the KICK registers on the local core if (and only if) all the following conditions are met: - This configuration is set to 'true' - SharedRegion #0 is valid and the local core is its owner - SharedRegion #0 is not valid and the local core is CORE0
 
Interrupt_intClear()  // module-wide
index URL

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
index URL

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
index URL

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
index URL

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
index URL

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
index URL

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
index URL

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
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/family/c647x/Interrupt.xdc
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  ...
 
    var obj = new Interrupt.InterruptDataStruct// ;
        obj.remoteCoreId = UInt  ...
        obj.isrFxn = String  ...
        obj.isrArg = String  ...
        obj.isFlagged = Bool  ...
module-wide config parameters
    Interrupt.enableKick// If set to 'true' IPC will unlock the KICK registers on C66x devices = Bool true;
 
    Interrupt.common$// Common module configuration parameters = Types.Common$ undefined;
    Interrupt.rovViewInfo//  = ViewInfo.Instance ViewInfo.create;
 
 
struct Interrupt.IntInfo
index URL
XDCscript usage meta-domain
var obj = new Interrupt.IntInfo;
 
    obj.localIntId = UInt  ...
    obj.remoteIntId = UInt  ...
    obj.intVectorId = UInt  ...
 
C SYNOPSIS
Interrupt_IntInfo
 
metaonly struct Interrupt.InterruptDataStruct
index URL
XDCscript usage meta-domain
var obj = new Interrupt.InterruptDataStruct;
 
    obj.remoteCoreId = UInt  ...
    obj.isrFxn = String  ...
    obj.isrArg = String  ...
    obj.isFlagged = Bool  ...
 
 
config Interrupt.enableKick  // module-wide
index URL

If set to 'true' IPC will unlock the KICK registers on C66x devices

XDCscript usage meta-domain
Interrupt.enableKick = Bool true;
 
DETAILS
IPC unlocks the KICK registers on the local core if (and only if) all the following conditions are met: - This configuration is set to 'true' - SharedRegion #0 is valid and the local core is its owner - SharedRegion #0 is not valid and the local core is CORE0
C SYNOPSIS
Interrupt_enableKick
 
metaonly config Interrupt.common$  // module-wide
index URL

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.
 
metaonly config Interrupt.rovViewInfo  // module-wide
index URL
XDCscript usage meta-domain
Interrupt.rovViewInfo = ViewInfo.Instance ViewInfo.create;
 
generated on Sat, 11 Feb 2012 00:37:48 GMT