module ti.sysbios.family.c64p.Hwi

C64+ Hardware Interrupt Support Module

This Hwi module provides C64+ family-specific implementations of the APIs defined in IHwi. [ more ... ]
C synopsis target-domain sourced in ti/sysbios/family/c64p/Hwi.xdc
#include <ti/sysbios/family/c64p/Hwi.h>
Functions
Void
Void
Void
Bits16 
Bits16 
Void 
Void
Void 
Bits16 
Functions common to all IHwi modules
Void 
macro UInt 
UInt 
macro UInt 
UInt 
Ptr 
Bool 
macro Void 
Void 
Void 
Void 
Void 
Functions common to all target instances
Functions common to all target modules
Defines
#define
Typedefs
typedef Void 
typedef Hwi_Object *
typedef struct
typedef UArg 
typedef enum
typedef struct
typedef struct
typedef struct
typedef struct
Constants
extern const Bool 
extern const Bool 
extern const Bool 
extern const Bool 
extern const Bool 
extern const Error_Id 
extern const Log_Event 
extern const Log_Event 
 
DETAILS
This Hwi module provides C64+ family-specific implementations of the APIs defined in IHwi.
Additional C64+ device-specific APIs are also provided.
An example of creating a Hwi instance:
  Int intNum;
  Hwi_Params params;
  Error_Block eb;
  
  // Initialize the error block
  Error_init(&eb);

  // Initialize the Hwi parameters
  Hwi_Params_init(&params);
  
  // Set the GEM event id in the params
  params.eventId = 78

  // Specify the interrupt vector number 
  intNum = 8;

  // create the Hwi for the specified interrupt number and params
  Hwi_create(intNum, myIsr, &params, &eb);

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
disableIER Y Y Y Y N
disableInterrupt Y Y Y Y N
enable Y Y Y N N
enableIER Y Y Y Y N
enableInterrupt Y Y Y Y N
eventMap Y Y Y Y N
getHandle Y Y Y Y N
Params_init Y Y Y Y Y
restore Y Y Y Y Y
restoreIER Y Y Y Y N
restoreInterrupt Y Y Y Y Y
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

C64+ supports 16 interrupts

C synopsis target-domain
#define Hwi_NUM_INTERRUPTS (Int)16
 
 
enum Hwi_MaskingOption

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.
 
typedef Hwi_FuncPtr

Hwi create function type definition

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

Interrupt Return Pointer

C synopsis target-domain
typedef UArg Hwi_Irp;
 
DETAILS
This is the address of the interrupted instruction.
 
struct Hwi_HookSet

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

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
 
config Hwi_E_alreadyDefined  // module-wide

Error raised when Hwi is already defined

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

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

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

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

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

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

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_enableException  // module-wide

enable Exception module for exception processing

C synopsis target-domain
extern const Bool Hwi_enableException;
 
 
Hwi_clearInterrupt()  // module-wide

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

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_disableIER()  // module-wide

Disable certain maskable interrupts

C synopsis target-domain
Bits16 Hwi_disableIER(Bits16 mask);
 
ARGUMENTS
mask — bitmask of interrupts to disable
RETURNS
previous IER settings bitmask
DETAILS
Atomically disables specific interrupts by clearing the bits specified by mask in the Interrupt Enable Register (IER).
The IER bits to be cleared should be set to 1 in the mask.
 
Hwi_disableInterrupt()  // module-wide

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

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_enableIER()  // module-wide

Enable certain maskable interrupts

C synopsis target-domain
Bits16 Hwi_enableIER(Bits16 mask);
 
ARGUMENTS
mask — bitmask of interrupts to enable
RETURNS
previous IER settings bitmask
DETAILS
Atomically enables specific interrupts by setting the bits specified by mask in the Interrupt Enable Register (IER).
The IER bits to be set should be set to 1 in the mask.
 
Hwi_enableInterrupt()  // module-wide

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_eventMap()  // module-wide

Maps a GEM event to interrupt number

C synopsis target-domain
Void Hwi_eventMap(Int intNum, Int eventId);
 
ARGUMENTS
intNum — interrupt number
eventId — event ID
DETAILS
Function maps a GEM event to an interrupt number so that the event is the interrupt source of the vector.
      // Maps GEM event #65 as the interrupt source of int vector #7
      Hwi_eventMap(7, 65);
 
Hwi_getHandle()  // module-wide

Returns Hwi_handle associated with interrupt number

C synopsis target-domain
Hwi_Handle Hwi_getHandle(UInt intNum);
 
ARGUMENTS
intNum — interrupt number
RETURNS
handle associated with intNum
 
Hwi_getStackInfo()  // module-wide

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

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_restoreIER()  // module-wide

Restore maskable interrupts to the state they were in when either disableIER() or enableIER() was called

