module ti.sysbios.gates.GateHwi
index URL

Hardware Interrupt Gate

GateHwi uses disabling and enabling of interrupts as the resource locking mechanism. Such a gate guarantees exclusive access to the CPU. This gate can be used whenever the resource is being shared by Tasks, Swis, and/or Hwis. [ more ... ]
C synopsis target-domain sourced in ti/sysbios/gates/GateHwi.xdc
#include <ti/sysbios/gates/GateHwi.h>
Functions
Void
GateHwi_construct// Initialize a new instance object inside the provided structure(GateHwi_Struct *structP, const GateHwi_Params *params);
GateHwi_Handle
GateHwi_create// Allocate and initialize a new instance object and return its handle(const GateHwi_Params *params, Error_Block *eb);
Void
GateHwi_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(GateHwi_Handle *handleP);
Void
GateHwi_destruct// Finalize the instance object inside the provided structure(GateHwi_Struct *structP);
Void
GateHwi_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(GateHwi_Params *params);
Functions common to all IGateProvider modules
Bool 
GateHwi_query// Runtime test for a particular gate quality(Int qual);
Functions common to all target instances
GateHwi_handle// Convert this instance structure pointer into an instance handle, GateHwi_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, GateHwi_Handle_label// The label associated with this instance object, GateHwi_Handle_name// The name of this instance object, GateHwi_Handle_upCast// unconditionally move one level up the inheritance hierarchy, GateHwi_Object_count// The number of statically-created instance objects, GateHwi_Object_first// The handle of the first dynamically-created instance object, or NULL, GateHwi_Object_get// The handle of the i-th statically-created instance object (array == NULL), GateHwi_Object_heap// The heap used to allocate dynamically-created instance objects, GateHwi_Object_next// The handle of the next dynamically-created instance object, or NULL, GateHwi_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
GateHwi_Module_getMask// Returns the diagnostics mask for this module, GateHwi_Module_hasMask// Test whether this module has a diagnostics mask, GateHwi_Module_heap// The heap from which this module allocates memory, GateHwi_Module_id// Get this module's unique id, GateHwi_Module_setMask// Set the diagnostics mask for this module, GateHwi_Module_startupDone// Test if this module has completed startup
Defines
#define
GateHwi_Q_BLOCKING// Blocking quality (Int)1
#define
GateHwi_Q_PREEMPTING// Preempting quality (Int)2
Typedefs
typedef GateHwi_Object *
GateHwi_Handle// Client reference to an instance object;
typedef struct
GateHwi_Object// Opaque internal representation of an instance object GateHwi_Object;
typedef struct
GateHwi_Params// Instance config-params structure ...
typedef struct
GateHwi_Struct// Opaque client structure large enough to hold an instance object GateHwi_Struct;
 
DETAILS
GateHwi uses disabling and enabling of interrupts as the resource locking mechanism. Such a gate guarantees exclusive access to the CPU. This gate can be used whenever the resource is being shared by Tasks, Swis, and/or Hwis.
The duration between the enter and leave should be as short as possible to minimize Hwi latency.
GateHwi inherits from xdc.runtime.IGateProvider, therefore supports nesting.

Calling Context

Function Hwi Swi Task Main Startup
Params_init Y Y Y Y Y
query Y Y Y Y Y
construct Y Y Y Y N
create N* N* Y Y N
delete N* N* Y Y N
destruct Y Y Y Y N
enter Y Y Y Y** Y**
leave Y Y Y Y** Y**
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. GateHwi_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. GateHwi_Module_startupDone() returns FALSE).
  • *: Assuming blocking Heap is used for creation.
  • **: Must be used in enter/leave pairs.
const GateHwi_Q_BLOCKING
index URL

Blocking quality

C synopsis target-domain
#define GateHwi_Q_BLOCKING (Int)1
DETAILS
Gates with this "quality" may cause the calling thread to block; i.e., suspend execution until another thread leaves the gate.
const GateHwi_Q_PREEMPTING
index URL

Preempting quality

C synopsis target-domain
#define GateHwi_Q_PREEMPTING (Int)2
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
GateHwi_query()  // module-wide
index URL

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateHwi_query(Int qual);
ARGUMENTS
qual — constant describing a quality
RETURNS
Returns TRUE if the gate has the given quality, and FALSE otherwise, which includes the case when the gate does not recognize the constant describing the quality.
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId GateHwi_Module_id();
// Get this module's unique id
 
