interface ti.sdo.ipc.interfaces.IGateMPSupport
index URL
XDCspec summary sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
interface IGateMPSupport {  ...
// inherits xdc.runtime.IGateProvider
    // inherits xdc.runtime.IModule
instance:  ...
XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
package ti.sdo.ipc.interfaces;
 
interface IGateMPSupport inherits IGateProvider {
module-wide constants & types
    const Int Q_BLOCKING// Blocking quality = 1;
    const Int Q_PREEMPTING// Preempting quality = 2;
module-wide config parameters
    metaonly config Types.Common$ common$// Common module configuration parameters;
module-wide functions
    Bool query// Runtime test for a particular gate quality(Int qual);
    SizeT sharedMemReq// Amount of shared memory required for creation of each instance(IGateMPSupport.Params *params);
 
    metaonly UInt getNumResources// Returns the number of resources offered by the GateMP delegate();
    metaonly Bool queryMeta// Configuration time test for a particular gate quality(Int qual);
 
 
instance:
per-instance config parameters
    config UInt resourceId// Logical resource id = 0;
    config Ptr sharedAddr// Physical address of the shared memory = null;
per-instance creation
    create// Create an instance-object(IGateProvider.Handle localGate);
per-instance functions
    IArg enter// Enter this gate();
    Void leave// Leave this gate(IArg key);
}
 
const IGateMPSupport.Q_BLOCKING
index URL

Blocking quality

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
const Int 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.
 
const IGateMPSupport.Q_PREEMPTING
index URL

Preempting quality

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
const Int Q_PREEMPTING = 2;
 
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
 
metaonly config IGateMPSupport.common$  // module-wide
index URL

Common module configuration parameters

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
metaonly config Types.Common$ common$;
 
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.
 
IGateMPSupport.query()  // module-wide
index URL

Runtime test for a particular gate quality

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
Bool 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.
 
IGateMPSupport.sharedMemReq()  // module-wide
index URL

Amount of shared memory required for creation of each instance

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
SizeT 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 IGateMPSupport.getNumResources()  // module-wide
index URL

Returns the number of resources offered by the GateMP delegate

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
metaonly UInt getNumResources();
 
 
metaonly IGateMPSupport.queryMeta()  // module-wide
index URL

Configuration time test for a particular gate quality

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
metaonly Bool queryMeta(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.
 
config IGateMPSupport.resourceId  // instance
index URL

Logical resource id

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
config UInt resourceId = 0;
 
 
config IGateMPSupport.sharedAddr  // instance
index URL

Physical address of the shared memory

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
config Ptr sharedAddr = null;
 
DETAILS
This parameter is only used by GateMP delegates that use shared memory
Instance Creation
index URL

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
create(IGateProvider.Handle localGate);
// Create an instance-object
ARGUMENTS
localGate — Gate to use for local protection.
DETAILS
A Non-NULL gate for local protection must be passed to the create call. If no local protection is desired, a xdc.runtime.GateNull handle must be passed in.
 
IGateMPSupport.enter()  // instance
index URL

Enter this gate

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
IArg enter();
 
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.
 
IGateMPSupport.leave()  // instance
index URL

Leave this gate

XDCspec declarations sourced in ti/sdo/ipc/interfaces/IGateMPSupport.xdc
Void leave(IArg key);
 
ARGUMENTS
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).
generated on Sat, 11 Feb 2012 00:38:03 GMT