This module has a common header that can be found in the
ti.ipc
package. Application code should include the common header file (not the
RTSC-generated one):
#include <ti/ipc/ListMP.h>
The RTSC module must be used in the application's RTSC configuration file
(.cfg):
ListMP = xdc.useModule('ti.sdo.ipc.ListMP');
Documentation for all runtime APIs, instance configuration parameters,
error codes macros and type definitions available to the application
integrator can be found in the
Doxygen documenation
for the IPC product. However, the documentation presented on this page
should be referred to for information specific to the RTSC module, such as
module configuration, Errors, and Asserts.
Module-Wide Built-Ins |
|
// Get this module's unique id
Bool ListMP_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool ListMP_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 ListMP_Module_getMask();
// Returns the diagnostics mask for this module
Void ListMP_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types |
|
typedef struct ListMP_Object ListMP_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct ListMP_Struct ListMP_Struct;
// Opaque client structure large enough to hold an instance object
// Convert this instance structure pointer into an instance handle
// Convert this instance handle into an instance structure pointer
Instance Config Parameters |
|
typedef struct ListMP_Params {
// Instance config-params structure
// Common per-instance configs
// GateMP used for critical region management of the shared memory
String name;
// Name of the instance
UInt16 regionId;
// SharedRegion ID
} ListMP_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
config ListMP_gate // instance |
|
GateMP used for critical region management of the shared memory
DETAILS
Using the default value of NULL will result in the default GateMP
being used for context protection.
config ListMP_name // instance |
|
Name of the instance
DETAILS
The name must be unique among all ListMP instances in the sytem.
When using
regionId to create a new instance, the name must
not be null.
config ListMP_regionId // instance |
|
SharedRegion ID
DETAILS
The ID corresponding to the index of the shared region in which this
shared instance is to be placed. This is used in create() only when
name is not null.
Instance Built-Ins |
|
Int ListMP_Object_count();
// The number of statically-created instance objects
// The handle of the i-th statically-created instance object (array == NULL)
// The handle of the first dynamically-created instance object, or NULL
// The handle of the next dynamically-created instance object, or NULL
// The heap used to allocate dynamically-created instance objects
// The label associated with this instance object
// The name of this instance object