module ti.sysbios.hal.Hwi
index URL

Hardware Interrupt Manager Proxy

This module is a proxy to the generic Hwi module functions Hwi_enable, Hwi_disable, and Hwi_restore as defined in IHwi.xdc. [ more ... ]
XDCspec summary sourced in ti/sysbios/hal/Hwi.xdc
@ModuleStartup
module Hwi {  ...
// inherits ti.sysbios.interfaces.IHwi
    // inherits xdc.runtime.IModule
instance:  ...
C synopsis target-domain
#include <ti/sysbios/hal/Hwi.h>
module-wide constants & types
    typedef enum Hwi_MaskingOption// Shorthand interrupt masking options {
        Hwi_MaskingOption_NONE// No interrupts are disabled,
        Hwi_MaskingOption_ALL// All interrupts are disabled,
        Hwi_MaskingOption_SELF// Only this interrupt is disabled,
        Hwi_MaskingOption_BITMASK// User supplies IER masks,
        Hwi_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
    } Hwi_MaskingOption;
 
    typedef Void (*Hwi_FuncPtr// Hwi create function type definition)(UArg);
    typedef UArg Hwi_Irp// Interrupt Return Pointer. This is the address of the interrupted instruction;
 
    typedef struct Hwi_HookSet// Hwi hook set type definition {
        Void (*registerFxn)(Int);
        Void (*createFxn)(IHwi_Handle,Error_Block*);
        Void (*beginFxn)(IHwi_Handle);
        Void (*endFxn)(IHwi_Handle);
        Void (*deleteFxn)(IHwi_Handle);
    } Hwi_HookSet;
module-wide config parameters
    extern const Bool Hwi_dispatcherAutoNestingSupport// Include interrupt nesting logic in interrupt dispatcher? Default is true;
    extern const Bool Hwi_dispatcherIrpTrackingSupport// This dispatcher configuration option controls whether the dispatcher retains the interrupted thread's return address. This option is enabled by default;
    extern const Bool Hwi_dispatcherSwiSupport// Include Swi scheduling logic in interrupt dispatcher? Default is inherited from BIOS.swiEnabled, which is true by default;
    extern const Bool Hwi_dispatcherTaskSupport// Include Task scheduling logic in interrupt dispatcher? Default is inherited from BIOS.taskEnabled, which is true by default;
module-wide functions
    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 );
    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_startup// Initially enable interrupts( );
module-wide built-ins
    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// Set the diagnostics mask for this module( Bits16 mask );
per-instance object types
    typedef struct Hwi_Object// Opaque internal representation of an instance object Hwi_Object;
    typedef Hwi_Object *Hwi_Handle// Client reference to an instance object;
    typedef struct Hwi_Struct// Opaque client structure large enough to hold an instance object Hwi_Struct;
 
    Hwi_Handle Hwi_handle// Convert this instance structure pointer into an instance handle( Hwi_Struct *structP );
    Hwi_Struct *Hwi_struct// Convert this instance handle into an instance structure pointer( Hwi_Handle handle );
per-instance config parameters
    typedef struct Hwi_Params// Instance config-params structure {
        IInstance_Params *instance;
        UArg arg// ISR function argument. Default is 0;
        Bool enableInt// Enable this interrupt now? Default is true;
        Int eventId// Interrupt event ID (Interrupt Selection Number) Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored;
        IHwi_MaskingOption maskSetting// maskSetting. Default is {@link #MaskingOption Hwi_MaskingOption_SELF};
        Int priority// Interrupt priority. Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored;
    } Hwi_Params;
 
    Void Hwi_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation( Hwi_Params *params );
per-instance creation
    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_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 );
per-instance deletion
    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 );
per-instance functions
    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 );
    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 );
per-instance convertors
    IHwi_Handle Hwi_Handle_upCast// unconditionally move one level up the inheritance hierarchy( Hwi_Handle handle );
    Hwi_Handle Hwi_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure( IHwi_Handle handle );
per-instance built-ins
    Int Hwi_Object_count// The number of statically-created instance objects( );
    Hwi_Handle Hwi_Object_get// The handle of the i-th statically-created instance object (array == NULL)( Hwi_Object *array, Int i );
    Hwi_Handle Hwi_Object_first// The handle of the first dynamically-created instance object, or NULL( );
    Hwi_Handle Hwi_Object_next// The handle of the next dynamically-created instance object, or NULL( Hwi_Handle handle );
    IHeap_Handle Hwi_Object_heap// The heap used to allocate dynamically-created instance objects( );
    Types_Label *Hwi_Handle_label// The label associated with this instance object( Hwi_Handle handle, Types_Label *buf );
    String Hwi_Handle_name// The name of this instance object( Hwi_Handle handle );
 
