const GateHWSpinlock.Q_BLOCKING |
 |
Blocking quality
XDCscript usage |
meta-domain |
const GateHWSpinlock.Q_BLOCKING = 1;
#define GateHWSpinlock_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 GateHWSpinlock.Q_PREEMPTING |
 |
Preempting quality
XDCscript usage |
meta-domain |
const GateHWSpinlock.Q_PREEMPTING = 2;
#define GateHWSpinlock_Q_PREEMPTING (Int)2
DETAILS
Gates with this "quality" allow other threads to preempt the thread
that has already entered the gate.
enum GateHWSpinlock.LocalProtect |
 |
Local protection enum
XDCscript usage |
meta-domain |
values of type GateHWSpinlock.LocalProtect
const GateHWSpinlock.LocalProtect_NONE;
const GateHWSpinlock.LocalProtect_INTERRUPT;
const GateHWSpinlock.LocalProtect_TASKLET;
const GateHWSpinlock.LocalProtect_THREAD;
const GateHWSpinlock.LocalProtect_PROCESS;
typedef enum GateHWSpinlock_LocalProtect {
GateHWSpinlock_LocalProtect_NONE,
GateHWSpinlock_LocalProtect_INTERRUPT,
GateHWSpinlock_LocalProtect_TASKLET,
GateHWSpinlock_LocalProtect_THREAD,
GateHWSpinlock_LocalProtect_PROCESS
} GateHWSpinlock_LocalProtect;
DETAILS
Must be the same GateMP.
config GateHWSpinlock.A_invProtectionLevel // module-wide |
 |
Asserted when an invalid protection level is encountered
XDCscript usage |
meta-domain |
msg: "A_invProtectionLevel: Unknown level of local protection"
};
extern const Assert_Id GateHWSpinlock_A_invProtectionLevel;
config GateHWSpinlock.A_invSpinLockNum // module-wide |
 |
Assert raised when provided lockNum is invalid for the relevant device
XDCscript usage |
meta-domain |
msg: "A_invSpinLockNum: Invalid hardware spinlock number"
};
extern const Assert_Id GateHWSpinlock_A_invSpinLockNum;
config GateHWSpinlock.A_invalidParams // module-wide |
 |
Asserted when insufficient information is passed to open
XDCscript usage |
meta-domain |
msg: "A_invalidParams: Need to supply either a name or a spinlock Number"
};
extern const Assert_Id GateHWSpinlock_A_invalidParams;
config GateHWSpinlock.LM_close // module-wide |
 |
Logged on gate close
XDCscript usage |
meta-domain |
msg: "LM_close: Gate (lockNum = %d) closed"
};
extern const Log_Event GateHWSpinlock_LM_close;
config GateHWSpinlock.LM_create // module-wide |
 |
Logged on gate create
XDCscript usage |
meta-domain |
msg: "LM_create: Gate (lockNum = %d) created"
};
extern const Log_Event GateHWSpinlock_LM_create;
config GateHWSpinlock.LM_delete // module-wide |
 |
Logged on gate deletion
XDCscript usage |
meta-domain |
msg: "LM_delete: Gate (lockNum = %d) deleted"
};
extern const Log_Event GateHWSpinlock_LM_delete;
config GateHWSpinlock.LM_enter // module-wide |
 |
Logged on gate enter
XDCscript usage |
meta-domain |
msg: "LM_enter: Gate (lockNum = %d) entered, returning key = %d"
};
extern const Log_Event GateHWSpinlock_LM_enter;
config GateHWSpinlock.LM_leave // module-wide |
 |
Logged on gate leave
XDCscript usage |
meta-domain |
msg: "LM_leave: Gate (lockNum = %d) left using key = %d"
};
extern const Log_Event GateHWSpinlock_LM_leave;
config GateHWSpinlock.LM_open // module-wide |
 |
Logged on gate open
XDCscript usage |
meta-domain |
msg: "LM_open: Remote gate (lockNum = %d) opened"
};
extern const Log_Event GateHWSpinlock_LM_open;
config GateHWSpinlock.baseAddr // module-wide |
 |
