module ti.syslink.ipc.rtos.syslinkMemMgr.tilerMemMgr.TilerMemoryMgr
C synopsis target-domain sourced in ti/syslink/ipc/rtos/syslinkMemMgr/tilerMemMgr/TilerMemoryMgr.xdc
#include <ti/syslink/ipc/rtos/syslinkMemMgr/tilerMemMgr/TilerMemoryMgr.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 TilerMemoryMgr_MAX_NAME_LENGTH
C synopsis target-domain
#define TilerMemoryMgr_MAX_NAME_LENGTH (UInt8)32
 
 
const TilerMemoryMgr_MAX_TILER_BLOCKS
C synopsis target-domain
#define TilerMemoryMgr_MAX_TILER_BLOCKS (UInt8)10
 
 
enum TilerMemoryMgr_AddrType
C synopsis target-domain
typedef enum TilerMemoryMgr_AddrType {
    TilerMemoryMgr_AddrType_Virtual,
    TilerMemoryMgr_AddrType_Portable,
    TilerMemoryMgr_AddrType_EndValue
} TilerMemoryMgr_AddrType;
 
 
enum TilerMemoryMgr_Type
C synopsis target-domain
typedef enum TilerMemoryMgr_Type {
    TilerMemoryMgr_TYPE_SHAREDMEM,
    TilerMemoryMgr_TYPE_TILERMEM,
    TilerMemoryMgr_TYPE_NONE
} TilerMemoryMgr_Type;
 
 
struct TilerMemoryMgr_AllocBlock
C synopsis target-domain
typedef struct TilerMemoryMgr_AllocBlock {
    UInt16 pixelFormat;
    union {
        struct {
            UInt16 width;
            UInt16 height;
        } area;
        UInt16 len;
    } dim;
    UInt32 stride;
} TilerMemoryMgr_AllocBlock;
 
 
struct TilerMemoryMgr_allocParams
C synopsis target-domain
typedef struct TilerMemoryMgr_allocParams {
    UInt32 size;
    UInt32 align;
    UInt32 tilerBlocks;
} TilerMemoryMgr_allocParams;
 
 
struct TilerMemoryMgr_createParams
C synopsis target-domain
typedef struct TilerMemoryMgr_createParams {
    UInt32 size;
    ISyslinkMemMgr_Type type;
    UInt8 name[ISyslinkMemMgr_MAX_NAME_LENGTH];
} TilerMemoryMgr_createParams;
 
 
struct TilerMemoryMgr_freeParams
C synopsis target-domain
typedef struct TilerMemoryMgr_freeParams {
    Ptr ptr;
    UInt32 size;
} TilerMemoryMgr_freeParams;
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId TilerMemoryMgr_Module_id();
// Get this module's unique id
 
Bool TilerMemoryMgr_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle TilerMemoryMgr_Module_heap();
// The heap from which this module allocates memory
 
Bool TilerMemoryMgr_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 TilerMemoryMgr_Module_getMask();
// Returns the diagnostics mask for this module
 
Void TilerMemoryMgr_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct TilerMemoryMgr_Object TilerMemoryMgr_Object;
// Opaque internal representation of an instance object
 
typedef TilerMemoryMgr_Object *TilerMemoryMgr_Handle;
// Client reference to an instance object
 
typedef struct TilerMemoryMgr_Struct TilerMemoryMgr_Struct;
// Opaque client structure large enough to hold an instance object
 
TilerMemoryMgr_Handle TilerMemoryMgr_handle(TilerMemoryMgr_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
TilerMemoryMgr_Struct *TilerMemoryMgr_struct(TilerMemoryMgr_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct TilerMemoryMgr_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    IHeap_Handle heapHandle;
    // 
} TilerMemoryMgr_Params;
 
Void TilerMemoryMgr_Params_init(TilerMemoryMgr_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config TilerMemoryMgr_heapHandle  // instance
C synopsis target-domain
      ...
    IHeap_Handle heapHandle;
 
 
TilerMemoryMgr_alloc()  // instance
C synopsis target-domain
Ptr TilerMemoryMgr_alloc(TilerMemoryMgr_Handle handle, Ptr allocParams);
 
ARGUMENTS
handle — handle of a previously-created TilerMemoryMgr instance object
 
TilerMemoryMgr_free()  // instance
C synopsis target-domain
Int32 TilerMemoryMgr_free(TilerMemoryMgr_Handle handle, Ptr freeParams);
 
ARGUMENTS
handle — handle of a previously-created TilerMemoryMgr instance object
 
TilerMemoryMgr_translate()  // instance
C synopsis target-domain
Ptr TilerMemoryMgr_translate(TilerMemoryMgr_Handle handle, Ptr srcAddr, ISyslinkMemMgr_AddrType srcAddrType, ISyslinkMemMgr_AddrType desAddrType);
 
ARGUMENTS
handle — handle of a previously-created TilerMemoryMgr instance object
Instance Convertors

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

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

Common module configuration parameters

XDCscript usage meta-domain
TilerMemoryMgr.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 TilerMemoryMgr.Params;
// Instance config-params object
    params.heapHandle = IHeap.Handle null;
    // 
 
config TilerMemoryMgr.heapHandle  // instance
XDCscript usage meta-domain
var params = new TilerMemoryMgr.Params;
  ...
params.heapHandle = IHeap.Handle null;
 
C SYNOPSIS
generated on Mon, 20 Jun 2011 05:31:11 GMT