qdf_util.h 20 KB

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