module ti.sysbios.family.arm.tms570.Hwi
index URL

Hardware Interrupt Support Module

This Hwi module provides TMS570 (VIM) specific implementations of the APIs defined in IHwi. [ more ... ]
C synopsis target-domain sourced in ti/sysbios/family/arm/tms570/Hwi.xdc
#include <ti/sysbios/family/arm/tms570/Hwi.h>
Functions
Void
Hwi_construct// Initialize a new instance object inside the provided structure(Hwi_Struct *structP, Int intNum, IHwi_FuncPtr hwiFxn, const Hwi_Params *params, Error_Block *eb);
Hwi_Handle
Hwi_create// Allocate and initialize a new instance object and return its handle(Int intNum, IHwi_FuncPtr hwiFxn, const Hwi_Params *params, Error_Block *eb);
Void
Hwi_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(Hwi_Handle *handleP);
Void
Hwi_destruct// Finalize the instance object inside the provided structure(Hwi_Struct *structP);
UInt 
Hwi_disableFIQ// Disable FIQ interrupts();
UInt 
Hwi_disableIRQ// Disable IRQ interrupts();
UInt 
Hwi_enableFIQ// Enable FIQ interrupts();
UInt 
Hwi_enableIRQ// Enable IRQ interrupts();
Hwi_Object *
Hwi_getHandle// Returns pointer to Hwi instance object(UInt intNum);
Void
Hwi_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(Hwi_Params *params);
Void 
Hwi_reconfig// Reconfigure a dispatched interrupt(Hwi_Handle handle, Hwi_FuncPtr fxn, Hwi_Params *params);
Void 
Hwi_restoreFIQ// Restore FIQ interrupts(UInt key);
Void 
Hwi_restoreIRQ// Restore IRQ interrupts(UInt key);
Void 
Hwi_setPriority// Set an interrupt's relative priority(UInt intNum, UInt priority);
Void 
Hwi_setType// Set an interrupt's type (FIQ/IRQ)(UInt intNum, Hwi_Type type);
Functions common to all IHwi modules
Void 
Hwi_clearInterrupt// Clear a specific interrupt(UInt intNum);
macro UInt 
Hwi_disable// Globally disable interrupts();
UInt 
Hwi_disableInterrupt// Disable a specific interrupt(UInt intNum);
macro UInt 
Hwi_enable// Globally enable interrupts();
UInt 
Hwi_enableInterrupt// Enable a specific interrupt(UInt intNum);
IHwi_FuncPtr 
Hwi_getFunc// Get Hwi function and arg(Hwi_Handle handle, UArg *arg);
Ptr 
Hwi_getHookContext// Get hook instance's context for a Hwi(Hwi_Handle handle, Int id);
IHwi_Irp 
Hwi_getIrp// Get address of interrupted instruction(Hwi_Handle handle);
Bool 
Hwi_getStackInfo// Get Hwi stack usage Info(IHwi_StackInfo *stkInfo, Bool computeStackDepth);
macro Void 
Hwi_restore// Globally restore interrupts(UInt key);
Void 
Hwi_restoreInterrupt// Restore a specific interrupt's enabled/disabled state(UInt intNum, UInt key);
Void 
Hwi_setFunc// Overwrite Hwi function and arg(Hwi_Handle handle, IHwi_FuncPtr fxn, UArg arg);
Void 
Hwi_setHookContext// Set hook instance's context for a Hwi(Hwi_Handle handle, Int id, Ptr hookContext);
Void 
Hwi_startup// Initially enable interrupts();
Functions common to all target instances
Hwi_handle// Convert this instance structure pointer into an instance handle, Hwi_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, Hwi_Handle_label// The label associated with this instance object, Hwi_Handle_name// The name of this instance object, Hwi_Handle_upCast// unconditionally move one level up the inheritance hierarchy, Hwi_Object_count// The number of statically-created instance objects, Hwi_Object_first// The handle of the first dynamically-created instance object, or NULL, Hwi_Object_get// The handle of the i-th statically-created instance object (array == NULL), Hwi_Object_heap// The heap used to allocate dynamically-created instance objects, Hwi_Object_next// The handle of the next dynamically-created instance object, or NULL, Hwi_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
Hwi_Module_getMask// Returns the diagnostics mask for this module, Hwi_Module_hasMask// Test whether this module has a diagnostics mask, Hwi_Module_heap// The heap from which this module allocates memory, Hwi_Module_id// Get this module's unique id, Hwi_Module_setMask// Set the diagnostics mask for this module, Hwi_Module_startupDone// Test if this module has completed startup
Defines
#define
Hwi_NUM_INTERRUPTS// The TMS570 ARM Interrupt Controller supports 64 interrupts (Int)64
Typedefs
typedef Void 
(*Hwi_FuncPtr// Hwi create function type definition)(UArg);
typedef Hwi_Object *
Hwi_Handle// Client reference to an instance object;
typedef struct
Hwi_HookSet// Hwi hook set type definition ...
typedef UArg 
Hwi_Irp// Interrupt Return Pointer;
typedef enum
Hwi_MaskingOption// Shorthand interrupt masking options ...
typedef struct
Hwi_Object// Opaque internal representation of an instance object Hwi_Object;
typedef struct
Hwi_Params// Instance config-params structure ...
typedef struct
Hwi_StackInfo// Structure contains Hwi stack usage info ...
typedef struct
Hwi_Struct// Opaque client structure large enough to hold an instance object Hwi_Struct;
typedef enum
Hwi_Type// Interrupt type. IRQ or FIQ ...
typedef Void 
(*Hwi_VectorFuncPtr// Hwi vector function type definition)(Void);
typedef struct
Hwi_VIM// ARM Interrupt Controller ...
Constants
extern const Bool 
Hwi_dispatcherAutoNestingSupport// Include interrupt nesting logic in interrupt dispatcher?;
extern const Bool 
Hwi_dispatcherIrpTrackingSupport// Controls whether the dispatcher retains the interrupted thread's return address;
extern const Bool 
Hwi_dispatcherSwiSupport// Include Swi scheduling logic in interrupt dispatcher?;
extern const Bool 
Hwi_dispatcherTaskSupport// Include Task scheduling logic in interrupt dispatcher?;
extern const Error_Id 
Hwi_E_alreadyDefined// Error raised when Hwi is already defined;
extern const Ptr 
Hwi_fiqStack// FIQ stack pointer. Default = null. (Indicates that stack is to be created using staticPlace();
extern const Log_Event 
Hwi_LD_end// Issued just after return from Hwi function (with interrupts disabled);
extern const Log_Event 
Hwi_LM_begin// Issued just prior to Hwi function invocation (with interrupts disabled);
 
DETAILS
This Hwi module provides TMS570 (VIM) specific implementations of the APIs defined in IHwi.
Additional ARM device-specific APIs are also provided.
NOTE
In this Hwi module implementation, the instance config parameter value MaskingOption_LOWER is equivalent to MaskingOption_SELF. Statically configuring a Hwi object's Params.maskSetting to MaskingOption_LOWER will result in the generation of a benign build warning. Dynamic usages of MaskingOption_LOWER will be silently converted to MaskingOption_SELF.

Calling Context

Function Hwi Swi Task Main Startup
clearInterrupt Y Y Y Y Y
create N N Y Y N
disable Y Y Y Y Y
disableREQMASKSET0 Y Y Y Y N
disableREQMASKSET1 Y Y Y Y N
disableFIQ Y Y Y Y Y
disableInterrupt Y Y Y Y N
disableIRQ Y Y Y Y Y
enable Y Y Y N N
enableREQMASKSET0 Y Y Y Y N
enableREQMASKSET1 Y Y Y Y N
enableFIQ Y Y Y N N
enableInterrupt Y Y Y Y N
enableIRQ Y Y Y N N
getHandle Y Y Y Y N
Params_init Y Y Y Y Y
restore Y Y Y Y Y
restoreREQMASKSET0 Y Y Y Y N
restoreREQMASKSET1 Y Y Y Y N
restoreFIQ Y Y Y Y Y
restoreInterrupt Y Y Y Y Y
restoreIRQ Y Y Y Y Y
setPriority Y Y Y Y N
construct N N Y Y N
delete N N Y Y N
destruct N N Y Y N
getHookContext Y Y Y Y N
reconfig Y Y Y Y N
setFunc Y Y Y Y N
setHookContext Y Y Y Y N
Definitions:
  • Hwi: API is callable from a Hwi thread.
  • Swi: API is callable from a Swi thread.
  • Task: API is callable from a Task thread.
  • Main: API is callable during any of these phases:
    • In your module startup after this module is started (e.g. Hwi_Module_startupDone() returns TRUE).
    • During xdc.runtime.Startup.lastFxns.
    • During main().
    • During BIOS.startupFxns.
  • Startup: API is callable during any of these phases:
    • During xdc.runtime.Startup.firstFxns.
    • In your module startup before this module is started (e.g. Hwi_Module_startupDone() returns FALSE).
 
const Hwi_NUM_INTERRUPTS
index URL

The TMS570 ARM Interrupt Controller supports 64 interrupts

C synopsis target-domain
#define Hwi_NUM_INTERRUPTS (Int)64
 
 
enum Hwi_MaskingOption
index URL

Shorthand interrupt masking options

C synopsis target-domain
typedef enum Hwi_MaskingOption {
    Hwi_MaskingOption_NONE,
    Hwi_MaskingOption_ALL,
    Hwi_MaskingOption_SELF,
    Hwi_MaskingOption_BITMASK,
    Hwi_MaskingOption_LOWER
} Hwi_MaskingOption;
 
VALUES
MaskingOption_NONE — No interrupts are disabled
MaskingOption_ALL — All interrupts are disabled
MaskingOption_SELF — Only this interrupt is disabled
MaskingOption_BITMASK — User supplies interrupt enable masks
MaskingOption_LOWER — All current and lower priority interrupts are disabled.
Only a few targets/devices truly support this masking option. For those that don't, this setting is treated the same as MaskingOption_SELF.
 
enum Hwi_Type
index URL

Interrupt type. IRQ or FIQ

C synopsis target-domain
typedef enum Hwi_Type {
    Hwi_Type_IRQ,
    // IRQ interrupt
    Hwi_Type_FIQ
    // FIQ interrupt
} Hwi_Type;
 
 
typedef Hwi_FuncPtr
index URL

Hwi create function type definition

C synopsis target-domain
typedef Void (*Hwi_FuncPtr)(UArg);
 
 
typedef Hwi_Irp
index URL

Interrupt Return Pointer

C synopsis target-domain
typedef UArg Hwi_Irp;
 
DETAILS
This is the address of the interrupted instruction.
 
typedef Hwi_VectorFuncPtr
index URL

Hwi vector function type definition

C synopsis target-domain
typedef Void (*Hwi_VectorFuncPtr)(Void);
 
 
struct Hwi_HookSet
index URL

Hwi hook set type definition

C synopsis target-domain
typedef struct Hwi_HookSet {
    Void (*registerFxn)(Int);
    Void (*createFxn)(IHwi_Handle,Error_Block*);
    Void (*beginFxn)(IHwi_Handle);
    Void (*endFxn)(IHwi_Handle);
    Void (*deleteFxn)(IHwi_Handle);
} Hwi_HookSet;
 
DETAILS
The functions that make up a hookSet have certain restrictions. They cannot call any Hwi instance functions other than Hwi_getHookContext() and Hwi_setHookContext(). For all practical purposes, they should treat the Hwi_Handle passed to these functions as an opaque handle.
 
struct Hwi_StackInfo
index URL

Structure contains Hwi stack usage info

C synopsis target-domain
typedef struct Hwi_StackInfo {
    SizeT hwiStackPeak;
    SizeT hwiStackSize;
    Ptr hwiStackBase;
} Hwi_StackInfo;
 
DETAILS
Used by getStackInfo() and viewGetStackInfo() functions
 
struct Hwi_VIM
index URL

ARM Interrupt Controller

C synopsis target-domain
typedef struct Hwi_VIM {
    UInt32 PARFLG;
    // 0xFDEC VIM RAM Parity Flag Register
    UInt32 PARCTL;
    // 0xFDF0 VIM RAM Parity Control Register
    UInt32 ADDERR;
    // 0xFDF4 Address Parity Error Register
    UInt32 FBPARERR;
    // 0xFDF8 Fallback Parity Error Register
    UInt32 RESFC;
    // 0xFDFC reserved
    UInt32 IRQINDEX;
    // 0x0000 current IRQ id
    UInt32 FIQINDEX;
    // 0x0004 current FIQ id
    UInt32 RES08[2];
    // 0x0008 reserved
    UInt32 FIRQPR[4];
    // 0x0010-0x001C FIQ/IRQ Program Control Registers
    UInt32 INTREQ[4];
    // 0x0020-0x002C Pending Interrupt Request Registers
    UInt32 REQENASET[4];
    // 0x0030-0x003C Interrupt (Enable) Mask Set Registers
    UInt32 REQENACLR[4];
    // 0x0040-0x004C Interrupt (Enable) Mask Clear Registers
    UInt32 WAKEENASET[4];
    // 0x0050-0x005C Wake Mask Set Registers
    UInt32 WAKEENACLR[4];
    // 0x0060-0x006C Wake Mask Clear Registers
    UInt32 IRQVECREG;
    // 0x0070 IRQ vector
    UInt32 FIQVECREG;
    // 0x0074 FIQ vector
    UInt32 CAPEVT;
    // 0x0078 Capture Event Register
    UInt32 RES7C[1];
    // 0x007C reserved
    UInt8 CHANMAP[128];
    // 0x0080-0x00FF Channel Map (Priority) Registers
} Hwi_VIM;
 
 
config Hwi_E_alreadyDefined  // module-wide
index URL

Error raised when Hwi is already defined

C synopsis target-domain
extern const Error_Id Hwi_E_alreadyDefined;
 
 
config Hwi_LD_end  // module-wide
index URL

Issued just after return from Hwi function (with interrupts disabled)

C synopsis target-domain
extern const Log_Event Hwi_LD_end;
 
 
config Hwi_LM_begin  // module-wide
index URL

Issued just prior to Hwi function invocation (with interrupts disabled)

C synopsis target-domain
extern const Log_Event Hwi_LM_begin;
 
 
config Hwi_dispatcherAutoNestingSupport  // module-wide
index URL

Include interrupt nesting logic in interrupt dispatcher?

C synopsis target-domain
extern const Bool Hwi_dispatcherAutoNestingSupport;
 
DETAILS
Default is true.
This option provides the user with the ability to optimize interrupt dispatcher performance when support for interrupt nesting is not required.
Setting this parameter to false will disable the logic in the interrupt dispatcher that manipulates interrupt mask registers and enables and disables interrupts before and after invoking the user's Hwi function.
Set this parameter to false if you don't need interrupts enabled during the execution of your Hwi functions.
 
config Hwi_dispatcherIrpTrackingSupport  // module-wide
index URL

Controls whether the dispatcher retains the interrupted thread's return address

C synopsis target-domain
extern const Bool Hwi_dispatcherIrpTrackingSupport;
 
DETAILS
This option is enabled by default.
Setting this parameter to false will disable the logic in the interrupt dispatcher that keeps track of the interrupt's return address and provide a small savings in interrupt latency.
The application can get an interrupt's most recent return address using the getIrp API.
 
config Hwi_dispatcherSwiSupport  // module-wide
index URL

Include Swi scheduling logic in interrupt dispatcher?

C synopsis target-domain
extern const Bool Hwi_dispatcherSwiSupport;
 
DETAILS
Default is inherited from BIOS.swiEnabled, which is true by default.
This option provides the user with the ability to optimize interrupt dispatcher performance when it is known that Swis will not be posted from any of their Hwi threads.
Setting this parameter to false will disable the logic in the interrupt dispatcher that invokes the Swi scheduler prior to returning from an interrupt.
 
config Hwi_dispatcherTaskSupport  // module-wide
index URL

Include Task scheduling logic in interrupt dispatcher?

C synopsis target-domain
extern const Bool Hwi_dispatcherTaskSupport;
 
DETAILS
Default is inherited from BIOS.taskEnabled, which is true by default.
This option provides the user with the ability to optimize interrupt dispatcher performance when it is known that no Task scheduling APIs (ie Semaphore_post()) will be executed from any of their Hwi threads.
Setting this parameter to false will disable the logic in the interrupt dispatcher that invokes the Task scheduler prior to returning from an interrupt.
 
config Hwi_fiqStack  // module-wide
index URL

FIQ stack pointer. Default = null. (Indicates that stack is to be created using staticPlace()

C synopsis target-domain
extern const Ptr Hwi_fiqStack;
 
 
Hwi_clearInterrupt()  // module-wide
index URL

Clear a specific interrupt

C synopsis target-domain
Void Hwi_clearInterrupt(UInt intNum);
 
ARGUMENTS
intNum — interrupt number to clear
DETAILS
Clears a specific interrupt's pending status. The implementation is family-specific.
 
Hwi_disable()  // module-wide
index URL

Globally disable interrupts

C synopsis target-domain
macro UInt Hwi_disable();
 
RETURNS
opaque key for use by Hwi_restore()
DETAILS
Hwi_disable globally disables hardware interrupts and returns an opaque key indicating whether interrupts were globally enabled or disabled on entry to Hwi_disable(). The actual value of the key is target/device specific and is meant to be passed to Hwi_restore().
Call Hwi_disable before a portion of a function that needs to run without interruption. When critical processing is complete, call Hwi_restore or Hwi_enable to reenable hardware interrupts.
Servicing of interrupts that occur while interrupts are disabled is postponed until interrupts are reenabled. However, if the same type of interrupt occurs several times while interrupts are disabled, the interrupt's function is executed only once when interrupts are reenabled.
A context switch can occur when calling Hwi_enable or Hwi_restore if an enabled interrupt occurred while interrupts are disabled.
Hwi_disable may be called from main(). However, since Hwi interrupts are already disabled in main(), such a call has no effect.
CONSTRAINTS
If a Task switching API such as Semaphore_pend(), Semaphore_post(), Task_sleep(), or Task_yield() is invoked which results in a context switch while interrupts are disabled, an embedded call to Hwi_enable occurs on the way to the new thread context which unconditionally re-enables interrupts. Interrupts will remain enabled until a subsequent Hwi_disable invocation.
Swis always run with interrupts enabled. See Swi_post() for a discussion Swis and interrupts.
 
Hwi_disableFIQ()  // module-wide
index URL

Disable FIQ interrupts

C synopsis target-domain
UInt Hwi_disableFIQ();
 
RETURNS
previous FIQ interrupt enable/disable state
 
Hwi_disableIRQ()  // module-wide
index URL

Disable IRQ interrupts

C synopsis target-domain
UInt Hwi_disableIRQ();
 
RETURNS
previous IRQ interrupt enable/disable state
 
Hwi_disableInterrupt()  // module-wide
index URL

Disable a specific interrupt

C synopsis target-domain
UInt Hwi_disableInterrupt(UInt intNum);
 
ARGUMENTS
intNum — interrupt number to disable
RETURNS
key to restore previous enable/disable state
DETAILS
Disable a specific interrupt identified by an interrupt number.
 
Hwi_enable()  // module-wide
index URL

Globally enable interrupts

C synopsis target-domain
macro UInt Hwi_enable();
 
RETURNS
opaque key for use by Hwi_restore()
DETAILS
Hwi_enable globally enables hardware interrupts and returns an opaque key indicating whether interrupts were globally enabled or disabled on entry to Hwi_enable(). The actual value of the key is target/device specific and is meant to be passed to Hwi_restore().
This function is called as part of SYS/BIOS Startup_POST_APP_MAIN phase.
Hardware interrupts are enabled unless a call to Hwi_disable disables them.
Servicing of interrupts that occur while interrupts are disabled is postponed until interrupts are reenabled. However, if the same type of interrupt occurs several times while interrupts are disabled, the interrupt's function is executed only once when interrupts are reenabled.
A context switch can occur when calling Hwi_enable or Hwi_restore if an enabled interrupt occurred while interrupts are disabled.
Any call to Hwi_enable enables interrupts, even if Hwi_disable has been called several times.
Hwi_enable must not be called from main().
 
Hwi_enableFIQ()  // module-wide
index URL

Enable FIQ interrupts

C synopsis target-domain
UInt Hwi_enableFIQ();
 
RETURNS
previous FIQ interrupt enable/disable state
 
Hwi_enableIRQ()  // module-wide
index URL

Enable IRQ interrupts

C synopsis target-domain
UInt Hwi_enableIRQ();
 
ARGUMENTS
key — enable/disable state to restore
 
Hwi_enableInterrupt()  // module-wide
index URL

Enable a specific interrupt

C synopsis target-domain
UInt Hwi_enableInterrupt(UInt intNum);
 
ARGUMENTS
intNum — interrupt number to enable
RETURNS
key to restore previous enable/disable state
DETAILS
Enables a specific interrupt identified by an interrupt number.
 
Hwi_getHandle()  // module-wide
index URL

Returns pointer to Hwi instance object

C synopsis target-domain
Hwi_Object *Hwi_getHandle(UInt intNum);
 
ARGUMENTS
intNum — interrupt number
 
Hwi_getStackInfo()  // module-wide
index URL

Get Hwi stack usage Info

C synopsis target-domain
Bool Hwi_getStackInfo(IHwi_StackInfo *stkInfo, Bool computeStackDepth);
 
ARGUMENTS
stkInfo — pointer to structure of type StackInfo
computeStackDepth — decides whether to compute stack depth
RETURNS
boolean to indicate a stack overflow
DETAILS
getStackInfo returns the Hwi stack usage info to its calling function by filling stack base address, stack size and stack peak fields in the StackInfo structure.
getStackInfo accepts two arguments, a pointer to a structure of type StackInfo and a boolean. If the boolean is set to true, the function computes the stack depth and fills the stack peak field in the StackInfo structure. If a stack overflow is detected, the stack depth is not computed. If the boolean is set to false, the function only checks for a stack overflow.
The isr stack is always checked for an overflow and a boolean is returned to indicate whether an overflow occured.
Below is an example of calling getStackInfo() API:
  #include <ti/sysbios/BIOS.h>
  #include <ti/sysbios/hal/Hwi.h>
  #include <ti/sysbios/knl/Swi.h>
  #include <ti/sysbios/knl/Task.h>

  Swi_Handle swi0;
  volatile Bool swiStackOverflow = FALSE;

  Void swi0Fxn(UArg arg1, UArg arg2)
  {
      Hwi_StackInfo stkInfo;

      // Request stack depth
      swiStackOverflow = Hwi_getStackInfo(&stkInfo, TRUE);
 
      // Alternately, we can omit the request for stack depth and 
      // request only the stack base and stack size (the check for
      // stack overflow is always performed):
      //
      // swiStackOverflow = Hwi_getStackInfo(&stkInfo, FALSE);

      if (swiStackOverflow) {
          // isr Stack Overflow detected
      }
  }

  Void idleTask()
  {
      Swi_post(swi0);
  }

  Int main(Int argc, char* argv[])
  {
      swi0 = Swi_create(swi0Fxn, NULL, NULL);

      BIOS_start();
      return (0);
  }
 
Hwi_restore()  // module-wide
index URL

Globally restore interrupts

C synopsis target-domain
macro Void Hwi_restore(UInt key);
 
ARGUMENTS
key — enable/disable state to restore
DETAILS
Hwi_restore globally restores interrupts to the state determined by the key argument provided by a previous invocation of Hwi_disable.
A context switch may occur when calling Hwi_restore if Hwi_restore reenables interrupts and another Hwi occurred while interrupts were disabled.
Hwi_restore may be called from main(). However, since Hwi_enable cannot be called from main(), interrupts are always disabled in main(), and a call to Hwi_restore has no effect.
 
Hwi_restoreFIQ()  // module-wide
index URL

Restore FIQ interrupts

C synopsis target-domain
Void Hwi_restoreFIQ(UInt key);
 
ARGUMENTS
key — enable/disable state to restore
 
Hwi_restoreIRQ()  // module-wide
index URL

Restore IRQ interrupts

C synopsis target-domain
Void Hwi_restoreIRQ(UInt key);
 
ARGUMENTS
key — enable/disable state to restore
 
Hwi_restoreInterrupt()  // module-wide
index URL

Restore a specific interrupt's enabled/disabled state

C synopsis target-domain
Void Hwi_restoreInterrupt(UInt intNum, UInt key);
 
ARGUMENTS
intNum — interrupt number to restore
key — key returned from enableInt or disableInt
DETAILS
Restores a specific interrupt identified by an interrupt number. restoreInterrupt is generally used to restore an interrupt to its state before disableInterrupt or enableInterrupt was invoked
 
Hwi_setPriority()  // module-wide
index URL

Set an interrupt's relative priority

C synopsis target-domain
Void Hwi_setPriority(UInt intNum, UInt priority);
 
ARGUMENTS
intNum — ID of interrupt
priority — priority (0-63)
 
Hwi_setType()  // module-wide
index URL

Set an interrupt's type (FIQ/IRQ)

C synopsis target-domain
Void Hwi_setType(UInt intNum, Hwi_Type type);
 
ARGUMENTS
intNum — ID of interrupt
type — type = FIQ/IRQ
DETAILS
Not an instance function so that it can be used with non-dispatched interrupts.
 
Hwi_startup()  // module-wide
index URL

Initially enable interrupts

C synopsis target-domain
Void Hwi_startup();
 
DETAILS
Called within BIOS_start
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId Hwi_Module_id();
// Get this module's unique id
 
Bool Hwi_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle Hwi_Module_heap();
// The heap from which this module allocates memory
 
Bool Hwi_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 Hwi_Module_getMask();
// Returns the diagnostics mask for this module
 
Void Hwi_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types
index URL

C synopsis target-domain
typedef struct Hwi_Object Hwi_Object;
// Opaque internal representation of an instance object
 
typedef Hwi_Object *Hwi_Handle;
// Client reference to an instance object
 
typedef struct Hwi_Struct Hwi_Struct;
// Opaque client structure large enough to hold an instance object
 
Hwi_Handle Hwi_handle(Hwi_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
Hwi_Struct *Hwi_struct(Hwi_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters
index URL

C synopsis target-domain
typedef struct Hwi_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    UArg arg;
    // ISR function argument. Default is 0
    Bits32 disableMask0;
    // disableMask0. default is derived from MaskingOption_SELF maskSetting
    Bits32 disableMask1;
    // disableMask1. default is derived from MaskingOption_SELF maskSetting
    Bool enableInt;
    // Enable this interrupt when object is created? Default is true
    Int eventId;
    // Interrupt event ID (Interrupt Selection Number)
    IHwi_MaskingOption maskSetting;
    // maskSetting. Default is Hwi_MaskingOption_SELF
    Int priority;
    // Interrupt priority
    Bits32 restoreMask0;
    // restoreMask0. default is derived from MaskingOption_SELF maskSetting
    Bits32 restoreMask1;
    // restoreMask1. default is derived from MaskingOption_SELF maskSetting
    Hwi_Type type;
    // Interrupt type (IRQ/FIQ. Default is IRQ
    Bool wakeEnable;
    // wakeEnable. default is true
} Hwi_Params;
 
Void Hwi_Params_init(Hwi_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config Hwi_arg  // instance
index URL

ISR function argument. Default is 0

C synopsis target-domain
struct Hwi_Params {
      ...
    UArg arg;
 
 
config Hwi_disableMask0  // instance
index URL

disableMask0. default is derived from MaskingOption_SELF maskSetting

C synopsis target-domain
struct Hwi_Params {
      ...
    Bits32 disableMask0;
 
 
config Hwi_disableMask1  // instance
index URL

disableMask1. default is derived from MaskingOption_SELF maskSetting

C synopsis target-domain
struct Hwi_Params {
      ...
    Bits32 disableMask1;
 
 
config Hwi_enableInt  // instance
index URL

Enable this interrupt when object is created? Default is true

C synopsis target-domain
struct Hwi_Params {
      ...
    Bool enableInt;
 
 
config Hwi_eventId  // instance
index URL

Interrupt event ID (Interrupt Selection Number)

C synopsis target-domain
struct Hwi_Params {
      ...
    Int eventId;
 
DETAILS
Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored.
 
config Hwi_maskSetting  // instance
index URL

maskSetting. Default is Hwi_MaskingOption_SELF

C synopsis target-domain
struct Hwi_Params {
      ...
    IHwi_MaskingOption maskSetting;
 
 
config Hwi_priority  // instance
index URL

Interrupt priority

C synopsis target-domain
struct Hwi_Params {
      ...
    Int priority;
 
DETAILS
Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored.
 
config Hwi_restoreMask0  // instance
index URL

restoreMask0. default is derived from MaskingOption_SELF maskSetting

C synopsis target-domain
struct Hwi_Params {
      ...
    Bits32 restoreMask0;
 
 
config Hwi_restoreMask1  // instance
index URL

restoreMask1. default is derived from MaskingOption_SELF maskSetting

C synopsis target-domain
struct Hwi_Params {
      ...
    Bits32 restoreMask1;
 
 
config Hwi_type  // instance
index URL

Interrupt type (IRQ/FIQ. Default is IRQ

C synopsis target-domain
struct Hwi_Params {
      ...
    Hwi_Type type;
 
 
config Hwi_wakeEnable  // instance
index URL

wakeEnable. default is true

C synopsis target-domain
struct Hwi_Params {
      ...
    Bool wakeEnable;
 
Instance Creation
index URL

C synopsis target-domain
Hwi_Handle Hwi_create(Int intNum, IHwi_FuncPtr hwiFxn, const Hwi_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void Hwi_construct(Hwi_Struct *structP, Int intNum, IHwi_FuncPtr hwiFxn, const Hwi_Params *params, Error_Block *eb);
// Initialize a new instance object inside the provided structure
ARGUMENTS
intNum — interrupt number
hwiFxn — pointer to ISR function
params — per-instance config params, or NULL to select default values (target-domain only)
eb — active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
A Hwi dispatcher table entry is created and filled with the function specified by the fxn parameter and the attributes specified by the params parameter.
If params is NULL, the Hwi's dispatcher properties are assigned a default set of values. Otherwise, the following properties are specified by a structure of type Hwi_Params.
  • The arg element is a generic argument that is passed to the plugged function as its only parameter. The default value is 0.
  • The enableInt element determines whether the interrupt should be enabled in the IER by create.
  • The maskSetting element defines the dispatcherAutoNestingSupport behavior of the interrupt.
Hwi_create returns a pointer to the created Hwi object.
Instance Deletion
index URL

C synopsis target-domain
Void Hwi_delete(Hwi_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void Hwi_destruct(Hwi_Struct *structP);
// Finalize the instance object inside the provided structure
 
Hwi_getFunc()  // instance
index URL

Get Hwi function and arg

C synopsis target-domain
IHwi_FuncPtr Hwi_getFunc(Hwi_Handle handle, UArg *arg);
 
ARGUMENTS
handle — handle of a previously-created Hwi instance object
arg — pointer for returning hwi's ISR function argument
RETURNS
hwi's ISR function
 
Hwi_getHookContext()  // instance
index URL

Get hook instance's context for a Hwi

C synopsis target-domain
Ptr Hwi_getHookContext(Hwi_Handle handle, Int id);
 
ARGUMENTS
handle — handle of a previously-created Hwi instance object
RETURNS
hook instance's context for hwi
 
Hwi_getIrp()  // instance
index URL

Get address of interrupted instruction

C synopsis target-domain
IHwi_Irp Hwi_getIrp(Hwi_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created Hwi instance object
RETURNS
most current IRP of a Hwi
 
Hwi_reconfig()  // instance
index URL

Reconfigure a dispatched interrupt

C synopsis target-domain
Void Hwi_reconfig(Hwi_Handle handle, Hwi_FuncPtr fxn, Hwi_Params *params);
 
ARGUMENTS
handle — handle of a previously-created Hwi instance object
 
Hwi_setFunc()  // instance
index URL

Overwrite Hwi function and arg

C synopsis target-domain
Void Hwi_setFunc(Hwi_Handle handle, IHwi_FuncPtr fxn, UArg arg);
 
ARGUMENTS
handle — handle of a previously-created Hwi instance object
fxn — pointer to ISR function
arg — argument to ISR function
DETAILS
Replaces a Hwi object's hwiFxn function originally provided in create.
 
Hwi_setHookContext()  // instance
index URL

Set hook instance's context for a Hwi

C synopsis target-domain
Void Hwi_setHookContext(Hwi_Handle handle, Int id, Ptr hookContext);
 
ARGUMENTS
handle — handle of a previously-created Hwi instance object
id — hook instance's ID
hookContext — value to write to context
Instance Convertors
index URL

C synopsis target-domain
IHwi_Handle Hwi_Handle_upCast(Hwi_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
Hwi_Handle Hwi_Handle_downCast(IHwi_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins
index URL

C synopsis target-domain
Int Hwi_Object_count();
// The number of statically-created instance objects
 
Hwi_Handle Hwi_Object_get(Hwi_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
Hwi_Handle Hwi_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
Hwi_Handle Hwi_Object_next(Hwi_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle Hwi_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *Hwi_Handle_label(Hwi_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String Hwi_Handle_name(Hwi_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sysbios/family/arm/tms570/Hwi.xdc
var Hwi = xdc.useModule('ti.sysbios.family.arm.tms570.Hwi');
module-wide constants & types
    const Hwi.NUM_INTERRUPTS// The TMS570 ARM Interrupt Controller supports 64 interrupts = 64;
 
    values of type Hwi.MaskingOption// Shorthand interrupt masking options
        const Hwi.MaskingOption_NONE;
        const Hwi.MaskingOption_ALL;
        const Hwi.MaskingOption_SELF;
        const Hwi.MaskingOption_BITMASK;
        const Hwi.MaskingOption_LOWER;
 
    values of type Hwi.Type// Interrupt type. IRQ or FIQ
        const Hwi.Type_IRQ// IRQ interrupt;
        const Hwi.Type_FIQ// FIQ interrupt;
 
    var obj = new Hwi.HookSet// Hwi hook set type definition;
        obj.registerFxn = Void(*)(Int)  ...
        obj.createFxn = Void(*)(IHwi.Handle,Error.Block*)  ...
        obj.beginFxn = Void(*)(IHwi.Handle)  ...
        obj.endFxn = Void(*)(IHwi.Handle)  ...
        obj.deleteFxn = Void(*)(IHwi.Handle)  ...
 
    var obj = new Hwi.StackInfo// Structure contains Hwi stack usage info;
        obj.hwiStackPeak = SizeT  ...
        obj.hwiStackSize = SizeT  ...
        obj.hwiStackBase = Ptr  ...
 
    var obj = new Hwi.VIM// ARM Interrupt Controller;
        obj.PARFLG// 0xFDEC VIM RAM Parity Flag Register = UInt32  ...
        obj.PARCTL// 0xFDF0 VIM RAM Parity Control Register = UInt32  ...
        obj.ADDERR// 0xFDF4 Address Parity Error Register = UInt32  ...
        obj.FBPARERR// 0xFDF8 Fallback Parity Error Register = UInt32  ...
        obj.RESFC// 0xFDFC reserved = UInt32  ...
        obj.IRQINDEX// 0x0000 current IRQ id = UInt32  ...
        obj.FIQINDEX// 0x0004 current FIQ id = UInt32  ...
        obj.RES08// 0x0008 reserved = UInt32[2]  ...
        obj.FIRQPR// 0x0010-0x001C FIQ/IRQ Program Control Registers = UInt32[4]  ...
        obj.INTREQ// 0x0020-0x002C Pending Interrupt Request Registers = UInt32[4]  ...
        obj.REQENASET// 0x0030-0x003C Interrupt (Enable) Mask Set Registers = UInt32[4]  ...
        obj.REQENACLR// 0x0040-0x004C Interrupt (Enable) Mask Clear Registers = UInt32[4]  ...
        obj.WAKEENASET// 0x0050-0x005C Wake Mask Set Registers = UInt32[4]  ...
        obj.WAKEENACLR// 0x0060-0x006C Wake Mask Clear Registers = UInt32[4]  ...
        obj.IRQVECREG// 0x0070 IRQ vector = UInt32  ...
        obj.FIQVECREG// 0x0074 FIQ vector = UInt32  ...
        obj.CAPEVT// 0x0078 Capture Event Register = UInt32  ...
        obj.RES7C// 0x007C reserved = UInt32[1]  ...
        obj.CHANMAP// 0x0080-0x00FF Channel Map (Priority) Registers = UInt8[128]  ...
module-wide config parameters
    Hwi.E_alreadyDefined// Error raised when Hwi is already defined = Error.Desc {
        msg: "E_alreadyDefined: Hwi already defined: intr# %d"
    };
    Hwi.LD_end// Issued just after return from Hwi function (with interrupts disabled) = Log.EventDesc {
        mask: Diags.USER2,
        msg: "LD_end: hwi: 0x%x"
    };
    Hwi.LM_begin// Issued just prior to Hwi function invocation (with interrupts disabled) = Log.EventDesc {
        mask: Diags.USER1 | Diags.USER2,
        msg: "LM_begin: hwi: 0x%x, func: 0x%x, preThread: %d, intNum: %d, irp: 0x%x"
    };
    Hwi.dispatcherAutoNestingSupport// Include interrupt nesting logic in interrupt dispatcher? = Bool true;
    Hwi.dispatcherIrpTrackingSupport// Controls whether the dispatcher retains the interrupted thread's return address = Bool true;
    Hwi.dispatcherSwiSupport// Include Swi scheduling logic in interrupt dispatcher? = Bool undefined;
    Hwi.dispatcherTaskSupport// Include Task scheduling logic in interrupt dispatcher? = Bool undefined;
    Hwi.fiqStack// FIQ stack pointer. Default = null. (Indicates that stack is to be created using staticPlace() = Ptr null;
 
    Hwi.common$// Common module configuration parameters = Types.Common$ undefined;
    Hwi.dataAbortFunc// Data abort exception handler. Default is self loop = Void(*)(Void) undefined;
    Hwi.fiqFunc// FIQ interrupt handler. Default is internal FIQ dispatcher = Void(*)(Void) undefined;
    Hwi.fiqStackSection// Memory section used for FIQ stack Default is null = String null;
    Hwi.fiqStackSize// FIQ stack size in MAUs. Default is 1024 bytes = SizeT 1024;
    Hwi.irqFunc// IRQ interrupt handler. Default is internal IRQ dispatcher = Void(*)(Void) undefined;
    Hwi.prefetchAbortFunc// Prefetch abort exception handler. Default is self loop = Void(*)(Void) undefined;
    Hwi.reservedFunc// Reserved exception handler. Default is self loop = Void(*)(Void) undefined;
    Hwi.resetFunc// Reset Handler. Default is c_int00 = Void(*)(Void) undefined;
    Hwi.swiFunc// SWI Handler. Default is internal SWI handler = Void(*)(Void) undefined;
    Hwi.undefinedInstFunc// Undefined instruction exception handler. Default is self loop = Void(*)(Void) undefined;
module-wide functions
    Hwi.addHookSet// addHookSet is used in a config file to add a hook set (defined by struct HookSet)(IHwi.HookSet hook) returns Void
per-instance config parameters
    var params = new Hwi.Params// Instance config-params object;
        params.arg// ISR function argument. Default is 0 = UArg 0;
        params.disableMask0// disableMask0. default is derived from MaskingOption_SELF maskSetting = Bits32 0;
        params.disableMask1// disableMask1. default is derived from MaskingOption_SELF maskSetting = Bits32 0;
        params.enableInt// Enable this interrupt when object is created? Default is true = Bool true;
        params.eventId// Interrupt event ID (Interrupt Selection Number) = Int -1;
        params.maskSetting// maskSetting. Default is Hwi_MaskingOption_SELF = IHwi.MaskingOption IHwi.MaskingOption_SELF;
        params.priority// Interrupt priority = Int -1;
        params.restoreMask0// restoreMask0. default is derived from MaskingOption_SELF maskSetting = Bits32 0;
        params.restoreMask1// restoreMask1. default is derived from MaskingOption_SELF maskSetting = Bits32 0;
        params.type// Interrupt type (IRQ/FIQ. Default is IRQ = Hwi.Type Hwi.Type_IRQ;
        params.wakeEnable// wakeEnable. default is true = Bool true;
per-instance creation
    var inst = Hwi.create// Create an instance-object(Int intNum, Void(*)(UArg) hwiFxn, params);
 
 
const Hwi.NUM_INTERRUPTS
index URL

The TMS570 ARM Interrupt Controller supports 64 interrupts

XDCscript usage meta-domain
const Hwi.NUM_INTERRUPTS = 64;
 
C SYNOPSIS
Hwi_NUM_INTERRUPTS
 
enum Hwi.MaskingOption
index URL

Shorthand interrupt masking options

XDCscript usage meta-domain
values of type Hwi.MaskingOption
    const Hwi.MaskingOption_NONE;
    const Hwi.MaskingOption_ALL;
    const Hwi.MaskingOption_SELF;
    const Hwi.MaskingOption_BITMASK;
    const Hwi.MaskingOption_LOWER;
 
VALUES
MaskingOption_NONE — No interrupts are disabled
MaskingOption_ALL — All interrupts are disabled
MaskingOption_SELF — Only this interrupt is disabled
MaskingOption_BITMASK — User supplies interrupt enable masks
MaskingOption_LOWER — All current and lower priority interrupts are disabled.
Only a few targets/devices truly support this masking option. For those that don't, this setting is treated the same as MaskingOption_SELF.
C SYNOPSIS
Hwi_MaskingOption
 
enum Hwi.Type
index URL

Interrupt type. IRQ or FIQ

XDCscript usage meta-domain
values of type Hwi.Type
    const Hwi.Type_IRQ;
    // IRQ interrupt
    const Hwi.Type_FIQ;
    // FIQ interrupt
 
C SYNOPSIS
Hwi_Type
 
struct Hwi.HookSet
index URL

Hwi hook set type definition

XDCscript usage meta-domain
var obj = new Hwi.HookSet;
 
    obj.registerFxn = Void(*)(Int)  ...
    obj.createFxn = Void(*)(IHwi.Handle,Error.Block*)  ...
    obj.beginFxn = Void(*)(IHwi.Handle)  ...
    obj.endFxn = Void(*)(IHwi.Handle)  ...
    obj.deleteFxn = Void(*)(IHwi.Handle)  ...
 
DETAILS
The functions that make up a hookSet have certain restrictions. They cannot call any Hwi instance functions other than Hwi_getHookContext() and Hwi_setHookContext(). For all practical purposes, they should treat the Hwi_Handle passed to these functions as an opaque handle.
C SYNOPSIS
Hwi_HookSet
 
struct Hwi.StackInfo
index URL

Structure contains Hwi stack usage info

XDCscript usage meta-domain
var obj = new Hwi.StackInfo;
 
    obj.hwiStackPeak = SizeT  ...
    obj.hwiStackSize = SizeT  ...
    obj.hwiStackBase = Ptr  ...
 
DETAILS
Used by getStackInfo() and viewGetStackInfo() functions
C SYNOPSIS
Hwi_StackInfo
 
struct Hwi.VIM
index URL

ARM Interrupt Controller

XDCscript usage meta-domain
var obj = new Hwi.VIM;
 
    obj.PARFLG = UInt32  ...
    // 0xFDEC VIM RAM Parity Flag Register
    obj.PARCTL = UInt32  ...
    // 0xFDF0 VIM RAM Parity Control Register
    obj.ADDERR = UInt32  ...
    // 0xFDF4 Address Parity Error Register
    obj.FBPARERR = UInt32  ...
    // 0xFDF8 Fallback Parity Error Register
    obj.RESFC = UInt32  ...
    // 0xFDFC reserved
    obj.IRQINDEX = UInt32  ...
    // 0x0000 current IRQ id
    obj.FIQINDEX = UInt32  ...
    // 0x0004 current FIQ id
    obj.RES08 = UInt32[2]  ...
    // 0x0008 reserved
    obj.FIRQPR = UInt32[4]  ...
    // 0x0010-0x001C FIQ/IRQ Program Control Registers
    obj.INTREQ = UInt32[4]  ...
    // 0x0020-0x002C Pending Interrupt Request Registers
    obj.REQENASET = UInt32[4]  ...
    // 0x0030-0x003C Interrupt (Enable) Mask Set Registers
    obj.REQENACLR = UInt32[4]  ...
    // 0x0040-0x004C Interrupt (Enable) Mask Clear Registers
    obj.WAKEENASET = UInt32[4]  ...
    // 0x0050-0x005C Wake Mask Set Registers
    obj.WAKEENACLR = UInt32[4]  ...
    // 0x0060-0x006C Wake Mask Clear Registers
    obj.IRQVECREG = UInt32  ...
    // 0x0070 IRQ vector
    obj.FIQVECREG = UInt32  ...
    // 0x0074 FIQ vector
    obj.CAPEVT = UInt32  ...
    // 0x0078 Capture Event Register
    obj.RES7C = UInt32[1]  ...
    // 0x007C reserved
    obj.CHANMAP = UInt8[128]  ...
    // 0x0080-0x00FF Channel Map (Priority) Registers
 
C SYNOPSIS
Hwi_VIM
 
config Hwi.E_alreadyDefined  // module-wide
index URL

Error raised when Hwi is already defined

XDCscript usage meta-domain
Hwi.E_alreadyDefined = Error.Desc {
    msg: "E_alreadyDefined: Hwi already defined: intr# %d"
};
 
C SYNOPSIS
Hwi_E_alreadyDefined
 
config Hwi.LD_end  // module-wide
index URL

Issued just after return from Hwi function (with interrupts disabled)

XDCscript usage meta-domain
Hwi.LD_end = Log.EventDesc {
    mask: Diags.USER2,
    msg: "LD_end: hwi: 0x%x"
};
 
C SYNOPSIS
Hwi_LD_end
 
config Hwi.LM_begin  // module-wide
index URL

Issued just prior to Hwi function invocation (with interrupts disabled)

XDCscript usage meta-domain
Hwi.LM_begin = Log.EventDesc {
    mask: Diags.USER1 | Diags.USER2,
    msg: "LM_begin: hwi: 0x%x, func: 0x%x, preThread: %d, intNum: %d, irp: 0x%x"
};
 
C SYNOPSIS
Hwi_LM_begin
 
config Hwi.dispatcherAutoNestingSupport  // module-wide
index URL

Include interrupt nesting logic in interrupt dispatcher?

XDCscript usage meta-domain
Hwi.dispatcherAutoNestingSupport = Bool true;
 
DETAILS
Default is true.
This option provides the user with the ability to optimize interrupt dispatcher performance when support for interrupt nesting is not required.
Setting this parameter to false will disable the logic in the interrupt dispatcher that manipulates interrupt mask registers and enables and disables interrupts before and after invoking the user's Hwi function.
Set this parameter to false if you don't need interrupts enabled during the execution of your Hwi functions.
C SYNOPSIS
Hwi_dispatcherAutoNestingSupport
 
config Hwi.dispatcherIrpTrackingSupport  // module-wide
index URL

Controls whether the dispatcher retains the interrupted thread's return address

XDCscript usage meta-domain
Hwi.dispatcherIrpTrackingSupport = Bool true;
 
DETAILS
This option is enabled by default.
Setting this parameter to false will disable the logic in the interrupt dispatcher that keeps track of the interrupt's return address and provide a small savings in interrupt latency.
The application can get an interrupt's most recent return address using the getIrp API.
C SYNOPSIS
Hwi_dispatcherIrpTrackingSupport
 
config Hwi.dispatcherSwiSupport  // module-wide
index URL

Include Swi scheduling logic in interrupt dispatcher?

XDCscript usage meta-domain
Hwi.dispatcherSwiSupport = Bool undefined;
 
DETAILS
Default is inherited from BIOS.swiEnabled, which is true by default.
This option provides the user with the ability to optimize interrupt dispatcher performance when it is known that Swis will not be posted from any of their Hwi threads.
Setting this parameter to false will disable the logic in the interrupt dispatcher that invokes the Swi scheduler prior to returning from an interrupt.
C SYNOPSIS
Hwi_dispatcherSwiSupport
 
config Hwi.dispatcherTaskSupport  // module-wide
index URL

Include Task scheduling logic in interrupt dispatcher?

XDCscript usage meta-domain
Hwi.dispatcherTaskSupport = Bool undefined;
 
DETAILS
Default is inherited from BIOS.taskEnabled, which is true by default.
This option provides the user with the ability to optimize interrupt dispatcher performance when it is known that no Task scheduling APIs (ie Semaphore_post()) will be executed from any of their Hwi threads.
Setting this parameter to false will disable the logic in the interrupt dispatcher that invokes the Task scheduler prior to returning from an interrupt.
C SYNOPSIS
Hwi_dispatcherTaskSupport
 
config Hwi.fiqStack  // module-wide
index URL

FIQ stack pointer. Default = null. (Indicates that stack is to be created using staticPlace()

XDCscript usage meta-domain
Hwi.fiqStack = Ptr null;
 
C SYNOPSIS
Hwi_fiqStack
 
metaonly config Hwi.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
Hwi.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 Hwi.dataAbortFunc  // module-wide
index URL

Data abort exception handler. Default is self loop

XDCscript usage meta-domain
Hwi.dataAbortFunc = Void(*)(Void) undefined;
 
 
metaonly config Hwi.fiqFunc  // module-wide
index URL

FIQ interrupt handler. Default is internal FIQ dispatcher

XDCscript usage meta-domain
Hwi.fiqFunc = Void(*)(Void) undefined;
 
 
metaonly config Hwi.fiqStackSection  // module-wide
index URL

Memory section used for FIQ stack Default is null

XDCscript usage meta-domain
Hwi.fiqStackSection = String null;
 
 
metaonly config Hwi.fiqStackSize  // module-wide
index URL

FIQ stack size in MAUs. Default is 1024 bytes

XDCscript usage meta-domain
Hwi.fiqStackSize = SizeT 1024;
 
 
metaonly config Hwi.irqFunc  // module-wide
index URL

IRQ interrupt handler. Default is internal IRQ dispatcher

XDCscript usage meta-domain
Hwi.irqFunc = Void(*)(Void) undefined;
 
 
metaonly config Hwi.prefetchAbortFunc  // module-wide
index URL

Prefetch abort exception handler. Default is self loop

XDCscript usage meta-domain
Hwi.prefetchAbortFunc = Void(*)(Void) undefined;
 
 
metaonly config Hwi.reservedFunc  // module-wide
index URL

Reserved exception handler. Default is self loop

XDCscript usage meta-domain
Hwi.reservedFunc = Void(*)(Void) undefined;
 
 
metaonly config Hwi.resetFunc  // module-wide
index URL

Reset Handler. Default is c_int00

XDCscript usage meta-domain
Hwi.resetFunc = Void(*)(Void) undefined;
 
 
metaonly config Hwi.swiFunc  // module-wide
index URL

SWI Handler. Default is internal SWI handler

XDCscript usage meta-domain
Hwi.swiFunc = Void(*)(Void) undefined;
 
 
metaonly config Hwi.undefinedInstFunc  // module-wide
index URL

Undefined instruction exception handler. Default is self loop

XDCscript usage meta-domain
Hwi.undefinedInstFunc = Void(*)(Void) undefined;
 
 
metaonly Hwi.addHookSet()  // module-wide
index URL

addHookSet is used in a config file to add a hook set (defined by struct HookSet)

XDCscript usage meta-domain
Hwi.addHookSet(IHwi.HookSet hook) returns Void
 
ARGUMENTS
hook — structure of type HookSet
DETAILS
HookSet structure elements may be omitted, in which case those elements will not exist.
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Hwi.Params;
// Instance config-params object
    params.arg = UArg 0;
    // ISR function argument. Default is 0
    params.disableMask0 = Bits32 0;
    // disableMask0. default is derived from MaskingOption_SELF maskSetting
    params.disableMask1 = Bits32 0;
    // disableMask1. default is derived from MaskingOption_SELF maskSetting
    params.enableInt = Bool true;
    // Enable this interrupt when object is created? Default is true
    params.eventId = Int -1;
    // Interrupt event ID (Interrupt Selection Number)
    params.maskSetting = IHwi.MaskingOption IHwi.MaskingOption_SELF;
    // maskSetting. Default is Hwi_MaskingOption_SELF
    params.priority = Int -1;
    // Interrupt priority
    params.restoreMask0 = Bits32 0;
    // restoreMask0. default is derived from MaskingOption_SELF maskSetting
    params.restoreMask1 = Bits32 0;
    // restoreMask1. default is derived from MaskingOption_SELF maskSetting
    params.type = Hwi.Type Hwi.Type_IRQ;
    // Interrupt type (IRQ/FIQ. Default is IRQ
    params.wakeEnable = Bool true;
    // wakeEnable. default is true
 
config Hwi.arg  // instance
index URL

ISR function argument. Default is 0

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.arg = UArg 0;
 
C SYNOPSIS
null
 
config Hwi.disableMask0  // instance
index URL

disableMask0. default is derived from MaskingOption_SELF maskSetting

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.disableMask0 = Bits32 0;
 
C SYNOPSIS
null
 
config Hwi.disableMask1  // instance
index URL

disableMask1. default is derived from MaskingOption_SELF maskSetting

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.disableMask1 = Bits32 0;
 
C SYNOPSIS
null
 
config Hwi.enableInt  // instance
index URL

Enable this interrupt when object is created? Default is true

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.enableInt = Bool true;
 
C SYNOPSIS
null
 
config Hwi.eventId  // instance
index URL

Interrupt event ID (Interrupt Selection Number)

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.eventId = Int -1;
 
DETAILS
Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored.
C SYNOPSIS
null
 
config Hwi.maskSetting  // instance
index URL

maskSetting. Default is Hwi_MaskingOption_SELF

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.maskSetting = IHwi.MaskingOption IHwi.MaskingOption_SELF;
 
C SYNOPSIS
null
 
config Hwi.priority  // instance
index URL

Interrupt priority

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.priority = Int -1;
 
DETAILS
Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored.
C SYNOPSIS
null
 
config Hwi.restoreMask0  // instance
index URL

restoreMask0. default is derived from MaskingOption_SELF maskSetting

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.restoreMask0 = Bits32 0;
 
C SYNOPSIS
null
 
config Hwi.restoreMask1  // instance
index URL

restoreMask1. default is derived from MaskingOption_SELF maskSetting

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.restoreMask1 = Bits32 0;
 
C SYNOPSIS
null
 
config Hwi.type  // instance
index URL

Interrupt type (IRQ/FIQ. Default is IRQ

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.type = Hwi.Type Hwi.Type_IRQ;
 
C SYNOPSIS
null
 
config Hwi.wakeEnable  // instance
index URL

wakeEnable. default is true

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.wakeEnable = Bool true;
 
C SYNOPSIS
null
Instance Creation
index URL

XDCscript usage meta-domain
var params = new Hwi.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = Hwi.create(Int intNum, Void(*)(UArg) hwiFxn, params);
// Create an instance-object
ARGUMENTS
intNum — interrupt number
hwiFxn — pointer to ISR function
params — per-instance config params, or NULL to select default values (target-domain only)
eb — active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
A Hwi dispatcher table entry is created and filled with the function specified by the fxn parameter and the attributes specified by the params parameter.
If params is NULL, the Hwi's dispatcher properties are assigned a default set of values. Otherwise, the following properties are specified by a structure of type Hwi_Params.
  • The arg element is a generic argument that is passed to the plugged function as its only parameter. The default value is 0.
  • The enableInt element determines whether the interrupt should be enabled in the IER by create.
  • The maskSetting element defines the dispatcherAutoNestingSupport behavior of the interrupt.
Hwi_create returns a pointer to the created Hwi object.
generated on Thu, 01 Mar 2012 16:57:42 GMT