XDCscript usage meta-domain
var Hwi = xdc.useModule('ti.sysbios.hal.Hwi');
module-wide constants & types
    values of type Hwi.MaskingOption// Shorthand interrupt masking options
        const Hwi.MaskingOption_NONE// No interrupts are disabled;
        const Hwi.MaskingOption_ALL// All interrupts are disabled;
        const Hwi.MaskingOption_SELF// Only this interrupt is disabled;
        const Hwi.MaskingOption_BITMASK// User supplies IER masks;
        const Hwi.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;
 
    var obj = new Hwi.BasicView// ;
        obj.label = String  ...
        obj.delegateHwiHandle = String  ...
        obj.intNum = Int  ...
        obj.fxn = String  ...
        obj.arg = UArg  ...
 
    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.ModuleView// ;
        obj.delegateHwiModule = String  ...
        obj.options = String[4]  ...
        obj.hwiStackPeak = SizeT  ...
        obj.hwiStackSize = SizeT  ...
        obj.hwiStackBase = Ptr  ...
module-wide config parameters
    Hwi.dispatcherAutoNestingSupport// Include interrupt nesting logic in interrupt dispatcher? Default is true = Bool true;
    Hwi.dispatcherIrpTrackingSupport// This dispatcher configuration option controls whether the dispatcher retains the interrupted thread's return address. This option is enabled by default = Bool true;
    Hwi.dispatcherSwiSupport// Include Swi scheduling logic in interrupt dispatcher? Default is inherited from BIOS.swiEnabled, which is true by default = Bool undefined;
    Hwi.dispatcherTaskSupport// Include Task scheduling logic in interrupt dispatcher? Default is inherited from BIOS.taskEnabled, which is true by default = Bool undefined;
 
    Hwi.checkStackFlag// Check for Hwi stack overrun during Idle loop = Bool true;
    Hwi.common$// Common module configuration parameters = Types.Common$ undefined;
    Hwi.rovViewInfo//  = ViewInfo.Instance ViewInfo.create;
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.enableInt// Enable this interrupt now? Default is true = Bool true;
        params.eventId// Interrupt event ID (Interrupt Selection Number) Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored = Int -1;
        params.maskSetting// maskSetting. Default is {@link #MaskingOption Hwi_MaskingOption_SELF} = IHwi.MaskingOption IHwi.MaskingOption_SELF;
        params.priority// Interrupt priority. Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored = Int -1;
per-instance creation
    var inst = Hwi.create// Create an instance-object( Int intNum, Void(*)(UArg) hwiFxn, params );
 
XDCspec declarations sourced in ti/sysbios/hal/Hwi.xdc
package ti.sysbios.hal;
 
@ModuleStartup
module Hwi inherits IHwi {
module-wide constants & types
    enum MaskingOption// Shorthand interrupt masking options {
        MaskingOption_NONE// No interrupts are disabled,
        MaskingOption_ALL// All interrupts are disabled,
        MaskingOption_SELF// Only this interrupt is disabled,
        MaskingOption_BITMASK// User supplies IER 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 Void (*FuncPtr// Hwi create function type definition)(UArg);
    typedef UArg Irp// Interrupt Return Pointer. This is the address of the interrupted instruction;
 
    metaonly struct BasicView//  {
        String label;
        String delegateHwiHandle;
        Int intNum;
        String fxn;
        UArg arg;
    };
 
    struct HookSet// Hwi hook set type definition {
        Void (*registerFxn)(Int);
        Void (*createFxn)(IHwi.Handle,Error.Block*);
        Void (*beginFxn)(IHwi.Handle);
        Void (*endFxn)(IHwi.Handle);
        Void (*deleteFxn)(IHwi.Handle);
    };
 
    metaonly struct ModuleView//  {
        String delegateHwiModule;
        String options[4];
        SizeT hwiStackPeak;
        SizeT hwiStackSize;
        Ptr hwiStackBase;
    };
module-wide config parameters
    config Bool dispatcherAutoNestingSupport// Include interrupt nesting logic in interrupt dispatcher? Default is true = true;
    config Bool dispatcherIrpTrackingSupport// This dispatcher configuration option controls whether the dispatcher retains the interrupted thread's return address. This option is enabled by default = true;
    config Bool dispatcherSwiSupport// Include Swi scheduling logic in interrupt dispatcher? Default is inherited from BIOS.swiEnabled, which is true by default;
    config Bool dispatcherTaskSupport// Include Task scheduling logic in interrupt dispatcher? Default is inherited from BIOS.taskEnabled, which is true by default;
 
    metaonly config Bool checkStackFlag// Check for Hwi stack overrun during Idle loop = true;
    metaonly config Types.Common$ common$// Common module configuration parameters;
    metaonly config ViewInfo.Instance rovViewInfo//  = ViewInfo.create;
