module ti.sdo.ipc.gates.GateMPSupportNull

index URL

Module to plug GateMP proxies

C synopsis
Individual elements
XDCscript usage
Individual elements

C synopsis target-domain sourced in ti/sdo/ipc/gates/GateMPSupportNull.xdc

#include <ti/sdo/ipc/gates/GateMPSupportNull.h>

Functions
Void	GateMPSupportNull_construct// Initialize a new instance object inside the provided structure(GateMPSupportNull_Struct structP, IGateProvider_Handle localGate, const GateMPSupportNull_Params params);
GateMPSupportNull_Handle	GateMPSupportNull_create// Allocate and initialize a new instance object and return its handle(IGateProvider_Handle localGate, const GateMPSupportNull_Params params, Error_Block eb);
Void	GateMPSupportNull_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(GateMPSupportNull_Handle *handleP);
Void	GateMPSupportNull_destruct// Finalize the instance object inside the provided structure(GateMPSupportNull_Struct *structP);
Void	GateMPSupportNull_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(GateMPSupportNull_Params *params);
Functions common to all IGateProvider modules
Bool	GateMPSupportNull_query// Runtime test for a particular gate quality(Int qual);
Functions common to all IGateMPSupport modules
SizeT	GateMPSupportNull_sharedMemReq// Amount of shared memory required for creation of each instance(IGateMPSupport_Params *params);
Functions common to all target instances
	GateMPSupportNull_handle// Convert this instance structure pointer into an instance handle, GateMPSupportNull_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, GateMPSupportNull_Handle_downCast2// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure, GateMPSupportNull_Handle_label// The label associated with this instance object, GateMPSupportNull_Handle_name// The name of this instance object, GateMPSupportNull_Handle_upCast// unconditionally move one level up the inheritance hierarchy, GateMPSupportNull_Handle_upCast2// unconditionally move 2 levels up the inheritance hierarchy, GateMPSupportNull_Object_count// The number of statically-created instance objects, GateMPSupportNull_Object_first// The handle of the first dynamically-created instance object, or NULL, GateMPSupportNull_Object_get// The handle of the i-th statically-created instance object (array == NULL), GateMPSupportNull_Object_heap// The heap used to allocate dynamically-created instance objects, GateMPSupportNull_Object_next// The handle of the next dynamically-created instance object, or NULL, GateMPSupportNull_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	GateMPSupportNull_Module_getMask// Returns the diagnostics mask for this module, GateMPSupportNull_Module_hasMask// Test whether this module has a diagnostics mask, GateMPSupportNull_Module_heap// The heap from which this module allocates memory, GateMPSupportNull_Module_id// Get this module's unique id, GateMPSupportNull_Module_setMask// Set the diagnostics mask for this module, GateMPSupportNull_Module_startupDone// Test if this module has completed startup
Defines
#define	GateMPSupportNull_Q_BLOCKING// Blocking quality (Int)1
#define	GateMPSupportNull_Q_PREEMPTING// Preempting quality (Int)2
Typedefs
typedef enum	GateMPSupportNull_Action// Error codes returned by certain calls in GateMP ...
typedef GateMPSupportNull_Object *	GateMPSupportNull_Handle// Client reference to an instance object;
typedef struct	GateMPSupportNull_Object// Opaque internal representation of an instance object GateMPSupportNull_Object;
typedef struct	GateMPSupportNull_Params// Instance config-params structure ...
typedef struct	GateMPSupportNull_Struct// Opaque client structure large enough to hold an instance object GateMPSupportNull_Struct;
Constants
extern const GateMPSupportNull_Action	GateMPSupportNull_action// Assert if the enter and/or leave is called;
extern const Assert_Id	GateMPSupportNull_A_invalidAction// Assert raised when trying to use GateMPSupportNull's enter or leave;

const GateMPSupportNull_Q_BLOCKING

index URL

Blocking quality

C synopsis target-domain

#define GateMPSupportNull_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 GateMPSupportNull_Q_PREEMPTING

index URL

Preempting quality

C synopsis target-domain

#define GateMPSupportNull_Q_PREEMPTING (Int)2

DETAILS

Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.

enum GateMPSupportNull_Action

index URL

Error codes returned by certain calls in GateMP

C synopsis target-domain

typedef enum GateMPSupportNull_Action {

GateMPSupportNull_Action_NONE,

GateMPSupportNull_Action_ASSERT

} GateMPSupportNull_Action;

config GateMPSupportNull_A_invalidAction // module-wide

index URL

Assert raised when trying to use GateMPSupportNull's enter or leave

C synopsis target-domain

extern const Assert_Id GateMPSupportNull_A_invalidAction;

config GateMPSupportNull_action // module-wide

index URL

Assert if the enter and/or leave is called

C synopsis target-domain