Bool GateHwi_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle GateHwi_Module_heap();
// The heap from which this module allocates memory
 
Bool GateHwi_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 GateHwi_Module_getMask();
// Returns the diagnostics mask for this module
 
Void GateHwi_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types
index URL

C synopsis target-domain
typedef struct GateHwi_Object GateHwi_Object;
// Opaque internal representation of an instance object
 
typedef GateHwi_Object *GateHwi_Handle;
// Client reference to an instance object
 
typedef struct GateHwi_Struct GateHwi_Struct;
// Opaque client structure large enough to hold an instance object
 
GateHwi_Handle GateHwi_handle(GateHwi_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
GateHwi_Struct *GateHwi_struct(GateHwi_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters
index URL

C synopsis target-domain
typedef struct GateHwi_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
} GateHwi_Params;
 
Void GateHwi_Params_init(GateHwi_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
Instance Creation
index URL

C synopsis target-domain
GateHwi_Handle GateHwi_create(const GateHwi_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void GateHwi_construct(GateHwi_Struct *structP, const GateHwi_Params *params);
// Initialize a new instance object inside the provided structure
ARGUMENTS
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)
Instance Deletion
index URL

C synopsis target-domain
Void GateHwi_delete(GateHwi_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateHwi_destruct(GateHwi_Struct *structP);
// Finalize the instance object inside the provided structure
Instance Convertors
index URL

C synopsis target-domain
IGateProvider_Handle GateHwi_Handle_upCast(GateHwi_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
GateHwi_Handle GateHwi_Handle_downCast(IGateProvider_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins
index URL

C synopsis target-domain
Int GateHwi_Object_count();
// The number of statically-created instance objects
 
GateHwi_Handle GateHwi_Object_get(GateHwi_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
GateHwi_Handle GateHwi_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
GateHwi_Handle GateHwi_Object_next(GateHwi_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateHwi_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateHwi_Handle_label(GateHwi_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String GateHwi_Handle_name(GateHwi_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sysbios/gates/GateHwi.xdc
var GateHwi = xdc.useModule('ti.sysbios.gates.GateHwi');
module-wide constants & types
    const GateHwi.Q_BLOCKING// Blocking quality = 1;
    const GateHwi.Q_PREEMPTING// Preempting quality = 2;
    var obj = new GateHwi.BasicView// ;
        obj.label = String  ...
module-wide config parameters
    GateHwi.common$// Common module configuration parameters = Types.Common$ undefined;
    GateHwi.rovViewInfo//  = ViewInfo.Instance ViewInfo.create;
module-wide functions
    GateHwi.queryMeta// Configuration time test for a particular gate quality(Int qual) returns Bool
per-instance config parameters
    var params = new GateHwi.Params// Instance config-params object;
per-instance creation
    var inst = GateHwi.create// Create an instance-object(params);
 
const GateHwi.Q_BLOCKING
index URL

Blocking quality

XDCscript usage meta-domain
const GateHwi.Q_BLOCKING = 1;
DETAILS
Gates with this "quality" may cause the calling thread to block; i.e., suspend execution until another thread leaves the gate.
C SYNOPSIS
GateHwi_Q_BLOCKING
const GateHwi.Q_PREEMPTING
index URL

Preempting quality

XDCscript usage meta-domain
const GateHwi.Q_PREEMPTING = 2;
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
C SYNOPSIS
GateHwi_Q_PREEMPTING
metaonly struct GateHwi.BasicView
index URL
XDCscript usage meta-domain
var obj = new GateHwi.BasicView;
 
    obj.label = String  ...
metaonly config GateHwi.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
GateHwi.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 GateHwi.rovViewInfo  // module-wide
index URL
XDCscript usage meta-domain
GateHwi.rovViewInfo = ViewInfo.Instance ViewInfo.create;
metaonly GateHwi.queryMeta()  // module-wide
index URL

Configuration time test for a particular gate quality

XDCscript usage meta-domain
GateHwi.queryMeta(Int qual) returns Bool
ARGUMENTS
qual — constant describing a quality
RETURNS
Returns TRUE if the gate has the given quality, and FALSE otherwise, which includes the case when the gate does not recognize the constant describing the quality.
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new GateHwi.Params;
// Instance config-params object
Instance Creation
index URL

XDCscript usage meta-domain
var params = new GateHwi.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateHwi.create(params);
// Create an instance-object
ARGUMENTS
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)
generated on Fri, 21 Jan 2011 00:19:23 GMT