2 * Copyright (c) 2013 Qualcomm Atheros, Inc.
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:
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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
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.
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.
36 * @ingroup adf_os_public
37 * @file adf_os_timer.h
38 * This file abstracts OS timers.
41 #ifndef _ADF_OS_TIMER_H
42 #define _ADF_OS_TIMER_H
44 #include <adf_os_types.h>
45 #include <adf_os_timer_pvt.h>
49 * @brief Platform timer object
51 typedef __adf_os_timer_t adf_os_timer_t;
55 * @brief Initialize a timer
57 * @param[in] hdl OS handle
58 * @param[in] timer timer object pointer
59 * @param[in] func timer function
60 * @param[in] context context of timer function
63 adf_os_timer_init(adf_os_handle_t hdl,
64 adf_os_timer_t *timer,
65 adf_os_timer_func_t func,
68 __adf_os_timer_init(hdl, timer, func, arg);
72 * @brief Start a one-shot timer
74 * @param[in] timer timer object pointer
75 * @param[in] msec expiration period in milliseconds
78 adf_os_timer_start(adf_os_timer_t *timer, int msec)
80 __adf_os_timer_start(timer, msec);
84 * @brief Cancel a timer
86 * @param[in] timer timer object pointer
88 * @retval TRUE timer was cancelled and deactived
89 * @retval FALSE timer was cancelled but already got fired.
91 static inline a_bool_t
92 adf_os_timer_cancel(adf_os_timer_t *timer)
94 return __adf_os_timer_cancel(timer);