ath9k_htc/target_firmware/magpie_fw_dev/target/inc/adf_os_time.h

   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
  43 #include <adf_os_time_pvt.h>
  44
  45 /**
  46  * @brief count the number of ticks elapsed from the time when
  47  *        the system booted
  48  *
  49  * @return ticks
  50  */
  51 static inline unsigned long
  52 adf_os_ticks(void)
  53 {
  54         return __adf_os_ticks();
  55 }
  56
  57 /**
  58  * @brief convert ticks to milliseconds
  59  *
  60  * @param[in] ticks number of ticks
  61  * @return time in milliseconds
  62  */
  63 static inline a_uint32_t
  64 adf_os_ticks_to_msecs(unsigned long ticks)
  65 {
  66         return (__adf_os_ticks_to_msecs(ticks));
  67 }
  68
  69 /**
  70  * @brief convert milliseconds to ticks
  71  *
  72  * @param[in] time in milliseconds
  73  * @return number of ticks
  74  */
  75 static inline unsigned long
  76 adf_os_msecs_to_ticks(a_uint32_t msecs)
  77 {
  78         return (__adf_os_msecs_to_ticks(msecs));
  79 }
  80
  81 /**
  82  * @brief Return a monotonically increasing time. This increments once per HZ ticks
  83  */
  84 static inline unsigned long
  85 adf_os_getuptime(void)
  86 {
  87     return (__adf_os_getuptime());
  88 }
  89
  90 /**
  91  * @brief Delay in microseconds
  92  *
  93  * @param[in] microseconds to delay
  94  */
  95 static inline void
  96 adf_os_udelay(int usecs)
  97 {
  98     __adf_os_udelay(usecs);
  99 }
 100
 101 /**
 102  * @brief Delay in milliseconds.
 103  *
 104  * @param[in] milliseconds to delay
 105  */
 106 static inline void
 107 adf_os_mdelay(int msecs)
 108 {
 109     __adf_os_mdelay(msecs);
 110 }
 111
 112 /**
 113  * @brief Check if _a is later than _b.
 114  */
 115 #define adf_os_time_after(_a, _b)       __adf_os_time_after(_a, _b)
 116
 117 /**
 118  * @brief Check if _a is prior to _b.
 119  */
 120 #define adf_os_time_before(_a, _b)      __adf_os_time_before(_a, _b)
 121
 122 /**
 123  * @brief Check if _a atleast as recent as _b, if not later.
 124  */
 125 #define adf_os_time_after_eq(_a, _b)    __adf_os_time_after_eq(_a, _b)
 126
 127 #endif
 128
 129