1/*
2Copyright (c) 2012, Broadcom Europe Ltd
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright
8 notice, this list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright
10 notice, this list of conditions and the following disclaimer in the
11 documentation and/or other materials provided with the distribution.
12 * Neither the name of the copyright holder nor the
13 names of its contributors may be used to endorse or promote products
14 derived from this software without specific prior written permission.
15
16THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*/
27
28/*=============================================================================
29VideoCore OS Abstraction Layer - memory support
30=============================================================================*/
31
32#ifndef VCOS_MEM_H
33#define VCOS_MEM_H
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39#include "interface/vcos/vcos_types.h"
40#include "vcos.h"
41
42/** \file
43 *
44 * Memory allocation api (malloc/free equivalents) is for benefit of host
45 * applications. VideoCore code should use rtos_XXX functions.
46 *
47 */
48
49
50/** Allocate memory
51 *
52 * @param size Size of memory to allocate
53 * @param description Description, to aid in debugging. May be ignored internally on some platforms.
54 */
55VCOS_INLINE_DECL
56void *vcos_malloc(VCOS_UNSIGNED size, const char *description);
57
58void *vcos_kmalloc(VCOS_UNSIGNED size, const char *description);
59void *vcos_kcalloc(VCOS_UNSIGNED num, VCOS_UNSIGNED size, const char *description);
60
61/** Allocate cleared memory
62 *
63 * @param num Number of items to allocate.
64 * @param size Size of each item in bytes.
65 * @param description Description, to aid in debugging. May be ignored internally on some platforms.
66 */
67VCOS_INLINE_DECL
68void *vcos_calloc(VCOS_UNSIGNED num, VCOS_UNSIGNED size, const char *description);
69
70/** Free memory
71 *
72 * Free memory that has been allocated.
73 */
74VCOS_INLINE_DECL
75void vcos_free(void *ptr);
76
77void vcos_kfree(void *ptr);
78
79/** Allocate aligned memory
80 *
81 * Allocate memory aligned on the specified boundary.
82 *
83 * @param size Size of memory to allocate
84 * @param description Description, to aid in debugging. May be ignored internally on some platforms.
85 */
86VCOS_INLINE_DECL
87void *vcos_malloc_aligned(VCOS_UNSIGNED size, VCOS_UNSIGNED align, const char *description);
88
89/** Return the amount of free heap memory
90 *
91 */
92VCOS_INLINE_DECL
93unsigned long vcos_get_free_mem(void);
94
95#ifdef __cplusplus
96}
97#endif
98
99#endif
100
101
102