module ti.sdo.ipc.nsremote.NameServerMessageQ
index URL

Used by NameServer to communicate to remote processors

This module is used by ti.sdo.utils.NameServer to communicate to remote processors using ti.sdo.ipc.MessageQ. There needs to be one instance between each two cores in the system. Interrupts must be enabled before using this module. This module does not require any share memory.
C synopsis target-domain sourced in ti/sdo/ipc/nsremote/NameServerMessageQ.xdc
#include <ti/sdo/ipc/nsremote/NameServerMessageQ.h>
Functions
Void
NameServerMessageQ_construct// Initialize a new instance object inside the provided structure(NameServerMessageQ_Struct *structP, UInt16 procId, const NameServerMessageQ_Params *params);
NameServerMessageQ_Handle
NameServerMessageQ_create// Allocate and initialize a new instance object and return its handle(UInt16 procId, const NameServerMessageQ_Params *params, Error_Block *eb);
Void
NameServerMessageQ_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(NameServerMessageQ_Handle *handleP);
Void
NameServerMessageQ_destruct// Finalize the instance object inside the provided structure(NameServerMessageQ_Struct *structP);
Void
NameServerMessageQ_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(NameServerMessageQ_Params *params);
Functions common to all INameServerRemote modules
Int 
NameServerMessageQ_attach// Function is called by Ipc_attach() through NameServer_SetupProxy(UInt16 remoteProcId, Ptr sharedAddr);
Int 
NameServerMessageQ_detach// Function is called by Ipc_detach() through NameServer_SetupProxy(UInt16 remoteProcId);
Int 
NameServerMessageQ_get// (NameServerMessageQ_Handle handle, String instanceName, String name, Ptr value, UInt32 *valueLen, ISync_Handle syncHandle, Error_Block *eb);
SizeT 
NameServerMessageQ_sharedMemReq// Returns the shared memory size requirement for a single instance(Ptr sharedAddr);
Functions common to all target instances
NameServerMessageQ_handle// Convert this instance structure pointer into an instance handle, NameServerMessageQ_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, NameServerMessageQ_Handle_label// The label associated with this instance object, NameServerMessageQ_Handle_name// The name of this instance object, NameServerMessageQ_Handle_upCast// unconditionally move one level up the inheritance hierarchy, NameServerMessageQ_Object_count// The number of statically-created instance objects, NameServerMessageQ_Object_first// The handle of the first dynamically-created instance object, or NULL, NameServerMessageQ_Object_get// The handle of the i-th statically-created instance object (array == NULL), NameServerMessageQ_Object_heap// The heap used to allocate dynamically-created instance objects, NameServerMessageQ_Object_next// The handle of the next dynamically-created instance object, or NULL, NameServerMessageQ_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
NameServerMessageQ_Module_getMask// Returns the diagnostics mask for this module, NameServerMessageQ_Module_hasMask// Test whether this module has a diagnostics mask, NameServerMessageQ_Module_heap// The heap from which this module allocates memory, NameServerMessageQ_Module_id// Get this module's unique id, NameServerMessageQ_Module_setMask// Set the diagnostics mask for this module, NameServerMessageQ_Module_startupDone// Test if this module has completed startup
Defines
#define
NameServerMessageQ_maxNameLen// maximum number of characters for name in bytes (UInt)32
Typedefs
typedef NameServerMessageQ_Object *
NameServerMessageQ_Handle// Client reference to an instance object;
typedef struct
NameServerMessageQ_Object// Opaque internal representation of an instance object NameServerMessageQ_Object;
typedef struct
NameServerMessageQ_Params// Instance config-params structure ...
typedef enum
NameServerMessageQ_Status// Status codes returned by certain calls ...
typedef struct
NameServerMessageQ_Struct// Opaque client structure large enough to hold an instance object NameServerMessageQ_Struct;
Constants
extern const Assert_Id 
NameServerMessageQ_A_nameIsTooLong// Assert raised if too many characters in the name;
extern const Assert_Id 
NameServerMessageQ_A_reservedMsgQueueId// Assert raised if first MessageQ created already;
extern const Error_Id 
NameServerMessageQ_E_outOfMemory// Error raised if all the message queue objects are taken;
extern const UInt16 
NameServerMessageQ_heapId// The heap from which to alloc a message;
extern const UInt 
NameServerMessageQ_timeoutInMicroSecs// The timeout value in terms of microseconds;
 
 
const NameServerMessageQ_maxNameLen
index URL

maximum number of characters for name in bytes

C synopsis target-domain
#define NameServerMessageQ_maxNameLen (UInt)32
 
 
enum NameServerMessageQ_Status
index URL

Status codes returned by certain calls

