module ti.sdo.ipc.family.vayu.InterruptHost

index URL

TI81xx/A8 based interrupt manager

C synopsis
Individual elements
Configuration settings
Individual elements

C synopsis target-domain sourced in ti/sdo/ipc/family/vayu/InterruptHost.xdc

#include <ti/sdo/ipc/family/vayu/InterruptHost.h>

Functions common to all IInterrupt modules
UInt	InterruptHost_intClear// Clear interrupt(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void	InterruptHost_intDisable// Disables the interrupt corresponding to intId(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void	InterruptHost_intEnable// Enables the interrupt corresponding to intId(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Void	InterruptHost_intRegister// Register an interrupt line to a remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, Fxn func, UArg arg);
Void	InterruptHost_intSend// Send interrupt to the remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo, UArg arg);
Void	InterruptHost_intUnregister// Unregister an interrupt line to a remote processor(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);
Functions common to all target modules
	InterruptHost_Module_getMask// Returns the diagnostics mask for this module, InterruptHost_Module_hasMask// Test whether this module has a diagnostics mask, InterruptHost_Module_heap// The heap from which this module allocates memory, InterruptHost_Module_id// Get this module's unique id, InterruptHost_Module_setMask// Set the diagnostics mask for this module, InterruptHost_Module_startupDone// Test if this module has completed startup
Defines
#define	InterruptHost_NUM_BENELLI_CORES// (UInt8)2
#define	InterruptHost_NUM_CORES// (UInt8)11
#define	InterruptHost_NUM_EVES// (UInt8)4
#define	InterruptHost_NUM_EVE_MBX// (UInt8)12
#define	InterruptHost_NUM_HOST_CORES// (UInt8)1
#define	InterruptHost_NUM_SYS_MBX// (UInt8)4
Typedefs
typedef struct	InterruptHost_IntInfo// ...
Constants
extern const UInt32	InterruptHost_mailboxBaseAddr// [InterruptHost_NUM_EVE_MBX + InterruptHost_NUM_SYS_MBX];
extern const UInt32	InterruptHost_mailboxTable// [InterruptHost_NUM_CORES * InterruptHost_NUM_CORES];
extern const UInt32	InterruptHost_procIdTable// [InterruptHost_NUM_CORES];

const InterruptHost_NUM_BENELLI_CORES

index URL

C synopsis target-domain

#define InterruptHost_NUM_BENELLI_CORES (UInt8)2

const InterruptHost_NUM_CORES

index URL

C synopsis target-domain

#define InterruptHost_NUM_CORES (UInt8)11

const InterruptHost_NUM_EVES

index URL

C synopsis target-domain

#define InterruptHost_NUM_EVES (UInt8)4

const InterruptHost_NUM_EVE_MBX

index URL

C synopsis target-domain

#define InterruptHost_NUM_EVE_MBX (UInt8)12

const InterruptHost_NUM_HOST_CORES

index URL

C synopsis target-domain

#define InterruptHost_NUM_HOST_CORES (UInt8)1

const InterruptHost_NUM_SYS_MBX

index URL

C synopsis target-domain

#define InterruptHost_NUM_SYS_MBX (UInt8)4

struct InterruptHost_IntInfo

index URL

C synopsis target-domain

typedef struct InterruptHost_IntInfo {

UInt localIntId;

UInt remoteIntId;

UInt intVectorId;

} InterruptHost_IntInfo;

config InterruptHost_mailboxBaseAddr // module-wide

index URL

C synopsis target-domain

extern const UInt32 InterruptHost_mailboxBaseAddr[InterruptHost_NUM_EVE_MBX + InterruptHost_NUM_SYS_MBX];

config InterruptHost_mailboxTable // module-wide

index URL

C synopsis target-domain

extern const UInt32 InterruptHost_mailboxTable[InterruptHost_NUM_CORES * InterruptHost_NUM_CORES];

config InterruptHost_procIdTable // module-wide

index URL

C synopsis target-domain

extern const UInt32 InterruptHost_procIdTable[InterruptHost_NUM_CORES];

InterruptHost_intClear() // module-wide

index URL

Clear interrupt

C synopsis target-domain

UInt InterruptHost_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

InterruptHost_intDisable() // module-wide

index URL

Disables the interrupt corresponding to intId

C synopsis target-domain

Void InterruptHost_intDisable(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);

ARGUMENTS

remoteProcId — Remote MultiProc Id

intInfo — Information needed to configure interrupt line

InterruptHost_intEnable() // module-wide

index URL

Enables the interrupt corresponding to intId

C synopsis target-domain

Void InterruptHost_intEnable(UInt16 remoteProcId, IInterrupt_IntInfo *intInfo);

