1 /* 2 * Copyright (c) 2014-2020 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 /** 173 * qdf_in_interrupt - returns true if in interrupt context 174 */ 175 #define qdf_in_interrupt in_interrupt 176 177 #define __qdf_min(_a, _b) min(_a, _b) 178 #define __qdf_max(_a, _b) max(_a, _b) 179 180 /** 181 * Setting it to blank as feature is not intended to be supported 182 * on linux version less than 4.3 183 */ 184 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 3, 0) || \ 185 LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0) 186 #define __QDF_DECLARE_EWMA(name, _factor, _weight) 187 188 #define __qdf_ewma_tx_lag int 189 #define __qdf_ewma_rx_rssi int 190 #else 191 #define __QDF_DECLARE_EWMA(name, _factor, _weight) \ 192 DECLARE_EWMA(name, _factor, _weight) 193 194 #define __qdf_ewma_tx_lag struct ewma_tx_lag 195 #define __qdf_ewma_rx_rssi struct ewma_rx_rssi 196 #endif 197 198 #define __qdf_ffz(mask) (~(mask) == 0 ? -1 : ffz(mask)) 199 200 #define MEMINFO_KB(x) ((x) << (PAGE_SHIFT - 10)) /* In kilobytes */ 201 202 /** 203 * @brief Assert 204 */ 205 #define __qdf_assert(expr) do { \ 206 if (unlikely(!(expr))) { \ 207 pr_err("Assertion failed! %s:%s %s:%d\n", \ 208 # expr, __func__, __FILE__, __LINE__); \ 209 dump_stack(); \ 210 QDF_BUG(0); \ 211 } \ 212 } while (0) 213 214 /** 215 * @brief Assert 216 */ 217 #define __qdf_target_assert(expr) do { \ 218 if (unlikely(!(expr))) { \ 219 qdf_err("Assertion failed! %s:%s %s:%d", \ 220 #expr, __FUNCTION__, __FILE__, __LINE__); \ 221 dump_stack(); \ 222 QDF_DEBUG_PANIC("Take care of the TARGET ASSERT first\n"); \ 223 } \ 224 } while (0) 225 226 /** 227 * @brief Compile time Assert 228 */ 229 #define QDF_COMPILE_TIME_ASSERT(assertion_name, predicate) \ 230 typedef char assertion_name[(predicate) ? 1 : -1] 231 232 #define __qdf_container_of(ptr, type, member) container_of(ptr, type, member) 233 234 #define __qdf_ntohs ntohs 235 #define __qdf_ntohl ntohl 236 237 #define __qdf_htons htons 238 #define __qdf_htonl htonl 239 240 #define __qdf_cpu_to_le16 cpu_to_le16 241 #define __qdf_cpu_to_le32 cpu_to_le32 242 #define __qdf_cpu_to_le64 cpu_to_le64 243 244 #define __qdf_le16_to_cpu le16_to_cpu 245 #define __qdf_le32_to_cpu le32_to_cpu 246 #define __qdf_le64_to_cpu le64_to_cpu 247 248 #define __qdf_cpu_to_be16 cpu_to_be16 249 #define __qdf_cpu_to_be32 cpu_to_be32 250 #define __qdf_cpu_to_be64 cpu_to_be64 251 252 #define __qdf_be16_to_cpu be16_to_cpu 253 #define __qdf_be32_to_cpu be32_to_cpu 254 #define __qdf_be64_to_cpu be64_to_cpu 255 256 /** 257 * @brief memory barriers. 258 */ 259 #define __qdf_wmb() wmb() 260 #define __qdf_rmb() rmb() 261 #define __qdf_mb() mb() 262 #define __qdf_ioread32(offset) ioread32(offset) 263 #define __qdf_iowrite32(offset, value) iowrite32(value, offset) 264 265 #define __qdf_roundup(x, y) roundup(x, y) 266 267 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 3, 0) || \ 268 LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0) 269 #define __qdf_ewma_tx_lag_init(tx_lag) 270 #define __qdf_ewma_tx_lag_add(tx_lag, value) 271 #define __qdf_ewma_tx_lag_read(tx_lag) 272 273 #define __qdf_ewma_rx_rssi_init(rx_rssi) 274 #define __qdf_ewma_rx_rssi_add(rx_rssi, value) 275 #define __qdf_ewma_rx_rssi_read(rx_rssi) 276 #else 277 #define __qdf_ewma_tx_lag_init(tx_lag) \ 278 ewma_tx_lag_init(tx_lag) 279 280 #define __qdf_ewma_tx_lag_add(tx_lag, value) \ 281 ewma_tx_lag_add(tx_lag, value) 282 283 #define __qdf_ewma_tx_lag_read(tx_lag) \ 284 ewma_tx_lag_read(tx_lag) 285 286 #define __qdf_ewma_rx_rssi_init(rx_rssi) \ 287 ewma_rx_rssi_init(rx_rssi) 288 289 #define __qdf_ewma_rx_rssi_add(rx_rssi, value) \ 290 ewma_rx_rssi_add(rx_rssi, value) 291 292 #define __qdf_ewma_rx_rssi_read(rx_rssi) \ 293 ewma_rx_rssi_read(rx_rssi) 294 #endif 295 296 #define __qdf_prefetch(x) prefetch(x) 297 298 #ifdef QCA_CONFIG_SMP 299 /** 300 * __qdf_get_cpu() - get cpu_index 301 * 302 * Return: cpu_index 303 */ 304 static inline 305 int __qdf_get_cpu(void) 306 { 307 int cpu_index = get_cpu(); 308 309 put_cpu(); 310 return cpu_index; 311 } 312 #else 313 static inline 314 int __qdf_get_cpu(void) 315 { 316 return 0; 317 } 318 #endif 319 320 static inline int __qdf_device_init_wakeup(__qdf_device_t qdf_dev, bool enable) 321 { 322 return device_init_wakeup(qdf_dev->dev, enable); 323 } 324 325 /** 326 * __qdf_get_totalramsize() - Get total ram size in Kb 327 * 328 * Return: Total ram size in Kb 329 */ 330 static inline uint64_t 331 __qdf_get_totalramsize(void) 332 { 333 struct sysinfo meminfo; 334 335 si_meminfo(&meminfo); 336 return MEMINFO_KB(meminfo.totalram); 337 } 338 339 /** 340 * __qdf_get_lower_32_bits() - get lower 32 bits from an address. 341 * @addr: address 342 * 343 * This api returns the lower 32 bits of an address. 344 * 345 * Return: lower 32 bits. 346 */ 347 static inline 348 uint32_t __qdf_get_lower_32_bits(__qdf_dma_addr_t addr) 349 { 350 return lower_32_bits(addr); 351 } 352 353 /** 354 * __qdf_get_upper_32_bits() - get upper 32 bits from an address. 355 * @addr: address 356 * 357 * This api returns the upper 32 bits of an address. 358 * 359 * Return: upper 32 bits. 360 */ 361 static inline 362 uint32_t __qdf_get_upper_32_bits(__qdf_dma_addr_t addr) 363 { 364 return upper_32_bits(addr); 365 } 366 367 /** 368 * __qdf_rounddown_pow_of_two() - Round down to nearest power of two 369 * @n: number to be tested 370 * 371 * Test if the input number is power of two, and return the nearest power of two 372 * 373 * Return: number rounded down to the nearest power of two 374 */ 375 static inline 376 unsigned long __qdf_rounddown_pow_of_two(unsigned long n) 377 { 378 if (is_power_of_2(n)) 379 return n; /* already a power of 2 */ 380 381 return __rounddown_pow_of_two(n); 382 } 383 384 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 13, 0) 385 386 /** 387 * __qdf_set_dma_coherent_mask() - set max number of bits allowed in dma addr 388 * @dev: device pointer 389 * @addr_bits: max number of bits allowed in dma address 390 * 391 * This API sets the maximum allowed number of bits in the dma address. 392 * 393 * Return: 0 - success, non zero - failure 394 */ 395 static inline 396 int __qdf_set_dma_coherent_mask(struct device *dev, uint8_t addr_bits) 397 { 398 return dma_set_mask_and_coherent(dev, DMA_BIT_MASK(addr_bits)); 399 } 400 401 #else 402 403 /** 404 * __qdf_set_dma_coherent_mask() - set max number of bits allowed in dma addr 405 * @dev: device pointer 406 * @addr_bits: max number of bits allowed in dma address 407 * 408 * This API sets the maximum allowed number of bits in the dma address. 409 * 410 * Return: 0 - success, non zero - failure 411 */ 412 static inline 413 int __qdf_set_dma_coherent_mask(struct device *dev, uint8_t addr_bits) 414 { 415 return dma_set_coherent_mask(dev, DMA_BIT_MASK(addr_bits)); 416 } 417 #endif 418 /** 419 * qdf_get_random_bytes() - returns nbytes bytes of random 420 * data 421 * 422 * Return: random bytes of data 423 */ 424 static inline 425 void __qdf_get_random_bytes(void *buf, int nbytes) 426 { 427 return get_random_bytes(buf, nbytes); 428 } 429 430 /** 431 * __qdf_do_div() - wrapper function for kernel macro(do_div). 432 * @dividend: Dividend value 433 * @divisor : Divisor value 434 * 435 * Return: Quotient 436 */ 437 static inline 438 uint64_t __qdf_do_div(uint64_t dividend, uint32_t divisor) 439 { 440 do_div(dividend, divisor); 441 /*do_div macro updates dividend with Quotient of dividend/divisor */ 442 return dividend; 443 } 444 445 /** 446 * __qdf_do_div_rem() - wrapper function for kernel macro(do_div) 447 * to get remainder. 448 * @dividend: Dividend value 449 * @divisor : Divisor value 450 * 451 * Return: remainder 452 */ 453 static inline 454 uint64_t __qdf_do_div_rem(uint64_t dividend, uint32_t divisor) 455 { 456 return do_div(dividend, divisor); 457 } 458 459 /** 460 * __qdf_hex_to_bin() - Wrapper function to kernel API to get unsigned 461 * integer from hexa decimal ASCII character. 462 * @ch: hexa decimal ASCII character 463 * 464 * Return: For hexa decimal ASCII char return actual decimal value 465 * else -1 for bad input. 466 */ 467 static inline 468 int __qdf_hex_to_bin(char ch) 469 { 470 return hex_to_bin(ch); 471 } 472 473 /** 474 * __qdf_hex_str_to_binary() - Wrapper function to get array of unsigned 475 * integers from string of hexa decimal ASCII characters. 476 * @dst: output array to hold converted values 477 * @src: input string of hexa decimal ASCII characters 478 * @count: size of dst string 479 * 480 * Return: For a string of hexa decimal ASCII characters return 0 481 * else -1 for bad input. 482 */ 483 static inline 484 int __qdf_hex_str_to_binary(u8 *dst, const char *src, size_t count) 485 { 486 return hex2bin(dst, src, count); 487 } 488 489 /** 490 * __qdf_fls() - find last set bit in a given 32 bit input 491 * @x: 32 bit mask 492 * 493 * Return: zero if the input is zero, otherwise returns the bit 494 * position of the last set bit, where the LSB is 1 and MSB is 32. 495 */ 496 static inline 497 int __qdf_fls(uint32_t x) 498 { 499 return fls(x); 500 } 501 502 #endif /*_I_QDF_UTIL_H*/ 503