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
37 * @file adf_os_atomic.h
38 * This file abstracts an atomic counter.
41 #ifndef _ADF_OS_ATOMIC_H
42 #define _ADF_OS_ATOMIC_H
44 #include <adf_os_atomic_pvt.h>
46 * @brief Atomic type of variable.
47 * Use this when you want a simple resource counter etc. which is atomic
48 * across multiple CPU's. These maybe slower than usual counters on some
49 * platforms/OS'es, so use them with caution.
51 typedef __adf_os_atomic_t adf_os_atomic_t;
54 * @brief Initialize an atomic type variable
55 * @param[in] v a pointer to an opaque atomic variable
58 adf_os_atomic_init(adf_os_atomic_t *v)
60 __adf_os_atomic_init(v);
64 * @brief Read the value of an atomic variable.
65 * @param[in] v a pointer to an opaque atomic variable
67 * @return the current value of the variable
69 static inline a_uint32_t
70 adf_os_atomic_read(adf_os_atomic_t *v)
72 return (__adf_os_atomic_read(v));
76 * @brief Increment the value of an atomic variable.
77 * @param[in] v a pointer to an opaque atomic variable
80 adf_os_atomic_inc(adf_os_atomic_t *v)
82 return (__adf_os_atomic_inc(v));
86 * @brief Decrement the value of an atomic variable.
87 * @param v a pointer to an opaque atomic variable
90 adf_os_atomic_dec(adf_os_atomic_t *v)
92 return (__adf_os_atomic_dec(v));