module ti.syslink.ipc.rtos.syslinkMemMgr.SyslinkMemMgr
C synopsis target-domain sourced in ti/syslink/ipc/rtos/syslinkMemMgr/SyslinkMemMgr.xdc
#include <ti/syslink/ipc/rtos/syslinkMemMgr/SyslinkMemMgr.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
Constants
extern const Assert_Id 
 
 
const SyslinkMemMgr_MAX_NAME_LENGTH
C synopsis target-domain
#define SyslinkMemMgr_MAX_NAME_LENGTH (UInt8)32
 
 
const SyslinkMemMgr_MAX_TILER_BLOCKS
C synopsis target-domain
#define SyslinkMemMgr_MAX_TILER_BLOCKS (UInt8)10
 
 
enum SyslinkMemMgr_AddrType
C synopsis target-domain
typedef enum SyslinkMemMgr_AddrType {
    SyslinkMemMgr_AddrType_Virtual,
    SyslinkMemMgr_AddrType_Portable,
    SyslinkMemMgr_AddrType_EndValue
} SyslinkMemMgr_AddrType;
 
 
enum SyslinkMemMgr_Type
C synopsis target-domain
typedef enum SyslinkMemMgr_Type {
    SyslinkMemMgr_TYPE_SHAREDMEM,
    SyslinkMemMgr_TYPE_TILERMEM,
    SyslinkMemMgr_TYPE_NONE
} SyslinkMemMgr_Type;
 
 
struct SyslinkMemMgr_AllocBlock
C synopsis target-domain
typedef struct SyslinkMemMgr_AllocBlock {
    UInt16 pixelFormat;
    union {
        struct {
            UInt16 width;
            UInt16 height;
        } area;
        UInt16 len;
    } dim;
    UInt32 stride;
} SyslinkMemMgr_AllocBlock;
 
 
struct SyslinkMemMgr_allocParams
C synopsis target-domain
typedef struct SyslinkMemMgr_allocParams {
    UInt32 size;
    UInt32 align;
    UInt32 tilerBlocks;
} SyslinkMemMgr_allocParams;
 
 
struct SyslinkMemMgr_createParams
C synopsis target-domain
typedef struct SyslinkMemMgr_createParams {
    UInt32 size;
    ISyslinkMemMgr_Type type;
    UInt8 name[ISyslinkMemMgr_MAX_NAME_LENGTH];
} SyslinkMemMgr_createParams;
 
 
struct SyslinkMemMgr_freeParams
C synopsis target-domain
typedef struct SyslinkMemMgr_freeParams {
    Ptr ptr;
    UInt32 size;
} SyslinkMemMgr_freeParams;
 
 
config SyslinkMemMgr_A_invalidParams  // module-wide

Assert raised when an invalid parameter(s) is passed into a function

C synopsis target-domain
extern const Assert_Id SyslinkMemMgr_A_invalidParams;
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId SyslinkMemMgr_Module_id();
// Get this module's unique id
 
Bool SyslinkMemMgr_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SyslinkMemMgr_Module_heap();
// The heap from which this module allocates memory
 
Bool SyslinkMemMgr_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SyslinkMemMgr_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SyslinkMemMgr_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct SyslinkMemMgr_Object SyslinkMemMgr_Object;
// Opaque internal representation of an instance object
 
typedef SyslinkMemMgr_Object *SyslinkMemMgr_Handle;
// Client reference to an instance object
 
typedef struct SyslinkMemMgr_Struct SyslinkMemMgr_Struct;
// Opaque client structure large enough to hold an instance object
 