extern const GateMPSupportNull_Action GateMPSupportNull_action;

GateMPSupportNull_query() // module-wide

index URL

Runtime test for a particular gate quality

C synopsis target-domain

Bool GateMPSupportNull_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.

GateMPSupportNull_sharedMemReq() // module-wide

index URL

Amount of shared memory required for creation of each instance

C synopsis target-domain

SizeT GateMPSupportNull_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

index URL

C synopsis target-domain

Types_ModuleId GateMPSupportNull_Module_id();

// Get this module's unique id

Bool GateMPSupportNull_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle GateMPSupportNull_Module_heap();

// The heap from which this module allocates memory

Bool GateMPSupportNull_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 GateMPSupportNull_Module_getMask();

// Returns the diagnostics mask for this module

Void GateMPSupportNull_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

Instance Object Types

index URL

C synopsis target-domain

typedef struct GateMPSupportNull_Object GateMPSupportNull_Object;

// Opaque internal representation of an instance object

typedef GateMPSupportNull_Object *GateMPSupportNull_Handle;

// Client reference to an instance object

typedef struct GateMPSupportNull_Struct GateMPSupportNull_Struct;

// Opaque client structure large enough to hold an instance object

GateMPSupportNull_Handle GateMPSupportNull_handle(GateMPSupportNull_Struct *structP);

// Convert this instance structure pointer into an instance handle

GateMPSupportNull_Struct *GateMPSupportNull_struct(GateMPSupportNull_Handle handle);

// Convert this instance handle into an instance structure pointer

Instance Config Parameters

index URL

C synopsis target-domain

typedef struct GateMPSupportNull_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

} GateMPSupportNull_Params;

Void GateMPSupportNull_Params_init(GateMPSupportNull_Params *params);

// Initialize this config-params structure with supplier-specified defaults before instance creation

config GateMPSupportNull_resourceId // instance

index URL

Logical resource id

C synopsis target-domain

struct GateMPSupportNull_Params {

...

UInt resourceId;

config GateMPSupportNull_sharedAddr // instance

index URL

Physical address of the shared memory

C synopsis target-domain

struct GateMPSupportNull_Params {

...

Ptr sharedAddr;

DETAILS

This parameter is only used by GateMP delegates that use shared memory

Instance Creation

index URL

C synopsis target-domain

GateMPSupportNull_Handle GateMPSupportNull_create(IGateProvider_Handle localGate, const GateMPSupportNull_Params *params, Error_Block *eb);

// Allocate and initialize a new instance object and return its handle

Void GateMPSupportNull_construct(GateMPSupportNull_Struct *structP, IGateProvider_Handle localGate, const GateMPSupportNull_Params *params);

// Initialize a new instance object inside the provided structure

ARGUMENTS

localGate — Gate to use for local protection.

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)

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.

Instance Deletion

index URL

C synopsis target-domain

Void GateMPSupportNull_delete(GateMPSupportNull_Handle *handleP);

// Finalize and free this previously allocated instance object, setting the referenced handle to NULL

Void GateMPSupportNull_destruct(GateMPSupportNull_Struct *structP);

// Finalize the instance object inside the provided structure

Instance Convertors

index URL

C synopsis target-domain

IGateMPSupport_Handle GateMPSupportNull_Handle_upCast(GateMPSupportNull_Handle handle);

// unconditionally move one level up the inheritance hierarchy

GateMPSupportNull_Handle GateMPSupportNull_Handle_downCast(IGateMPSupport_Handle handle);

// conditionally move one level down the inheritance hierarchy; NULL upon failure

IGateProvider_Handle GateMPSupportNull_Handle_upCast2(GateMPSupportNull_Handle handle);

// unconditionally move 2 levels up the inheritance hierarchy

GateMPSupportNull_Handle GateMPSupportNull_Handle_downCast2(IGateProvider_Handle handle);

// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure

Instance Built-Ins

index URL

C synopsis target-domain

Int GateMPSupportNull_Object_count();

// The number of statically-created instance objects

GateMPSupportNull_Handle GateMPSupportNull_Object_get(GateMPSupportNull_Object *array, Int i);

// The handle of the i-th statically-created instance object (array == NULL)

GateMPSupportNull_Handle GateMPSupportNull_Object_first();

// The handle of the first dynamically-created instance object, or NULL

GateMPSupportNull_Handle GateMPSupportNull_Object_next(GateMPSupportNull_Handle handle);

// The handle of the next dynamically-created instance object, or NULL

IHeap_Handle GateMPSupportNull_Object_heap();

// The heap used to allocate dynamically-created instance objects

Types_Label *GateMPSupportNull_Handle_label(GateMPSupportNull_Handle handle, Types_Label *buf);

// The label associated with this instance object

String GateMPSupportNull_Handle_name(GateMPSupportNull_Handle handle);

// The name of this instance object

XDCscript usage meta-domain sourced in ti/sdo/ipc/gates/GateMPSupportNull.xdc

var GateMPSupportNull = xdc.useModule('ti.sdo.ipc.gates.GateMPSupportNull');

module-wide constants & types

const GateMPSupportNull.Q_BLOCKING// Blocking quality = 1;

const GateMPSupportNull.Q_PREEMPTING// Preempting quality = 2;

values of type GateMPSupportNull.Action// Error codes returned by certain calls in GateMP

const GateMPSupportNull.Action_NONE;

const GateMPSupportNull.Action_ASSERT;

module-wide config parameters

GateMPSupportNull.A_invalidAction// Assert raised when trying to use GateMPSupportNull's enter or leave = Assert.Desc {

msg: "A_invalidAction: Cannot use ti.sdo.ipc.gates.GateMPSupportNull"

};

