module ti.sdo.ipc.family.arctic.InterruptArp32
index URL

ARP32 based interrupt manager

C synopsis target-domain sourced in ti/sdo/ipc/family/arctic/InterruptArp32.xdc
#include <ti/sdo/ipc/family/arctic/InterruptArp32.h>
Functions common to all IInterrupt modules
UInt 
InterruptArp32_intClear// Clear interrupt(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
InterruptArp32_intDisable// Disables the interrupt corresponding to intId(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
InterruptArp32_intEnable// Enables the interrupt corresponding to intId(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
InterruptArp32_intRegister// Register an interrupt line to a remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, Fxn func, UArg arg);
Void 
InterruptArp32_intSend// Send interrupt to the remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, UArg arg);
Void 
InterruptArp32_intUnregister// Unregister an interrupt line to a remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Functions common to all target modules
InterruptArp32_Module_getMask// Returns the diagnostics mask for this module, InterruptArp32_Module_hasMask// Test whether this module has a diagnostics mask, InterruptArp32_Module_heap// The heap from which this module allocates memory, InterruptArp32_Module_id// Get this module's unique id, InterruptArp32_Module_setMask// Set the diagnostics mask for this module, InterruptArp32_Module_startupDone// Test if this module has completed startup
Typedefs
typedef struct
InterruptArp32_IntInfo//  ...
Constants
extern const UInt32 
InterruptArp32_mailboxBaseAddr// ;
 
 
struct InterruptArp32_IntInfo
index URL
C synopsis target-domain
typedef struct InterruptArp32_IntInfo {
    UInt localIntId;
    UInt remoteIntId;
    UInt intVectorId;
} InterruptArp32_IntInfo;
 
 
config InterruptArp32_mailboxBaseAddr  // module-wide
index URL
C synopsis target-domain
extern const UInt32 InterruptArp32_mailboxBaseAddr;
 
 
InterruptArp32_intClear()  // module-wide
index URL

Clear interrupt

C synopsis target-domain
UInt InterruptArp32_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
 
InterruptArp32_intDisable()  // module-wide
index URL

Disables the interrupt corresponding to intId

C synopsis target-domain
Void InterruptArp32_intDisable(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
 
InterruptArp32_intEnable()  // module-wide
index URL

Enables the interrupt corresponding to intId

C synopsis target-domain
Void InterruptArp32_intEnable(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
 
ARGUMENTS
remoteProcId — Remote MultiProc Id
intInfo — Information needed to configure interrupt line
 
InterruptArp32_intRegister()  // module-wide
index URL

Register an interrupt line to a remote processor

C synopsis target-domain
Void InterruptArp32_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
 
InterruptArp32_intSend()  // module-wide
index URL

Send interrupt to the remote processor

C synopsis target-domain
Void InterruptArp32_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.
 
InterruptArp32_intUnregister()  // module-wide
index URL

Unregister an interrupt line to a remote processor

C synopsis target-domain
Void InterruptArp32_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 InterruptArp32_Module_id();
// Get this module's unique id
 
Bool InterruptArp32_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle InterruptArp32_Module_heap();
// The heap from which this module allocates memory
 
Bool InterruptArp32_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 InterruptArp32_Module_getMask();
// Returns the diagnostics mask for this module
 
Void InterruptArp32_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/family/arctic/InterruptArp32.xdc
var InterruptArp32 = xdc.useModule('ti.sdo.ipc.family.arctic.InterruptArp32');
module-wide constants & types
    var obj = new InterruptArp32.IntInfo// ;
        obj.localIntId = UInt  ...
        obj.remoteIntId = UInt  ...
        obj.intVectorId = UInt  ...
module-wide config parameters
    InterruptArp32.mailboxBaseAddr//  = UInt32 0x4008B000;
 
    InterruptArp32.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
struct InterruptArp32.IntInfo
index URL
XDCscript usage meta-domain
var obj = new InterruptArp32.IntInfo;
 
    obj.localIntId = UInt  ...
    obj.remoteIntId = UInt  ...
    obj.intVectorId = UInt  ...
 
C SYNOPSIS
InterruptArp32_IntInfo
 
config InterruptArp32.mailboxBaseAddr  // module-wide
index URL
XDCscript usage meta-domain
InterruptArp32.mailboxBaseAddr = UInt32 0x4008B000;
 
C SYNOPSIS
InterruptArp32_mailboxBaseAddr
 
metaonly config InterruptArp32.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
InterruptArp32.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.
generated on Sat, 11 Feb 2012 00:37:47 GMT