module ti.mcu.msp430.runtime.GateGIE

Global interrupt disable/enable implementation of IGateProvider

C synopsis
Individual elements
XDCscript usage
Individual elements

Instances of this gate implementation disable all interrupts and should only be used for modules in which the data structures protected by module-level gates are held for fixed short durations.

C synopsis target-domain sourced in ti/mcu/msp430/runtime/GateGIE.xdc

#include <ti/mcu/msp430/runtime/GateGIE.h>

Functions
Void	GateGIE_construct// Initialize a new instance object inside the provided structure(GateGIE_Struct structP, const GateGIE_Params params);
GateGIE_Handle	GateGIE_create// Allocate and initialize a new instance object and return its handle(const GateGIE_Params params, Error_Block eb);
Void	GateGIE_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(GateGIE_Handle *handleP);
Void	GateGIE_destruct// Finalize the instance object inside the provided structure(GateGIE_Struct *structP);
Void	GateGIE_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(GateGIE_Params *params);
Functions common to all IGateProvider modules
IArg	GateGIE_enter// Enter this gate(GateGIE_Handle handle);
Void	GateGIE_leave// Leave this gate(GateGIE_Handle handle, IArg key);
Bool	GateGIE_query// Runtime test for a particular gate quality(Int qual);
Functions common to all target instances
	GateGIE_handle// Convert this instance structure pointer into an instance handle, GateGIE_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, GateGIE_Handle_label// The label associated with this instance object, GateGIE_Handle_name// The name of this instance object, GateGIE_Handle_upCast// unconditionally move one level up the inheritance hierarchy, GateGIE_Object_count// The number of statically-created instance objects, GateGIE_Object_first// The handle of the first dynamically-created instance object, or NULL, GateGIE_Object_get// The handle of the i-th statically-created instance object (array == NULL), GateGIE_Object_heap// The heap used to allocate dynamically-created instance objects, GateGIE_Object_next// The handle of the next dynamically-created instance object, or NULL, GateGIE_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	GateGIE_Module_getMask// Returns the diagnostics mask for this module, GateGIE_Module_hasMask// Test whether this module has a diagnostics mask, GateGIE_Module_heap// The heap from which this module allocates memory, GateGIE_Module_id// Get this module's unique id, GateGIE_Module_setMask// Set the diagnostics mask for this module, GateGIE_Module_startupDone// Test if this module has completed startup
Defines
#define	GateGIE_Q_BLOCKING// Blocking quality (Int)1
#define	GateGIE_Q_PREEMPTING// Preempting quality (Int)2
Typedefs
typedef GateGIE_Object *	GateGIE_Handle// Client reference to an instance object;
typedef struct	GateGIE_Object// Opaque internal representation of an instance object GateGIE_Object;
typedef struct	GateGIE_Params// Instance config-params structure ...
typedef struct	GateGIE_Struct// Opaque client structure large enough to hold an instance object GateGIE_Struct;

const GateGIE_Q_BLOCKING

index URL

Blocking quality

C synopsis target-domain

#define GateGIE_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 GateGIE_Q_PREEMPTING

index URL

Preempting quality

C synopsis target-domain

#define GateGIE_Q_PREEMPTING (Int)2

DETAILS

Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.

GateGIE_query() // module-wide

index URL

Runtime test for a particular gate quality

C synopsis target-domain

Bool GateGIE_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 GateGIE_Module_id();

// Get this module's unique id

Bool GateGIE_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle GateGIE_Module_heap();

// The heap from which this module allocates memory

Bool GateGIE_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 GateGIE_Module_getMask();

// Returns the diagnostics mask for this module

Void GateGIE_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

Instance Object Types

index URL

C synopsis target-domain

typedef struct GateGIE_Object GateGIE_Object;

// Opaque internal representation of an instance object

typedef GateGIE_Object *GateGIE_Handle;

// Client reference to an instance object

typedef struct GateGIE_Struct GateGIE_Struct;

// Opaque client structure large enough to hold an instance object

GateGIE_Handle GateGIE_handle(GateGIE_Struct *structP);

// Convert this instance structure pointer into an instance handle

GateGIE_Struct *GateGIE_struct(GateGIE_Handle handle);

// Convert this instance handle into an instance structure pointer

Instance Config Parameters

index URL

C synopsis target-domain

typedef struct GateGIE_Params {

// Instance config-params structure

IInstance_Params *instance;

// Common per-instance configs

} GateGIE_Params;

Void GateGIE_Params_init(GateGIE_Params *params);

