module ti.sysbios.gates.GateTask

Task Gate

GateTask uses disabling and enabling of tasks as the resource locking mechanism. This gate can be used whenever the resource is being shared by Tasks. This gate cannot be used by a Hwi or Swi. [ more ... ]
C synopsis target-domain sourced in ti/sysbios/gates/GateTask.xdc
#include <ti/sysbios/gates/GateTask.h>
Functions
Void
Void
Void
Void
Functions common to all IGateProvider modules
IArg 
Void 
Bool 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
Typedefs
typedef GateTask_Object *
typedef struct
typedef struct
typedef struct
Constants
extern const Assert_Id 
 
DETAILS
GateTask uses disabling and enabling of tasks as the resource locking mechanism. This gate can be used whenever the resource is being shared by Tasks. This gate cannot be used by a Hwi or Swi.
The duration between the enter and leave should be as short as possible to minimize Task latency.
GateTask 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 N N Y Y** N
leave N N 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. GateTask_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. GateTask_Module_startupDone() returns FALSE).
  • *: Assuming blocking Heap is used for creation.
  • **: Must be used in enter/leave pairs.
 
const GateTask_Q_BLOCKING

Blocking quality

C synopsis target-domain
#define GateTask_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 GateTask_Q_PREEMPTING

Preempting quality

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

Asserted when enter is called from a hardware/software interrupt thread

C synopsis target-domain
extern const Assert_Id GateTask_A_badContext;
 
 
GateTask_query()  // module-wide

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateTask_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

C synopsis target-domain
Types_ModuleId GateTask_Module_id();
// Get this module's unique id
 
Bool GateTask_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle GateTask_Module_heap();
// The heap from which this module allocates memory
 
Bool GateTask_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 GateTask_Module_getMask();
// Returns the diagnostics mask for this module
 
Void GateTask_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct GateTask_Object GateTask_Object;
// Opaque internal representation of an instance object
 
typedef GateTask_Object *GateTask_Handle;
// Client reference to an instance object
 
typedef struct GateTask_Struct GateTask_Struct;
// Opaque client structure large enough to hold an instance object
 
GateTask_Handle GateTask_handle(GateTask_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
GateTask_Struct *GateTask_struct(GateTask_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

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

C synopsis target-domain
GateTask_Handle GateTask_create(const GateTask_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void GateTask_construct(GateTask_Struct *structP, const GateTask_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

C synopsis target-domain
Void GateTask_delete(GateTask_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateTask_destruct(GateTask_Struct *structP);
// Finalize the instance object inside the provided structure
 
GateTask_enter()  // instance

Enter this gate

C synopsis target-domain
IArg GateTask_enter(GateTask_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created GateTask 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.
 
GateTask_leave()  // instance

Leave this gate

C synopsis target-domain
Void GateTask_leave(GateTask_Handle handle, IArg key);
 
ARGUMENTS
handle — handle of a previously-created GateTask 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

C synopsis target-domain
IGateProvider_Handle GateTask_Handle_upCast(GateTask_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
GateTask_Handle GateTask_Handle_downCast(IGateProvider_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int GateTask_Object_count();
// The number of statically-created instance objects
 
GateTask_Handle GateTask_Object_get(GateTask_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
GateTask_Handle GateTask_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
GateTask_Handle GateTask_Object_next(GateTask_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateTask_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateTask_Handle_label(GateTask_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String GateTask_Handle_name(GateTask_Handle handle);
// The name of this instance object
 
Configuration settings sourced in ti/sysbios/gates/GateTask.xdc
var GateTask = xdc.useModule('ti.sysbios.gates.GateTask');
module-wide constants & types
module-wide config parameters
        msg: "A_badContext: bad calling context. May not be entered from a software or hardware interrupt thread."
    };
 
module-wide functions
per-instance config parameters
    var params = new GateTask.Params// Instance config-params object;
per-instance creation
    var inst = GateTask.create// Create an instance-object(params);
 
 
const GateTask.Q_BLOCKING

Blocking quality

Configuration settings
const GateTask.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
 
const GateTask.Q_PREEMPTING

Preempting quality

Configuration settings
const GateTask.Q_PREEMPTING = 2;
 
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
C SYNOPSIS
 
config GateTask.A_badContext  // module-wide

Asserted when enter is called from a hardware/software interrupt thread

Configuration settings
GateTask.A_badContext = Assert.Desc {
    msg: "A_badContext: bad calling context. May not be entered from a software or hardware interrupt thread."
};
 
C SYNOPSIS
 
metaonly config GateTask.common$  // module-wide

Common module configuration parameters

Configuration settings
GateTask.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 GateTask.queryMeta()  // module-wide

Configuration time test for a particular gate quality

Configuration settings
GateTask.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

Configuration settings
var params = new GateTask.Params;
// Instance config-params object
Static Instance Creation

Configuration settings
var params = new GateTask.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateTask.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, 25 May 2017 22:10:07 GMT