module ti.sdo.ipc.gates.GateHWSpinlock

Multiprocessor gate that utilizes a hardware spinlock

C synopsis target-domain sourced in ti/sdo/ipc/gates/GateHWSpinlock.xdc
#include <ti/sdo/ipc/gates/GateHWSpinlock.h>
Functions
Void
Void
Void
Void
Functions common to all IGateProvider modules
IArg 
Void 
Bool 
Functions common to all IGateMPSupport modules
SizeT 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
Typedefs
typedef enum
typedef struct
typedef struct
typedef struct
Constants
extern const Assert_Id 
extern const Assert_Id 
extern const Assert_Id 
extern const Ptr 
extern const Log_Event 
extern const Log_Event 
extern const Log_Event 
extern const Log_Event 
extern const Log_Event 
extern const Log_Event 
 
const GateHWSpinlock_Q_BLOCKING

Blocking quality

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

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

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

C synopsis target-domain
extern const Assert_Id GateHWSpinlock_A_invProtectionLevel;
config GateHWSpinlock_A_invSpinLockNum  // module-wide

Assert raised when provided lockNum is invalid for the relevant device

C synopsis target-domain
extern const Assert_Id GateHWSpinlock_A_invSpinLockNum;
config GateHWSpinlock_A_invalidParams  // module-wide

Asserted when insufficient information is passed to open

C synopsis target-domain
extern const Assert_Id GateHWSpinlock_A_invalidParams;
config GateHWSpinlock_LM_close  // module-wide

Logged on gate close

C synopsis target-domain
extern const Log_Event GateHWSpinlock_LM_close;
config GateHWSpinlock_LM_create  // module-wide

Logged on gate create

C synopsis target-domain
extern const Log_Event GateHWSpinlock_LM_create;
config GateHWSpinlock_LM_delete  // module-wide

Logged on gate deletion

C synopsis target-domain
extern const Log_Event GateHWSpinlock_LM_delete;
config GateHWSpinlock_LM_enter  // module-wide

Logged on gate enter

C synopsis target-domain
extern const Log_Event GateHWSpinlock_LM_enter;
config GateHWSpinlock_LM_leave  // module-wide

Logged on gate leave

C synopsis target-domain
extern const Log_Event GateHWSpinlock_LM_leave;
config GateHWSpinlock_LM_open  // module-wide

Logged on gate open

C synopsis target-domain
extern const Log_Event GateHWSpinlock_LM_open;
config GateHWSpinlock_baseAddr  // module-wide

Device-specific base address for HW Semaphore subsystem

C synopsis target-domain
extern const Ptr GateHWSpinlock_baseAddr;
GateHWSpinlock_query()  // module-wide

Runtime test for a particular gate quality

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

C synopsis target-domain
SizeT GateHWSpinlock_sharedMemReq(IGateMPSupport_Params *params);
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.
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId GateHWSpinlock_Module_id();
// Get this module's unique id
 
Bool GateHWSpinlock_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle GateHWSpinlock_Module_heap();
// 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
Instance Object Types

C synopsis target-domain
typedef struct GateHWSpinlock_Object GateHWSpinlock_Object;
// Opaque internal representation of an instance object
 
typedef GateHWSpinlock_Object *GateHWSpinlock_Handle;
// Client reference to an instance object
 
typedef struct GateHWSpinlock_Struct GateHWSpinlock_Struct;
// Opaque client structure large enough to hold an instance object
 
