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