wiced_memory.h File Reference

Data Structures
struct	wiced_bt_pool_statistics_s
	AIROC Bluetooth buffer pool statistics. More...
struct	wiced_bt_heap_statistics_s
	AIROC Bluetooth heap statistics. More...
struct	wiced_bt_buffer_q_t
	This queue is a general purpose buffer queue, for application use. More...

Macros
#define	wiced_bt_buffer_pool_t   wiced_bt_pool_t
#define	WICED_DEFAULT_HEAP   ((wiced_bt_heap_t *)NULL)
	If an application wants to get a buffer from the default heap, he can use this. More...
#define	wiced_bt_get_buffer(size)   wiced_bt_get_buffer_from_heap(WICED_DEFAULT_HEAP, (size))
	Allocates a buffer from the DEFAULT heap . More...
#define	wiced_memory_allocate(size)   wiced_bt_get_buffer(size)
	Function wiced_memory_allocate. More...
#define	wiced_memory_free(memoryBlock)   wiced_bt_free_buffer(memoryBlock)
	Function wiced_memory_free. More...

Typedefs
typedef void	wiced_bt_buffer_t
	AIROC Bluetooth Buffer.
typedef struct t_wiced_bt_pool	wiced_bt_pool_t
	AIROC Bluetooth Pool.
typedef struct t_wiced_bt_heap	wiced_bt_heap_t
	AIROC Bluetooth Heap.
typedef struct wiced_bt_pool_statistics_s	wiced_bt_pool_statistics_t
	AIROC Bluetooth buffer pool statistics.
typedef struct wiced_bt_heap_statistics_s	wiced_bt_heap_statistics_t
	AIROC Bluetooth heap statistics.

Functions
uint32_t	wiced_memory_get_free_bytes (void)
	Returns the number of free bytes of RAM left. More...
wiced_bt_heap_t *	wiced_bt_create_heap (const char *name, void *p_area, int size, wiced_bt_lock_t *p_lock, wiced_bool_t b_make_default)
	Initializes dynamic memory area. More...
void	wiced_bt_delete_heap (wiced_bt_heap_t *p_heap)
	Deletes the heap created with wiced_bt_create_heap. More...
wiced_bt_pool_t *	wiced_bt_create_pool (const char *name, uint32_t buffer_size, uint32_t buffer_cnt, wiced_bt_lock_t *p_lock)
	Creates a buffer pool for application usage. More...
void	wiced_bt_delete_pool (wiced_bt_pool_t *p_pool)
	Deletes a buffer pool created using wiced_bt_create_pool. More...
wiced_bt_buffer_t *	wiced_bt_get_buffer_from_pool (wiced_bt_pool_t *p_pool)
	Get buffer from requested pool. More...
wiced_bt_buffer_t *	wiced_bt_get_buffer_from_heap (wiced_bt_heap_t *p_heap, uint32_t size)
	Allocates a buffer from the requested heap. More...
uint32_t	wiced_bt_get_pool_free_count (wiced_bt_pool_t *p_pool)
	To get the number of buffers available in the pool. More...
uint32_t	wiced_bt_get_largest_heap_buffer (wiced_bt_heap_t *p_heap)
	To get the size of the largest buffer available in the heap. More...
void	wiced_bt_free_buffer (wiced_bt_buffer_t *p_buf)
	Frees a buffer back to the pool or heap it came from. More...
uint32_t	wiced_bt_get_buffer_size (wiced_bt_buffer_t *p_buf)
	Gets the buffer size. More...
void	wiced_bt_init_q (wiced_bt_buffer_q_t *p_q, wiced_bt_lock_t *p_lock)
	Called by an application to initialize a AIROC buffer queue. More...
void	wiced_bt_enqueue (wiced_bt_buffer_q_t *p_q, wiced_bt_buffer_t *p_buf)
	Enqueue a buffer at the tail of the queue. More...
void	wiced_bt_enqueue_head (wiced_bt_buffer_q_t *p_q, wiced_bt_buffer_t *p_buf)
	Enqueue a buffer at the head of the queue. More...
wiced_bt_buffer_t *	wiced_bt_dequeue (wiced_bt_buffer_q_t *p_q)
	Dequeues a buffer from the head of a queue. More...
wiced_bt_buffer_t *	wiced_bt_remove_from_queue (wiced_bt_buffer_q_t *p_q, wiced_bt_buffer_t *p_buf)
	Dequeue a buffer from the middle of the queue. More...
wiced_bt_buffer_t *	wiced_bt_getfirst (wiced_bt_buffer_q_t *p_q)
	Return a pointer to the first buffer in a queue. More...
wiced_bt_buffer_t *	wiced_bt_getlast (wiced_bt_buffer_q_t *p_q)
	Return a pointer to the last buffer in a queue. More...
wiced_bt_buffer_t *	wiced_bt_getnext (wiced_bt_buffer_t *p_buf)
	Return a pointer to the next buffer in a queue. More...
uint32_t	wiced_bt_queue_is_empty (wiced_bt_buffer_q_t *p_q)
	Check the status of a queue. More...
uint32_t	wiced_bt_queue_get_count (wiced_bt_buffer_q_t *p_q)
	Get the number of items in the queue. More...
wiced_bt_buffer_t *	wiced_memory_alloc_long_term_mem_block (int size, const char *block_name)
	Allocate long term memory, typically used for control blocks allocated through config, not expected to be freed during the lifetime of the application. More...
void	wiced_memory_free_long_term_mem_block (wiced_bt_buffer_t *p_mem)
	Free long term memory, used to free memory allocated with wiced_memory_allocate_long_term, typically called during application shutdown. More...
wiced_bool_t	wiced_bt_get_heap_statistics (void *p_heap, wiced_bt_heap_statistics_t *p_stats)
	Get/Print the heap stats. More...
void	wiced_set_exception_callback (pf_wiced_exception pf_handler)
	Set the exception callback. More...