ath9k_htc/target_firmware/magpie_fw_dev/target/inc/adf_os_defer.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_defer.h
  38  * This file abstracts deferred execution contexts.
  39  */
  40
  41 #ifndef __ADF_OS_DEFER_H
  42 #define __ADF_OS_DEFER_H
  43
  44 #include <adf_os_types.h>
  45 #include <adf_os_defer_pvt.h>
  46
  47 /**
  48  * TODO This implements work queues (worker threads, kernel threads etc.).
  49  * Note that there is no cancel on a scheduled work. You cannot free a work
  50  * item if its queued. You cannot know if a work item is queued or not unless
  51  * its running, whence you know its not queued.
  52  *
  53  * so if, say, a module is asked to unload itself, how exactly will it make
  54  * sure that the work's not queued, for OS'es that dont provide such a
  55  * mechanism??
  56  */
  57
  58 /**
  59  * @brief Representation of a work queue.
  60  */
  61 typedef __adf_os_work_t     adf_os_work_t;
  62
  63 /**
  64  * @brief Representation of a bottom half.
  65  */
  66 typedef __adf_os_bh_t       adf_os_bh_t;
  67
  68
  69
  70 /**
  71  * @brief This initiallizes the Bottom half deferred handler
  72  *
  73  * @param[in] hdl   OS handle
  74  * @param[in] bh    bottom instance
  75  * @param[in] func  deferred function to run at bottom half interrupt
  76  *                  context.
  77  * @param[in] arg   argument for the deferred function
  78  */
  79 static inline void
  80 adf_os_init_bh(adf_os_handle_t  hdl, adf_os_bh_t  *bh,
  81                adf_os_defer_fn_t  func,void  *arg)
  82 {
  83     __adf_os_init_bh(hdl, bh, func, arg);
  84 }
  85
  86
  87 /**
  88  * @brief schedule a bottom half (DPC)
  89  *
  90  * @param[in] hdl   OS handle
  91  * @param[in] bh    bottom instance
  92  */
  93 static inline void
  94 adf_os_sched_bh(adf_os_handle_t hdl, adf_os_bh_t *bh)
  95 {
  96     __adf_os_sched_bh(hdl, bh);
  97 }
  98
  99 /**
 100  * @brief disable the bh (synchronous)
 101  *
 102  * @param[in] hdl   OS handle
 103  * @param[in] bh    bottom instance
 104  */
 105 static inline void
 106 adf_os_disable_bh(adf_os_handle_t hdl, adf_os_bh_t *bh)
 107 {
 108     __adf_os_disable_bh(hdl,bh);
 109 }
 110
 111 /*********************Non-Interrupt Context deferred Execution***************/
 112
 113 /**
 114  * @brief allocate a work/task queue, This runs in non-interrupt
 115  *        context, so can be preempted by H/W & S/W intr
 116  *
 117  * @param[in] hdl   OS handle
 118  * @param[in] work  work instance
 119  * @param[in] func  deferred function to run at bottom half non-interrupt
 120  *                  context.
 121  * @param[in] arg   argument for the deferred function
 122  */
 123 static inline void
 124 adf_os_init_work(adf_os_handle_t hdl, adf_os_work_t  *work,
 125                  adf_os_defer_fn_t  func, void  *arg)
 126 {
 127     __adf_os_init_work(hdl, work, func, arg);
 128 }
 129
 130 /**
 131  * @brief Schedule a deferred task on non-interrupt context
 132  *
 133  * @param[in] hdl   OS handle
 134  * @param[in] work  work instance
 135  */
 136 static inline void
 137 adf_os_sched_work(adf_os_handle_t  hdl, adf_os_work_t   *work)
 138 {
 139     __adf_os_sched_work(hdl, work);
 140 }
 141
 142 /**
 143  *@brief disable the deferred task (synchronous)
 144  *
 145  *@param[in] hdl    OS handle
 146  *@param[in] work   work instance
 147  */
 148 static inline void
 149 adf_os_disable_work(adf_os_handle_t hdl, adf_os_work_t *work)
 150 {
 151     __adf_os_disable_work(hdl, work);
 152 }
 153
 154
 155 /**
 156  * XXX API to specify processor while scheduling a bh => only on vista
 157  */
 158
 159
 160 #endif /*_ADF_OS_DEFER_H*/