C synopsis target-domain
typedef enum NameServerMessageQ_Status {
    NameServerMessageQ_S_SUCCESS,
    NameServerMessageQ_E_FAIL,
    NameServerMessageQ_E_ERROR
} NameServerMessageQ_Status;
 
 
config NameServerMessageQ_A_nameIsTooLong  // module-wide
index URL

Assert raised if too many characters in the name

C synopsis target-domain
extern const Assert_Id NameServerMessageQ_A_nameIsTooLong;
 
 
config NameServerMessageQ_A_reservedMsgQueueId  // module-wide
index URL

Assert raised if first MessageQ created already

C synopsis target-domain
extern const Assert_Id NameServerMessageQ_A_reservedMsgQueueId;
 
 
config NameServerMessageQ_E_outOfMemory  // module-wide
index URL

Error raised if all the message queue objects are taken

C synopsis target-domain
extern const Error_Id NameServerMessageQ_E_outOfMemory;
 
 
config NameServerMessageQ_heapId  // module-wide
index URL

The heap from which to alloc a message

C synopsis target-domain
extern const UInt16 NameServerMessageQ_heapId;
 
 
config NameServerMessageQ_timeoutInMicroSecs  // module-wide
index URL

The timeout value in terms of microseconds

C synopsis target-domain
extern const UInt NameServerMessageQ_timeoutInMicroSecs;
 
DETAILS
A NameServer request will return after this amout of time without a response. The default timeout value is 1 s. To not wait, use the value of '0'. To wait forever, use '~(0)'.
 
NameServerMessageQ_attach()  // module-wide
index URL

Function is called by Ipc_attach() through NameServer_SetupProxy

C synopsis target-domain
Int NameServerMessageQ_attach(UInt16 remoteProcId, Ptr sharedAddr);
 
 
NameServerMessageQ_detach()  // module-wide
index URL

Function is called by Ipc_detach() through NameServer_SetupProxy

C synopsis target-domain
Int NameServerMessageQ_detach(UInt16 remoteProcId);
 
 
NameServerMessageQ_sharedMemReq()  // module-wide
index URL

Returns the shared memory size requirement for a single instance

C synopsis target-domain
SizeT NameServerMessageQ_sharedMemReq(Ptr sharedAddr);
 
ARGUMENTS
sharedAddr — Shared address
RETURNS
Number of MAUs needed to create the instance.
DETAILS
Function is called during Ipc_attach() through NameServer_SetupProxy.
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId NameServerMessageQ_Module_id();
// Get this module's unique id
 
Bool NameServerMessageQ_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle NameServerMessageQ_Module_heap();
// The heap from which this module allocates memory
 
Bool NameServerMessageQ_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 NameServerMessageQ_Module_getMask();
// Returns the diagnostics mask for this module
 
Void NameServerMessageQ_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types
index URL

C synopsis target-domain
typedef struct NameServerMessageQ_Object NameServerMessageQ_Object;
// Opaque internal representation of an instance object
 
typedef NameServerMessageQ_Object *NameServerMessageQ_Handle;
// Client reference to an instance object
 
typedef struct NameServerMessageQ_Struct NameServerMessageQ_Struct;
// Opaque client structure large enough to hold an instance object
 
