module ti.sdo.ipc.gates.GateHWSem

Multiprocessor gate that utilizes a hardware semaphore

XDCspec summary sourced in ti/sdo/ipc/gates/GateHWSem.xdc
@ModuleStartup
module GateHWSem {  ...
    // inherits xdc.runtime.IGateProvider
        // inherits xdc.runtime.IModule
instance:  ...
C synopsis target-domain
#include <ti/sdo/ipc/gates/GateHWSem.h>
module-wide constants & types
 
        GateHWSem_LocalProtect_NONE,
module-wide config parameters
module-wide functions
module-wide built-ins
per-instance object types
 
per-instance config parameters
        IInstance_Params *instance;
        Bool openFlag// ;
        UInt16 regionId// ;
        UInt resourceId// Logical resource id;
    } GateHWSem_Params;
 
per-instance creation
per-instance deletion
per-instance functions
    Void GateHWSem_leave// Leave this gate( GateHWSem_Handle handle, IArg key );
per-instance convertors
per-instance built-ins
 
XDCscript usage meta-domain
var GateHWSem = xdc.useModule('ti.sdo.ipc.gates.GateHWSem');
module-wide constants & types
 
        const GateHWSem.LocalProtect_NONE;
        const GateHWSem.LocalProtect_INTERRUPT;
        const GateHWSem.LocalProtect_TASKLET;
        const GateHWSem.LocalProtect_THREAD;
        const GateHWSem.LocalProtect_PROCESS;
module-wide config parameters
        msg: "A_invProtectionLevel: Unknown level of local protection"
    };
        msg: "A_invSemNum: Invalid hardware semaphore number"
    };
        msg: "A_invalidParams: Need to supply either a name or a semaphore Number"
    };
 
module-wide functions
per-instance config parameters
    var params = new GateHWSem.Params// Instance config-params object;
        params.openFlag//  = Bool false;
        params.regionId//  = UInt16 0;
        params.resourceId// Logical resource id = UInt 0;
        params.sharedAddr// Physical address of the shared memory = Ptr null;
per-instance creation
    var inst = GateHWSem.create// Create an instance-object( IGateMPSupport.LocalProtect localProtect, params );
 
XDCspec declarations sourced in ti/sdo/ipc/gates/GateHWSem.xdc
package ti.sdo.ipc.gates;
 
@ModuleStartup
module GateHWSem inherits IGateMPSupport {
module-wide constants & types
    const Int Q_BLOCKING// Blocking quality = 1;
    const Int Q_PREEMPTING// Preempting quality = 2;
 
        LocalProtect_NONE,
        LocalProtect_INTERRUPT,
        LocalProtect_TASKLET,
        LocalProtect_THREAD,
        LocalProtect_PROCESS
    };
module-wide config parameters
        msg: "A_invProtectionLevel: Unknown level of local protection"
    };
        msg: "A_invSemNum: Invalid hardware semaphore number"
    };
        msg: "A_invalidParams: Need to supply either a name or a semaphore Number"
    };
 
module-wide functions
 
 
 
instance:
per-instance config parameters
    config UInt resourceId// Logical resource id = 0;
per-instance creation
per-instance functions
    IArg enter// Enter this gate( );
    Void leave// Leave this gate( IArg key );
}
 
const GateHWSem.Q_BLOCKING

Blocking quality

XDCscript usage meta-domain
const GateHWSem.Q_BLOCKING = 1;
C synopsis target-domain
#define GateHWSem_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 GateHWSem.Q_PREEMPTING

Preempting quality

XDCscript usage meta-domain
const GateHWSem.Q_PREEMPTING = 2;
C synopsis target-domain
#define GateHWSem_Q_PREEMPTING (Int)2
 
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
 
enum GateHWSem.LocalProtect

Local protection enum

XDCscript usage meta-domain
values of type GateHWSem.LocalProtect
    const GateHWSem.LocalProtect_NONE;
    const GateHWSem.LocalProtect_INTERRUPT;
    const GateHWSem.LocalProtect_TASKLET;
    const GateHWSem.LocalProtect_THREAD;
    const GateHWSem.LocalProtect_PROCESS;
C synopsis target-domain
typedef enum GateHWSem_LocalProtect {
    GateHWSem_LocalProtect_NONE,
    GateHWSem_LocalProtect_INTERRUPT,
    GateHWSem_LocalProtect_TASKLET,
    GateHWSem_LocalProtect_THREAD,
    GateHWSem_LocalProtect_PROCESS
} GateHWSem_LocalProtect;
 
DETAILS
Must be the same GateMP.
 
config GateHWSem.A_invProtectionLevel  // module-wide

Asserted when an invalid protection level is encountered

XDCscript usage meta-domain
GateHWSem.A_invProtectionLevel = Assert.Desc {
    msg: "A_invProtectionLevel: Unknown level of local protection"
};
C synopsis target-domain
extern const Assert_Id GateHWSem_A_invProtectionLevel;
 
 
config GateHWSem.A_invSemNum  // module-wide

Asserted when supplied semNum is invalid for the relevant device

XDCscript usage meta-domain
GateHWSem.A_invSemNum = Assert.Desc {
    msg: "A_invSemNum: Invalid hardware semaphore number"
};
C synopsis target-domain
extern const Assert_Id GateHWSem_A_invSemNum;
 
 
config GateHWSem.A_invalidParams  // module-wide