Device-specific base address for HW Semaphore subsystem
XDCscript usage |
meta-domain |
GateHWSpinlock.baseAddr = Ptr null;
extern const Ptr GateHWSpinlock_baseAddr;
metaonly config GateHWSpinlock.common$ // module-wide |
 |
Common module configuration parameters
XDCscript usage |
meta-domain |
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.
GateHWSpinlock.query( ) // module-wide |
 |
Runtime test for a particular gate quality
Bool GateHWSpinlock_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.
GateHWSpinlock.sharedMemReq( ) // module-wide |
 |
Amount of shared memory required for creation of each instance
ARGUMENTS
params
Pointer to the parameters that will be used in
the create.
DETAILS
The value returned by this function may depend on the cache alignment
requirements for the shared region from which memory will be used.
RETURNS
Number of MAUs needed to create the instance.
metaonly GateHWSpinlock.getNumResources( ) // module-wide |
 |
Number of gates instance within the module
XDCscript usage |
meta-domain |
GateHWSpinlock.getNumResources( ) returns UInt
metaonly GateHWSpinlock.queryMeta( ) // module-wide |
 |
Configuration time test for a particular gate quality
XDCscript usage |
meta-domain |
GateHWSpinlock.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.
module-wide built-ins |
 |
// Get this module's unique id
Bool GateHWSpinlock_Module_startupDone( );
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool GateHWSpinlock_Module_hasMask( );
// Test whether this module has a diagnostics mask
Bits16 GateHWSpinlock_Module_getMask( );
// Returns the diagnostics mask for this module
Void GateHWSpinlock_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
per-instance object types |
 |
typedef struct GateHWSpinlock_Object GateHWSpinlock_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct GateHWSpinlock_Struct GateHWSpinlock_Struct;
// Opaque client structure large enough to hold an instance object
// Convert this instance structure pointer into an instance handle
// Convert this instance handle into an instance structure pointer
per-instance config parameters |
 |
XDCscript usage |
meta-domain |
var params = new GateHWSpinlock.Params;
// Instance config-params object
params.openFlag = Bool false;
//
params.regionId = UInt16 0;
//
params.resourceId = UInt 0;
// Logical resource id
params.sharedAddr = Ptr null;
// Physical address of the shared memory
typedef struct GateHWSpinlock_Params {
// Instance config-params structure
// Common per-instance configs
Bool openFlag;
//
UInt16 regionId;
//
UInt resourceId;
// Logical resource id
Ptr sharedAddr;
// Physical address of the shared memory
} GateHWSpinlock_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
config GateHWSpinlock.resourceId // per-instance |
 |
Logical resource id
XDCscript usage |
meta-domain |
var params = new GateHWSpinlock.Params;
...
params.resourceId = UInt 0;
config GateHWSpinlock.sharedAddr // per-instance |
 |
Physical address of the shared memory
XDCscript usage |
meta-domain |
var params = new GateHWSpinlock.Params;
...
params.sharedAddr = Ptr null;
DETAILS
The creator must supply the shared memory that will be used
for maintaining shared state information. This parameter is used
only when
Type is set to
Type_SHARED
per-instance creation |
 |
XDCscript usage |
meta-domain |
var params =
new GateHWSpinlock.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
// Create an instance-object
// Allocate and initialize a new instance object and return its handle
// 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)
per-instance deletion |
 |
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
GateHWSpinlock.enter( ) // per-instance |
 |
Enter this gate
ARGUMENTS
handle
handle of a previously-created GateHWSpinlock 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.
GateHWSpinlock.leave( ) // per-instance |
 |
Leave this gate
ARGUMENTS
handle
handle of a previously-created GateHWSpinlock 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).
per-instance convertors |
 |
// unconditionally move one level up the inheritance hierarchy
// conditionally move one level down the inheritance hierarchy; NULL upon failure
// unconditionally move 2 levels up the inheritance hierarchy
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
per-instance built-ins |
 |
Int GateHWSpinlock_Object_count( );
// The number of statically-created instance objects
// The handle of the i-th statically-created instance object (array == NULL)
// The handle of the first dynamically-created instance object, or NULL
// The handle of the next dynamically-created instance object, or NULL
// The heap used to allocate dynamically-created instance objects
// The label associated with this instance object
// The name of this instance object