drivers/net/wireless/iwlwifi/iwl-op-mode.h

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63 #ifndef __iwl_op_mode_h__
  64 #define __iwl_op_mode_h__
  65
  66 #include <linux/debugfs.h>
  67
  68 struct iwl_op_mode;
  69 struct iwl_trans;
  70 struct sk_buff;
  71 struct iwl_device_cmd;
  72 struct iwl_rx_cmd_buffer;
  73 struct iwl_fw;
  74 struct iwl_cfg;
  75
  76 /**
  77  * DOC: Operational mode - what is it ?
  78  *
  79  * The operational mode (a.k.a. op_mode) is the layer that implements
  80  * mac80211's handlers. It knows two APIs: mac80211's and the fw's. It uses
  81  * the transport API to access the HW. The op_mode doesn't need to know how the
  82  * underlying HW works, since the transport layer takes care of that.
  83  *
  84  * There can be several op_mode: i.e. different fw APIs will require two
  85  * different op_modes. This is why the op_mode is virtualized.
  86  */
  87
  88 /**
  89  * DOC: Life cycle of the Operational mode
  90  *
  91  * The operational mode has a very simple life cycle.
  92  *
  93  *      1) The driver layer (iwl-drv.c) chooses the op_mode based on the
  94  *         capabilities advertized by the fw file (in TLV format).
  95  *      2) The driver layer starts the op_mode (ops->start)
  96  *      3) The op_mode registers mac80211
  97  *      4) The op_mode is governed by mac80211
  98  *      5) The driver layer stops the op_mode
  99  */
 100
 101 /**
 102  * struct iwl_op_mode_ops - op_mode specific operations
 103  *
 104  * The op_mode exports its ops so that external components can start it and
 105  * interact with it. The driver layer typically calls the start and stop
 106  * handlers, the transport layer calls the others.
 107  *
 108  * All the handlers MUST be implemented
 109  *
 110  * @start: start the op_mode. The transport layer is already allocated.
 111  *      May sleep
 112  * @stop: stop the op_mode. Must free all the memory allocated.
 113  *      May sleep
 114  * @rx: Rx notification to the op_mode. rxb is the Rx buffer itself. Cmd is the
 115  *      HCMD this Rx responds to.
 116  *      This callback may sleep, it is called from a threaded IRQ handler.
 117  * @queue_full: notifies that a HW queue is full.
 118  *      Must be atomic and called with BH disabled.
 119  * @queue_not_full: notifies that a HW queue is not full any more.
 120  *      Must be atomic and called with BH disabled.
 121  * @hw_rf_kill:notifies of a change in the HW rf kill switch. True means that
 122  *      the radio is killed. Return %true if the device should be stopped by
 123  *      the transport immediately after the call. May sleep.
 124  * @free_skb: allows the transport layer to free skbs that haven't been
 125  *      reclaimed by the op_mode. This can happen when the driver is freed and
 126  *      there are Tx packets pending in the transport layer.
 127  *      Must be atomic
 128  * @nic_error: error notification. Must be atomic and must be called with BH
 129  *      disabled.
 130  * @cmd_queue_full: Called when the command queue gets full. Must be atomic and
 131  *      called with BH disabled.
 132  * @nic_config: configure NIC, called before firmware is started.
 133  *      May sleep
 134  * @wimax_active: invoked when WiMax becomes active. May sleep
 135  * @enter_d0i3: configure the fw to enter d0i3. May sleep.
 136  * @exit_d0i3: configure the fw to exit d0i3. May sleep.
 137  */
 138 struct iwl_op_mode_ops {
 139         struct iwl_op_mode *(*start)(struct iwl_trans *trans,
 140                                      const struct iwl_cfg *cfg,
 141                                      const struct iwl_fw *fw,
 142                                      struct dentry *dbgfs_dir);
 143         void (*stop)(struct iwl_op_mode *op_mode);
 144         int (*rx)(struct iwl_op_mode *op_mode, struct iwl_rx_cmd_buffer *rxb,
 145                   struct iwl_device_cmd *cmd);
 146         void (*queue_full)(struct iwl_op_mode *op_mode, int queue);
 147         void (*queue_not_full)(struct iwl_op_mode *op_mode, int queue);
 148         bool (*hw_rf_kill)(struct iwl_op_mode *op_mode, bool state);
 149         void (*free_skb)(struct iwl_op_mode *op_mode, struct sk_buff *skb);
 150         void (*nic_error)(struct iwl_op_mode *op_mode);
 151         void (*cmd_queue_full)(struct iwl_op_mode *op_mode);
 152         void (*nic_config)(struct iwl_op_mode *op_mode);
 153         void (*wimax_active)(struct iwl_op_mode *op_mode);
 154         int (*enter_d0i3)(struct iwl_op_mode *op_mode);
 155         int (*exit_d0i3)(struct iwl_op_mode *op_mode);
 156 };
 157
 158 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops);
 159 void iwl_opmode_deregister(const char *name);
 160
 161 /**
 162  * struct iwl_op_mode - operational mode
 163  * @ops: pointer to its own ops
 164  *
 165  * This holds an implementation of the mac80211 / fw API.
 166  */
 167 struct iwl_op_mode {
 168         const struct iwl_op_mode_ops *ops;
 169
 170         char op_mode_specific[0] __aligned(sizeof(void *));
 171 };
 172
 173 static inline void iwl_op_mode_stop(struct iwl_op_mode *op_mode)
 174 {
 175         might_sleep();
 176         op_mode->ops->stop(op_mode);
 177 }
 178
 179 static inline int iwl_op_mode_rx(struct iwl_op_mode *op_mode,
 180                                   struct iwl_rx_cmd_buffer *rxb,
 181                                   struct iwl_device_cmd *cmd)
 182 {
 183         might_sleep();
 184         return op_mode->ops->rx(op_mode, rxb, cmd);
 185 }
 186
 187 static inline void iwl_op_mode_queue_full(struct iwl_op_mode *op_mode,
 188                                           int queue)
 189 {
 190         op_mode->ops->queue_full(op_mode, queue);
 191 }
 192
 193 static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode *op_mode,
 194                                               int queue)
 195 {
 196         op_mode->ops->queue_not_full(op_mode, queue);
 197 }
 198
 199 static inline bool __must_check
 200 iwl_op_mode_hw_rf_kill(struct iwl_op_mode *op_mode, bool state)
 201 {
 202         might_sleep();
 203         return op_mode->ops->hw_rf_kill(op_mode, state);
 204 }
 205
 206 static inline void iwl_op_mode_free_skb(struct iwl_op_mode *op_mode,
 207                                         struct sk_buff *skb)
 208 {
 209         op_mode->ops->free_skb(op_mode, skb);
 210 }
 211
 212 static inline void iwl_op_mode_nic_error(struct iwl_op_mode *op_mode)
 213 {
 214         op_mode->ops->nic_error(op_mode);
 215 }
 216
 217 static inline void iwl_op_mode_cmd_queue_full(struct iwl_op_mode *op_mode)
 218 {
 219         op_mode->ops->cmd_queue_full(op_mode);
 220 }
 221
 222 static inline void iwl_op_mode_nic_config(struct iwl_op_mode *op_mode)
 223 {
 224         might_sleep();
 225         op_mode->ops->nic_config(op_mode);
 226 }
 227
 228 static inline void iwl_op_mode_wimax_active(struct iwl_op_mode *op_mode)
 229 {
 230         might_sleep();
 231         op_mode->ops->wimax_active(op_mode);
 232 }
 233
 234 static inline int iwl_op_mode_enter_d0i3(struct iwl_op_mode *op_mode)
 235 {
 236         might_sleep();
 237
 238         if (!op_mode->ops->enter_d0i3)
 239                 return 0;
 240         return op_mode->ops->enter_d0i3(op_mode);
 241 }
 242
 243 static inline int iwl_op_mode_exit_d0i3(struct iwl_op_mode *op_mode)
 244 {
 245         might_sleep();
 246
 247         if (!op_mode->ops->exit_d0i3)
 248                 return 0;
 249         return op_mode->ops->exit_d0i3(op_mode);
 250 }
 251
 252 #endif /* __iwl_op_mode_h__ */