ath9k_htc/target_firmware/magpie_fw_dev/target/adf/adf_os_timer_pvt.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 #ifndef _ADF_OS_TIMER_PVT_H
  36 #define _ADF_OS_TIMER_PVT_H
  37
  38 #include <cmnos_api.h>
  39 #include "Magpie_api.h"
  40
  41
  42 typedef struct
  43 {
  44         A_timer_t                               *magpie_timer;
  45         adf_os_timer_func_t     timer_func;
  46 }__adf_os_timer_t;
  47
  48 //typedef A_timer_t     __adf_os_timer_t;
  49
  50 void
  51 __adf_os_timer_func(A_HANDLE timer_handle, void *arg);
  52
  53 /*
  54  * Initialize a timer
  55  */
  56 static inline void
  57 __adf_os_timer_init(adf_os_handle_t  hdl, __adf_os_timer_t   *timer,
  58                     adf_os_timer_func_t  func, void *arg)
  59 {
  60     timer->timer_func = func;
  61     A_INIT_TIMER(timer->magpie_timer, __adf_os_timer_func, arg);
  62 }
  63
  64 /*
  65  * start a timer
  66  */
  67 static inline void
  68 __adf_os_timer_start(__adf_os_timer_t *timer, int msec)
  69 {
  70     A_TIMEOUT_MS(timer->magpie_timer, msec);
  71 }
  72 /*
  73  * Cancel a timer
  74  *
  75  * Return: TRUE if timer was cancelled and deactived,
  76  *         FALSE if timer was cancelled but already got fired.
  77  */
  78 static inline a_bool_t
  79 __adf_os_timer_cancel(__adf_os_timer_t *timer)
  80 {
  81         A_UNTIMEOUT(timer->magpie_timer);
  82         return A_TRUE;
  83 }
  84
  85 /*
  86  * XXX Synchronously canel a timer
  87  *
  88  * Return: TRUE if timer was cancelled and deactived,
  89  *         FALSE if timer was cancelled but already got fired.
  90  *
  91  * Synchronization Rules:
  92  * 1. caller must make sure timer function will not use
  93  *    adf_os_set_timer to add iteself again.
  94  * 2. caller must not hold any lock that timer function
  95  *    is likely to hold as well.
  96  * 3. It can't be called from interrupt context.
  97  */
  98 static inline a_bool_t
  99 __adf_os_timer_sync_cancel(__adf_os_timer_t *timer)
 100 {
 101     // @TODO: IS OK??
 102     A_UNTIMEOUT(timer->magpie_timer);
 103     return A_TRUE;
 104 }
 105
 106
 107 #endif