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. |
8b4139dc | 9 | * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH |
d0f76d68 EG |
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 | |
410dc5aa | 26 | * in the file called COPYING. |
d0f76d68 EG |
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 | * | |
51368bf7 | 34 | * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved. |
8b4139dc | 35 | * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH |
d0f76d68 EG |
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 | ||
f14d6b39 | 68 | #include <linux/netdevice.h> |
97c79527 JB |
69 | #include <linux/debugfs.h> |
70 | ||
d0f76d68 EG |
71 | struct iwl_op_mode; |
72 | struct iwl_trans; | |
ed277c93 | 73 | struct sk_buff; |
db70f290 | 74 | struct iwl_device_cmd; |
48a2d66f | 75 | struct iwl_rx_cmd_buffer; |
0692fe41 | 76 | struct iwl_fw; |
a025ec3e | 77 | struct iwl_cfg; |
d0f76d68 | 78 | |
53476fe1 EG |
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 advertized by the fw file (in TLV format). | |
98 | * 2) The driver layer starts the op_mode (ops->start) | |
e89044d7 | 99 | * 3) The op_mode registers mac80211 |
53476fe1 EG |
100 | * 4) The op_mode is governed by mac80211 |
101 | * 5) The driver layer stops the op_mode | |
102 | */ | |
103 | ||
d0f76d68 EG |
104 | /** |
105 | * struct iwl_op_mode_ops - op_mode specific operations | |
106 | * | |
53476fe1 EG |
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 | * | |
d0f76d68 EG |
111 | * All the handlers MUST be implemented |
112 | * | |
53476fe1 | 113 | * @start: start the op_mode. The transport layer is already allocated. |
d0f76d68 | 114 | * May sleep |
53476fe1 | 115 | * @stop: stop the op_mode. Must free all the memory allocated. |
d0f76d68 | 116 | * May sleep |
db70f290 | 117 | * @rx: Rx notification to the op_mode. rxb is the Rx buffer itself. Cmd is the |
f14d6b39 JB |
118 | * HCMD this Rx responds to. Can't sleep. |
119 | * @napi_add: NAPI initialisation. 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. | |
9eae88fa | 123 | * @queue_full: notifies that a HW queue is full. |
901787c1 | 124 | * Must be atomic and called with BH disabled. |
02e38358 | 125 | * @queue_not_full: notifies that a HW queue is not full any more. |
901787c1 | 126 | * Must be atomic and called with BH disabled. |
7120d989 | 127 | * @hw_rf_kill:notifies of a change in the HW rf kill switch. True means that |
14cfca71 JB |
128 | * the radio is killed. Return %true if the device should be stopped by |
129 | * the transport immediately after the call. May sleep. | |
ed277c93 EG |
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 | |
901787c1 EG |
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. | |
ecdb975c JB |
138 | * @nic_config: configure NIC, called before firmware is started. |
139 | * May sleep | |
2bfb5092 | 140 | * @wimax_active: invoked when WiMax becomes active. May sleep |
b3370d47 EP |
141 | * @enter_d0i3: configure the fw to enter d0i3. May sleep. |
142 | * @exit_d0i3: configure the fw to exit d0i3. May sleep. | |
d0f76d68 EG |
143 | */ |
144 | struct iwl_op_mode_ops { | |
0692fe41 | 145 | struct iwl_op_mode *(*start)(struct iwl_trans *trans, |
2152268f | 146 | const struct iwl_cfg *cfg, |
9da987ac MV |
147 | const struct iwl_fw *fw, |
148 | struct dentry *dbgfs_dir); | |
d0f76d68 | 149 | void (*stop)(struct iwl_op_mode *op_mode); |
48a2d66f | 150 | int (*rx)(struct iwl_op_mode *op_mode, struct iwl_rx_cmd_buffer *rxb, |
db70f290 | 151 | struct iwl_device_cmd *cmd); |
f14d6b39 JB |
152 | void (*napi_add)(struct iwl_op_mode *op_mode, |
153 | struct napi_struct *napi, | |
154 | struct net_device *napi_dev, | |
155 | int (*poll)(struct napi_struct *, int), | |
156 | int weight); | |
9eae88fa JB |
157 | void (*queue_full)(struct iwl_op_mode *op_mode, int queue); |
158 | void (*queue_not_full)(struct iwl_op_mode *op_mode, int queue); | |
14cfca71 | 159 | bool (*hw_rf_kill)(struct iwl_op_mode *op_mode, bool state); |
ed277c93 | 160 | void (*free_skb)(struct iwl_op_mode *op_mode, struct sk_buff *skb); |
bcb9321c | 161 | void (*nic_error)(struct iwl_op_mode *op_mode); |
0e781842 | 162 | void (*cmd_queue_full)(struct iwl_op_mode *op_mode); |
ecdb975c | 163 | void (*nic_config)(struct iwl_op_mode *op_mode); |
8a8bbdb4 | 164 | void (*wimax_active)(struct iwl_op_mode *op_mode); |
b3370d47 EP |
165 | int (*enter_d0i3)(struct iwl_op_mode *op_mode); |
166 | int (*exit_d0i3)(struct iwl_op_mode *op_mode); | |
d0f76d68 EG |
167 | }; |
168 | ||
cc5f7e39 DF |
169 | int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops); |
170 | void iwl_opmode_deregister(const char *name); | |
171 | ||
d0f76d68 EG |
172 | /** |
173 | * struct iwl_op_mode - operational mode | |
09d95db2 | 174 | * @ops: pointer to its own ops |
d0f76d68 EG |
175 | * |
176 | * This holds an implementation of the mac80211 / fw API. | |
d0f76d68 EG |
177 | */ |
178 | struct iwl_op_mode { | |
179 | const struct iwl_op_mode_ops *ops; | |
d0f76d68 EG |
180 | |
181 | char op_mode_specific[0] __aligned(sizeof(void *)); | |
182 | }; | |
183 | ||
184 | static inline void iwl_op_mode_stop(struct iwl_op_mode *op_mode) | |
185 | { | |
53476fe1 | 186 | might_sleep(); |
d0f76d68 EG |
187 | op_mode->ops->stop(op_mode); |
188 | } | |
189 | ||
db70f290 | 190 | static inline int iwl_op_mode_rx(struct iwl_op_mode *op_mode, |
48a2d66f | 191 | struct iwl_rx_cmd_buffer *rxb, |
db70f290 EG |
192 | struct iwl_device_cmd *cmd) |
193 | { | |
194 | return op_mode->ops->rx(op_mode, rxb, cmd); | |
195 | } | |
196 | ||
9eae88fa JB |
197 | static inline void iwl_op_mode_queue_full(struct iwl_op_mode *op_mode, |
198 | int queue) | |
02e38358 | 199 | { |
9eae88fa | 200 | op_mode->ops->queue_full(op_mode, queue); |
02e38358 EG |
201 | } |
202 | ||
203 | static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode *op_mode, | |
9eae88fa | 204 | int queue) |
02e38358 | 205 | { |
9eae88fa | 206 | op_mode->ops->queue_not_full(op_mode, queue); |
02e38358 EG |
207 | } |
208 | ||
14cfca71 JB |
209 | static inline bool __must_check |
210 | iwl_op_mode_hw_rf_kill(struct iwl_op_mode *op_mode, bool state) | |
7120d989 | 211 | { |
2bfb5092 | 212 | might_sleep(); |
14cfca71 | 213 | return op_mode->ops->hw_rf_kill(op_mode, state); |
7120d989 EG |
214 | } |
215 | ||
ed277c93 EG |
216 | static inline void iwl_op_mode_free_skb(struct iwl_op_mode *op_mode, |
217 | struct sk_buff *skb) | |
218 | { | |
219 | op_mode->ops->free_skb(op_mode, skb); | |
220 | } | |
221 | ||
bcb9321c EG |
222 | static inline void iwl_op_mode_nic_error(struct iwl_op_mode *op_mode) |
223 | { | |
224 | op_mode->ops->nic_error(op_mode); | |
225 | } | |
226 | ||
0e781842 JB |
227 | static inline void iwl_op_mode_cmd_queue_full(struct iwl_op_mode *op_mode) |
228 | { | |
229 | op_mode->ops->cmd_queue_full(op_mode); | |
230 | } | |
231 | ||
ecdb975c JB |
232 | static inline void iwl_op_mode_nic_config(struct iwl_op_mode *op_mode) |
233 | { | |
234 | might_sleep(); | |
235 | op_mode->ops->nic_config(op_mode); | |
236 | } | |
237 | ||
8a8bbdb4 DF |
238 | static inline void iwl_op_mode_wimax_active(struct iwl_op_mode *op_mode) |
239 | { | |
2bfb5092 | 240 | might_sleep(); |
8a8bbdb4 DF |
241 | op_mode->ops->wimax_active(op_mode); |
242 | } | |
243 | ||
b3370d47 EP |
244 | static inline int iwl_op_mode_enter_d0i3(struct iwl_op_mode *op_mode) |
245 | { | |
246 | might_sleep(); | |
247 | ||
248 | if (!op_mode->ops->enter_d0i3) | |
249 | return 0; | |
250 | return op_mode->ops->enter_d0i3(op_mode); | |
251 | } | |
252 | ||
253 | static inline int iwl_op_mode_exit_d0i3(struct iwl_op_mode *op_mode) | |
254 | { | |
255 | might_sleep(); | |
256 | ||
257 | if (!op_mode->ops->exit_d0i3) | |
258 | return 0; | |
259 | return op_mode->ops->exit_d0i3(op_mode); | |
260 | } | |
261 | ||
f14d6b39 JB |
262 | static inline void iwl_op_mode_napi_add(struct iwl_op_mode *op_mode, |
263 | struct napi_struct *napi, | |
264 | struct net_device *napi_dev, | |
265 | int (*poll)(struct napi_struct *, int), | |
266 | int weight) | |
267 | { | |
268 | if (!op_mode->ops->napi_add) | |
269 | return; | |
270 | op_mode->ops->napi_add(op_mode, napi, napi_dev, poll, weight); | |
271 | } | |
272 | ||
d0f76d68 | 273 | #endif /* __iwl_op_mode_h__ */ |