SyslinkMemMgr_Handle SyslinkMemMgr_handle(SyslinkMemMgr_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
SyslinkMemMgr_Struct *SyslinkMemMgr_struct(SyslinkMemMgr_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct SyslinkMemMgr_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    IHeap_Handle heapHandle;
    // 
    SyslinkMemMgr_Type memMgrType;
    // 
    String name;
    // 
    UInt32 size;
    // 
} SyslinkMemMgr_Params;
 
Void SyslinkMemMgr_Params_init(SyslinkMemMgr_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config SyslinkMemMgr_heapHandle  // instance
C synopsis target-domain
      ...
    IHeap_Handle heapHandle;
 
 
config SyslinkMemMgr_memMgrType  // instance
C synopsis target-domain
      ...
    SyslinkMemMgr_Type memMgrType;
 
 
config SyslinkMemMgr_name  // instance
C synopsis target-domain
      ...
    String name;
 
 
config SyslinkMemMgr_size  // instance
C synopsis target-domain
      ...
    UInt32 size;
 
 
SyslinkMemMgr_alloc()  // instance
C synopsis target-domain
Ptr SyslinkMemMgr_alloc(SyslinkMemMgr_Handle handle, Ptr allocParams);
 
ARGUMENTS
handle — handle of a previously-created SyslinkMemMgr instance object
 
SyslinkMemMgr_free()  // instance
C synopsis target-domain
Int32 SyslinkMemMgr_free(SyslinkMemMgr_Handle handle, Ptr freeParams);
 
ARGUMENTS
handle — handle of a previously-created SyslinkMemMgr instance object
 
SyslinkMemMgr_translate()  // instance
C synopsis target-domain
Ptr SyslinkMemMgr_translate(SyslinkMemMgr_Handle handle, Ptr srcAddr, ISyslinkMemMgr_AddrType srcAddrType, ISyslinkMemMgr_AddrType desAddrType);
 
ARGUMENTS
handle — handle of a previously-created SyslinkMemMgr instance object
Instance Convertors

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

C synopsis target-domain
Int SyslinkMemMgr_Object_count();
// The number of statically-created instance objects
 
SyslinkMemMgr_Handle SyslinkMemMgr_Object_get(SyslinkMemMgr_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
SyslinkMemMgr_Handle SyslinkMemMgr_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
SyslinkMemMgr_Handle SyslinkMemMgr_Object_next(SyslinkMemMgr_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle SyslinkMemMgr_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *SyslinkMemMgr_Handle_label(SyslinkMemMgr_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String SyslinkMemMgr_Handle_name(SyslinkMemMgr_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/syslink/ipc/rtos/syslinkMemMgr/SyslinkMemMgr.xdc
var SyslinkMemMgr = xdc.useModule('ti.syslink.ipc.rtos.syslinkMemMgr.SyslinkMemMgr');
module-wide constants & types
    const SyslinkMemMgr.MAX_NAME_LENGTH//  = 32;
 
    values of type SyslinkMemMgr.AddrType// 
        const SyslinkMemMgr.AddrType_Virtual;
        const SyslinkMemMgr.AddrType_Portable;
        const SyslinkMemMgr.AddrType_EndValue;
 
    values of type SyslinkMemMgr.Type// 
        const SyslinkMemMgr.TYPE_SHAREDMEM;
        const SyslinkMemMgr.TYPE_TILERMEM;
        const SyslinkMemMgr.TYPE_NONE;
 
    var obj = new SyslinkMemMgr.AllocBlock// ;
        obj.pixelFormat = UInt16  ...
        obj.dim = ISyslinkMemMgr.__struct__1  ...
        obj.stride = UInt32  ...
 
    var obj = new SyslinkMemMgr.allocParams// ;
        obj.size = UInt32  ...
        obj.align = UInt32  ...
        obj.tilerBlocks = UInt32  ...
 
    var obj = new SyslinkMemMgr.createParams// ;
        obj.size = UInt32  ...
        obj.type = ISyslinkMemMgr.Type  ...
        obj.name = UInt8[ISyslinkMemMgr.MAX_NAME_LENGTH]  ...
 
    var obj = new SyslinkMemMgr.freeParams// ;
        obj.ptr = Ptr  ...
        obj.size = UInt32  ...
module-wide config parameters
        msg: "A_invalidParams: Invalid parameter"
    };
 
per-instance config parameters
    var params = new SyslinkMemMgr.Params// Instance config-params object;
        params.heapHandle//  = IHeap.Handle null;
        params.name//  = String null;
        params.size//  = UInt32 0;
 
 
const SyslinkMemMgr.MAX_NAME_LENGTH
XDCscript usage meta-domain
const SyslinkMemMgr.MAX_NAME_LENGTH = 32;
 
C SYNOPSIS
 
const SyslinkMemMgr.MAX_TILER_BLOCKS
XDCscript usage meta-domain
const SyslinkMemMgr.MAX_TILER_BLOCKS = 10;
 
C SYNOPSIS
 
enum SyslinkMemMgr.AddrType
XDCscript usage meta-domain
values of type SyslinkMemMgr.AddrType
    const SyslinkMemMgr.AddrType_Virtual;
    const SyslinkMemMgr.AddrType_Portable;
    const SyslinkMemMgr.AddrType_EndValue;
 
C SYNOPSIS
 
enum SyslinkMemMgr.Type
XDCscript usage meta-domain
values of type SyslinkMemMgr.Type
    const SyslinkMemMgr.TYPE_SHAREDMEM;
    const SyslinkMemMgr.TYPE_TILERMEM;
    const SyslinkMemMgr.TYPE_NONE;
 
C SYNOPSIS
 
struct SyslinkMemMgr.AllocBlock
XDCscript usage meta-domain
var obj = new SyslinkMemMgr.AllocBlock;
 
    obj.pixelFormat = UInt16  ...
    obj.dim = ISyslinkMemMgr.__struct__1  ...
    obj.stride = UInt32  ...
 
C SYNOPSIS
 
struct SyslinkMemMgr.allocParams
XDCscript usage meta-domain
var obj = new SyslinkMemMgr.allocParams;
 
    obj.size = UInt32  ...
    obj.align = UInt32  ...
    obj.tilerBlocks = UInt32  ...
 
C SYNOPSIS
 
struct SyslinkMemMgr.createParams
XDCscript usage meta-domain
var obj = new SyslinkMemMgr.createParams;
 
    obj.size = UInt32  ...
    obj.type = ISyslinkMemMgr.Type  ...
    obj.name = UInt8[ISyslinkMemMgr.MAX_NAME_LENGTH]  ...
 
C SYNOPSIS
 
struct SyslinkMemMgr.freeParams
XDCscript usage meta-domain
var obj = new SyslinkMemMgr.freeParams;
 
    obj.ptr = Ptr  ...
    obj.size = UInt32  ...
 
C SYNOPSIS
 
config SyslinkMemMgr.A_invalidParams  // module-wide

Assert raised when an invalid parameter(s) is passed into a function

XDCscript usage meta-domain
SyslinkMemMgr.A_invalidParams = Assert.Desc {
    msg: "A_invalidParams: Invalid parameter"
};
 
C SYNOPSIS
 
metaonly config SyslinkMemMgr.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
SyslinkMemMgr.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 SyslinkMemMgr.Params;
// Instance config-params object
    params.heapHandle = IHeap.Handle null;
    // 
    params.memMgrType = SyslinkMemMgr.Type ISyslinkMemMgr.TYPE_NONE;
    // 
    params.name = String null;
    // 
    params.size = UInt32 0;
    // 
 
config SyslinkMemMgr.heapHandle  // instance
XDCscript usage meta-domain
var params = new SyslinkMemMgr.Params;
  ...
params.heapHandle = IHeap.Handle null;
 
C SYNOPSIS
 
config SyslinkMemMgr.memMgrType  // instance
XDCscript usage meta-domain
var params = new SyslinkMemMgr.Params;
  ...
 
C SYNOPSIS
 
config SyslinkMemMgr.name  // instance
XDCscript usage meta-domain
var params = new SyslinkMemMgr.Params;
  ...
params.name = String null;
 
C SYNOPSIS
 
config SyslinkMemMgr.size  // instance
XDCscript usage meta-domain
var params = new SyslinkMemMgr.Params;
  ...
params.size = UInt32 0;
 
C SYNOPSIS
generated on Fri, 02 Dec 2011 14:44:31 GMT