GateHWSpinlock_Handle GateHWSpinlock_handle(GateHWSpinlock_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
GateHWSpinlock_Struct *GateHWSpinlock_struct(GateHWSpinlock_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct GateHWSpinlock_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    UInt resourceId;
    // Logical resource id
    Ptr sharedAddr;
    // Physical address of the shared memory
} GateHWSpinlock_Params;
 
Void GateHWSpinlock_Params_init(GateHWSpinlock_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
config GateHWSpinlock_resourceId  // instance

Logical resource id

C synopsis target-domain
      ...
    UInt resourceId;
config GateHWSpinlock_sharedAddr  // instance

Physical address of the shared memory

C synopsis target-domain
      ...
    Ptr sharedAddr;
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
Instance Creation

C synopsis target-domain
GateHWSpinlock_Handle GateHWSpinlock_create(IGateMPSupport_LocalProtect localProtect, const GateHWSpinlock_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void GateHWSpinlock_construct(GateHWSpinlock_Struct *structP, IGateMPSupport_LocalProtect localProtect, const GateHWSpinlock_Params *params, Error_Block *eb);
// 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 GateHWSpinlock_delete(GateHWSpinlock_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateHWSpinlock_destruct(GateHWSpinlock_Struct *structP);
// Finalize the instance object inside the provided structure
GateHWSpinlock_enter()  // instance

Enter this gate

C synopsis target-domain
IArg GateHWSpinlock_enter(GateHWSpinlock_Handle handle);
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()  // instance

Leave this gate

C synopsis target-domain
Void GateHWSpinlock_leave(GateHWSpinlock_Handle handle, IArg key);
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).
Instance Convertors

C synopsis target-domain
IGateMPSupport_Handle GateHWSpinlock_Handle_upCast(GateHWSpinlock_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
GateHWSpinlock_Handle GateHWSpinlock_Handle_downCast(IGateMPSupport_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IGateProvider_Handle GateHWSpinlock_Handle_upCast2(GateHWSpinlock_Handle handle);
// unconditionally move 2 levels up the inheritance hierarchy
 
GateHWSpinlock_Handle GateHWSpinlock_Handle_downCast2(IGateProvider_Handle handle);
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int GateHWSpinlock_Object_count();
// The number of statically-created instance objects
 
GateHWSpinlock_Handle GateHWSpinlock_Object_get(GateHWSpinlock_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
GateHWSpinlock_Handle GateHWSpinlock_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
GateHWSpinlock_Handle GateHWSpinlock_Object_next(GateHWSpinlock_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateHWSpinlock_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateHWSpinlock_Handle_label(GateHWSpinlock_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String GateHWSpinlock_Handle_name(GateHWSpinlock_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/gates/GateHWSpinlock.xdc
var GateHWSpinlock = xdc.useModule('ti.sdo.ipc.gates.GateHWSpinlock');
module-wide constants & types
        const GateHWSpinlock.LocalProtect_NONE;
        const GateHWSpinlock.LocalProtect_INTERRUPT;
        const GateHWSpinlock.LocalProtect_TASKLET;
        const GateHWSpinlock.LocalProtect_THREAD;
        const GateHWSpinlock.LocalProtect_PROCESS;
module-wide config parameters
        msg: "A_invProtectionLevel: Unknown level of local protection"
    };
        msg: "A_invSpinLockNum: Invalid hardware spinlock number"
    };
        msg: "A_invalidParams: Need to supply either a name or a spinlock Number"
    };
        mask: Diags.USER1,
        msg: "LM_close: Gate (lockNum = %d) closed"
    };
        mask: Diags.USER1,
        msg: "LM_create: Gate (lockNum = %d) created"
    };
        mask: Diags.USER1,
        msg: "LM_delete: Gate (lockNum = %d) deleted"
    };
        mask: Diags.USER1,
        msg: "LM_enter: Gate (lockNum = %d) entered, returning key = %d"
    };
        mask: Diags.USER1,
        msg: "LM_leave: Gate (lockNum = %d) left using key = %d"
    };
        mask: Diags.USER1,
        msg: "LM_open: Remote gate (lockNum = %d) opened"
    };
module-wide functions
per-instance config parameters
    var params = new GateHWSpinlock.Params// Instance config-params object;
        params.resourceId// Logical resource id = UInt 0;
        params.sharedAddr// Physical address of the shared memory = Ptr null;
per-instance creation
    var inst = GateHWSpinlock.create// Create an instance-object(IGateMPSupport.LocalProtect localProtect, params);
 
const GateHWSpinlock.Q_BLOCKING

Blocking quality

XDCscript usage meta-domain
const GateHWSpinlock.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 GateHWSpinlock.Q_PREEMPTING

Preempting quality