ARGUMENTS

remoteProcId — Remote MultiProc Id

intInfo — Information needed to configure interrupt line

InterruptHost_intRegister() // module-wide

index URL

C synopsis target-domain

Void InterruptHost_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

InterruptHost_intSend() // module-wide

index URL

Send interrupt to the remote processor

C synopsis target-domain

Void InterruptHost_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.

InterruptHost_intUnregister() // module-wide

index URL

Unregister an interrupt line to a remote processor

C synopsis target-domain

Void InterruptHost_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 InterruptHost_Module_id();

// Get this module's unique id

Bool InterruptHost_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle InterruptHost_Module_heap();

// The heap from which this module allocates memory

Bool InterruptHost_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 InterruptHost_Module_getMask();

// Returns the diagnostics mask for this module

Void InterruptHost_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

Configuration settings sourced in ti/sdo/ipc/family/vayu/InterruptHost.xdc

var InterruptHost = xdc.useModule('ti.sdo.ipc.family.vayu.InterruptHost');

module-wide constants & types

const InterruptHost.NUM_BENELLI_CORES// = 2;

const InterruptHost.NUM_CORES// = 11;

const InterruptHost.NUM_EVES// = 4;

const InterruptHost.NUM_EVE_MBX// = 12;

const InterruptHost.NUM_HOST_CORES// = 1;

const InterruptHost.NUM_SYS_MBX// = 4;

var obj = new InterruptHost.IntInfo// ;

obj.localIntId = UInt ...

obj.remoteIntId = UInt ...

obj.intVectorId = UInt ...

module-wide config parameters

InterruptHost.mailboxBaseAddr// = UInt32[InterruptHost.NUM_EVE_MBX+InterruptHost.NUM_SYS_MBX] undefined;

InterruptHost.mailboxTable// = UInt32[InterruptHost.NUM_CORES*InterruptHost.NUM_CORES] undefined;

InterruptHost.procIdTable// = UInt32[InterruptHost.NUM_CORES] undefined;

InterruptHost.common$// Common module configuration parameters = Types.Common$ undefined;

const InterruptHost.NUM_BENELLI_CORES

index URL

Configuration settings

const InterruptHost.NUM_BENELLI_CORES = 2;

C SYNOPSIS

InterruptHost_NUM_BENELLI_CORES

const InterruptHost.NUM_CORES

index URL

Configuration settings

const InterruptHost.NUM_CORES = 11;

C SYNOPSIS

InterruptHost_NUM_CORES

const InterruptHost.NUM_EVES

index URL

Configuration settings

const InterruptHost.NUM_EVES = 4;

C SYNOPSIS

InterruptHost_NUM_EVES

const InterruptHost.NUM_EVE_MBX

index URL

Configuration settings

const InterruptHost.NUM_EVE_MBX = 12;

C SYNOPSIS

InterruptHost_NUM_EVE_MBX

const InterruptHost.NUM_HOST_CORES

index URL

Configuration settings

const InterruptHost.NUM_HOST_CORES = 1;

C SYNOPSIS

InterruptHost_NUM_HOST_CORES

const InterruptHost.NUM_SYS_MBX

index URL

Configuration settings

const InterruptHost.NUM_SYS_MBX = 4;

C SYNOPSIS

InterruptHost_NUM_SYS_MBX

struct InterruptHost.IntInfo

index URL

Configuration settings

var obj = new InterruptHost.IntInfo;

obj.localIntId = UInt ...

obj.remoteIntId = UInt ...

obj.intVectorId = UInt ...

C SYNOPSIS

InterruptHost_IntInfo

config InterruptHost.mailboxBaseAddr // module-wide

index URL

Configuration settings

InterruptHost.mailboxBaseAddr = UInt32[InterruptHost.NUM_EVE_MBX+InterruptHost.NUM_SYS_MBX] undefined;

C SYNOPSIS

InterruptHost_mailboxBaseAddr

config InterruptHost.mailboxTable // module-wide

index URL

Configuration settings

InterruptHost.mailboxTable = UInt32[InterruptHost.NUM_CORES*InterruptHost.NUM_CORES] undefined;

C SYNOPSIS

InterruptHost_mailboxTable

config InterruptHost.procIdTable // module-wide

index URL

Configuration settings

InterruptHost.procIdTable = UInt32[InterruptHost.NUM_CORES] undefined;

C SYNOPSIS

InterruptHost_procIdTable

metaonly config InterruptHost.common$ // module-wide

index URL

Common module configuration parameters

Configuration settings

InterruptHost.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 Fri, 21 Aug 2015 19:35:59 GMT