module-wide functions
    Void clearInterrupt// Clear a specific interrupt( UInt intNum );
    @Macro override UInt disable// Globally disable interrupts( );
    UInt disableInterrupt// Disable a specific interrupt( UInt intNum );
    @Macro override UInt enable// Globally enable interrupts( );
    UInt enableInterrupt// Enable a specific interrupt( UInt intNum );
    @Macro override Void restore// Globally restore interrupts( UInt key );
    Void restoreInterrupt// Restore a specific interrupt's enabled/disabled state( UInt intNum, UInt key );
    Void startup// Initially enable interrupts( );
 
    metaonly Void addHookSet// addHookSet is used in a config file to add a hook set (defined by struct HookSet)( IHwi.HookSet hook );
 
 
instance:
per-instance config parameters
    config UArg arg// ISR function argument. Default is 0 = 0;
    config Bool enableInt// Enable this interrupt now? Default is true = true;
    config Int eventId// Interrupt event ID (Interrupt Selection Number) Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored = -1;
    config IHwi.MaskingOption maskSetting// maskSetting. Default is Hwi_MaskingOption_SELF = IHwi.MaskingOption_SELF;
    config Int priority// Interrupt priority. Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored = -1;
per-instance creation
    create// Create an instance-object( Int intNum, IHwi.FuncPtr hwiFxn );
per-instance functions
    IHwi.FuncPtr getFunc// Get Hwi function and arg( UArg *arg );
    override Ptr getHookContext// Get hook instance's context for a hwi( Int id );
    IHwi.Irp getIrp// Get address of interrupted instruction( );
    Void setFunc// Overwrite Hwi function and arg( IHwi.FuncPtr fxn, UArg arg );
    override Void setHookContext// Set hook instance's context for a hwi( Int id, Ptr hookContext );
}
DETAILS
This module is a proxy to the generic Hwi module functions Hwi_enable, Hwi_disable, and Hwi_restore as defined in IHwi.xdc.
The actual implementations of the Hwi module functions are provided by the Hwi module delegates.
Additional, family specific Hwi module APIs may also be provided by the Hwi module delegates.
Follow the link below to determine which Hwi delegate is used for your Target/Device:
Delegate Mappings

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
disableInterrupt Y Y Y Y N
enable Y Y Y N N
enableInterrupt Y Y Y Y N
Params_init Y Y Y Y Y
restore Y Y Y Y Y
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
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).
 
enum Hwi.MaskingOption
index URL

Shorthand interrupt masking options

XDCscript usage meta-domain
values of type Hwi.MaskingOption
    const Hwi.MaskingOption_NONE;
    // No interrupts are disabled
    const Hwi.MaskingOption_ALL;
    // All interrupts are disabled
    const Hwi.MaskingOption_SELF;
    // Only this interrupt is disabled
    const Hwi.MaskingOption_BITMASK;
    // User supplies IER masks
    const Hwi.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 target-domain
typedef enum Hwi_MaskingOption {
    Hwi_MaskingOption_NONE,
    // No interrupts are disabled
    Hwi_MaskingOption_ALL,
    // All interrupts are disabled
    Hwi_MaskingOption_SELF,
    // Only this interrupt is disabled
    Hwi_MaskingOption_BITMASK,
    // User supplies IER masks
    Hwi_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
} Hwi_MaskingOption;
 
 
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. This is the address of the interrupted instruction

C synopsis target-domain
typedef UArg Hwi_Irp;
 
 
metaonly struct Hwi.BasicView
index URL
XDCscript usage meta-domain
var obj = new Hwi.BasicView;
 
    obj.label = String  ...
    obj.delegateHwiHandle = String  ...
    obj.intNum = Int  ...
    obj.fxn = String  ...
    obj.arg = UArg  ...
 
 
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)  ...
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;
 
 
metaonly struct Hwi.ModuleView
index URL
XDCscript usage meta-domain
var obj = new Hwi.ModuleView;
 
    obj.delegateHwiModule = String  ...
    obj.options = String[4]  ...
    obj.hwiStackPeak = SizeT  ...
    obj.hwiStackSize = SizeT  ...
    obj.hwiStackBase = Ptr  ...
 
 
config Hwi.dispatcherAutoNestingSupport  // module-wide
index URL

Include interrupt nesting logic in interrupt dispatcher? Default is true

XDCscript usage meta-domain
Hwi.dispatcherAutoNestingSupport = Bool true;
C synopsis target-domain
extern const Bool Hwi_dispatcherAutoNestingSupport;
 
DETAILS
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

This dispatcher configuration option controls whether the dispatcher retains the interrupted thread's return address. This option is enabled by default