GateMPSupportNull.action// Assert if the enter and/or leave is called = GateMPSupportNull.Action GateMPSupportNull.Action_ASSERT;

GateMPSupportNull.common$// Common module configuration parameters = Types.Common$ undefined;

module-wide functions

GateMPSupportNull.getNumResources// Returns the number of resources offered by the GateMP delegate() returns UInt

GateMPSupportNull.queryMeta// Configuration time test for a particular gate quality(Int qual) returns Bool

per-instance config parameters

var params = new GateMPSupportNull.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 = GateMPSupportNull.create// Create an instance-object(IGateProvider.Handle localGate, params);

const GateMPSupportNull.Q_BLOCKING

index URL

Blocking quality

XDCscript usage meta-domain

const GateMPSupportNull.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

GateMPSupportNull_Q_BLOCKING

const GateMPSupportNull.Q_PREEMPTING

index URL

Preempting quality

XDCscript usage meta-domain

const GateMPSupportNull.Q_PREEMPTING = 2;

DETAILS

Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.

C SYNOPSIS

GateMPSupportNull_Q_PREEMPTING

enum GateMPSupportNull.Action

index URL

Error codes returned by certain calls in GateMP

XDCscript usage meta-domain

values of type GateMPSupportNull.Action

const GateMPSupportNull.Action_NONE;

const GateMPSupportNull.Action_ASSERT;

C SYNOPSIS

GateMPSupportNull_Action

config GateMPSupportNull.A_invalidAction // module-wide

index URL

Assert raised when trying to use GateMPSupportNull's enter or leave

XDCscript usage meta-domain

GateMPSupportNull.A_invalidAction = Assert.Desc {

msg: "A_invalidAction: Cannot use ti.sdo.ipc.gates.GateMPSupportNull"

};

C SYNOPSIS

GateMPSupportNull_A_invalidAction

config GateMPSupportNull.action // module-wide

index URL

Assert if the enter and/or leave is called

XDCscript usage meta-domain

GateMPSupportNull.action = GateMPSupportNull.Action GateMPSupportNull.Action_ASSERT;

C SYNOPSIS

GateMPSupportNull_action

metaonly config GateMPSupportNull.common$ // module-wide

index URL

Common module configuration parameters

XDCscript usage meta-domain

GateMPSupportNull.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 GateMPSupportNull.getNumResources() // module-wide

index URL

Returns the number of resources offered by the GateMP delegate

XDCscript usage meta-domain

GateMPSupportNull.getNumResources() returns UInt

metaonly GateMPSupportNull.queryMeta() // module-wide

index URL

Configuration time test for a particular gate quality

XDCscript usage meta-domain

GateMPSupportNull.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

index URL

XDCscript usage meta-domain

var params = new GateMPSupportNull.Params;

// Instance config-params object

params.resourceId = UInt 0;

// Logical resource id

params.sharedAddr = Ptr null;

// Physical address of the shared memory

config GateMPSupportNull.resourceId // instance

index URL

Logical resource id

XDCscript usage meta-domain

var params = new GateMPSupportNull.Params;

...

params.resourceId = UInt 0;

C SYNOPSIS

null

config GateMPSupportNull.sharedAddr // instance

index URL

Physical address of the shared memory

XDCscript usage meta-domain

var params = new GateMPSupportNull.Params;

...

params.sharedAddr = Ptr null;

DETAILS

This parameter is only used by GateMP delegates that use shared memory

C SYNOPSIS

null

Instance Creation

index URL

XDCscript usage meta-domain

var params = new GateMPSupportNull.Params;

// Allocate instance config-params

params.config = ...

// Assign individual configs

var inst = GateMPSupportNull.create(IGateProvider.Handle localGate, params);

// Create an instance-object

ARGUMENTS

localGate — Gate to use for local protection.

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)

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.

generated on Sat, 11 Feb 2012 00:37:59 GMT