NameServerMessageQ_Handle NameServerMessageQ_handle(NameServerMessageQ_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
NameServerMessageQ_Struct *NameServerMessageQ_struct(NameServerMessageQ_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters
index URL

C synopsis target-domain
typedef struct NameServerMessageQ_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
} NameServerMessageQ_Params;
 
Void NameServerMessageQ_Params_init(NameServerMessageQ_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
Instance Creation
index URL

C synopsis target-domain
NameServerMessageQ_Handle NameServerMessageQ_create(UInt16 procId, const NameServerMessageQ_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void NameServerMessageQ_construct(NameServerMessageQ_Struct *structP, UInt16 procId, const NameServerMessageQ_Params *params);
// 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
index URL

C synopsis target-domain
Void NameServerMessageQ_delete(NameServerMessageQ_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void NameServerMessageQ_destruct(NameServerMessageQ_Struct *structP);
// Finalize the instance object inside the provided structure
 
NameServerMessageQ_get()  // instance
index URL
C synopsis target-domain
Int NameServerMessageQ_get(NameServerMessageQ_Handle handle, String instanceName, String name, Ptr value, UInt32 *valueLen, ISync_Handle syncHandle, Error_Block *eb);
 
ARGUMENTS
handle — handle of a previously-created NameServerMessageQ instance object
Instance Convertors
index URL

C synopsis target-domain
INameServerRemote_Handle NameServerMessageQ_Handle_upCast(NameServerMessageQ_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
NameServerMessageQ_Handle NameServerMessageQ_Handle_downCast(INameServerRemote_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins
index URL

C synopsis target-domain
Int NameServerMessageQ_Object_count();
// The number of statically-created instance objects
 
NameServerMessageQ_Handle NameServerMessageQ_Object_get(NameServerMessageQ_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
NameServerMessageQ_Handle NameServerMessageQ_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
NameServerMessageQ_Handle NameServerMessageQ_Object_next(NameServerMessageQ_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle NameServerMessageQ_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *NameServerMessageQ_Handle_label(NameServerMessageQ_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String NameServerMessageQ_Handle_name(NameServerMessageQ_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/nsremote/NameServerMessageQ.xdc
var NameServerMessageQ = xdc.useModule('ti.sdo.ipc.nsremote.NameServerMessageQ');
module-wide constants & types
    const NameServerMessageQ.maxNameLen// maximum number of characters for name in bytes = 32;
 
    values of type NameServerMessageQ.Status// Status codes returned by certain calls
        const NameServerMessageQ.S_SUCCESS;
        const NameServerMessageQ.E_FAIL;
        const NameServerMessageQ.E_ERROR;
module-wide config parameters
    NameServerMessageQ.A_nameIsTooLong// Assert raised if too many characters in the name = Assert.Desc {
        msg: "Too many characters in name"
    };
    NameServerMessageQ.A_reservedMsgQueueId// Assert raised if first MessageQ created already = Assert.Desc {
        msg: "MessageQ Id 0 is reserved for NameServer"
    };
    NameServerMessageQ.E_outOfMemory// Error raised if all the message queue objects are taken = Error.Desc {
        msg: "E_outOfMemory: MessageQ_alloc faild from heap: %d"
    };
    NameServerMessageQ.heapId// The heap from which to alloc a message = UInt16 0;
    NameServerMessageQ.timeoutInMicroSecs// The timeout value in terms of microseconds = UInt 1000000;
 
    NameServerMessageQ.common$// Common module configuration parameters = Types.Common$ undefined;
per-instance config parameters
    var params = new NameServerMessageQ.Params// Instance config-params object;
per-instance creation
    var inst = NameServerMessageQ.create// Create an instance-object(UInt16 procId, params);
 
 
const NameServerMessageQ.maxNameLen
index URL

maximum number of characters for name in bytes

XDCscript usage meta-domain
const NameServerMessageQ.maxNameLen = 32;
 
C SYNOPSIS
NameServerMessageQ_maxNameLen
 
enum NameServerMessageQ.Status
index URL

Status codes returned by certain calls

XDCscript usage meta-domain
values of type NameServerMessageQ.Status
    const NameServerMessageQ.S_SUCCESS;
    const NameServerMessageQ.E_FAIL;
    const NameServerMessageQ.E_ERROR;
 
C SYNOPSIS
NameServerMessageQ_Status
 
config NameServerMessageQ.A_nameIsTooLong  // module-wide
index URL

Assert raised if too many characters in the name

XDCscript usage meta-domain
NameServerMessageQ.A_nameIsTooLong = Assert.Desc {
    msg: "Too many characters in name"
};
 
C SYNOPSIS
NameServerMessageQ_A_nameIsTooLong
 
config NameServerMessageQ.A_reservedMsgQueueId  // module-wide
index URL

Assert raised if first MessageQ created already

XDCscript usage meta-domain
NameServerMessageQ.A_reservedMsgQueueId = Assert.Desc {
    msg: "MessageQ Id 0 is reserved for NameServer"
};
 
C SYNOPSIS
NameServerMessageQ_A_reservedMsgQueueId
 
config NameServerMessageQ.E_outOfMemory  // module-wide
index URL

Error raised if all the message queue objects are taken

XDCscript usage meta-domain
NameServerMessageQ.E_outOfMemory = Error.Desc {
    msg: "E_outOfMemory: MessageQ_alloc faild from heap: %d"
};
 
C SYNOPSIS
NameServerMessageQ_E_outOfMemory
 
config NameServerMessageQ.heapId  // module-wide
index URL

The heap from which to alloc a message

XDCscript usage meta-domain
NameServerMessageQ.heapId = UInt16 0;
 
C SYNOPSIS
NameServerMessageQ_heapId
 
config NameServerMessageQ.timeoutInMicroSecs  // module-wide
index URL

The timeout value in terms of microseconds

XDCscript usage meta-domain
NameServerMessageQ.timeoutInMicroSecs = UInt 1000000;
 
DETAILS
A NameServer request will return after this amout of time without a response. The default timeout value is 1 s. To not wait, use the value of '0'. To wait forever, use '~(0)'.
C SYNOPSIS
NameServerMessageQ_timeoutInMicroSecs
 
metaonly config NameServerMessageQ.common$  // module-wide
index URL

Common module configuration parameters

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

XDCscript usage meta-domain
var params = new NameServerMessageQ.Params;
// Instance config-params object
Instance Creation
index URL

XDCscript usage meta-domain
var params = new NameServerMessageQ.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = NameServerMessageQ.create(UInt16 procId, 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, 22 May 2012 23:44:59 GMT