Asserted when insufficient information is passed to open

XDCscript usage meta-domain
GateHWSem.A_invalidParams = Assert.Desc {
    msg: "A_invalidParams: Need to supply either a name or a semaphore Number"
};
C synopsis target-domain
extern const Assert_Id GateHWSem_A_invalidParams;
 
 
metaonly config GateHWSem.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
GateHWSem.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.
 
GateHWSem.query( )  // module-wide

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateHWSem_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.
 
GateHWSem.sharedMemReq( )  // module-wide

Amount of shared memory required for creation of each instance

C synopsis target-domain
SizeT GateHWSem_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.
 
metaonly GateHWSem.getNumResources( )  // module-wide

Number of gates instance within the module

XDCscript usage meta-domain
GateHWSem.getNumResources( ) returns UInt
 
 
metaonly GateHWSem.queryMeta( )  // module-wide

Configuration time test for a particular gate quality

XDCscript usage meta-domain
GateHWSem.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

C synopsis target-domain
Types_ModuleId GateHWSem_Module_id( );
// Get this module's unique id
 
Bool GateHWSem_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle GateHWSem_Module_heap( );
// The heap from which this module allocates memory
 
Bool GateHWSem_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 GateHWSem_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void GateHWSem_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
 
per-instance object types

C synopsis target-domain
typedef struct GateHWSem_Object GateHWSem_Object;
// Opaque internal representation of an instance object
 
typedef GateHWSem_Object *GateHWSem_Handle;
// Client reference to an instance object
 
typedef struct GateHWSem_Struct GateHWSem_Struct;
// Opaque client structure large enough to hold an instance object
 
GateHWSem_Handle GateHWSem_handle( GateHWSem_Struct *structP );
// Convert this instance structure pointer into an instance handle
 
GateHWSem_Struct *GateHWSem_struct( GateHWSem_Handle handle );
// Convert this instance handle into an instance structure pointer
 
per-instance config parameters

XDCscript usage meta-domain
var params = new GateHWSem.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
C synopsis target-domain
typedef struct GateHWSem_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    Bool openFlag;
    // 
    UInt16 regionId;
    // 
    UInt resourceId;
    // Logical resource id
    Ptr sharedAddr;
    // Physical address of the shared memory
} GateHWSem_Params;
 
Void GateHWSem_Params_init( GateHWSem_Params *params );
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config GateHWSem.resourceId  // per-instance

Logical resource id

XDCscript usage meta-domain
var params = new GateHWSem.Params;
  ...
params.resourceId = UInt 0;
C synopsis target-domain
struct GateHWSem_Params {
      ...
    UInt resourceId;
 
 
config GateHWSem.sharedAddr  // per-instance

Physical address of the shared memory

XDCscript usage meta-domain
var params = new GateHWSem.Params;
  ...
params.sharedAddr = Ptr null;
C synopsis target-domain
struct GateHWSem_Params {
      ...
    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
 
per-instance creation

XDCscript usage meta-domain
var params = new GateHWSem.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateHWSem.create( IGateMPSupport.LocalProtect localProtect, params );
// Create an instance-object
C synopsis target-domain
GateHWSem_Handle GateHWSem_create( IGateMPSupport_LocalProtect localProtect, const GateHWSem_Params *params, Error_Block *eb );
// Allocate and initialize a new instance object and return its handle
 
Void GateHWSem_construct( GateHWSem_Struct *structP, IGateMPSupport_LocalProtect localProtect, const GateHWSem_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)
 
per-instance deletion

C synopsis target-domain
Void GateHWSem_delete( GateHWSem_Handle *handleP );
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateHWSem_destruct( GateHWSem_Struct *structP );
// Finalize the instance object inside the provided structure
 
GateHWSem.enter( )  // per-instance

Enter this gate

C synopsis target-domain
IArg GateHWSem_enter( GateHWSem_Handle handle );
 
ARGUMENTS
handle — handle of a previously-created GateHWSem 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.
 
GateHWSem.leave( )  // per-instance

Leave this gate

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

C synopsis target-domain
IGateMPSupport_Handle GateHWSem_Handle_upCast( GateHWSem_Handle handle );
// unconditionally move one level up the inheritance hierarchy
 
GateHWSem_Handle GateHWSem_Handle_downCast( IGateMPSupport_Handle handle );
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IGateProvider_Handle GateHWSem_Handle_upCast2( GateHWSem_Handle handle );
// unconditionally move 2 levels up the inheritance hierarchy
 
GateHWSem_Handle GateHWSem_Handle_downCast2( IGateProvider_Handle handle );
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
 
per-instance built-ins

C synopsis target-domain
Int GateHWSem_Object_count( );
// The number of statically-created instance objects
 
GateHWSem_Handle GateHWSem_Object_get( GateHWSem_Object *array, Int i );
// The handle of the i-th statically-created instance object (array == NULL)
 
GateHWSem_Handle GateHWSem_Object_first( );
// The handle of the first dynamically-created instance object, or NULL
 
GateHWSem_Handle GateHWSem_Object_next( GateHWSem_Handle handle );
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateHWSem_Object_heap( );
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateHWSem_Handle_label( GateHWSem_Handle handle, Types_Label *buf );
// The label associated with this instance object
 
String GateHWSem_Handle_name( GateHWSem_Handle handle );
// The name of this instance object
generated on Fri, 09 Apr 2010 01:41:15 GMT