qdf_util.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857
  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. * DOC: qdf_util.h
  20. * This file defines utility functions.
  21. */
  22. #ifndef _QDF_UTIL_H
  23. #define _QDF_UTIL_H
  24. #include <i_qdf_util.h>
  25. #ifdef QCA_CONFIG_SMP
  26. #define QDF_MAX_AVAILABLE_CPU 8
  27. #else
  28. #define QDF_MAX_AVAILABLE_CPU 1
  29. #endif
  30. typedef __qdf_wait_queue_head_t qdf_wait_queue_head_t;
  31. /**
  32. * qdf_unlikely - Compiler-dependent macro denoting code likely to execute
  33. * @_expr: expression to be checked
  34. */
  35. #define qdf_unlikely(_expr) __qdf_unlikely(_expr)
  36. /**
  37. * qdf_likely - Compiler-dependent macro denoting code unlikely to execute
  38. * @_expr: expression to be checked
  39. */
  40. #define qdf_likely(_expr) __qdf_likely(_expr)
  41. /**
  42. * qdf_wmb - write memory barrier.
  43. */
  44. #define qdf_wmb() __qdf_wmb()
  45. /**
  46. * qdf_rmb - read memory barrier.
  47. */
  48. #define qdf_rmb() __qdf_rmb()
  49. /**
  50. * qdf_mb - read + write memory barrier.
  51. */
  52. #define qdf_mb() __qdf_mb()
  53. /**
  54. * qdf_ioread32 - read a register
  55. * @offset: register address
  56. */
  57. #define qdf_ioread32(offset) __qdf_ioread32(offset)
  58. /**
  59. * qdf_iowrite32 - write a register
  60. * @offset: register address
  61. * @value: value to write (32bit value)
  62. */
  63. #define qdf_iowrite32(offset, value) __qdf_iowrite32(offset, value)
  64. /**
  65. * qdf_assert - assert "expr" evaluates to false.
  66. */
  67. #ifdef QDF_DEBUG
  68. #define qdf_assert(expr) __qdf_assert(expr)
  69. #else
  70. #define qdf_assert(expr)
  71. #endif /* QDF_DEBUG */
  72. /**
  73. * qdf_assert_always - alway assert "expr" evaluates to false.
  74. */
  75. #define qdf_assert_always(expr) __qdf_assert(expr)
  76. /**
  77. * qdf_target_assert_always - alway target assert "expr" evaluates to false.
  78. */
  79. #define qdf_target_assert_always(expr) __qdf_target_assert(expr)
  80. /**
  81. * QDF_MAX - get maximum of two values
  82. * @_x: 1st argument
  83. * @_y: 2nd argument
  84. */
  85. #define QDF_MAX(_x, _y) (((_x) > (_y)) ? (_x) : (_y))
  86. /**
  87. * QDF_MIN - get minimum of two values
  88. * @_x: 1st argument
  89. * @_y: 2nd argument
  90. */
  91. #define QDF_MIN(_x, _y) (((_x) < (_y)) ? (_x) : (_y))
  92. /**
  93. * QDF_IS_ADDR_BROADCAST - is mac address broadcast mac address
  94. * @_a: pointer to mac address
  95. */
  96. #define QDF_IS_ADDR_BROADCAST(_a) \
  97. ((_a)[0] == 0xff && \
  98. (_a)[1] == 0xff && \
  99. (_a)[2] == 0xff && \
  100. (_a)[3] == 0xff && \
  101. (_a)[4] == 0xff && \
  102. (_a)[5] == 0xff)
  103. #define QDF_DECLARE_EWMA(name, factor, weight) \
  104. __QDF_DECLARE_EWMA(name, factor, weight)
  105. #define qdf_ewma_tx_lag __qdf_ewma_tx_lag
  106. #define qdf_ewma_tx_lag_init(tx_lag) \
  107. __qdf_ewma_tx_lag_init(tx_lag)
  108. #define qdf_ewma_tx_lag_add(tx_lag, value) \
  109. __qdf_ewma_tx_lag_add(tx_lag, value)
  110. #define qdf_ewma_tx_lag_read(tx_lag) \
  111. __qdf_ewma_tx_lag_read(tx_lag)
  112. #define qdf_ewma_rx_rssi __qdf_ewma_rx_rssi
  113. #define qdf_ewma_rx_rssi_init(rx_rssi) \
  114. __qdf_ewma_rx_rssi_init(rx_rssi)
  115. #define qdf_ewma_rx_rssi_add(rx_rssi, value) \
  116. __qdf_ewma_rx_rssi_add(rx_rssi, value)
  117. #define qdf_ewma_rx_rssi_read(rx_rssi) \
  118. __qdf_ewma_rx_rssi_read(rx_rssi)
  119. #define QDF_CHAR_BIT 8
  120. /**
  121. * qdf_bitmap - Define a bitmap
  122. * @name: name of the bitmap
  123. * @bits: num of bits in the bitmap
  124. *
  125. * Return: none
  126. */
  127. #define qdf_bitmap(name, bits) __qdf_bitmap(name, bits)
  128. /**
  129. * qdf_set_bit() - set bit in address
  130. * @nr: bit number to be set
  131. * @addr: address buffer pointer
  132. *
  133. * Return: none
  134. */
  135. #define qdf_set_bit(nr, addr) __qdf_set_bit(nr, addr)
  136. /**
  137. * qdf_clear_bit() - clear bit in address
  138. * @nr: bit number to be clear
  139. * @addr: address buffer pointer
  140. *
  141. * Return: none
  142. */
  143. #define qdf_clear_bit(nr, addr) __qdf_clear_bit(nr, addr)
  144. /**
  145. * qdf_test_bit() - test bit position in address
  146. * @nr: bit number to be tested
  147. * @addr: address buffer pointer
  148. *
  149. * Return: none
  150. */
  151. #define qdf_test_bit(nr, addr) __qdf_test_bit(nr, addr)
  152. /**
  153. * qdf_test_and_clear_bit() - test and clear bit position in address
  154. * @nr: bit number to be tested
  155. * @addr: address buffer pointer
  156. *
  157. * Return: none
  158. */
  159. #define qdf_test_and_clear_bit(nr, addr) __qdf_test_and_clear_bit(nr, addr)
  160. /**
  161. * qdf_find_first_bit() - find first bit position in address
  162. * @addr: address buffer pointer
  163. * @nbits: number of bits
  164. *
  165. * Return: position first set bit in addr
  166. */
  167. #define qdf_find_first_bit(addr, nbits) __qdf_find_first_bit(addr, nbits)
  168. /**
  169. * qdf_bitmap_empty() - Check if bitmap is empty
  170. * @addr: Address buffer pointer
  171. * @nbits: Number of bits
  172. *
  173. * Return: True if no bit set, else false
  174. */
  175. #define qdf_bitmap_empty(addr, nbits) __qdf_bitmap_empty(addr, nbits)
  176. /**
  177. * qdf_bitmap_and() - AND operation on the bitmap
  178. * @dst: Destination buffer pointer
  179. * @src1: First source buffer pointer
  180. * @src2: Second source buffer pointer
  181. * @nbits: Number of bits
  182. *
  183. * Return: Bitwise and of src1 and src2 in dst
  184. */
  185. #define qdf_bitmap_and(dst, src1, src2, nbits) \
  186. __qdf_bitmap_and(dst, src1, src2, nbits)
  187. #define qdf_wait_queue_interruptible(wait_queue, condition) \
  188. __qdf_wait_queue_interruptible(wait_queue, condition)
  189. /**
  190. * qdf_wait_queue_timeout() - wait for specified time on given condition
  191. * @wait_queue: wait queue to wait on
  192. * @condition: condition to wait on
  193. * @timeout: timeout value in jiffies
  194. *
  195. * Return: 0 if condition becomes false after timeout
  196. * 1 or remaining jiffies, if condition becomes true during timeout
  197. */
  198. #define qdf_wait_queue_timeout(wait_queue, condition, timeout) \
  199. __qdf_wait_queue_timeout(wait_queue, \
  200. condition, timeout)
  201. #define qdf_init_waitqueue_head(_q) __qdf_init_waitqueue_head(_q)
  202. #define qdf_wake_up_interruptible(_q) __qdf_wake_up_interruptible(_q)
  203. /**
  204. * qdf_wake_up() - wakes up sleeping waitqueue
  205. * @wait_queue: wait queue, which needs wake up
  206. *
  207. * Return: none
  208. */
  209. #define qdf_wake_up(_q) __qdf_wake_up(_q)
  210. #define qdf_wake_up_completion(_q) __qdf_wake_up_completion(_q)
  211. /**
  212. * qdf_container_of - cast a member of a structure out to the containing
  213. * structure
  214. * @ptr: the pointer to the member.
  215. * @type: the type of the container struct this is embedded in.
  216. * @member: the name of the member within the struct.
  217. */
  218. #define qdf_container_of(ptr, type, member) \
  219. __qdf_container_of(ptr, type, member)
  220. /**
  221. * qdf_is_pwr2 - test input value is power of 2 integer
  222. * @value: input integer
  223. */
  224. #define QDF_IS_PWR2(value) (((value) ^ ((value)-1)) == ((value) << 1) - 1)
  225. /**
  226. * qdf_roundup() - roundup the input value
  227. * @x: value to roundup
  228. * @y: input value rounded to multiple of this
  229. *
  230. * Return: rounded value
  231. */
  232. #define qdf_roundup(x, y) __qdf_roundup(x, y)
  233. /**
  234. * qdf_is_macaddr_equal() - compare two QDF MacAddress
  235. * @mac_addr1: Pointer to one qdf MacAddress to compare
  236. * @mac_addr2: Pointer to the other qdf MacAddress to compare
  237. *
  238. * This function returns a bool that tells if a two QDF MacAddress'
  239. * are equivalent.
  240. *
  241. * Return: true if the MacAddress's are equal
  242. * not true if the MacAddress's are not equal
  243. */
  244. static inline bool qdf_is_macaddr_equal(struct qdf_mac_addr *mac_addr1,
  245. struct qdf_mac_addr *mac_addr2)
  246. {
  247. return __qdf_is_macaddr_equal(mac_addr1, mac_addr2);
  248. }
  249. /**
  250. * qdf_is_macaddr_zero() - check for a MacAddress of all zeros.
  251. * @mac_addr: pointer to the struct qdf_mac_addr to check.
  252. *
  253. * This function returns a bool that tells if a MacAddress is made up of
  254. * all zeros.
  255. *
  256. * Return: true if the MacAddress is all Zeros
  257. * false if the MacAddress is not all Zeros.
  258. */
  259. static inline bool qdf_is_macaddr_zero(struct qdf_mac_addr *mac_addr)
  260. {
  261. struct qdf_mac_addr zero_mac_addr = QDF_MAC_ADDR_ZERO_INIT;
  262. return qdf_is_macaddr_equal(mac_addr, &zero_mac_addr);
  263. }
  264. /**
  265. * qdf_zero_macaddr() - zero out a MacAddress
  266. * @mac_addr: pointer to the struct qdf_mac_addr to zero.
  267. *
  268. * This function zeros out a QDF MacAddress type.
  269. *
  270. * Return: none
  271. */
  272. static inline void qdf_zero_macaddr(struct qdf_mac_addr *mac_addr)
  273. {
  274. __qdf_zero_macaddr(mac_addr);
  275. }
  276. /**
  277. * qdf_is_macaddr_group() - check for a MacAddress is a 'group' address
  278. * @mac_addr1: pointer to the qdf MacAddress to check
  279. *
  280. * This function returns a bool that tells if a the input QDF MacAddress
  281. * is a "group" address. Group addresses have the 'group address bit' turned
  282. * on in the MacAddress. Group addresses are made up of Broadcast and
  283. * Multicast addresses.
  284. *
  285. * Return: true if the input MacAddress is a Group address
  286. * false if the input MacAddress is not a Group address
  287. */
  288. static inline bool qdf_is_macaddr_group(struct qdf_mac_addr *mac_addr)
  289. {
  290. return mac_addr->bytes[0] & 0x01;
  291. }
  292. /**
  293. * qdf_is_macaddr_broadcast() - check for a MacAddress is a broadcast address
  294. * @mac_addr: Pointer to the qdf MacAddress to check
  295. *
  296. * This function returns a bool that tells if a the input QDF MacAddress
  297. * is a "broadcast" address.
  298. *
  299. * Return: true if the input MacAddress is a broadcast address
  300. * flase if the input MacAddress is not a broadcast address
  301. */
  302. static inline bool qdf_is_macaddr_broadcast(struct qdf_mac_addr *mac_addr)
  303. {
  304. struct qdf_mac_addr broadcast_mac_addr = QDF_MAC_ADDR_BCAST_INIT;
  305. return qdf_is_macaddr_equal(mac_addr, &broadcast_mac_addr);
  306. }
  307. /**
  308. * qdf_copy_macaddr() - copy a QDF MacAddress
  309. * @dst_addr: pointer to the qdf MacAddress to copy TO (the destination)
  310. * @src_addr: pointer to the qdf MacAddress to copy FROM (the source)
  311. *
  312. * This function copies a QDF MacAddress into another QDF MacAddress.
  313. *
  314. * Return: none
  315. */
  316. static inline void qdf_copy_macaddr(struct qdf_mac_addr *dst_addr,
  317. struct qdf_mac_addr *src_addr)
  318. {
  319. *dst_addr = *src_addr;
  320. }
  321. /**
  322. * qdf_set_macaddr_broadcast() - set a QDF MacAddress to the 'broadcast'
  323. * @mac_addr: pointer to the qdf MacAddress to set to broadcast
  324. *
  325. * This function sets a QDF MacAddress to the 'broadcast' MacAddress. Broadcast
  326. * MacAddress contains all 0xFF bytes.
  327. *
  328. * Return: none
  329. */
  330. static inline void qdf_set_macaddr_broadcast(struct qdf_mac_addr *mac_addr)
  331. {
  332. __qdf_set_macaddr_broadcast(mac_addr);
  333. }
  334. /**
  335. * qdf_set_u16() - Assign 16-bit unsigned value to a byte array base on CPU's
  336. * endianness.
  337. * @ptr: Starting address of a byte array
  338. * @value: The value to assign to the byte array
  339. *
  340. * Caller must validate the byte array has enough space to hold the vlaue
  341. *
  342. * Return: The address to the byte after the assignment. This may or may not
  343. * be valid. Caller to verify.
  344. */
  345. static inline uint8_t *qdf_set_u16(uint8_t *ptr, uint16_t value)
  346. {
  347. #if defined(ANI_BIG_BYTE_ENDIAN)
  348. *(ptr) = (uint8_t) (value >> 8);
  349. *(ptr + 1) = (uint8_t) (value);
  350. #else
  351. *(ptr + 1) = (uint8_t) (value >> 8);
  352. *(ptr) = (uint8_t) (value);
  353. #endif
  354. return ptr + 2;
  355. }
  356. /**
  357. * qdf_get_u16() - Retrieve a 16-bit unsigned value from a byte array base on
  358. * CPU's endianness.
  359. * @ptr: Starting address of a byte array
  360. * @value: Pointer to a caller allocated buffer for 16 bit value. Value is to
  361. * assign to this location.
  362. *
  363. * Caller must validate the byte array has enough space to hold the vlaue
  364. *
  365. * Return: The address to the byte after the assignment. This may or may not
  366. * be valid. Caller to verify.
  367. */
  368. static inline uint8_t *qdf_get_u16(uint8_t *ptr, uint16_t *value)
  369. {
  370. #if defined(ANI_BIG_BYTE_ENDIAN)
  371. *value = (((uint16_t) (*ptr << 8)) | ((uint16_t) (*(ptr + 1))));
  372. #else
  373. *value = (((uint16_t) (*(ptr + 1) << 8)) | ((uint16_t) (*ptr)));
  374. #endif
  375. return ptr + 2;
  376. }
  377. /**
  378. * qdf_get_u32() - retrieve a 32-bit unsigned value from a byte array base on
  379. * CPU's endianness.
  380. * @ptr: Starting address of a byte array
  381. * @value: Pointer to a caller allocated buffer for 32 bit value. Value is to
  382. * assign to this location.
  383. *
  384. * Caller must validate the byte array has enough space to hold the vlaue
  385. *
  386. * Return: The address to the byte after the assignment. This may or may not
  387. * be valid. Caller to verify.
  388. */
  389. static inline uint8_t *qdf_get_u32(uint8_t *ptr, uint32_t *value)
  390. {
  391. #if defined(ANI_BIG_BYTE_ENDIAN)
  392. *value = ((uint32_t) (*(ptr) << 24) |
  393. (uint32_t) (*(ptr + 1) << 16) |
  394. (uint32_t) (*(ptr + 2) << 8) | (uint32_t) (*(ptr + 3)));
  395. #else
  396. *value = ((uint32_t) (*(ptr + 3) << 24) |
  397. (uint32_t) (*(ptr + 2) << 16) |
  398. (uint32_t) (*(ptr + 1) << 8) | (uint32_t) (*(ptr)));
  399. #endif
  400. return ptr + 4;
  401. }
  402. /**
  403. * qdf_ntohs - Convert a 16-bit value from network byte order to host byte order
  404. */
  405. #define qdf_ntohs(x) __qdf_ntohs(x)
  406. /**
  407. * qdf_ntohl - Convert a 32-bit value from network byte order to host byte order
  408. */
  409. #define qdf_ntohl(x) __qdf_ntohl(x)
  410. /**
  411. * qdf_htons - Convert a 16-bit value from host byte order to network byte order
  412. */
  413. #define qdf_htons(x) __qdf_htons(x)
  414. /**
  415. * qdf_htonl - Convert a 32-bit value from host byte order to network byte order
  416. */
  417. #define qdf_htonl(x) __qdf_htonl(x)
  418. /**
  419. * qdf_cpu_to_le16 - Convert a 16-bit value from CPU byte order to
  420. * little-endian byte order
  421. *
  422. * @x: value to be converted
  423. */
  424. #define qdf_cpu_to_le16(x) __qdf_cpu_to_le16(x)
  425. /**
  426. * qdf_cpu_to_le32 - Convert a 32-bit value from CPU byte order to
  427. * little-endian byte order
  428. *
  429. * @x: value to be converted
  430. */
  431. #define qdf_cpu_to_le32(x) __qdf_cpu_to_le32(x)
  432. /**
  433. * qdf_cpu_to_le64 - Convert a 64-bit value from CPU byte order to
  434. * little-endian byte order
  435. *
  436. * @x: value to be converted
  437. */
  438. #define qdf_cpu_to_le64(x) __qdf_cpu_to_le64(x)
  439. /**
  440. * qdf_le16_to_cpu - Convert a 16-bit value from little-endian byte order
  441. * to CPU byte order
  442. *
  443. * @x: value to be converted
  444. */
  445. #define qdf_le16_to_cpu(x) __qdf_le16_to_cpu(x)
  446. /**
  447. * qdf_le32_to_cpu - Convert a 32-bit value from little-endian byte
  448. * order to CPU byte order
  449. *
  450. * @x: value to be converted
  451. */
  452. #define qdf_le32_to_cpu(x) __qdf_le32_to_cpu(x)
  453. /**
  454. * qdf_le64_to_cpu - Convert a 64-bit value from little-endian byte
  455. * order to CPU byte order
  456. *
  457. * @x: value to be converted
  458. */
  459. #define qdf_le64_to_cpu(x) __qdf_le64_to_cpu(x)
  460. /**
  461. * qdf_cpu_to_be16 - Convert a 16-bit value from CPU byte order to
  462. * big-endian byte order
  463. *
  464. * @x: value to be converted
  465. */
  466. #define qdf_cpu_to_be16(x) __qdf_cpu_to_be16(x)
  467. /**
  468. * qdf_cpu_to_be32 - Convert a 32-bit value from CPU byte order to
  469. * big-endian byte order
  470. *
  471. * @x: value to be converted
  472. */
  473. #define qdf_cpu_to_be32(x) __qdf_cpu_to_be32(x)
  474. /**
  475. * qdf_cpu_to_be64 - Convert a 64-bit value from CPU byte order to
  476. * big-endian byte order
  477. *
  478. * @x: value to be converted
  479. */
  480. #define qdf_cpu_to_be64(x) __qdf_cpu_to_be64(x)
  481. /**
  482. * qdf_be16_to_cpu - Convert a 16-bit value from big-endian byte order
  483. * to CPU byte order
  484. *
  485. * @x: value to be converted
  486. */
  487. #define qdf_be16_to_cpu(x) __qdf_be16_to_cpu(x)
  488. /**
  489. * qdf_be32_to_cpu - Convert a 32-bit value from big-endian byte order
  490. * to CPU byte order
  491. *
  492. * @x: value to be converted
  493. */
  494. #define qdf_be32_to_cpu(x) __qdf_be32_to_cpu(x)
  495. /**
  496. * qdf_be64_to_cpu - Convert a 64-bit value from big-endian byte order
  497. * to CPU byte order
  498. *
  499. * @x: value to be converted
  500. */
  501. #define qdf_be64_to_cpu(x) __qdf_be64_to_cpu(x)
  502. /**
  503. * qdf_function - replace with the name of the current function
  504. */
  505. #define qdf_function __qdf_function
  506. /**
  507. * qdf_min - minimum of two numbers
  508. */
  509. #define qdf_min(a, b) __qdf_min(a, b)
  510. /**
  511. * qdf_ffz() - find first (least significant) zero bit
  512. * @mask: the bitmask to check
  513. *
  514. * Return: The zero-based index of the first zero bit, or -1 if none are found
  515. */
  516. #define qdf_ffz(mask) __qdf_ffz(mask)
  517. /**
  518. * qdf_prefetch - prefetches the cacheline for read
  519. *
  520. * @x: address to be prefetched
  521. */
  522. #define qdf_prefetch(x) __qdf_prefetch(x)
  523. /**
  524. * qdf_get_pwr2() - get next power of 2 integer from input value
  525. * @value: input value to find next power of 2 integer
  526. *
  527. * Get next power of 2 integer from input value
  528. *
  529. * Return: Power of 2 integer
  530. */
  531. static inline int qdf_get_pwr2(int value)
  532. {
  533. int log2;
  534. if (QDF_IS_PWR2(value))
  535. return value;
  536. log2 = 0;
  537. while (value) {
  538. value >>= 1;
  539. log2++;
  540. }
  541. return 1 << log2;
  542. }
  543. static inline
  544. int qdf_get_cpu(void)
  545. {
  546. return __qdf_get_cpu();
  547. }
  548. /**
  549. * qdf_get_hweight8() - count num of 1's in 8-bit bitmap
  550. * @value: input bitmap
  551. *
  552. * Count num of 1's set in the 8-bit bitmap
  553. *
  554. * Return: num of 1's
  555. */
  556. static inline
  557. unsigned int qdf_get_hweight8(unsigned int w)
  558. {
  559. unsigned int res = w - ((w >> 1) & 0x55);
  560. res = (res & 0x33) + ((res >> 2) & 0x33);
  561. return (res + (res >> 4)) & 0x0F;
  562. }
  563. /**
  564. * qdf_get_hweight16() - count num of 1's in 16-bit bitmap
  565. * @value: input bitmap
  566. *
  567. * Count num of 1's set in the 16-bit bitmap
  568. *
  569. * Return: num of 1's
  570. */
  571. static inline
  572. unsigned int qdf_get_hweight16(unsigned int w)
  573. {
  574. unsigned int res = (w & 0x5555) + ((w >> 1) & 0x5555);
  575. res = (res & 0x3333) + ((res >> 2) & 0x3333);
  576. res = (res & 0x0F0F) + ((res >> 4) & 0x0F0F);
  577. return (res & 0x00FF) + ((res >> 8) & 0x00FF);
  578. }
  579. /**
  580. * qdf_get_hweight32() - count num of 1's in 32-bit bitmap
  581. * @value: input bitmap
  582. *
  583. * Count num of 1's set in the 32-bit bitmap
  584. *
  585. * Return: num of 1's
  586. */
  587. static inline
  588. unsigned int qdf_get_hweight32(unsigned int w)
  589. {
  590. unsigned int res = (w & 0x55555555) + ((w >> 1) & 0x55555555);
  591. res = (res & 0x33333333) + ((res >> 2) & 0x33333333);
  592. res = (res & 0x0F0F0F0F) + ((res >> 4) & 0x0F0F0F0F);
  593. res = (res & 0x00FF00FF) + ((res >> 8) & 0x00FF00FF);
  594. return (res & 0x0000FFFF) + ((res >> 16) & 0x0000FFFF);
  595. }
  596. /**
  597. * qdf_device_init_wakeup() - allow a device to wake up the aps system
  598. * @qdf_dev: the qdf device context
  599. * @enable: enable/disable the device as a wakup source
  600. *
  601. * Return: 0 or errno
  602. */
  603. static inline int qdf_device_init_wakeup(qdf_device_t qdf_dev, bool enable)
  604. {
  605. return __qdf_device_init_wakeup(qdf_dev, enable);
  606. }
  607. static inline
  608. uint64_t qdf_get_totalramsize(void)
  609. {
  610. return __qdf_get_totalramsize();
  611. }
  612. /**
  613. * qdf_get_lower_32_bits() - get lower 32 bits from an address.
  614. * @addr: address
  615. *
  616. * This api returns the lower 32 bits of an address.
  617. *
  618. * Return: lower 32 bits.
  619. */
  620. static inline
  621. uint32_t qdf_get_lower_32_bits(qdf_dma_addr_t addr)
  622. {
  623. return __qdf_get_lower_32_bits(addr);
  624. }
  625. /**
  626. * qdf_get_upper_32_bits() - get upper 32 bits from an address.
  627. * @addr: address
  628. *
  629. * This api returns the upper 32 bits of an address.
  630. *
  631. * Return: upper 32 bits.
  632. */
  633. static inline
  634. uint32_t qdf_get_upper_32_bits(qdf_dma_addr_t addr)
  635. {
  636. return __qdf_get_upper_32_bits(addr);
  637. }
  638. /**
  639. * qdf_rounddown_pow_of_two() - Round down to nearest power of two
  640. * @n: number to be tested
  641. *
  642. * Test if the input number is power of two, and return the nearest power of two
  643. *
  644. * Return: number rounded down to the nearest power of two
  645. */
  646. static inline
  647. unsigned long qdf_rounddown_pow_of_two(unsigned long n)
  648. {
  649. return __qdf_rounddown_pow_of_two(n);
  650. }
  651. /**
  652. * qdf_set_dma_coherent_mask() - set max number of bits allowed in dma addr
  653. * @dev: device pointer
  654. * @addr_bits: max number of bits allowed in dma address
  655. *
  656. * This API sets the maximum allowed number of bits in the dma address.
  657. *
  658. * Return: 0 - success, non zero - failure
  659. */
  660. static inline
  661. int qdf_set_dma_coherent_mask(struct device *dev, uint8_t addr_bits)
  662. {
  663. return __qdf_set_dma_coherent_mask(dev, addr_bits);
  664. }
  665. /**
  666. * qdf_do_div() - wrapper function for kernel macro(do_div).
  667. * @dividend: Dividend value
  668. * @divisor : Divisor value
  669. *
  670. * Return: Quotient
  671. */
  672. static inline
  673. uint64_t qdf_do_div(uint64_t dividend, uint32_t divisor)
  674. {
  675. return __qdf_do_div(dividend, divisor);
  676. }
  677. /**
  678. * qdf_do_div_rem() - wrapper function for kernel macro(do_div)
  679. * to get remainder.
  680. * @dividend: Dividend value
  681. * @divisor : Divisor value
  682. *
  683. * Return: remainder
  684. */
  685. static inline
  686. uint64_t qdf_do_div_rem(uint64_t dividend, uint32_t divisor)
  687. {
  688. return __qdf_do_div_rem(dividend, divisor);
  689. }
  690. /**
  691. * qdf_get_random_bytes() - returns nbytes bytes of random
  692. * data
  693. *
  694. * Return: random bytes of data
  695. */
  696. static inline
  697. void qdf_get_random_bytes(void *buf, int nbytes)
  698. {
  699. return __qdf_get_random_bytes(buf, nbytes);
  700. }
  701. /**
  702. * qdf_hex_to_bin() - QDF API to Convert hexa decimal ASCII character to
  703. * unsigned integer value.
  704. * @ch: hexa decimal ASCII character
  705. *
  706. * Return: For hexa decimal ASCII char return actual decimal value
  707. * else -1 for bad input.
  708. */
  709. static inline
  710. int qdf_hex_to_bin(char ch)
  711. {
  712. return __qdf_hex_to_bin(ch);
  713. }
  714. /**
  715. * qdf_hex_str_to_binary() - QDF API to Convert string of hexa decimal
  716. * ASCII characters to array of unsigned integers.
  717. * @dst: output array to hold converted values
  718. * @src: input string of hexa decimal ASCII characters
  719. * @count: size of dst string
  720. *
  721. * This function is used to convert string of hexa decimal characters to
  722. * array of unsigned integers and caller should ensure:
  723. * a) @dst, @src are not NULL,
  724. * b) size of @dst should be (size of src / 2)
  725. *
  726. * Example 1:
  727. * src = 11aa, means, src[0] = '1', src[1] = '2', src[2] = 'a', src[3] = 'a'
  728. * count = (size of src / 2) = 2
  729. * after conversion, dst[0] = 0x11, dst[1] = oxAA and return (0).
  730. *
  731. * Example 2:
  732. * src = 11az, means, src[0] = '1', src[1] = '2', src[2] = 'a', src[3] = 'z'
  733. * src[3] is not ASCII hexa decimal character, return negative value (-1).
  734. *
  735. * Return: For a string of hexa decimal ASCII characters return 0
  736. * else -1 for bad input.
  737. */
  738. static inline
  739. int qdf_hex_str_to_binary(u8 *dst, const char *src, size_t count)
  740. {
  741. return __qdf_hex_str_to_binary(dst, src, count);
  742. }
  743. /**
  744. * qdf_fls() - find last set bit in a given 32 bit input
  745. * @x: 32 bit mask
  746. *
  747. * Return: zero if the input is zero, otherwise returns the bit
  748. * position of the last set bit, where the LSB is 1 and MSB is 32.
  749. */
  750. static inline
  751. int qdf_fls(uint32_t x)
  752. {
  753. return __qdf_fls(x);
  754. }
  755. #endif /*_QDF_UTIL_H*/