Commit | Line | Data |
---|---|---|
d0f76d68 EG |
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 | * | |
51368bf7 | 8 | * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved. |
d0f76d68 EG |
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 | |
410dc5aa | 25 | * in the file called COPYING. |
d0f76d68 EG |
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 | * | |
51368bf7 | 33 | * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved. |
d0f76d68 EG |
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 | ||
f14d6b39 | 66 | #include <linux/netdevice.h> |
97c79527 JB |
67 | #include <linux/debugfs.h> |
68 | ||
d0f76d68 EG |
69 | struct iwl_op_mode; |
70 | struct iwl_trans; | |
ed277c93 | 71 | struct sk_buff; |
db70f290 | 72 | struct iwl_device_cmd; |
48a2d66f | 73 | struct iwl_rx_cmd_buffer; |
0692fe41 | 74 | struct iwl_fw; |
a025ec3e | 75 | struct iwl_cfg; |
d0f76d68 | 76 | |
53476fe1 EG |
77 | /** |
78 | * DOC: Operational mode - what is it ? | |
79 | * | |
80 | * The operational mode (a.k.a. op_mode) is the layer that implements | |
81 | * mac80211's handlers. It knows two APIs: mac80211's and the fw's. It uses | |
82 | * the transport API to access the HW. The op_mode doesn't need to know how the | |
83 | * underlying HW works, since the transport layer takes care of that. | |
84 | * | |
85 | * There can be several op_mode: i.e. different fw APIs will require two | |
86 | * different op_modes. This is why the op_mode is virtualized. | |
87 | */ | |
88 | ||
89 | /** | |
90 | * DOC: Life cycle of the Operational mode | |
91 | * | |
92 | * The operational mode has a very simple life cycle. | |
93 | * | |
94 | * 1) The driver layer (iwl-drv.c) chooses the op_mode based on the | |
95 | * capabilities advertized by the fw file (in TLV format). | |
96 | * 2) The driver layer starts the op_mode (ops->start) | |
e89044d7 | 97 | * 3) The op_mode registers mac80211 |
53476fe1 EG |
98 | * 4) The op_mode is governed by mac80211 |
99 | * 5) The driver layer stops the op_mode | |
100 | */ | |
101 | ||
d0f76d68 EG |
102 | /** |
103 | * struct iwl_op_mode_ops - op_mode specific operations | |
104 | * | |
53476fe1 EG |
105 | * The op_mode exports its ops so that external components can start it and |
106 | * interact with it. The driver layer typically calls the start and stop | |
107 | * handlers, the transport layer calls the others. | |
108 | * | |
d0f76d68 EG |
109 | * All the handlers MUST be implemented |
110 | * | |
53476fe1 | 111 | * @start: start the op_mode. The transport layer is already allocated. |
d0f76d68 | 112 | * May sleep |
53476fe1 | 113 | * @stop: stop the op_mode. Must free all the memory allocated. |
d0f76d68 | 114 | * May sleep |
db70f290 | 115 | * @rx: Rx notification to the op_mode. rxb is the Rx buffer itself. Cmd is the |
f14d6b39 JB |
116 | * HCMD this Rx responds to. Can't sleep. |
117 | * @napi_add: NAPI initialisation. The transport is fully responsible for NAPI, | |
118 | * but the higher layers need to know about it (in particular mac80211 to | |
119 | * to able to call the right NAPI RX functions); this function is needed | |
120 | * to eventually call netif_napi_add() with higher layer involvement. | |
9eae88fa | 121 | * @queue_full: notifies that a HW queue is full. |
901787c1 | 122 | * Must be atomic and called with BH disabled. |
02e38358 | 123 | * @queue_not_full: notifies that a HW queue is not full any more. |
901787c1 | 124 | * Must be atomic and called with BH disabled. |
7120d989 | 125 | * @hw_rf_kill:notifies of a change in the HW rf kill switch. True means that |
14cfca71 JB |
126 | * the radio is killed. Return %true if the device should be stopped by |
127 | * the transport immediately after the call. May sleep. | |
ed277c93 EG |
128 | * @free_skb: allows the transport layer to free skbs that haven't been |
129 | * reclaimed by the op_mode. This can happen when the driver is freed and | |
130 | * there are Tx packets pending in the transport layer. | |
131 | * Must be atomic | |
901787c1 EG |
132 | * @nic_error: error notification. Must be atomic and must be called with BH |
133 | * disabled. | |
134 | * @cmd_queue_full: Called when the command queue gets full. Must be atomic and | |
135 | * called with BH disabled. | |
ecdb975c JB |
136 | * @nic_config: configure NIC, called before firmware is started. |
137 | * May sleep | |
2bfb5092 | 138 | * @wimax_active: invoked when WiMax becomes active. May sleep |
b3370d47 EP |
139 | * @enter_d0i3: configure the fw to enter d0i3. May sleep. |
140 | * @exit_d0i3: configure the fw to exit d0i3. May sleep. | |
d0f76d68 EG |
141 | */ |
142 | struct iwl_op_mode_ops { | |
0692fe41 | 143 | struct iwl_op_mode *(*start)(struct iwl_trans *trans, |
2152268f | 144 | const struct iwl_cfg *cfg, |
9da987ac MV |
145 | const struct iwl_fw *fw, |
146 | struct dentry *dbgfs_dir); | |
d0f76d68 | 147 | void (*stop)(struct iwl_op_mode *op_mode); |
48a2d66f | 148 | int (*rx)(struct iwl_op_mode *op_mode, struct iwl_rx_cmd_buffer *rxb, |
db70f290 | 149 | struct iwl_device_cmd *cmd); |
f14d6b39 JB |
150 | void (*napi_add)(struct iwl_op_mode *op_mode, |
151 | struct napi_struct *napi, | |
152 | struct net_device *napi_dev, | |
153 | int (*poll)(struct napi_struct *, int), | |
154 | int weight); | |
9eae88fa JB |
155 | void (*queue_full)(struct iwl_op_mode *op_mode, int queue); |
156 | void (*queue_not_full)(struct iwl_op_mode *op_mode, int queue); | |
14cfca71 | 157 | bool (*hw_rf_kill)(struct iwl_op_mode *op_mode, bool state); |
ed277c93 | 158 | void (*free_skb)(struct iwl_op_mode *op_mode, struct sk_buff *skb); |
bcb9321c | 159 | void (*nic_error)(struct iwl_op_mode *op_mode); |
0e781842 | 160 | void (*cmd_queue_full)(struct iwl_op_mode *op_mode); |
ecdb975c | 161 | void (*nic_config)(struct iwl_op_mode *op_mode); |
8a8bbdb4 | 162 | void (*wimax_active)(struct iwl_op_mode *op_mode); |
b3370d47 EP |
163 | int (*enter_d0i3)(struct iwl_op_mode *op_mode); |
164 | int (*exit_d0i3)(struct iwl_op_mode *op_mode); | |
d0f76d68 EG |
165 | }; |
166 | ||
cc5f7e39 DF |
167 | int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops); |
168 | void iwl_opmode_deregister(const char *name); | |
169 | ||
d0f76d68 EG |
170 | /** |
171 | * struct iwl_op_mode - operational mode | |
09d95db2 | 172 | * @ops: pointer to its own ops |
d0f76d68 EG |
173 | * |
174 | * This holds an implementation of the mac80211 / fw API. | |
d0f76d68 EG |
175 | */ |
176 | struct iwl_op_mode { | |
177 | const struct iwl_op_mode_ops *ops; | |
d0f76d68 EG |
178 | |
179 | char op_mode_specific[0] __aligned(sizeof(void *)); | |
180 | }; | |
181 | ||
182 | static inline void iwl_op_mode_stop(struct iwl_op_mode *op_mode) | |
183 | { | |
53476fe1 | 184 | might_sleep(); |
d0f76d68 EG |
185 | op_mode->ops->stop(op_mode); |
186 | } | |
187 | ||
db70f290 | 188 | static inline int iwl_op_mode_rx(struct iwl_op_mode *op_mode, |
48a2d66f | 189 | struct iwl_rx_cmd_buffer *rxb, |
db70f290 EG |
190 | struct iwl_device_cmd *cmd) |
191 | { | |
192 | return op_mode->ops->rx(op_mode, rxb, cmd); | |
193 | } | |
194 | ||
9eae88fa JB |
195 | static inline void iwl_op_mode_queue_full(struct iwl_op_mode *op_mode, |
196 | int queue) | |
02e38358 | 197 | { |
9eae88fa | 198 | op_mode->ops->queue_full(op_mode, queue); |
02e38358 EG |
199 | } |
200 | ||
201 | static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode *op_mode, | |
9eae88fa | 202 | int queue) |
02e38358 | 203 | { |
9eae88fa | 204 | op_mode->ops->queue_not_full(op_mode, queue); |
02e38358 EG |
205 | } |
206 | ||
14cfca71 JB |
207 | static inline bool __must_check |
208 | iwl_op_mode_hw_rf_kill(struct iwl_op_mode *op_mode, bool state) | |
7120d989 | 209 | { |
2bfb5092 | 210 | might_sleep(); |
14cfca71 | 211 | return op_mode->ops->hw_rf_kill(op_mode, state); |
7120d989 EG |
212 | } |
213 | ||
ed277c93 EG |
214 | static inline void iwl_op_mode_free_skb(struct iwl_op_mode *op_mode, |
215 | struct sk_buff *skb) | |
216 | { | |
217 | op_mode->ops->free_skb(op_mode, skb); | |
218 | } | |
219 | ||
bcb9321c EG |
220 | static inline void iwl_op_mode_nic_error(struct iwl_op_mode *op_mode) |
221 | { | |
222 | op_mode->ops->nic_error(op_mode); | |
223 | } | |
224 | ||
0e781842 JB |
225 | static inline void iwl_op_mode_cmd_queue_full(struct iwl_op_mode *op_mode) |
226 | { | |
227 | op_mode->ops->cmd_queue_full(op_mode); | |
228 | } | |
229 | ||
ecdb975c JB |
230 | static inline void iwl_op_mode_nic_config(struct iwl_op_mode *op_mode) |
231 | { | |
232 | might_sleep(); | |
233 | op_mode->ops->nic_config(op_mode); | |
234 | } | |
235 | ||
8a8bbdb4 DF |
236 | static inline void iwl_op_mode_wimax_active(struct iwl_op_mode *op_mode) |
237 | { | |
2bfb5092 | 238 | might_sleep(); |
8a8bbdb4 DF |
239 | op_mode->ops->wimax_active(op_mode); |
240 | } | |
241 | ||
b3370d47 EP |
242 | static inline int iwl_op_mode_enter_d0i3(struct iwl_op_mode *op_mode) |
243 | { | |
244 | might_sleep(); | |
245 | ||
246 | if (!op_mode->ops->enter_d0i3) | |
247 | return 0; | |
248 | return op_mode->ops->enter_d0i3(op_mode); | |
249 | } | |
250 | ||
251 | static inline int iwl_op_mode_exit_d0i3(struct iwl_op_mode *op_mode) | |
252 | { | |
253 | might_sleep(); | |
254 | ||
255 | if (!op_mode->ops->exit_d0i3) | |
256 | return 0; | |
257 | return op_mode->ops->exit_d0i3(op_mode); | |
258 | } | |
259 | ||
f14d6b39 JB |
260 | static inline void iwl_op_mode_napi_add(struct iwl_op_mode *op_mode, |
261 | struct napi_struct *napi, | |
262 | struct net_device *napi_dev, | |
263 | int (*poll)(struct napi_struct *, int), | |
264 | int weight) | |
265 | { | |
266 | if (!op_mode->ops->napi_add) | |
267 | return; | |
268 | op_mode->ops->napi_add(op_mode, napi, napi_dev, poll, weight); | |
269 | } | |
270 | ||
d0f76d68 | 271 | #endif /* __iwl_op_mode_h__ */ |