// Initialize this config-params structure with supplier-specified defaults before instance creation

Instance Creation

index URL

C synopsis target-domain

GateGIE_Handle GateGIE_create(const GateGIE_Params *params, Error_Block *eb);

// Allocate and initialize a new instance object and return its handle

Void GateGIE_construct(GateGIE_Struct *structP, const GateGIE_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 GateGIE_delete(GateGIE_Handle *handleP);

// Finalize and free this previously allocated instance object, setting the referenced handle to NULL

Void GateGIE_destruct(GateGIE_Struct *structP);

// Finalize the instance object inside the provided structure

GateGIE_enter() // instance

index URL

Enter this gate

C synopsis target-domain

IArg GateGIE_enter(GateGIE_Handle handle);

ARGUMENTS

handle — handle of a previously-created GateGIE instance object

DETAILS

Each gate provider can implement mutual exclusion using different algorithms; e.g., disabling all scheduling, disabling the scheduling of all threads below a specified "priority level", suspending the caller when the gate has been entered by another thread and re-enabling it when the the other thread leaves the gate. However, in all cases, after this method returns that caller has exclusive access to the data protected by this gate.

A thread may reenter a gate without blocking or failing.

RETURNS

Returns a "key" that is used to leave this gate; this value is used to restore thread preemption to the state that existed just prior to entering this gate.

GateGIE_leave() // instance

index URL

Leave this gate

C synopsis target-domain

Void GateGIE_leave(GateGIE_Handle handle, IArg key);

ARGUMENTS

handle — handle of a previously-created GateGIE instance object

key — the value returned by a matching call to enter

DETAILS

This method is only called by threads that have previously entered this gate via enter. After this method returns, the caller must not access the data structure protected by this gate (unless the caller has entered the gate more than once and other calls to leave remain to balance the number of previous calls to enter).

Instance Convertors

index URL

C synopsis target-domain

IGateProvider_Handle GateGIE_Handle_upCast(GateGIE_Handle handle);

// unconditionally move one level up the inheritance hierarchy

GateGIE_Handle GateGIE_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 GateGIE_Object_count();

// The number of statically-created instance objects

GateGIE_Handle GateGIE_Object_get(GateGIE_Object *array, Int i);

// The handle of the i-th statically-created instance object (array == NULL)

GateGIE_Handle GateGIE_Object_first();

// The handle of the first dynamically-created instance object, or NULL

GateGIE_Handle GateGIE_Object_next(GateGIE_Handle handle);

// The handle of the next dynamically-created instance object, or NULL

IHeap_Handle GateGIE_Object_heap();

// The heap used to allocate dynamically-created instance objects

Types_Label *GateGIE_Handle_label(GateGIE_Handle handle, Types_Label *buf);

// The label associated with this instance object

String GateGIE_Handle_name(GateGIE_Handle handle);

// The name of this instance object

XDCscript usage meta-domain sourced in ti/mcu/msp430/runtime/GateGIE.xdc

var GateGIE = xdc.useModule('ti.mcu.msp430.runtime.GateGIE');

module-wide constants & types

const GateGIE.Q_BLOCKING// Blocking quality = 1;

const GateGIE.Q_PREEMPTING// Preempting quality = 2;

module-wide config parameters

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

module-wide functions

GateGIE.queryMeta// Configuration time test for a particular gate quality(Int qual) returns Bool

per-instance config parameters

var params = new GateGIE.Params// Instance config-params object;

per-instance creation

var inst = GateGIE.create// Create an instance-object(params);

const GateGIE.Q_BLOCKING

index URL

Blocking quality

XDCscript usage meta-domain

const GateGIE.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

GateGIE_Q_BLOCKING

const GateGIE.Q_PREEMPTING

index URL

Preempting quality

XDCscript usage meta-domain

const GateGIE.Q_PREEMPTING = 2;

DETAILS

Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.

C SYNOPSIS

GateGIE_Q_PREEMPTING

metaonly config GateGIE.common$ // module-wide

index URL

Common module configuration parameters

XDCscript usage meta-domain

GateGIE.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 GateGIE.queryMeta() // module-wide

index URL

Configuration time test for a particular gate quality

XDCscript usage meta-domain

GateGIE.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 GateGIE.Params;

// Instance config-params object

Instance Creation

index URL

XDCscript usage meta-domain

var params = new GateGIE.Params;

// Allocate instance config-params

params.config = ...

// Assign individual configs

var inst = GateGIE.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 Thu, 23 Aug 2012 18:53:49 GMT