qdf_util.h 24 KB

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