AR Osal Heap - Qualcomm Dragonwing Documentation

Header: ar_osal/api/ar_osal_heap.h

Structures

`ar_heap_info_t`

Heap memory info structure. Members

ar_heap_align_bytes

ar_heap_pool_type

heap memory byte alignment required.

ar_heap_id

pool type to allocate heap memory.

uint32_t

head id to allocate heap memory.

Functions

`ar_heap_init`

ar_heap_init initialize heap memory interface.

int32_t ar_heap_init(void)

Returns 0 Success Nonzero Failure

`ar_heap_deinit`

ar_heap_deinit.

int32_t ar_heap_deinit(void)

Returns 0 Success Nonzero Failure

`ar_heap_malloc`

Allocates heap memory.

void * ar_heap_malloc(size_t bytes, par_heap_info heap_info)

Parameters

size_t

number of bytes to allocate heap memory.

par_heap_info

pointer of type: ar_heap_info.

Returns Nonzero Success: pointer to the allocated heap memory NULL Failure

`ar_heap_calloc`

Allocates heap memory and initialize with 0.

void * ar_heap_calloc(size_t bytes, par_heap_info heap_info)

Parameters

size_t

number of bytes to allocate heap memory.

par_heap_info

pointer of type: ar_heap_info.

Returns Nonzero Success: pointer to the allocated heap memory NULL Failure

`ar_heap_free`

Frees heap memory.

void ar_heap_free(void *heap_ptr, par_heap_info heap_info)

Parameters

void *

pointer to heap memory obtained from ar_heap_alloc().

Returns 0 Success Nonzero Failure

Type Definitions

`ar_heap_align_bytes`

enum for heap memory byte alignments

typedef enum _ar_heap_align_bytes ar_heap_align_bytes

`ar_heap_id`

enum for heap memory ids

typedef enum _ar_heap_id ar_heap_id

`ar_heap_pool_type`

enum for heap memory types

typedef enum _ar_heap_pool_type ar_heap_pool_type

`ar_heap_info`

Heap memory info structure.

typedef struct ar_heap_info_t ar_heap_info

`par_heap_info`

typedef struct ar_heap_info_t * par_heap_info

Enumerations

`_ar_heap_align_bytes`

enum for heap memory byte alignments

Values

Name	Value	Description
`AR_HEAP_ALIGN_DEFAULT`	= 0
`AR_HEAP_ALIGN_4_BYTES`	= 1	default alignment
`AR_HEAP_ALIGN_8_BYTES`	= 2	4-byte boundary
`AR_HEAP_ALIGN_16_BYTES`	= 3	8-byte boundary

`_ar_heap_id`

enum for heap memory ids

Values

Name	Value	Description
`AR_HEAP_ID_DEFAULT`	= 0
`AR_HEAP_ID_1`	= 1	default heap id
`AR_HEAP_ID_2`	= 2	custom heap id 1
`AR_HEAP_ID_3`	= 3	custom heap id 2
`AR_HEAP_ID_4`	= 4	custom heap id 3
`AR_HEAP_ID_5`	= 5	custom heap id 4
`AR_HEAP_ID_6`	= 6	custom heap id 5
`AR_HEAP_ID_7`	= 7	custom heap id 6
`AR_HEAP_ID_8`	= 8	custom heap id 7
`AR_HEAP_ID_9`	= 9	custom heap id 8
`AR_HEAP_ID_10`	= 10	custom heap id 9
`AR_HEAP_ID_11`	= 11	custom heap id 10

`_ar_heap_pool_type`

enum for heap memory types

Values

Name	Value	Description
`AR_HEAP_POOL_DEFAULT`	= 0	default pool type, as supported by each platform.
`AR_HEAP_POOL_NON_PAGED_EXECUTE`	= 1	allocated memory is nonpaged and executable that is, instruction execution is enabled in this memory.
`AR_HEAP_POOL_NON_PAGED_NX`	= 2	allocated memory is nonpaged and instruction execution is disabled.
`AR_HEAP_POOL_PAGED`	= 4	allocated memory is pageable.

Macros

`AR_HEAP_TAG_DEFAULT`

default heap memory tag ASCII characters: ‘LASO’->‘OSAL’

#define AR_HEAP_TAG_DEFAULT (0x4c41534f)

API Reference

Structures

ar_heap_info_t

Functions

ar_heap_init

ar_heap_deinit

ar_heap_malloc

ar_heap_calloc

ar_heap_free

Type Definitions

ar_heap_align_bytes

ar_heap_id

ar_heap_pool_type

ar_heap_info

par_heap_info

Enumerations

_ar_heap_align_bytes

Values

_ar_heap_id

Values

_ar_heap_pool_type

Values

Macros

AR_HEAP_TAG_DEFAULT

`ar_heap_info_t`

`ar_heap_init`

`ar_heap_deinit`

`ar_heap_malloc`

`ar_heap_calloc`

`ar_heap_free`

`ar_heap_align_bytes`

`ar_heap_id`

`ar_heap_pool_type`

`ar_heap_info`

`par_heap_info`

`_ar_heap_align_bytes`

`_ar_heap_id`

`_ar_heap_pool_type`

`AR_HEAP_TAG_DEFAULT`