module ti.syslink.ipc.rtos.syslinkMemMgr.nullMemMgr.MemMgrSupportNull
C synopsis target-domain sourced in ti/syslink/ipc/rtos/syslinkMemMgr/nullMemMgr/MemMgrSupportNull.xdc
#include <ti/syslink/ipc/rtos/syslinkMemMgr/nullMemMgr/MemMgrSupportNull.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 MemMgrSupportNull_MAX_NAME_LENGTH
C synopsis target-domain
#define MemMgrSupportNull_MAX_NAME_LENGTH (UInt8)32
 
 
const MemMgrSupportNull_MAX_TILER_BLOCKS
C synopsis target-domain
#define MemMgrSupportNull_MAX_TILER_BLOCKS (UInt8)10
 
 
enum MemMgrSupportNull_AddrType
C synopsis target-domain
typedef enum MemMgrSupportNull_AddrType {
    MemMgrSupportNull_AddrType_Virtual,
    MemMgrSupportNull_AddrType_Portable,
    MemMgrSupportNull_AddrType_EndValue
} MemMgrSupportNull_AddrType;
 
 
enum MemMgrSupportNull_Type
C synopsis target-domain
typedef enum MemMgrSupportNull_Type {
    MemMgrSupportNull_TYPE_SHAREDMEM,
    MemMgrSupportNull_TYPE_TILERMEM,
    MemMgrSupportNull_TYPE_NONE
} MemMgrSupportNull_Type;
 
 
struct MemMgrSupportNull_AllocBlock
C synopsis target-domain
typedef struct MemMgrSupportNull_AllocBlock {
    UInt16 pixelFormat;
    union {
        struct {
            UInt16 width;
            UInt16 height;
        } area;
        UInt16 len;
    } dim;
    UInt32 stride;
} MemMgrSupportNull_AllocBlock;
 
 
struct MemMgrSupportNull_allocParams
C synopsis target-domain
typedef struct MemMgrSupportNull_allocParams {
    UInt32 size;
    UInt32 align;
    UInt32 tilerBlocks;
} MemMgrSupportNull_allocParams;
 
 
struct MemMgrSupportNull_createParams
C synopsis target-domain
typedef struct MemMgrSupportNull_createParams {
    UInt32 size;
    ISyslinkMemMgr_Type type;
    UInt8 name[ISyslinkMemMgr_MAX_NAME_LENGTH];
} MemMgrSupportNull_createParams;
 
 
struct MemMgrSupportNull_freeParams
C synopsis target-domain
typedef struct MemMgrSupportNull_freeParams {
    Ptr ptr;
    UInt32 size;
} MemMgrSupportNull_freeParams;
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId MemMgrSupportNull_Module_id();
// Get this module's unique id
 
Bool MemMgrSupportNull_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle MemMgrSupportNull_Module_heap();
// The heap from which this module allocates memory
 
Bool MemMgrSupportNull_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 MemMgrSupportNull_Module_getMask();
// Returns the diagnostics mask for this module
 
Void MemMgrSupportNull_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct MemMgrSupportNull_Object MemMgrSupportNull_Object;
// Opaque internal representation of an instance object
 
typedef MemMgrSupportNull_Object *MemMgrSupportNull_Handle;
// Client reference to an instance object
 
typedef struct MemMgrSupportNull_Struct MemMgrSupportNull_Struct;
// Opaque client structure large enough to hold an instance object
 
MemMgrSupportNull_Handle MemMgrSupportNull_handle(MemMgrSupportNull_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
MemMgrSupportNull_Struct *MemMgrSupportNull_struct(MemMgrSupportNull_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct MemMgrSupportNull_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    IHeap_Handle heapHandle;
    // 
} MemMgrSupportNull_Params;
 
Void MemMgrSupportNull_Params_init(MemMgrSupportNull_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config MemMgrSupportNull_heapHandle  // instance
C synopsis target-domain
      ...
    IHeap_Handle heapHandle;
 
 
MemMgrSupportNull_alloc()  // instance
C synopsis target-domain
Ptr MemMgrSupportNull_alloc(MemMgrSupportNull_Handle handle, Ptr allocParams);
 
ARGUMENTS
handle — handle of a previously-created MemMgrSupportNull instance object
 
MemMgrSupportNull_free()  // instance
C synopsis target-domain
Int32 MemMgrSupportNull_free(MemMgrSupportNull_Handle handle, Ptr freeParams);
 
ARGUMENTS
handle — handle of a previously-created MemMgrSupportNull instance object
 
MemMgrSupportNull_translate()  // instance
C synopsis target-domain
Ptr MemMgrSupportNull_translate(MemMgrSupportNull_Handle handle, Ptr srcAddr, ISyslinkMemMgr_AddrType srcAddrType, ISyslinkMemMgr_AddrType desAddrType);
 
ARGUMENTS
handle — handle of a previously-created MemMgrSupportNull instance object
Instance Convertors

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

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

Common module configuration parameters

XDCscript usage meta-domain
MemMgrSupportNull.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 MemMgrSupportNull.Params;
// Instance config-params object
    params.heapHandle = IHeap.Handle null;
    // 
 
config MemMgrSupportNull.heapHandle  // instance
XDCscript usage meta-domain
var params = new MemMgrSupportNull.Params;
  ...
params.heapHandle = IHeap.Handle null;
 
C SYNOPSIS
generated on Tue, 26 Jul 2011 23:22:43 GMT