XDCscript usage meta-domain
Hwi.dispatcherIrpTrackingSupport = Bool true;
C synopsis target-domain
extern const Bool Hwi_dispatcherIrpTrackingSupport;
 
DETAILS
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? Default is inherited from BIOS.swiEnabled, which is true by default

XDCscript usage meta-domain
Hwi.dispatcherSwiSupport = Bool undefined;
C synopsis target-domain
extern const Bool Hwi_dispatcherSwiSupport;
 
DETAILS
This option provides the user with the ability to optimize interrupt dispatcher performance when it is known that Swi's 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? Default is inherited from BIOS.taskEnabled, which is true by default

XDCscript usage meta-domain
Hwi.dispatcherTaskSupport = Bool undefined;
C synopsis target-domain
extern const Bool Hwi_dispatcherTaskSupport;
 
DETAILS
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.
 
metaonly config Hwi.checkStackFlag  // module-wide
index URL

Check for Hwi stack overrun during Idle loop

XDCscript usage meta-domain
Hwi.checkStackFlag = Bool true;
 
DETAILS
If true, then an idle function is added to the idle loop that checks for a Hwi stack overrun condition and raises an Error if one is detected.
Default is true.
 
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.rovViewInfo  // module-wide
index URL
XDCscript usage meta-domain
Hwi.rovViewInfo = ViewInfo.Instance ViewInfo.create;
 
 
Hwi.clearInterrupt( )  // module-wide
index URL

Clear a specific interrupt

C synopsis target-domain
Void Hwi_clearInterrupt( UInt intNum );
 
ARGUMENTS
intNum — interrupt number to enable
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.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 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.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.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.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.startup( )  // module-wide
index URL

Initially enable interrupts

C synopsis target-domain
Void Hwi_startup( );
 
DETAILS
Called within BIOS_start
 
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.
 
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
 
per-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
 
per-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.enableInt = Bool true;
    // Enable this interrupt now? Default is true
    params.eventId = Int -1;
    // Interrupt event ID (Interrupt Selection Number) Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored
    params.maskSetting = IHwi.MaskingOption IHwi.MaskingOption_SELF;
    // maskSetting. Default is {@link #MaskingOption Hwi_MaskingOption_SELF}
    params.priority = Int -1;
    // Interrupt priority. Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored
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
    Bool enableInt;
    // Enable this interrupt now? Default is true
    Int eventId;
    // Interrupt event ID (Interrupt Selection Number) Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored
    IHwi_MaskingOption maskSetting;
    // maskSetting. Default is {@link #MaskingOption Hwi_MaskingOption_SELF}
    Int priority;
    // Interrupt priority. Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored
} Hwi_Params;
 
Void Hwi_Params_init( Hwi_Params *params );
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config Hwi.arg  // per-instance
index URL

ISR function argument. Default is 0

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.arg = UArg 0;
C synopsis target-domain
struct Hwi_Params {
      ...
    UArg arg;
 
 
config Hwi.enableInt  // per-instance
index URL

Enable this interrupt now? Default is true

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.enableInt = Bool true;
C synopsis target-domain
struct Hwi_Params {
      ...
    Bool enableInt;
 
 
config Hwi.eventId  // per-instance
index URL

Interrupt event ID (Interrupt Selection Number) Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.eventId = Int -1;
C synopsis target-domain
struct Hwi_Params {
      ...
    Int eventId;
 
 
config Hwi.maskSetting  // per-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 target-domain
struct Hwi_Params {
      ...
    IHwi_MaskingOption maskSetting;
 
 
config Hwi.priority  // per-instance
index URL

Interrupt priority. Default is -1. Not all targets/devices support this instance parameter. On those that don't, this parameter is ignored

XDCscript usage meta-domain
var params = new Hwi.Params;
  ...
params.priority = Int -1;
C synopsis target-domain
struct Hwi_Params {
      ...
    Int priority;
 
 
per-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
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 Hwi's dispatcher properties are specified by a structure of type Hwi_Params.
The maskSetting element defines the dispatcherAutoNestingSupport behavior of the interrupt.
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.
Hwi_create returns a pointer to the created Hwi object.
 
per-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( )  // per-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( )  // per-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
hook instance's context for hwi
DETAILS
The Handle passed to this API must be the handle passed to any of the Hook functions, not the one returned by create.
 
Hwi.getIrp( )  // per-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.setFunc( )  // per-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( )  // per-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
hook instance's ID
hookContext — value to write to context
value to write to context
DETAILS
The Handle passed to this API must be the handle passed to any of the Hook functions, not the one returned by create.
 
per-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
 
per-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
generated on Mon, 21 Dec 2009 19:43:16 GMT