2 * Copyright (c) 2013 Qualcomm Atheros, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted (subject to the limitations in the
7 * disclaimer below) provided that the following conditions are met:
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the
17 * * Neither the name of Qualcomm Atheros nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
22 * GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
23 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
32 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
33 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * @ingroup adf_os_public
38 * This file abstracts memory operations.
44 #include <adf_os_types.h>
45 #include <adf_os_mem_pvt.h>
48 * @brief Allocate a memory buffer. Note this call can block.
50 * @param[in] size buffer size
52 * @return Buffer pointer or NULL if there's not enough memory.
55 adf_os_mem_alloc(adf_os_size_t size)
57 return __adf_os_mem_alloc(size);
61 * @brief Free malloc'ed buffer
63 * @param[in] buf buffer pointer allocated by @ref adf_os_mem_alloc
66 adf_os_mem_free(void *buf)
68 __adf_os_mem_free(buf);
72 * @brief Move a memory buffer. Overlapping regions are not allowed.
74 * @param[in] dst destination address
75 * @param[in] src source address
76 * @param[in] size buffer size
79 adf_os_mem_copy(void *dst, const void *src, adf_os_size_t size)
81 __adf_os_mem_copy(dst, src, size);
85 * @brief Does a non-destructive copy of memory buffer
87 * @param[in] dst destination address
88 * @param[in] src source address
89 * @param[in] size buffer size
92 adf_os_mem_move(void *dst, void *src, adf_os_size_t size)
94 __adf_os_mem_move(dst,src,size);
99 * @brief Fill a memory buffer
101 * @param[in] buf buffer to be filled
102 * @param[in] b byte to fill
103 * @param[in] size buffer size
106 adf_os_mem_set(void *buf, a_uint8_t b, adf_os_size_t size)
108 __adf_os_mem_set(buf, b, size);
113 * @brief Zero a memory buffer
115 * @param[in] buf buffer to be zeroed
116 * @param[in] size buffer size
119 adf_os_mem_zero(void *buf, adf_os_size_t size)
121 __adf_os_mem_zero(buf, size);
126 * @brief Compare two memory buffers
128 * @param[in] buf1 first buffer
129 * @param[in] buf2 second buffer
130 * @param[in] size buffer size
133 * @retval 1 not equal
136 adf_os_mem_cmp(void *buf1, void *buf2, adf_os_size_t size)
138 return __adf_os_mem_cmp(buf1, buf2, size);