module ti.sdo.ipc.family.omap4430.InterruptDucati
index URL

OMAP4430/Ducati IPC interrupt manager

C synopsis target-domain sourced in ti/sdo/ipc/family/omap4430/InterruptDucati.xdc
#include <ti/sdo/ipc/family/omap4430/InterruptDucati.h>
Functions common to all IInterrupt modules
UInt 
InterruptDucati_intClear// Clear interrupt(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
InterruptDucati_intDisable// Disables the interrupt corresponding to intId(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
InterruptDucati_intEnable// Enables the interrupt corresponding to intId(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void 
InterruptDucati_intRegister// Register an interrupt line to a remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, Fxn func, UArg arg);
Void 
InterruptDucati_intSend// Send interrupt to the remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, UArg arg);
Void 
InterruptDucati_intUnregister// Unregister an interrupt line to a remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Functions common to all target modules
InterruptDucati_Module_getMask// Returns the diagnostics mask for this module, InterruptDucati_Module_hasMask// Test whether this module has a diagnostics mask, InterruptDucati_Module_heap// The heap from which this module allocates memory, InterruptDucati_Module_id// Get this module's unique id, InterruptDucati_Module_setMask// Set the diagnostics mask for this module, InterruptDucati_Module_startupDone// Test if this module has completed startup
Typedefs
typedef struct
InterruptDucati_IntInfo//  ...
Constants
extern const UInt32 
InterruptDucati_ducatiCtrlBaseAddr// ;
extern const UInt32 
InterruptDucati_mailboxBaseAddr// ;
 
 
struct InterruptDucati_IntInfo
index URL
C synopsis target-domain
typedef struct InterruptDucati_IntInfo {
    UInt localIntId;
    UInt remoteIntId;
    UInt intVectorId;
} InterruptDucati_IntInfo;
 
 
config InterruptDucati_ducatiCtrlBaseAddr  // module-wide
index URL
C synopsis target-domain
extern const UInt32 InterruptDucati_ducatiCtrlBaseAddr;
 
 
config InterruptDucati_mailboxBaseAddr  // module-wide
index URL
C synopsis target-domain
extern const UInt32 InterruptDucati_mailboxBaseAddr;
 
 
InterruptDucati_intClear()  // module-wide
index URL

Clear interrupt

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

Disables the interrupt corresponding to intId

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

Enables the interrupt corresponding to intId

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

Register an interrupt line to a remote processor

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

Send interrupt to the remote processor

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

Unregister an interrupt line to a remote processor

C synopsis target-domain
Void InterruptDucati_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 InterruptDucati_Module_id();
// Get this module's unique id
 
Bool InterruptDucati_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle InterruptDucati_Module_heap();
// The heap from which this module allocates memory
 
Bool InterruptDucati_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 InterruptDucati_Module_getMask();
// Returns the diagnostics mask for this module
 
Void InterruptDucati_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/family/omap4430/InterruptDucati.xdc
var InterruptDucati = xdc.useModule('ti.sdo.ipc.family.omap4430.InterruptDucati');
module-wide constants & types
    var obj = new InterruptDucati.IntInfo// ;
        obj.localIntId = UInt  ...
        obj.remoteIntId = UInt  ...
        obj.intVectorId = UInt  ...
module-wide config parameters
    InterruptDucati.ducatiCtrlBaseAddr//  = UInt32 0x40001000;
    InterruptDucati.mailboxBaseAddr//  = UInt32 0x4A0F4000;
 
    InterruptDucati.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
struct InterruptDucati.IntInfo
index URL
XDCscript usage meta-domain
var obj = new InterruptDucati.IntInfo;
 
    obj.localIntId = UInt  ...
    obj.remoteIntId = UInt  ...
    obj.intVectorId = UInt  ...
 
C SYNOPSIS
InterruptDucati_IntInfo
 
config InterruptDucati.ducatiCtrlBaseAddr  // module-wide
index URL
XDCscript usage meta-domain
InterruptDucati.ducatiCtrlBaseAddr = UInt32 0x40001000;
 
C SYNOPSIS
InterruptDucati_ducatiCtrlBaseAddr
 
config InterruptDucati.mailboxBaseAddr  // module-wide
index URL
XDCscript usage meta-domain
InterruptDucati.mailboxBaseAddr = UInt32 0x4A0F4000;
 
C SYNOPSIS
InterruptDucati_mailboxBaseAddr
 
metaonly config InterruptDucati.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
InterruptDucati.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:54 GMT