module ti.ipc.namesrv.NameServerRemoteRpmsg
index URL
C synopsis target-domain sourced in ti/ipc/namesrv/NameServerRemoteRpmsg.xdc
#include <ti/ipc/namesrv/NameServerRemoteRpmsg.h>
Functions
Void
NameServerRemoteRpmsg_construct// Initialize a new instance object inside the provided structure(NameServerRemoteRpmsg_Struct *structP, UInt16 procId, const NameServerRemoteRpmsg_Params *params);
NameServerRemoteRpmsg_Handle
NameServerRemoteRpmsg_create// Allocate and initialize a new instance object and return its handle(UInt16 procId, const NameServerRemoteRpmsg_Params *params, Error_Block *eb);
Void
NameServerRemoteRpmsg_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(NameServerRemoteRpmsg_Handle *handleP);
Void
NameServerRemoteRpmsg_destruct// Finalize the instance object inside the provided structure(NameServerRemoteRpmsg_Struct *structP);
Void
NameServerRemoteRpmsg_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(NameServerRemoteRpmsg_Params *params);
Functions common to all INameServerRemote modules
Int 
NameServerRemoteRpmsg_attach// Function is called by Ipc_attach() through NameServer_SetupProxy(UInt16 remoteProcId, Ptr sharedAddr);
Int 
NameServerRemoteRpmsg_detach// Function is called by Ipc_detach() through NameServer_SetupProxy(UInt16 remoteProcId);
Int 
NameServerRemoteRpmsg_get// (NameServerRemoteRpmsg_Handle handle, String instanceName, String name, Ptr value, UInt32 *valueLen, ISync_Handle syncHandle, Error_Block *eb);
SizeT 
NameServerRemoteRpmsg_sharedMemReq// Returns the shared memory size requirement for a single instance(Ptr sharedAddr);
Functions common to all target instances
NameServerRemoteRpmsg_handle// Convert this instance structure pointer into an instance handle, NameServerRemoteRpmsg_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, NameServerRemoteRpmsg_Handle_label// The label associated with this instance object, NameServerRemoteRpmsg_Handle_name// The name of this instance object, NameServerRemoteRpmsg_Handle_upCast// unconditionally move one level up the inheritance hierarchy, NameServerRemoteRpmsg_Object_count// The number of statically-created instance objects, NameServerRemoteRpmsg_Object_first// The handle of the first dynamically-created instance object, or NULL, NameServerRemoteRpmsg_Object_get// The handle of the i-th statically-created instance object (array == NULL), NameServerRemoteRpmsg_Object_heap// The heap used to allocate dynamically-created instance objects, NameServerRemoteRpmsg_Object_next// The handle of the next dynamically-created instance object, or NULL, NameServerRemoteRpmsg_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
NameServerRemoteRpmsg_Module_getMask// Returns the diagnostics mask for this module, NameServerRemoteRpmsg_Module_hasMask// Test whether this module has a diagnostics mask, NameServerRemoteRpmsg_Module_heap// The heap from which this module allocates memory, NameServerRemoteRpmsg_Module_id// Get this module's unique id, NameServerRemoteRpmsg_Module_setMask// Set the diagnostics mask for this module, NameServerRemoteRpmsg_Module_startupDone// Test if this module has completed startup
Typedefs
typedef NameServerRemoteRpmsg_Object *
NameServerRemoteRpmsg_Handle// Client reference to an instance object;
typedef struct
NameServerRemoteRpmsg_Object// Opaque internal representation of an instance object NameServerRemoteRpmsg_Object;
typedef struct
NameServerRemoteRpmsg_Params// Instance config-params structure ...
typedef enum
NameServerRemoteRpmsg_Status// Status codes returned by certain calls ...
typedef struct
NameServerRemoteRpmsg_Struct// Opaque client structure large enough to hold an instance object NameServerRemoteRpmsg_Struct;
Constants
extern const Assert_Id 
NameServerRemoteRpmsg_A_nameIsTooLong// Assert raised if too many characters in the name;
extern const UInt 
NameServerRemoteRpmsg_timeoutInMicroSecs// The timeout value in terms of microseconds;
 
 
enum NameServerRemoteRpmsg_Status
index URL

Status codes returned by certain calls

C synopsis target-domain
typedef enum NameServerRemoteRpmsg_Status {
    NameServerRemoteRpmsg_S_SUCCESS,
    NameServerRemoteRpmsg_E_FAIL,
    NameServerRemoteRpmsg_E_ERROR
} NameServerRemoteRpmsg_Status;
 
 
config NameServerRemoteRpmsg_A_nameIsTooLong  // module-wide
index URL

Assert raised if too many characters in the name

C synopsis target-domain
extern const Assert_Id NameServerRemoteRpmsg_A_nameIsTooLong;
 
 
config NameServerRemoteRpmsg_timeoutInMicroSecs  // module-wide
index URL

The timeout value in terms of microseconds

C synopsis target-domain
extern const UInt NameServerRemoteRpmsg_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)'.
 
NameServerRemoteRpmsg_attach()  // module-wide
index URL

Function is called by Ipc_attach() through NameServer_SetupProxy

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

Function is called by Ipc_detach() through NameServer_SetupProxy

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

Returns the shared memory size requirement for a single instance

C synopsis target-domain
SizeT NameServerRemoteRpmsg_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 NameServerRemoteRpmsg_Module_id();
// Get this module's unique id
 
Bool NameServerRemoteRpmsg_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle NameServerRemoteRpmsg_Module_heap();
// The heap from which this module allocates memory
 
