1 /* 2 * Copyright (c) 2014-2021 The Linux Foundation. All rights reserved. 3 * 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 19 /** 20 * DOC: i_qdf_util.h 21 * This file provides OS dependent API's. 22 */ 23 24 #ifndef _I_QDF_UTIL_H 25 #define _I_QDF_UTIL_H 26 27 #include <linux/compiler.h> 28 #include <linux/kernel.h> 29 #include <linux/types.h> 30 #include <linux/mm.h> 31 #include <linux/errno.h> 32 #include <linux/average.h> 33 34 #include <linux/random.h> 35 #include <linux/io.h> 36 37 #include <qdf_types.h> 38 #include <asm/byteorder.h> 39 40 #if LINUX_VERSION_CODE <= KERNEL_VERSION(3, 3, 8) 41 #include <asm/system.h> 42 #else 43 #if defined(__LINUX_MIPS32_ARCH__) || defined(__LINUX_MIPS64_ARCH__) 44 #include <asm/dec/system.h> 45 #else 46 #endif 47 #endif 48 49 #include <qdf_types.h> 50 #include <linux/io.h> 51 #include <asm/byteorder.h> 52 53 #ifdef QCA_PARTNER_PLATFORM 54 #include "ath_carr_pltfrm.h" 55 #else 56 #include <linux/byteorder/generic.h> 57 #endif 58 59 typedef wait_queue_head_t __qdf_wait_queue_head_t; 60 61 /* Generic compiler-dependent macros if defined by the OS */ 62 #define __qdf_wait_queue_interruptible(wait_queue, condition) \ 63 wait_event_interruptible(wait_queue, condition) 64 65 #define __qdf_wait_queue_timeout(wait_queue, condition, timeout) \ 66 wait_event_timeout(wait_queue, condition, timeout) 67 68 69 #define __qdf_init_waitqueue_head(_q) init_waitqueue_head(_q) 70 71 #define __qdf_wake_up_interruptible(_q) wake_up_interruptible(_q) 72 73 #define __qdf_wake_up(_q) wake_up(_q) 74 75 #define __qdf_wake_up_completion(_q) wake_up_completion(_q) 76 77 #define __qdf_unlikely(_expr) unlikely(_expr) 78 #define __qdf_likely(_expr) likely(_expr) 79 80 #define __qdf_bitmap(name, bits) DECLARE_BITMAP(name, bits) 81 82 /** 83 * __qdf_set_bit() - set bit in address 84 * @nr: bit number to be set 85 * @addr: address buffer pointer 86 * 87 * Return: none 88 */ 89 static inline void __qdf_set_bit(unsigned int nr, unsigned long *addr) 90 { 91 __set_bit(nr, addr); 92 } 93 94 static inline void __qdf_clear_bit(unsigned int nr, unsigned long *addr) 95 { 96 __clear_bit(nr, addr); 97 } 98 99 static inline bool __qdf_test_bit(unsigned int nr, unsigned long *addr) 100 { 101 return test_bit(nr, addr); 102 } 103 104 static inline bool __qdf_test_and_clear_bit(unsigned int nr, 105 unsigned long *addr) 106 { 107 return __test_and_clear_bit(nr, addr); 108 } 109 110 static inline unsigned long __qdf_find_first_bit(unsigned long *addr, 111 unsigned long nbits) 112 { 113 return find_first_bit(addr, nbits); 114 } 115 116 static inline bool __qdf_bitmap_empty(unsigned long *addr, 117 unsigned long nbits) 118 { 119 return bitmap_empty(addr, nbits); 120 } 121 122 static inline int __qdf_bitmap_and(unsigned long *dst, unsigned long *src1, 123 unsigned long *src2, unsigned long nbits) 124 { 125 return bitmap_and(dst, src1, src2, nbits); 126 } 127 128 /** 129 * __qdf_set_macaddr_broadcast() - set a QDF MacAddress to the 'broadcast' 130 * @mac_addr: pointer to the qdf MacAddress to set to broadcast 131 * 132 * This function sets a QDF MacAddress to the 'broadcast' MacAddress. Broadcast 133 * MacAddress contains all 0xFF bytes. 134 * 135 * Return: none 136 */ 137 static inline void __qdf_set_macaddr_broadcast(struct qdf_mac_addr *mac_addr) 138 { 139 memset(mac_addr, 0xff, QDF_MAC_ADDR_SIZE); 140 } 141 142 /** 143 * __qdf_zero_macaddr() - zero out a MacAddress 144 * @mac_addr: pointer to the struct qdf_mac_addr to zero. 145 * 146 * This function zeros out a QDF MacAddress type. 147 * 148 * Return: none 149 */ 150 static inline void __qdf_zero_macaddr(struct qdf_mac_addr *mac_addr) 151 { 152 memset(mac_addr, 0, QDF_MAC_ADDR_SIZE); 153 } 154 155 /** 156 * __qdf_is_macaddr_equal() - compare two QDF MacAddress 157 * @mac_addr1: Pointer to one qdf MacAddress to compare 158 * @mac_addr2: Pointer to the other qdf MacAddress to compare 159 * 160 * This function returns a bool that tells if a two QDF MacAddress' 161 * are equivalent. 162 * 163 * Return: true if the MacAddress's are equal 164 * not true if the MacAddress's are not equal 165 */ 166 static inline bool __qdf_is_macaddr_equal(struct qdf_mac_addr *mac_addr1, 167 struct qdf_mac_addr *mac_addr2) 168 { 169 return 0 == memcmp(mac_addr1, mac_addr2, QDF_MAC_ADDR_SIZE); 170 } 171 172 #define __qdf_in_interrupt in_interrupt 173 174 #define __qdf_min(_a, _b) min(_a, _b) 175 #define __qdf_max(_a, _b) max(_a, _b) 176 177 /** 178 * Setting it to blank as feature is not intended to be supported 179 * on linux version less than 4.3 180 */ 181 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 3, 0) 182 #define __QDF_DECLARE_EWMA(name, _factor, _weight) 183 184 #define __qdf_ewma_tx_lag int 185 #define __qdf_ewma_rx_rssi int 186 #else 187 #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0) 188 #define __QDF_DECLARE_EWMA(name, _factor, _weight) \ 189 DECLARE_EWMA(name, ilog2(_factor), _weight) 190 #else 191 #define __QDF_DECLARE_EWMA(name, _factor, _weight) \ 192 DECLARE_EWMA(name, _factor, _weight) 193 #endif 194 195 #define __qdf_ewma_tx_lag struct ewma_tx_lag 196 #define __qdf_ewma_rx_rssi struct ewma_rx_rssi 197 #endif 198 199 #define __qdf_ffz(mask) (~(mask) == 0 ? -1 : ffz(mask)) 200 201 #define MEMINFO_KB(x) ((x) << (PAGE_SHIFT - 10)) /* In kilobytes */ 202 203 /** 204 * @brief Assert 205 */ 206 #define __qdf_assert(expr) do { \ 207 if (unlikely(!(expr))) { \ 208 pr_err("Assertion failed! %s:%s %s:%d\n", \ 209 # expr, __func__, __FILE__, __LINE__); \ 210 dump_stack(); \ 211 QDF_BUG_ON_ASSERT(0); \ 212 } \ 213 } while (0) 214 215 /** 216 * @brief Assert 217 */ 218 #define __qdf_target_assert(expr) do { \ 219 if (unlikely(!(expr))) { \ 220 qdf_err("Assertion failed! %s:%s %s:%d", \ 221 #expr, __FUNCTION__, __FILE__, __LINE__); \ 222 dump_stack(); \ 223 QDF_DEBUG_PANIC("Take care of the TARGET ASSERT first\n"); \ 224 } \ 225 } while (0) 226 227 /** 228 * @brief Compile time Assert 229 */ 230 #define QDF_COMPILE_TIME_ASSERT(assertion_name, predicate) \ 231 typedef char assertion_name[(predicate) ? 1 : -1] 232 233 #define __qdf_container_of(ptr, type, member) container_of(ptr, type, member) 234 235 #define __qdf_ntohs ntohs 236 #define __qdf_ntohl ntohl 237 238 #define __qdf_htons htons 239 #define __qdf_htonl htonl 240 241 #define __qdf_cpu_to_le16 cpu_to_le16 242 #define __qdf_cpu_to_le32 cpu_to_le32 243 #define __qdf_cpu_to_le64 cpu_to_le64 244 245 #define __qdf_le16_to_cpu le16_to_cpu 246 #define __qdf_le32_to_cpu le32_to_cpu 247 #define __qdf_le64_to_cpu le64_to_cpu 248 249 #define __qdf_cpu_to_be16 cpu_to_be16 250 #define __qdf_cpu_to_be32 cpu_to_be32 251 #define __qdf_cpu_to_be64 cpu_to_be64 252 253 #define __qdf_be16_to_cpu be16_to_cpu 254 #define __qdf_be32_to_cpu be32_to_cpu 255 #define __qdf_be64_to_cpu be64_to_cpu 256 257 /** 258 * @brief memory barriers. 259 */ 260 #define __qdf_wmb() wmb() 261 #define __qdf_rmb() rmb() 262 #define __qdf_mb() mb() 263 #define __qdf_ioread32(offset) ioread32(offset) 264 #define __qdf_iowrite32(offset, value) iowrite32(value, offset) 265 266 #define __qdf_roundup(x, y) roundup(x, y) 267 #define __qdf_ceil(x, y) DIV_ROUND_UP(x, y) 268 269 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 3, 0) 270 #define __qdf_ewma_tx_lag_init(tx_lag) 271 #define __qdf_ewma_tx_lag_add(tx_lag, value) 272 #define __qdf_ewma_tx_lag_read(tx_lag) 273 274 #define __qdf_ewma_rx_rssi_init(rx_rssi) 275 #define __qdf_ewma_rx_rssi_add(rx_rssi, value) 276 #define __qdf_ewma_rx_rssi_read(rx_rssi) 277 #else 278 #define __qdf_ewma_tx_lag_init(tx_lag) \ 279 ewma_tx_lag_init(tx_lag) 280 281 #define __qdf_ewma_tx_lag_add(tx_lag, value) \ 282 ewma_tx_lag_add(tx_lag, value) 283 284 #define __qdf_ewma_tx_lag_read(tx_lag) \ 285 ewma_tx_lag_read(tx_lag) 286 287 #define __qdf_ewma_rx_rssi_init(rx_rssi) \ 288 ewma_rx_rssi_init(rx_rssi) 289 290 #define __qdf_ewma_rx_rssi_add(rx_rssi, value) \ 291 ewma_rx_rssi_add(rx_rssi, value) 292 293 #define __qdf_ewma_rx_rssi_read(rx_rssi) \ 294 ewma_rx_rssi_read(rx_rssi) 295 #endif 296 297 #define __qdf_prefetch(x) prefetch(x) 298 299 #ifdef QCA_CONFIG_SMP 300 /** 301 * __qdf_get_cpu() - get cpu_index 302 * 303 * Return: cpu_index 304 */ 305 static inline 306 int __qdf_get_cpu(void) 307 { 308 int cpu_index = get_cpu(); 309 310 put_cpu(); 311 return cpu_index; 312 } 313 #else 314 static inline 315 int __qdf_get_cpu(void) 316 { 317 return 0; 318 } 319 #endif 320 321 static inline int __qdf_device_init_wakeup(__qdf_device_t qdf_dev, bool enable) 322 { 323 return device_init_wakeup(qdf_dev->dev, enable); 324 } 325 326 /** 327 * __qdf_get_totalramsize() - Get total ram size in Kb 328 * 329 * Return: Total ram size in Kb 330 */ 331 static inline uint64_t 332 __qdf_get_totalramsize(void) 333 { 334 struct sysinfo meminfo; 335 336 si_meminfo(&meminfo); 337 return MEMINFO_KB(meminfo.totalram); 338 } 339 340 /** 341 * __qdf_get_lower_32_bits() - get lower 32 bits from an address. 342 * @addr: address 343 * 344 * This api returns the lower 32 bits of an address. 345 * 346 * Return: lower 32 bits. 347 */ 348 static inline 349 uint32_t __qdf_get_lower_32_bits(__qdf_dma_addr_t addr) 350 { 351 return lower_32_bits(addr); 352 } 353 354 /** 355 * __qdf_get_upper_32_bits() - get upper 32 bits from an address. 356 * @addr: address 357 * 358 * This api returns the upper 32 bits of an address. 359 * 360 * Return: upper 32 bits. 361 */ 362 static inline 363 uint32_t __qdf_get_upper_32_bits(__qdf_dma_addr_t addr) 364 { 365 return upper_32_bits(addr); 366 } 367 368 /** 369 * __qdf_rounddown_pow_of_two() - Round down to nearest power of two 370 * @n: number to be tested 371 * 372 * Test if the input number is power of two, and return the nearest power of two 373 * 374 * Return: number rounded down to the nearest power of two 375 */ 376 static inline 377 unsigned long __qdf_rounddown_pow_of_two(unsigned long n) 378 { 379 if (is_power_of_2(n)) 380 return n; /* already a power of 2 */ 381 382 return __rounddown_pow_of_two(n); 383 } 384 385 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 13, 0) 386 387 /** 388 * __qdf_set_dma_coherent_mask() - set max number of bits allowed in dma addr 389 * @dev: device pointer 390 * @addr_bits: max number of bits allowed in dma address 391 * 392 * This API sets the maximum allowed number of bits in the dma address. 393 * 394 * Return: 0 - success, non zero - failure 395 */ 396 static inline 397 int __qdf_set_dma_coherent_mask(struct device *dev, uint8_t addr_bits) 398 { 399 return dma_set_mask_and_coherent(dev, DMA_BIT_MASK(addr_bits)); 400 } 401 402 #else 403 404 /** 405 * __qdf_set_dma_coherent_mask() - set max number of bits allowed in dma addr 406 * @dev: device pointer 407 * @addr_bits: max number of bits allowed in dma address 408 * 409 * This API sets the maximum allowed number of bits in the dma address. 410 * 411 * Return: 0 - success, non zero - failure 412 */ 413 static inline 414 int __qdf_set_dma_coherent_mask(struct device *dev, uint8_t addr_bits) 415 { 416 return dma_set_coherent_mask(dev, DMA_BIT_MASK(addr_bits)); 417 } 418 #endif 419 /** 420 * qdf_get_random_bytes() - returns nbytes bytes of random 421 * data 422 * 423 * Return: random bytes of data 424 */ 425 static inline 426 void __qdf_get_random_bytes(void *buf, int nbytes) 427 { 428 return get_random_bytes(buf, nbytes); 429 } 430 431 /** 432 * __qdf_do_div() - wrapper function for kernel macro(do_div). 433 * @dividend: Dividend value 434 * @divisor : Divisor value 435 * 436 * Return: Quotient 437 */ 438 static inline 439 uint64_t __qdf_do_div(uint64_t dividend, uint32_t divisor) 440 { 441 do_div(dividend, divisor); 442 /*do_div macro updates dividend with Quotient of dividend/divisor */ 443 return dividend; 444 } 445 446 /** 447 * __qdf_do_div_rem() - wrapper function for kernel macro(do_div) 448 * to get remainder. 449 * @dividend: Dividend value 450 * @divisor : Divisor value 451 * 452 * Return: remainder 453 */ 454 static inline 455 uint64_t __qdf_do_div_rem(uint64_t dividend, uint32_t divisor) 456 { 457 return do_div(dividend, divisor); 458 } 459 460 /** 461 * __qdf_hex_to_bin() - Wrapper function to kernel API to get unsigned 462 * integer from hexa decimal ASCII character. 463 * @ch: hexa decimal ASCII character 464 * 465 * Return: For hexa decimal ASCII char return actual decimal value 466 * else -1 for bad input. 467 */ 468 static inline 469 int __qdf_hex_to_bin(char ch) 470 { 471 return hex_to_bin(ch); 472 } 473 474 /** 475 * __qdf_hex_str_to_binary() - Wrapper function to get array of unsigned 476 * integers from string of hexa decimal ASCII characters. 477 * @dst: output array to hold converted values 478 * @src: input string of hexa decimal ASCII characters 479 * @count: size of dst string 480 * 481 * Return: For a string of hexa decimal ASCII characters return 0 482 * else -1 for bad input. 483 */ 484 static inline 485 int __qdf_hex_str_to_binary(u8 *dst, const char *src, size_t count) 486 { 487 return hex2bin(dst, src, count); 488 } 489 490 /** 491 * __qdf_fls() - find last set bit in a given 32 bit input 492 * @x: 32 bit mask 493 * 494 * Return: zero if the input is zero, otherwise returns the bit 495 * position of the last set bit, where the LSB is 1 and MSB is 32. 496 */ 497 static inline 498 int __qdf_fls(uint32_t x) 499 { 500 return fls(x); 501 } 502 503 #endif /*_I_QDF_UTIL_H*/ 504