qdf_util.h 22 KB

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