C synopsis target-domain
Bits16 Hwi_restoreIER(Bits16 mask);
 
ARGUMENTS
mask — bitmask of interrupts to restore
RETURNS
previous IER settings bitmask
DETAILS
Atomically writes the given mask to the IER register. Typically used to restore the IER register to the state returned from a call to either disableIER() or enableIER().
 
Hwi_restoreInterrupt()  // module-wide

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_startup()  // module-wide

Initially enable interrupts

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

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

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

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
    Bits16 disableMask;
    // Dispatcher auto-nesting interrupt disable mask
    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. Not supported on this target
    Bits16 restoreMask;
    // Dispatcher auto-nesting interrupt restore mask
} 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

ISR function argument. Default is 0

C synopsis target-domain
struct Hwi_Params {
      ...
    UArg arg;
 
 
config Hwi_disableMask  // instance

Dispatcher auto-nesting interrupt disable mask

C synopsis target-domain
struct Hwi_Params {
      ...
    Bits16 disableMask;
 
DETAILS
When the dispatcher's auto interrupt nesting support feature is enabled (see dispatcherAutoNestingSupport), this mask defines which IER bits are disabled prior to invoking the user's ISR function with GIE = 1.
disableMask bits set to 1 correspond to IER bits that will be cleared prior to invoking the ISR.
The value of this mask is normally auto-calculated based on the value of the maskSetting. However, manual setting of this mask is enabled by setting the maskSetting to MaskingOption_BITMASK.
The default value is derived from the MaskingOption_SELF maskSetting.
 
config Hwi_enableInt  // instance

Enable this interrupt when object is created? Default is true

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

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

maskSetting. Default is Hwi_MaskingOption_SELF

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

Interrupt priority. Not supported on this target

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_restoreMask  // instance

Dispatcher auto-nesting interrupt restore mask

C synopsis target-domain
struct Hwi_Params {
      ...
    Bits16 restoreMask;
 
DETAILS
When the dispatcher's auto interrupt nesting support feature is enabled (see dispatcherAutoNestingSupport), this mask defines which IER bits are restored to their previous setting upon return from the user's ISR function.
restoreMask bits set to 1 correspond to IER bits that will be restored.
The value of this mask is normally auto-calculated based on the value of the maskSetting. However, manual setting of this mask is enabled by setting the maskSetting to MaskingOption_BITMASK.
The default value is derived from the MaskingOption_SELF maskSetting.
Instance Creation

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

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

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

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

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

Reconfigures 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
fxn — pointer to ISR function
params — pointer to Hwi parameter structure
DETAILS
This function reconfigures the dispatched interrupt so the specified function is called with the specified parameters.
 
Hwi_setFunc()  // instance

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

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

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

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/c64p/Hwi.xdc
var Hwi = xdc.useModule('ti.sysbios.family.c64p.Hwi');
module-wide constants & types
 
        const Hwi.MaskingOption_NONE;
        const Hwi.MaskingOption_ALL;
        const Hwi.MaskingOption_SELF;
        const Hwi.MaskingOption_BITMASK;
        const Hwi.MaskingOption_LOWER;
 
        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)  ...
 
        obj.intNum = Int  ...
        obj.fxn// "Hwi_plug'd" ISR function = Void(*)(Void)  ...
        obj.enableInt = Bool  ...
        obj.eventId = Int  ...
 
        obj.hwiStackPeak = SizeT  ...
        obj.hwiStackSize = SizeT  ...
        obj.hwiStackBase = Ptr  ...
module-wide config parameters
        msg: "E_alreadyDefined: Hwi already defined: intr# %d"
    };
        mask: Diags.USER2,
        msg: "LD_end: hwi: 0x%x"
    };
        mask: Diags.USER1 | Diags.USER2,
        msg: "LM_begin: hwi: 0x%x, func: 0x%x, preThread: %d, intNum: %d, irp: 0x%x"
    };
 
module-wide functions
    Hwi.eventMapMeta// Maps GEM Event to interrupt number statically(Int intNum, Int eventId) returns Void
    Hwi.plugMeta// Statically plug an interrupt vector with an ISR address(UInt intNum, Void(*)(Void) fxn) 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;
per-instance creation
    var inst = Hwi.create// Create an instance-object(Int intNum, Void(*)(UArg) hwiFxn, params);
 
 
const Hwi.NUM_INTERRUPTS

C64+ supports 16 interrupts

XDCscript usage meta-domain
const Hwi.NUM_INTERRUPTS = 16;
 
C SYNOPSIS
 
enum Hwi.MaskingOption

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
 
struct Hwi.HookSet

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
 
metaonly struct Hwi.NonDispatchedInterrupt

non-dispatched interrupt object. provided so that XGCONF users can easily plug non-dispatched interrupts

