module ti.syslink.ipc.rtos.syslinkMemMgr.shMemMgr.SharedMemoryMgr
C synopsis target-domain sourced in ti/syslink/ipc/rtos/syslinkMemMgr/shMemMgr/SharedMemoryMgr.xdc
#include <ti/syslink/ipc/rtos/syslinkMemMgr/shMemMgr/SharedMemoryMgr.h>
Functions
Void
Functions common to all ISyslinkMemMgr modules
Ptr 
Int32 
Ptr 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
Typedefs
typedef enum
typedef struct
typedef struct
typedef struct
typedef struct
typedef struct
typedef struct
typedef struct
typedef enum
 
 
const SharedMemoryMgr_MAX_NAME_LENGTH
C synopsis target-domain
#define SharedMemoryMgr_MAX_NAME_LENGTH (UInt8)32
 
 
const SharedMemoryMgr_MAX_TILER_BLOCKS
C synopsis target-domain
#define SharedMemoryMgr_MAX_TILER_BLOCKS (UInt8)10
 
 
enum SharedMemoryMgr_AddrType
C synopsis target-domain
typedef enum SharedMemoryMgr_AddrType {
    SharedMemoryMgr_AddrType_Virtual,
    SharedMemoryMgr_AddrType_Portable,
    SharedMemoryMgr_AddrType_EndValue
} SharedMemoryMgr_AddrType;
 
 
enum SharedMemoryMgr_Type
C synopsis target-domain
typedef enum SharedMemoryMgr_Type {
    SharedMemoryMgr_TYPE_SHAREDMEM,
    SharedMemoryMgr_TYPE_TILERMEM,
    SharedMemoryMgr_TYPE_NONE
} SharedMemoryMgr_Type;
 
 
struct SharedMemoryMgr_AllocBlock
C synopsis target-domain
typedef struct SharedMemoryMgr_AllocBlock {
    UInt16 pixelFormat;
    union {
        struct {
            UInt16 width;
            UInt16 height;
        } area;
        UInt16 len;
    } dim;
    UInt32 stride;
} SharedMemoryMgr_AllocBlock;
 
 
struct SharedMemoryMgr_allocParams
C synopsis target-domain
typedef struct SharedMemoryMgr_allocParams {
    UInt32 size;
    UInt32 align;
    UInt32 tilerBlocks;
} SharedMemoryMgr_allocParams;
 
 
struct SharedMemoryMgr_createParams
C synopsis target-domain
typedef struct SharedMemoryMgr_createParams {
    UInt32 size;
    ISyslinkMemMgr_Type type;
    UInt8 name[ISyslinkMemMgr_MAX_NAME_LENGTH];
} SharedMemoryMgr_createParams;
 
 
struct SharedMemoryMgr_freeParams
C synopsis target-domain
typedef struct SharedMemoryMgr_freeParams {
    Ptr ptr;
    UInt32 size;
} SharedMemoryMgr_freeParams;
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId SharedMemoryMgr_Module_id();
// Get this module's unique id
 
Bool SharedMemoryMgr_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SharedMemoryMgr_Module_heap();
// The heap from which this module allocates memory
 
Bool SharedMemoryMgr_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SharedMemoryMgr_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SharedMemoryMgr_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct SharedMemoryMgr_Object SharedMemoryMgr_Object;
// Opaque internal representation of an instance object
 
typedef SharedMemoryMgr_Object *SharedMemoryMgr_Handle;
// Client reference to an instance object
 
typedef struct SharedMemoryMgr_Struct SharedMemoryMgr_Struct;
// Opaque client structure large enough to hold an instance object
 