XDCscript usage meta-domain
const GateHWSpinlock.Q_PREEMPTING = 2;
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
C SYNOPSIS
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;
DETAILS
Must be the same GateMP.
C SYNOPSIS
config GateHWSpinlock.A_invProtectionLevel  // module-wide

Asserted when an invalid protection level is encountered

XDCscript usage meta-domain
GateHWSpinlock.A_invProtectionLevel = Assert.Desc {
    msg: "A_invProtectionLevel: Unknown level of local protection"
};
C SYNOPSIS
config GateHWSpinlock.A_invSpinLockNum  // module-wide

Assert raised when provided lockNum is invalid for the relevant device

XDCscript usage meta-domain
GateHWSpinlock.A_invSpinLockNum = Assert.Desc {
    msg: "A_invSpinLockNum: Invalid hardware spinlock number"
};
C SYNOPSIS
config GateHWSpinlock.A_invalidParams  // module-wide

Asserted when insufficient information is passed to open

XDCscript usage meta-domain
GateHWSpinlock.A_invalidParams = Assert.Desc {
    msg: "A_invalidParams: Need to supply either a name or a spinlock Number"
};
C SYNOPSIS
config GateHWSpinlock.LM_close  // module-wide

Logged on gate close

XDCscript usage meta-domain
GateHWSpinlock.LM_close = Log.EventDesc {
    mask: Diags.USER1,
    msg: "LM_close: Gate (lockNum = %d) closed"
};
C SYNOPSIS
config GateHWSpinlock.LM_create  // module-wide

Logged on gate create

XDCscript usage meta-domain
GateHWSpinlock.LM_create = Log.EventDesc {
    mask: Diags.USER1,
    msg: "LM_create: Gate (lockNum = %d) created"
};
C SYNOPSIS
config GateHWSpinlock.LM_delete  // module-wide

Logged on gate deletion

XDCscript usage meta-domain
GateHWSpinlock.LM_delete = Log.EventDesc {
    mask: Diags.USER1,
    msg: "LM_delete: Gate (lockNum = %d) deleted"
};
C SYNOPSIS
config GateHWSpinlock.LM_enter  // module-wide

Logged on gate enter

XDCscript usage meta-domain
GateHWSpinlock.LM_enter = Log.EventDesc {
    mask: Diags.USER1,
    msg: "LM_enter: Gate (lockNum = %d) entered, returning key = %d"
};
C SYNOPSIS
config GateHWSpinlock.LM_leave  // module-wide

Logged on gate leave

XDCscript usage meta-domain
GateHWSpinlock.LM_leave = Log.EventDesc {
    mask: Diags.USER1,
    msg: "LM_leave: Gate (lockNum = %d) left using key = %d"
};
C SYNOPSIS
config GateHWSpinlock.LM_open  // module-wide

Logged on gate open

XDCscript usage meta-domain
GateHWSpinlock.LM_open = Log.EventDesc {
    mask: Diags.USER1,
    msg: "LM_open: Remote gate (lockNum = %d) opened"
};
C SYNOPSIS
config GateHWSpinlock.baseAddr  // module-wide

Device-specific base address for HW Semaphore subsystem

XDCscript usage meta-domain
GateHWSpinlock.baseAddr = Ptr null;
C SYNOPSIS
metaonly config GateHWSpinlock.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
GateHWSpinlock.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 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.
Instance Config Parameters

XDCscript usage meta-domain
var params = new GateHWSpinlock.Params;
// Instance config-params object
    params.resourceId = UInt 0;
    // Logical resource id
    params.sharedAddr = Ptr null;
    // Physical address of the shared memory
config GateHWSpinlock.resourceId  // instance

Logical resource id

XDCscript usage meta-domain
var params = new GateHWSpinlock.Params;
  ...
params.resourceId = UInt 0;
C SYNOPSIS
config GateHWSpinlock.sharedAddr  // 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
C SYNOPSIS
Instance Creation

XDCscript usage meta-domain
var params = new GateHWSpinlock.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateHWSpinlock.create(IGateMPSupport.LocalProtect localProtect, 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 Tue, 02 Nov 2010 01:37:27 GMT