XDCscript usage meta-domain
var obj = new Hwi.NonDispatchedInterrupt;
 
    obj.intNum = Int  ...
    obj.fxn = Void(*)(Void)  ...
    // "Hwi_plug'd" ISR function
    obj.enableInt = Bool  ...
    obj.eventId = Int  ...
 
 
struct Hwi.StackInfo

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
 
config Hwi.E_alreadyDefined  // module-wide

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
 
config Hwi.LD_end  // module-wide

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
 
config Hwi.LM_begin  // module-wide

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
 
config Hwi.dispatcherAutoNestingSupport  // module-wide

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
 
config Hwi.dispatcherIrpTrackingSupport  // module-wide

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
 
config Hwi.dispatcherSwiSupport  // module-wide

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
 
config Hwi.dispatcherTaskSupport  // module-wide

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
 
config Hwi.enableException  // module-wide

enable Exception module for exception processing

XDCscript usage meta-domain
Hwi.enableException = Bool true;
 
C SYNOPSIS
 
metaonly config Hwi.common$  // module-wide

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.nonDispatchedInterrupts  // module-wide

non-dispatched interrupt array. provided so that XGCONF users can easily plug non-dispatched interrupts

XDCscript usage meta-domain
Hwi.nonDispatchedInterrupts = Hwi.NonDispatchedInterrupt[string] undefined;
 
 
metaonly config Hwi.resetVectorAddress  // module-wide

Alternate reset vector address. Default is undefined

XDCscript usage meta-domain
Hwi.resetVectorAddress = Ptr undefined;
 
DETAILS
if initialized by the user then an additional reset vector is created and placed in the ".resetVector" section. To place the .resetVector section into a specific memory section, add the following command to your config script:
  Program.sectMap[".resetVector"] = YourMemorySection;
 
metaonly Hwi.addHookSet()  // module-wide

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.
 
metaonly Hwi.eventMapMeta()  // module-wide

Maps GEM Event to interrupt number statically

XDCscript usage meta-domain
Hwi.eventMapMeta(Int intNum, Int eventId) returns Void
 
ARGUMENTS
intNum — interrupt number
eventId — event Id
DETAILS
Function maps a GEM event to an interrupt number so that the event is the interrupt source of the vector.
      // Maps GEM event #65 as the interrupt source of int vector #7
      Hwi.eventMapMeta(7, 65);
 
metaonly Hwi.plugMeta()  // module-wide

Statically plug an interrupt vector with an ISR address

XDCscript usage meta-domain
Hwi.plugMeta(UInt intNum, Void(*)(Void) fxn) returns Void
 
ARGUMENTS
intNum — interrupt number
fxn — pointer to ISR function
Instance Config Parameters

XDCscript usage meta-domain
var params = new Hwi.Params;
// Instance config-params object
    params.arg = UArg 0;
    // ISR function argument. Default is 0
    params.disableMask = Bits16 0;
    // Dispatcher auto-nesting interrupt disable mask
    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 0;
    // Interrupt priority. Not supported on this target
    params.restoreMask = Bits16 0;
    // Dispatcher auto-nesting interrupt restore mask
 
config Hwi.arg  // instance

ISR function argument. Default is 0

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

Dispatcher auto-nesting interrupt disable mask

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.disableMask = Bits16 0;
 
DETAILS
When the dispatcher's auto interrupt nesting support feature is enabled (see dispatcherAutoNestingSupport), this mask defines which IER bits are disabled prior to invoking the user's ISR function with GIE = 1.
disableMask bits set to 1 correspond to IER bits that will be cleared prior to invoking the ISR.
The value of this mask is normally auto-calculated based on the value of the maskSetting. However, manual setting of this mask is enabled by setting the maskSetting to MaskingOption_BITMASK.
The default value is derived from the MaskingOption_SELF maskSetting.
C SYNOPSIS
 
config Hwi.enableInt  // instance

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
 
config Hwi.eventId  // instance

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
 
config Hwi.maskSetting  // instance

maskSetting. Default is Hwi_MaskingOption_SELF

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
 
C SYNOPSIS
 
config Hwi.priority  // instance

Interrupt priority. Not supported on this target

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

Dispatcher auto-nesting interrupt restore mask

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.restoreMask = Bits16 0;
 
DETAILS
When the dispatcher's auto interrupt nesting support feature is enabled (see dispatcherAutoNestingSupport), this mask defines which IER bits are restored to their previous setting upon return from the user's ISR function.
restoreMask bits set to 1 correspond to IER bits that will be restored.
The value of this mask is normally auto-calculated based on the value of the maskSetting. However, manual setting of this mask is enabled by setting the maskSetting to MaskingOption_BITMASK.
The default value is derived from the MaskingOption_SELF maskSetting.
C SYNOPSIS
Instance Creation

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:07 GMT