SharedMemoryMgr_Handle SharedMemoryMgr_handle(SharedMemoryMgr_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
SharedMemoryMgr_Struct *SharedMemoryMgr_struct(SharedMemoryMgr_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct SharedMemoryMgr_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    IHeap_Handle heapHandle;
    // 
} SharedMemoryMgr_Params;
 
Void SharedMemoryMgr_Params_init(SharedMemoryMgr_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config SharedMemoryMgr_heapHandle  // instance
C synopsis target-domain
      ...
    IHeap_Handle heapHandle;
 
 
SharedMemoryMgr_alloc()  // instance
C synopsis target-domain
Ptr SharedMemoryMgr_alloc(SharedMemoryMgr_Handle handle, Ptr allocParams);
 
ARGUMENTS
handle — handle of a previously-created SharedMemoryMgr instance object
 
SharedMemoryMgr_free()  // instance
C synopsis target-domain
Int32 SharedMemoryMgr_free(SharedMemoryMgr_Handle handle, Ptr freeParams);
 
ARGUMENTS
handle — handle of a previously-created SharedMemoryMgr instance object
 
SharedMemoryMgr_translate()  // instance
C synopsis target-domain
Ptr SharedMemoryMgr_translate(SharedMemoryMgr_Handle handle, Ptr srcAddr, ISyslinkMemMgr_AddrType srcAddrType, ISyslinkMemMgr_AddrType desAddrType);
 
ARGUMENTS
handle — handle of a previously-created SharedMemoryMgr instance object
Instance Convertors

C synopsis target-domain
ISyslinkMemMgr_Handle SharedMemoryMgr_Handle_upCast(SharedMemoryMgr_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
SharedMemoryMgr_Handle SharedMemoryMgr_Handle_downCast(ISyslinkMemMgr_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int SharedMemoryMgr_Object_count();
// The number of statically-created instance objects
 
SharedMemoryMgr_Handle SharedMemoryMgr_Object_get(SharedMemoryMgr_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
SharedMemoryMgr_Handle SharedMemoryMgr_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
SharedMemoryMgr_Handle SharedMemoryMgr_Object_next(SharedMemoryMgr_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle SharedMemoryMgr_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *SharedMemoryMgr_Handle_label(SharedMemoryMgr_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String SharedMemoryMgr_Handle_name(SharedMemoryMgr_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/syslink/ipc/rtos/syslinkMemMgr/shMemMgr/SharedMemoryMgr.xdc
var SharedMemoryMgr = xdc.useModule('ti.syslink.ipc.rtos.syslinkMemMgr.shMemMgr.SharedMemoryMgr');
module-wide constants & types
 
    values of type SharedMemoryMgr.AddrType// 
        const SharedMemoryMgr.AddrType_Virtual;
        const SharedMemoryMgr.AddrType_Portable;
        const SharedMemoryMgr.AddrType_EndValue;
 
    values of type SharedMemoryMgr.Type// 
        const SharedMemoryMgr.TYPE_SHAREDMEM;
        const SharedMemoryMgr.TYPE_TILERMEM;
        const SharedMemoryMgr.TYPE_NONE;
 
    var obj = new SharedMemoryMgr.AllocBlock// ;
        obj.pixelFormat = UInt16  ...
        obj.dim = ISyslinkMemMgr.__struct__1  ...
        obj.stride = UInt32  ...
 
    var obj = new SharedMemoryMgr.allocParams// ;
        obj.size = UInt32  ...
        obj.align = UInt32  ...
        obj.tilerBlocks = UInt32  ...
 
    var obj = new SharedMemoryMgr.createParams// ;
        obj.size = UInt32  ...
        obj.type = ISyslinkMemMgr.Type  ...
        obj.name = UInt8[ISyslinkMemMgr.MAX_NAME_LENGTH]  ...
 
    var obj = new SharedMemoryMgr.freeParams// ;
        obj.ptr = Ptr  ...
        obj.size = UInt32  ...
module-wide config parameters
per-instance config parameters
    var params = new SharedMemoryMgr.Params// Instance config-params object;
        params.heapHandle//  = IHeap.Handle null;
 
 
const SharedMemoryMgr.MAX_NAME_LENGTH
XDCscript usage meta-domain
const SharedMemoryMgr.MAX_NAME_LENGTH = 32;
 
C SYNOPSIS
 
const SharedMemoryMgr.MAX_TILER_BLOCKS
XDCscript usage meta-domain
const SharedMemoryMgr.MAX_TILER_BLOCKS = 10;
 
C SYNOPSIS
 
enum SharedMemoryMgr.AddrType
XDCscript usage meta-domain
values of type SharedMemoryMgr.AddrType
    const SharedMemoryMgr.AddrType_Virtual;
    const SharedMemoryMgr.AddrType_Portable;
    const SharedMemoryMgr.AddrType_EndValue;
 
C SYNOPSIS
 
enum SharedMemoryMgr.Type
XDCscript usage meta-domain
values of type SharedMemoryMgr.Type
    const SharedMemoryMgr.TYPE_SHAREDMEM;
    const SharedMemoryMgr.TYPE_TILERMEM;
    const SharedMemoryMgr.TYPE_NONE;
 
C SYNOPSIS
 
struct SharedMemoryMgr.AllocBlock
XDCscript usage meta-domain
var obj = new SharedMemoryMgr.AllocBlock;
 
    obj.pixelFormat = UInt16  ...
    obj.dim = ISyslinkMemMgr.__struct__1  ...
    obj.stride = UInt32  ...
 
C SYNOPSIS
 
struct SharedMemoryMgr.allocParams
XDCscript usage meta-domain
var obj = new SharedMemoryMgr.allocParams;
 
    obj.size = UInt32  ...
    obj.align = UInt32  ...
    obj.tilerBlocks = UInt32  ...
 
C SYNOPSIS
 
struct SharedMemoryMgr.createParams
XDCscript usage meta-domain
var obj = new SharedMemoryMgr.createParams;
 
    obj.size = UInt32  ...
    obj.type = ISyslinkMemMgr.Type  ...
    obj.name = UInt8[ISyslinkMemMgr.MAX_NAME_LENGTH]  ...
 
C SYNOPSIS
 
struct SharedMemoryMgr.freeParams
XDCscript usage meta-domain
var obj = new SharedMemoryMgr.freeParams;
 
    obj.ptr = Ptr  ...
    obj.size = UInt32  ...
 
C SYNOPSIS
 
metaonly config SharedMemoryMgr.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
SharedMemoryMgr.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

XDCscript usage meta-domain
var params = new SharedMemoryMgr.Params;
// Instance config-params object
    params.heapHandle = IHeap.Handle null;
    // 
 
config SharedMemoryMgr.heapHandle  // instance
XDCscript usage meta-domain
var params = new SharedMemoryMgr.Params;
  ...
params.heapHandle = IHeap.Handle null;
 
C SYNOPSIS
generated on Fri, 02 Dec 2011 14:44:32 GMT