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 - 2012 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 LICENSE.GPL.
  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 - 2012 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 struct iwl_op_mode;
  67 struct iwl_trans;
  68 struct sk_buff;
  69 struct iwl_device_cmd;
  70 struct iwl_rx_cmd_buffer;
  71 struct iwl_fw;
  72
  73 /**
  74  * DOC: Operational mode - what is it ?
  75  *
  76  * The operational mode (a.k.a. op_mode) is the layer that implements
  77  * mac80211's handlers. It knows two APIs: mac80211's and the fw's. It uses
  78  * the transport API to access the HW. The op_mode doesn't need to know how the
  79  * underlying HW works, since the transport layer takes care of that.
  80  *
  81  * There can be several op_mode: i.e. different fw APIs will require two
  82  * different op_modes. This is why the op_mode is virtualized.
  83  */
  84
  85 /**
  86  * DOC: Life cycle of the Operational mode
  87  *
  88  * The operational mode has a very simple life cycle.
  89  *
  90  *      1) The driver layer (iwl-drv.c) chooses the op_mode based on the
  91  *         capabilities advertized by the fw file (in TLV format).
  92  *      2) The driver layer starts the op_mode (ops->start)
  93  *      3) The op_mode registers registers mac80211
  94  *      4) The op_mode is governed by mac80211
  95  *      5) The driver layer stops the op_mode
  96  */
  97
  98 /**
  99  * struct iwl_op_mode_ops - op_mode specific operations
 100  *
 101  * The op_mode exports its ops so that external components can start it and
 102  * interact with it. The driver layer typically calls the start and stop
 103  * handlers, the transport layer calls the others.
 104  *
 105  * All the handlers MUST be implemented
 106  *
 107  * @start: start the op_mode. The transport layer is already allocated.
 108  *      May sleep
 109  * @stop: stop the op_mode. Must free all the memory allocated.
 110  *      May sleep
 111  * @rx: Rx notification to the op_mode. rxb is the Rx buffer itself. Cmd is the
 112  *      HCMD the this Rx responds to.
 113  *      Must be atomic.
 114  * @queue_full: notifies that a HW queue is full. Ac is the ac of the queue
 115  *      Must be atomic
 116  * @queue_not_full: notifies that a HW queue is not full any more.
 117  *      Ac is the ac of the queue. Must be atomic
 118  * @hw_rf_kill:notifies of a change in the HW rf kill switch. True means that
 119  *      the radio is killed. Must be atomic.
 120  * @free_skb: allows the transport layer to free skbs that haven't been
 121  *      reclaimed by the op_mode. This can happen when the driver is freed and
 122  *      there are Tx packets pending in the transport layer.
 123  *      Must be atomic
 124  * @nic_error: error notification. Must be atomic
 125  * @cmd_queue_full: Called when the command queue gets full. Must be atomic.
 126  * @nic_config: configure NIC, called before firmware is started.
 127  *      May sleep
 128  */
 129 struct iwl_op_mode_ops {
 130         struct iwl_op_mode *(*start)(struct iwl_trans *trans,
 131                                      const struct iwl_fw *fw);
 132         void (*stop)(struct iwl_op_mode *op_mode);
 133         int (*rx)(struct iwl_op_mode *op_mode, struct iwl_rx_cmd_buffer *rxb,
 134                   struct iwl_device_cmd *cmd);
 135         void (*queue_full)(struct iwl_op_mode *op_mode, u8 ac);
 136         void (*queue_not_full)(struct iwl_op_mode *op_mode, u8 ac);
 137         void (*hw_rf_kill)(struct iwl_op_mode *op_mode, bool state);
 138         void (*free_skb)(struct iwl_op_mode *op_mode, struct sk_buff *skb);
 139         void (*nic_error)(struct iwl_op_mode *op_mode);
 140         void (*cmd_queue_full)(struct iwl_op_mode *op_mode);
 141         void (*nic_config)(struct iwl_op_mode *op_mode);
 142 };
 143
 144 /**
 145  * struct iwl_op_mode - operational mode
 146  *
 147  * This holds an implementation of the mac80211 / fw API.
 148  *
 149  * @ops - pointer to its own ops
 150  */
 151 struct iwl_op_mode {
 152         const struct iwl_op_mode_ops *ops;
 153         const struct iwl_trans *trans;
 154
 155         char op_mode_specific[0] __aligned(sizeof(void *));
 156 };
 157
 158 static inline void iwl_op_mode_stop(struct iwl_op_mode *op_mode)
 159 {
 160         might_sleep();
 161
 162         op_mode->ops->stop(op_mode);
 163 }
 164
 165 static inline int iwl_op_mode_rx(struct iwl_op_mode *op_mode,
 166                                   struct iwl_rx_cmd_buffer *rxb,
 167                                   struct iwl_device_cmd *cmd)
 168 {
 169         return op_mode->ops->rx(op_mode, rxb, cmd);
 170 }
 171
 172 static inline void iwl_op_mode_queue_full(struct iwl_op_mode *op_mode, u8 ac)
 173 {
 174         op_mode->ops->queue_full(op_mode, ac);
 175 }
 176
 177 static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode *op_mode,
 178                                               u8 ac)
 179 {
 180         op_mode->ops->queue_not_full(op_mode, ac);
 181 }
 182
 183 static inline void iwl_op_mode_hw_rf_kill(struct iwl_op_mode *op_mode,
 184                                           bool state)
 185 {
 186         op_mode->ops->hw_rf_kill(op_mode, state);
 187 }
 188
 189 static inline void iwl_op_mode_free_skb(struct iwl_op_mode *op_mode,
 190                                         struct sk_buff *skb)
 191 {
 192         op_mode->ops->free_skb(op_mode, skb);
 193 }
 194
 195 static inline void iwl_op_mode_nic_error(struct iwl_op_mode *op_mode)
 196 {
 197         op_mode->ops->nic_error(op_mode);
 198 }
 199
 200 static inline void iwl_op_mode_cmd_queue_full(struct iwl_op_mode *op_mode)
 201 {
 202         op_mode->ops->cmd_queue_full(op_mode);
 203 }
 204
 205 static inline void iwl_op_mode_nic_config(struct iwl_op_mode *op_mode)
 206 {
 207         might_sleep();
 208         op_mode->ops->nic_config(op_mode);
 209 }
 210
 211 /*****************************************************
 212 * Op mode layers implementations
 213 ******************************************************/
 214 extern const struct iwl_op_mode_ops iwl_dvm_ops;
 215
 216 #endif /* __iwl_op_mode_h__ */