adf_os_time.h 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. /*
  2. * Copyright (c) 2013 Qualcomm Atheros, Inc.
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted (subject to the limitations in the
  7. * disclaimer below) provided that the following conditions are met:
  8. *
  9. * * Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. *
  12. * * Redistributions in binary form must reproduce the above copyright
  13. * notice, this list of conditions and the following disclaimer in the
  14. * documentation and/or other materials provided with the
  15. * distribution.
  16. *
  17. * * Neither the name of Qualcomm Atheros nor the names of its
  18. * contributors may be used to endorse or promote products derived
  19. * from this software without specific prior written permission.
  20. *
  21. * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  22. * GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
  23. * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  24. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30. * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31. * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  32. * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  33. * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34. */
  35. /**
  36. * @ingroup adf_os_public
  37. * @file adf_os_time.h
  38. * This file abstracts time related functionality.
  39. */
  40. #ifndef _ADF_OS_TIME_H
  41. #define _ADF_OS_TIME_H
  42. #include <adf_os_time_pvt.h>
  43. /**
  44. * @brief count the number of ticks elapsed from the time when
  45. * the system booted
  46. *
  47. * @return ticks
  48. */
  49. static inline unsigned long
  50. adf_os_ticks(void)
  51. {
  52. return __adf_os_ticks();
  53. }
  54. /**
  55. * @brief convert ticks to milliseconds
  56. *
  57. * @param[in] ticks number of ticks
  58. * @return time in milliseconds
  59. */
  60. static inline a_uint32_t
  61. adf_os_ticks_to_msecs(unsigned long ticks)
  62. {
  63. return (__adf_os_ticks_to_msecs(ticks));
  64. }
  65. /**
  66. * @brief convert milliseconds to ticks
  67. *
  68. * @param[in] time in milliseconds
  69. * @return number of ticks
  70. */
  71. static inline unsigned long
  72. adf_os_msecs_to_ticks(a_uint32_t msecs)
  73. {
  74. return (__adf_os_msecs_to_ticks(msecs));
  75. }
  76. /**
  77. * @brief Return a monotonically increasing time. This increments once per HZ ticks
  78. */
  79. static inline unsigned long
  80. adf_os_getuptime(void)
  81. {
  82. return (__adf_os_getuptime());
  83. }
  84. /**
  85. * @brief Delay in microseconds
  86. *
  87. * @param[in] microseconds to delay
  88. */
  89. static inline void
  90. adf_os_udelay(int usecs)
  91. {
  92. __adf_os_udelay(usecs);
  93. }
  94. /**
  95. * @brief Delay in milliseconds.
  96. *
  97. * @param[in] milliseconds to delay
  98. */
  99. static inline void
  100. adf_os_mdelay(int msecs)
  101. {
  102. __adf_os_mdelay(msecs);
  103. }
  104. /**
  105. * @brief Check if _a is later than _b.
  106. */
  107. #define adf_os_time_after(_a, _b) __adf_os_time_after(_a, _b)
  108. /**
  109. * @brief Check if _a is prior to _b.
  110. */
  111. #define adf_os_time_before(_a, _b) __adf_os_time_before(_a, _b)
  112. /**
  113. * @brief Check if _a atleast as recent as _b, if not later.
  114. */
  115. #define adf_os_time_after_eq(_a, _b) __adf_os_time_after_eq(_a, _b)
  116. #endif