Bool NameServerRemoteRpmsg_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 NameServerRemoteRpmsg_Module_getMask();
// Returns the diagnostics mask for this module
 
Void NameServerRemoteRpmsg_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types
index URL

C synopsis target-domain
typedef struct NameServerRemoteRpmsg_Object NameServerRemoteRpmsg_Object;
// Opaque internal representation of an instance object
 
typedef NameServerRemoteRpmsg_Object *NameServerRemoteRpmsg_Handle;
// Client reference to an instance object
 
typedef struct NameServerRemoteRpmsg_Struct NameServerRemoteRpmsg_Struct;
// Opaque client structure large enough to hold an instance object
 
NameServerRemoteRpmsg_Handle NameServerRemoteRpmsg_handle(NameServerRemoteRpmsg_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
NameServerRemoteRpmsg_Struct *NameServerRemoteRpmsg_struct(NameServerRemoteRpmsg_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters
index URL

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

C synopsis target-domain
NameServerRemoteRpmsg_Handle NameServerRemoteRpmsg_create(UInt16 procId, const NameServerRemoteRpmsg_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void NameServerRemoteRpmsg_construct(NameServerRemoteRpmsg_Struct *structP, UInt16 procId, const NameServerRemoteRpmsg_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 NameServerRemoteRpmsg_delete(NameServerRemoteRpmsg_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void NameServerRemoteRpmsg_destruct(NameServerRemoteRpmsg_Struct *structP);
// Finalize the instance object inside the provided structure
 
NameServerRemoteRpmsg_get()  // instance
index URL
C synopsis target-domain
Int NameServerRemoteRpmsg_get(NameServerRemoteRpmsg_Handle handle, String instanceName, String name, Ptr value, UInt32 *valueLen, ISync_Handle syncHandle, Error_Block *eb);
 
ARGUMENTS
handle — handle of a previously-created NameServerRemoteRpmsg instance object
Instance Convertors
index URL

C synopsis target-domain
INameServerRemote_Handle NameServerRemoteRpmsg_Handle_upCast(NameServerRemoteRpmsg_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
NameServerRemoteRpmsg_Handle NameServerRemoteRpmsg_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 NameServerRemoteRpmsg_Object_count();
// The number of statically-created instance objects
 
NameServerRemoteRpmsg_Handle NameServerRemoteRpmsg_Object_get(NameServerRemoteRpmsg_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
NameServerRemoteRpmsg_Handle NameServerRemoteRpmsg_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
NameServerRemoteRpmsg_Handle NameServerRemoteRpmsg_Object_next(NameServerRemoteRpmsg_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle NameServerRemoteRpmsg_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *NameServerRemoteRpmsg_Handle_label(NameServerRemoteRpmsg_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String NameServerRemoteRpmsg_Handle_name(NameServerRemoteRpmsg_Handle handle);
// The name of this instance object
 
Configuration settings sourced in ti/ipc/namesrv/NameServerRemoteRpmsg.xdc
var NameServerRemoteRpmsg = xdc.useModule('ti.ipc.namesrv.NameServerRemoteRpmsg');
module-wide constants & types
    values of type NameServerRemoteRpmsg.Status// Status codes returned by certain calls
        const NameServerRemoteRpmsg.S_SUCCESS;
        const NameServerRemoteRpmsg.E_FAIL;
        const NameServerRemoteRpmsg.E_ERROR;
module-wide config parameters
    NameServerRemoteRpmsg.A_nameIsTooLong// Assert raised if too many characters in the name = Assert.Desc {
        msg: "Too many characters in name"
    };
    NameServerRemoteRpmsg.timeoutInMicroSecs// The timeout value in terms of microseconds = UInt 1000000;
 
    NameServerRemoteRpmsg.common$// Common module configuration parameters = Types.Common$ undefined;
per-instance config parameters
    var params = new NameServerRemoteRpmsg.Params// Instance config-params object;
per-instance creation
    var inst = NameServerRemoteRpmsg.create// Create an instance-object(UInt16 procId, params);
 
 
enum NameServerRemoteRpmsg.Status
index URL

Status codes returned by certain calls

Configuration settings
values of type NameServerRemoteRpmsg.Status
    const NameServerRemoteRpmsg.S_SUCCESS;
    const NameServerRemoteRpmsg.E_FAIL;
    const NameServerRemoteRpmsg.E_ERROR;
 
C SYNOPSIS
NameServerRemoteRpmsg_Status
 
config NameServerRemoteRpmsg.A_nameIsTooLong  // module-wide
index URL

Assert raised if too many characters in the name

Configuration settings
NameServerRemoteRpmsg.A_nameIsTooLong = Assert.Desc {
    msg: "Too many characters in name"
};
 
C SYNOPSIS
NameServerRemoteRpmsg_A_nameIsTooLong
 
config NameServerRemoteRpmsg.timeoutInMicroSecs  // module-wide
index URL

The timeout value in terms of microseconds

Configuration settings
NameServerRemoteRpmsg.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
NameServerRemoteRpmsg_timeoutInMicroSecs
 
metaonly config NameServerRemoteRpmsg.common$  // module-wide
index URL

Common module configuration parameters

Configuration settings
NameServerRemoteRpmsg.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

Configuration settings
var params = new NameServerRemoteRpmsg.Params;
// Instance config-params object
Static Instance Creation
index URL

Configuration settings
var params = new NameServerRemoteRpmsg.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = NameServerRemoteRpmsg.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 Fri, 21 Aug 2015 19:35:31 GMT