Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 1 | /* |
Vinay Adella | 873dc40 | 2018-05-28 12:06:34 +0530 | [diff] [blame] | 2 | * Copyright (c) 2014-2018 The Linux Foundation. All rights reserved. |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 3 | * |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 4 | * Permission to use, copy, modify, and/or distribute this software for |
| 5 | * any purpose with or without fee is hereby granted, provided that the |
| 6 | * above copyright notice and this permission notice appear in all |
| 7 | * copies. |
| 8 | * |
| 9 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
| 10 | * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
| 11 | * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
| 12 | * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
| 13 | * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
| 14 | * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
| 15 | * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
| 16 | * PERFORMANCE OF THIS SOFTWARE. |
| 17 | */ |
| 18 | |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 19 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 20 | * DOC: qdf_atomic.h |
| 21 | * This file provides OS abstraction for atomic APIs. |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 22 | */ |
| 23 | |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 24 | #ifndef _QDF_ATOMIC_H |
| 25 | #define _QDF_ATOMIC_H |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 26 | |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 27 | #include <i_qdf_atomic.h> |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 28 | |
| 29 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 30 | * qdf_atomic_t - atomic type of variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 31 | * |
| 32 | * Use this when you want a simple resource counter etc. which is atomic |
| 33 | * across multiple CPU's. These maybe slower than usual counters on some |
| 34 | * platforms/OS'es, so use them with caution. |
| 35 | */ |
| 36 | |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 37 | typedef __qdf_atomic_t qdf_atomic_t; |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 38 | |
| 39 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 40 | * qdf_atomic_init() - initialize an atomic type variable |
| 41 | * @v: A pointer to an opaque atomic variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 42 | * |
| 43 | * Return: None |
| 44 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 45 | static inline QDF_STATUS qdf_atomic_init(qdf_atomic_t *v) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 46 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 47 | return __qdf_atomic_init(v); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 48 | } |
| 49 | |
| 50 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 51 | * qdf_atomic_read() - read the value of an atomic variable |
| 52 | * @v: A pointer to an opaque atomic variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 53 | * |
| 54 | * Return: The current value of the variable |
| 55 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 56 | static inline int32_t qdf_atomic_read(qdf_atomic_t *v) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 57 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 58 | return __qdf_atomic_read(v); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 62 | * qdf_atomic_inc() - increment the value of an atomic variable |
| 63 | * @v: A pointer to an opaque atomic variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 64 | * |
| 65 | * Return: None |
| 66 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 67 | static inline void qdf_atomic_inc(qdf_atomic_t *v) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 68 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 69 | __qdf_atomic_inc(v); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 73 | * qdf_atomic_dec() - decrement the value of an atomic variable |
| 74 | * @v: A pointer to an opaque atomic variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 75 | * |
| 76 | * Return: None |
| 77 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 78 | static inline void qdf_atomic_dec(qdf_atomic_t *v) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 79 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 80 | __qdf_atomic_dec(v); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 84 | * qdf_atomic_add() - add a value to the value of an atomic variable |
| 85 | * @i: The amount by which to increase the atomic counter |
| 86 | * @v: A pointer to an opaque atomic variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 87 | * |
| 88 | * Return: None |
| 89 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 90 | static inline void qdf_atomic_add(int i, qdf_atomic_t *v) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 91 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 92 | __qdf_atomic_add(i, v); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 96 | * qdf_atomic_sub() - Subtract a value from an atomic variable |
Houston Hoffman | e8f53a6 | 2015-12-06 20:29:12 -0800 | [diff] [blame] | 97 | * @i: the amount by which to decrease the atomic counter |
| 98 | * @v: a pointer to an opaque atomic variable |
| 99 | * |
| 100 | * Return: none |
| 101 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 102 | static inline void qdf_atomic_sub(int i, qdf_atomic_t *v) |
Houston Hoffman | e8f53a6 | 2015-12-06 20:29:12 -0800 | [diff] [blame] | 103 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 104 | __qdf_atomic_sub(i, v); |
Houston Hoffman | e8f53a6 | 2015-12-06 20:29:12 -0800 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 108 | * qdf_atomic_dec_and_test() - decrement an atomic variable and check if the |
| 109 | * new value is zero |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 110 | * @v: A pointer to an opaque atomic variable |
| 111 | * |
| 112 | * Return: |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 113 | * true (non-zero) if the new value is zero, |
| 114 | * false (0) if the new value is non-zero |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 115 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 116 | static inline int32_t qdf_atomic_dec_and_test(qdf_atomic_t *v) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 117 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 118 | return __qdf_atomic_dec_and_test(v); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 122 | * qdf_atomic_set() - set a value to the value of an atomic variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 123 | * @v: A pointer to an opaque atomic variable |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 124 | * @i: required value to set |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 125 | * |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 126 | * Atomically sets the value of v to i |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 127 | * Return: None |
| 128 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 129 | static inline void qdf_atomic_set(qdf_atomic_t *v, int i) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 130 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 131 | __qdf_atomic_set(v, i); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 132 | } |
| 133 | |
| 134 | /** |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 135 | * qdf_atomic_inc_return() - return the incremented value of an atomic variable |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 136 | * @v: A pointer to an opaque atomic variable |
| 137 | * |
| 138 | * Return: The current value of the variable |
| 139 | */ |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 140 | static inline int32_t qdf_atomic_inc_return(qdf_atomic_t *v) |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 141 | { |
Chouhan, Anurag | 5776318 | 2016-03-03 18:57:27 +0530 | [diff] [blame] | 142 | return __qdf_atomic_inc_return(v); |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 143 | } |
| 144 | |
Hanumanth Reddy Pothula | fd65c6e | 2017-04-13 16:39:57 +0530 | [diff] [blame] | 145 | /** |
Vinay Adella | 873dc40 | 2018-05-28 12:06:34 +0530 | [diff] [blame] | 146 | * qdf_atomic_dec_return() - return the decremented value of an atomic |
| 147 | * variable |
| 148 | * @v: A pointer to an opaque atomic variable |
| 149 | * |
| 150 | * Return: The current value of the variable |
| 151 | */ |
| 152 | static inline int32_t qdf_atomic_dec_return(qdf_atomic_t *v) |
| 153 | { |
| 154 | return __qdf_atomic_dec_return(v); |
| 155 | } |
| 156 | |
| 157 | /** |
Hanumanth Reddy Pothula | fd65c6e | 2017-04-13 16:39:57 +0530 | [diff] [blame] | 158 | * qdf_atomic_set_bit - Atomically set a bit in memory |
| 159 | * @nr: bit to set |
| 160 | * @addr: the address to start counting from |
| 161 | * |
| 162 | * Return: none |
| 163 | */ |
| 164 | static inline void qdf_atomic_set_bit(int nr, volatile unsigned long *addr) |
| 165 | { |
| 166 | __qdf_atomic_set_bit(nr, addr); |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * qdf_atomic_clear_bit - Atomically clear a bit in memory |
| 171 | * @nr: bit to clear |
| 172 | * @addr: the address to start counting from |
| 173 | * |
| 174 | * Return: none |
| 175 | */ |
| 176 | static inline void qdf_atomic_clear_bit(int nr, volatile unsigned long *addr) |
| 177 | { |
| 178 | __qdf_atomic_clear_bit(nr, addr); |
| 179 | } |
| 180 | |
| 181 | /** |
| 182 | * qdf_atomic_change_bit - Atomically toggle a bit in memory |
| 183 | * from addr |
| 184 | * @nr: bit to change |
| 185 | * @addr: the address to start counting from |
| 186 | * |
| 187 | * Return: none |
| 188 | */ |
| 189 | static inline void qdf_atomic_change_bit(int nr, volatile unsigned long *addr) |
| 190 | { |
| 191 | __qdf_atomic_change_bit(nr, addr); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * qdf_atomic_test_and_set_bit - Atomically set a bit and return its old value |
| 196 | * @nr: Bit to set |
| 197 | * @addr: the address to start counting from |
| 198 | * |
| 199 | * Return: return nr bit old value |
| 200 | */ |
| 201 | static inline int qdf_atomic_test_and_set_bit(int nr, |
| 202 | volatile unsigned long *addr) |
| 203 | { |
| 204 | return __qdf_atomic_test_and_set_bit(nr, addr); |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * qdf_atomic_test_and_clear_bit - Atomically clear a bit and return its old |
| 209 | * value |
| 210 | * @nr: bit to clear |
| 211 | * @addr: the address to start counting from |
| 212 | * |
| 213 | * Return: return nr bit old value |
| 214 | */ |
| 215 | static inline int qdf_atomic_test_and_clear_bit(int nr, |
| 216 | volatile unsigned long *addr) |
| 217 | { |
| 218 | return __qdf_atomic_test_and_clear_bit(nr, addr); |
| 219 | } |
| 220 | |
| 221 | /** |
| 222 | * qdf_atomic_test_and_change_bit - Atomically toggle a bit and return its old |
| 223 | * value |
| 224 | * @nr: bit to change |
| 225 | * @addr: the address to start counting from |
| 226 | * |
| 227 | * Return: return nr bit old value |
| 228 | */ |
| 229 | static inline int qdf_atomic_test_and_change_bit(int nr, |
| 230 | volatile unsigned long *addr) |
| 231 | { |
| 232 | return __qdf_atomic_test_and_change_bit(nr, addr); |
| 233 | } |
| 234 | |
| 235 | /** |
| 236 | * qdf_atomic_test_bit - Atomically get the nr-th bit value starting from addr |
| 237 | * @nr: bit to get |
| 238 | * @addr: the address to start counting from |
| 239 | * |
| 240 | * Return: return nr bit value |
| 241 | */ |
| 242 | static inline int qdf_atomic_test_bit(int nr, volatile unsigned long *addr) |
| 243 | { |
| 244 | return __qdf_atomic_test_bit(nr, addr); |
| 245 | } |
| 246 | |
Prakash Dhavali | d5c9f1c | 2015-11-08 19:04:44 -0800 | [diff] [blame] | 247 | #endif |