Merge remote-tracking branch 'wireless-next/master' into iwlwifi-next
[linux-block.git] / drivers / net / wireless / iwlwifi / mvm / mvm.h
CommitLineData
8ca151b5
JB
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) 2012 - 2013 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
410dc5aa 25 * in the file called COPYING.
8ca151b5
JB
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) 2012 - 2013 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
64#ifndef __IWL_MVM_H__
65#define __IWL_MVM_H__
66
67#include <linux/list.h>
68#include <linux/spinlock.h>
69#include <linux/leds.h>
70#include <linux/in6.h>
71
72#include "iwl-op-mode.h"
73#include "iwl-trans.h"
74#include "iwl-notif-wait.h"
75#include "iwl-eeprom-parse.h"
76#include "iwl-test.h"
77#include "iwl-trans.h"
78#include "sta.h"
79#include "fw-api.h"
80
81#define IWL_INVALID_MAC80211_QUEUE 0xff
831e85f3 82#define IWL_MVM_MAX_ADDRESSES 5
8101a7f0
EG
83/* RSSI offset for WkP */
84#define IWL_RSSI_OFFSET 50
8ca151b5
JB
85
86enum iwl_mvm_tx_fifo {
87 IWL_MVM_TX_FIFO_BK = 0,
88 IWL_MVM_TX_FIFO_BE,
89 IWL_MVM_TX_FIFO_VI,
90 IWL_MVM_TX_FIFO_VO,
91};
92
8ca151b5
JB
93extern struct ieee80211_ops iwl_mvm_hw_ops;
94/**
95 * struct iwl_mvm_mod_params - module parameters for iwlmvm
96 * @init_dbg: if true, then the NIC won't be stopped if the INIT fw asserted.
97 * We will register to mac80211 to have testmode working. The NIC must not
98 * be up'ed after the INIT fw asserted. This is useful to be able to use
99 * proprietary tools over testmode to debug the INIT fw.
100 * @power_scheme: CAM(Continuous Active Mode)-1, BPS(Balanced Power
101 * Save)-2(default), LP(Low Power)-3
102 */
103struct iwl_mvm_mod_params {
104 bool init_dbg;
105 int power_scheme;
106};
107extern struct iwl_mvm_mod_params iwlmvm_mod_params;
108
109struct iwl_mvm_phy_ctxt {
110 u16 id;
111 u16 color;
112
113 /*
114 * TODO: This should probably be removed. Currently here only for rate
115 * scaling algorithm
116 */
117 struct ieee80211_channel *channel;
118};
119
120struct iwl_mvm_time_event_data {
121 struct ieee80211_vif *vif;
122 struct list_head list;
123 unsigned long end_jiffies;
124 u32 duration;
125 bool running;
126 u32 uid;
127
128 /*
129 * The access to the 'id' field must be done when the
130 * mvm->time_event_lock is held, as it value is used to indicate
131 * if the te is in the time event list or not (when id == TE_MAX)
132 */
133 u32 id;
134};
135
136 /* Power management */
137
138/**
139 * enum iwl_power_scheme
140 * @IWL_POWER_LEVEL_CAM - Continuously Active Mode
141 * @IWL_POWER_LEVEL_BPS - Balanced Power Save (default)
142 * @IWL_POWER_LEVEL_LP - Low Power
143 */
144enum iwl_power_scheme {
145 IWL_POWER_SCHEME_CAM = 1,
146 IWL_POWER_SCHEME_BPS,
147 IWL_POWER_SCHEME_LP
148};
149
150#define IWL_CONN_MAX_LISTEN_INTERVAL 70
151
152/**
153 * struct iwl_mvm_vif - data per Virtual Interface, it is a MAC context
154 * @id: between 0 and 3
155 * @color: to solve races upon MAC addition and removal
156 * @ap_sta_id: the sta_id of the AP - valid only if VIF type is STA
157 * @uploaded: indicates the MAC context has been added to the device
158 * @ap_active: indicates that ap context is configured, and that the interface
159 * should get quota etc.
1e1391ca
IP
160 * @monitor_active: indicates that monitor context is configured, and that the
161 * interface should get quota etc.
8ca151b5
JB
162 * @queue_params: QoS params for this MAC
163 * @bcast_sta: station used for broadcast packets. Used by the following
164 * vifs: P2P_DEVICE, GO and AP.
165 * @beacon_skb: the skb used to hold the AP/GO beacon template
166 */
167struct iwl_mvm_vif {
168 u16 id;
169 u16 color;
170 u8 ap_sta_id;
171
172 bool uploaded;
173 bool ap_active;
1e1391ca 174 bool monitor_active;
8ca151b5 175
506a81e6
JB
176 u32 ap_beacon_time;
177
8ca151b5
JB
178 enum iwl_tsf_id tsf_id;
179
180 /*
181 * QoS data from mac80211, need to store this here
182 * as mac80211 has a separate callback but we need
183 * to have the data for the MAC context
184 */
185 struct ieee80211_tx_queue_params queue_params[IEEE80211_NUM_ACS];
186 struct iwl_mvm_time_event_data time_event_data;
187
188 struct iwl_mvm_int_sta bcast_sta;
189
190 /*
191 * Assigned while mac80211 has the interface in a channel context,
192 * or, for P2P Device, while it exists.
193 */
194 struct iwl_mvm_phy_ctxt *phy_ctxt;
195
196#ifdef CONFIG_PM_SLEEP
197 /* WoWLAN GTK rekey data */
198 struct {
199 u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
200 __le64 replay_ctr;
201 bool valid;
202 } rekey_data;
203
204 int tx_key_idx;
205
206#if IS_ENABLED(CONFIG_IPV6)
207 /* IPv6 addresses for WoWLAN */
208 struct in6_addr target_ipv6_addrs[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS];
209 int num_target_ipv6_addrs;
210#endif
211#endif
212
213#ifdef CONFIG_IWLWIFI_DEBUGFS
214 struct dentry *dbgfs_dir;
215 void *dbgfs_data;
216#endif
217};
218
219static inline struct iwl_mvm_vif *
220iwl_mvm_vif_from_mac80211(struct ieee80211_vif *vif)
221{
222 return (void *)vif->drv_priv;
223}
224
225enum iwl_mvm_status {
226 IWL_MVM_STATUS_HW_RFKILL,
227 IWL_MVM_STATUS_ROC_RUNNING,
228 IWL_MVM_STATUS_IN_HW_RESTART,
229};
230
231enum iwl_scan_status {
232 IWL_MVM_SCAN_NONE,
233 IWL_MVM_SCAN_OS,
234};
235
236/**
237 * struct iwl_nvm_section - describes an NVM section in memory.
238 *
239 * This struct holds an NVM section read from the NIC using NVM_ACCESS_CMD,
240 * and saved for later use by the driver. Not all NVM sections are saved
241 * this way, only the needed ones.
242 */
243struct iwl_nvm_section {
244 u16 length;
245 const u8 *data;
246};
247
248struct iwl_mvm {
249 /* for logger access */
250 struct device *dev;
251
252 struct iwl_trans *trans;
253 const struct iwl_fw *fw;
254 const struct iwl_cfg *cfg;
255 struct iwl_phy_db *phy_db;
256 struct ieee80211_hw *hw;
257
258 /* for protecting access to iwl_mvm */
259 struct mutex mutex;
260 struct list_head async_handlers_list;
261 spinlock_t async_handlers_lock;
262 struct work_struct async_handlers_wk;
263
264 struct work_struct roc_done_wk;
265
266 unsigned long status;
267
268 enum iwl_ucode_type cur_ucode;
269 bool ucode_loaded;
270 bool init_ucode_run;
271 u32 error_event_table;
272 u32 log_event_table;
273
274 u32 ampdu_ref;
275
276 struct iwl_notif_wait_data notif_wait;
277
278 unsigned long transport_queue_stop;
279 u8 queue_to_mac80211[IWL_MAX_HW_QUEUES];
280 atomic_t queue_stop_count[IWL_MAX_HW_QUEUES];
281
282 struct iwl_nvm_data *nvm_data;
b9545b48 283 /* NVM sections */
8ca151b5
JB
284 struct iwl_nvm_section nvm_sections[NVM_NUM_OF_SECTIONS];
285
286 /* EEPROM MAC addresses */
287 struct mac_address addresses[IWL_MVM_MAX_ADDRESSES];
288
289 /* data related to data path */
290 struct iwl_rx_phy_info last_phy_info;
291 struct ieee80211_sta __rcu *fw_id_to_mac_id[IWL_MVM_STATION_COUNT];
292 struct work_struct sta_drained_wk;
293 unsigned long sta_drained[BITS_TO_LONGS(IWL_MVM_STATION_COUNT)];
294
295 /* configured by mac80211 */
296 u32 rts_threshold;
297
298 /* Scan status, cmd (pre-allocated) and auxiliary station */
299 enum iwl_scan_status scan_status;
300 struct iwl_scan_cmd *scan_cmd;
301
302 /* Internal station */
303 struct iwl_mvm_int_sta aux_sta;
304
305 u8 scan_last_antenna_idx; /* to toggle TX between antennas */
306 u8 mgmt_last_antenna_idx;
307
308#ifdef CONFIG_IWLWIFI_DEBUGFS
309 struct dentry *debugfs_dir;
310 u32 dbgfs_sram_offset, dbgfs_sram_len;
311 bool prevent_power_down_d3;
312#endif
313
314 struct iwl_mvm_phy_ctxt phy_ctxt_roc;
315
316 struct list_head time_event_list;
317 spinlock_t time_event_lock;
318
319 /*
320 * A bitmap indicating the index of the key in use. The firmware
321 * can hold 16 keys at most. Reflect this fact.
322 */
323 unsigned long fw_key_table[BITS_TO_LONGS(STA_KEY_MAX_NUM)];
324 u8 vif_count;
325
326 struct led_classdev led;
327
328 struct ieee80211_vif *p2p_device_vif;
f444eb10
JB
329
330#ifdef CONFIG_PM_SLEEP
331 int gtk_ivlen, gtk_icvlen, ptk_ivlen, ptk_icvlen;
332#endif
f421f9c3
EG
333
334 /* BT-Coex */
335 u8 bt_kill_msk;
10942342 336 struct iwl_bt_coex_profile_notif last_bt_notif;
8ca151b5
JB
337};
338
339/* Extract MVM priv from op_mode and _hw */
340#define IWL_OP_MODE_GET_MVM(_iwl_op_mode) \
341 ((struct iwl_mvm *)(_iwl_op_mode)->op_mode_specific)
342
343#define IWL_MAC80211_GET_MVM(_hw) \
344 IWL_OP_MODE_GET_MVM((struct iwl_op_mode *)((_hw)->priv))
345
346extern const u8 iwl_mvm_ac_to_tx_fifo[];
347
348struct iwl_rate_info {
349 u8 plcp; /* uCode API: IWL_RATE_6M_PLCP, etc. */
350 u8 plcp_siso; /* uCode API: IWL_RATE_SISO_6M_PLCP, etc. */
351 u8 plcp_mimo2; /* uCode API: IWL_RATE_MIMO2_6M_PLCP, etc. */
352 u8 plcp_mimo3; /* uCode API: IWL_RATE_MIMO3_6M_PLCP, etc. */
353 u8 ieee; /* MAC header: IWL_RATE_6M_IEEE, etc. */
354};
355
356/******************
357 * MVM Methods
358 ******************/
359/* uCode */
360int iwl_run_init_mvm_ucode(struct iwl_mvm *mvm, bool read_nvm);
361
362/* Utils */
363int iwl_mvm_legacy_rate_to_mac80211_idx(u32 rate_n_flags,
364 enum ieee80211_band band);
365u8 iwl_mvm_mac80211_idx_to_hwrate(int rate_idx);
366void iwl_mvm_dump_nic_error_log(struct iwl_mvm *mvm);
367u8 first_antenna(u8 mask);
368u8 iwl_mvm_next_antenna(struct iwl_mvm *mvm, u8 valid, u8 last_idx);
369
370/* Tx / Host Commands */
371int __must_check iwl_mvm_send_cmd(struct iwl_mvm *mvm,
372 struct iwl_host_cmd *cmd);
373int __must_check iwl_mvm_send_cmd_pdu(struct iwl_mvm *mvm, u8 id,
374 u32 flags, u16 len, const void *data);
375int __must_check iwl_mvm_send_cmd_status(struct iwl_mvm *mvm,
376 struct iwl_host_cmd *cmd,
377 u32 *status);
378int __must_check iwl_mvm_send_cmd_pdu_status(struct iwl_mvm *mvm, u8 id,
379 u16 len, const void *data,
380 u32 *status);
381int iwl_mvm_tx_skb(struct iwl_mvm *mvm, struct sk_buff *skb,
382 struct ieee80211_sta *sta);
383int iwl_mvm_tx_skb_non_sta(struct iwl_mvm *mvm, struct sk_buff *skb);
384#ifdef CONFIG_IWLWIFI_DEBUG
385const char *iwl_mvm_get_tx_fail_reason(u32 status);
386#else
387static inline const char *iwl_mvm_get_tx_fail_reason(u32 status) { return ""; }
388#endif
389int iwl_mvm_flush_tx_path(struct iwl_mvm *mvm, u32 tfd_msk, bool sync);
390void iwl_mvm_async_handlers_purge(struct iwl_mvm *mvm);
391
392/* Statistics */
393int iwl_mvm_rx_reply_statistics(struct iwl_mvm *mvm,
394 struct iwl_rx_cmd_buffer *rxb,
395 struct iwl_device_cmd *cmd);
396int iwl_mvm_rx_statistics(struct iwl_mvm *mvm,
397 struct iwl_rx_cmd_buffer *rxb,
398 struct iwl_device_cmd *cmd);
399
400/* NVM */
401int iwl_nvm_init(struct iwl_mvm *mvm);
402
403int iwl_mvm_up(struct iwl_mvm *mvm);
404int iwl_mvm_load_d3_fw(struct iwl_mvm *mvm);
405
406int iwl_mvm_mac_setup_register(struct iwl_mvm *mvm);
407
408/*
409 * FW notifications / CMD responses handlers
410 * Convention: iwl_mvm_rx_<NAME OF THE CMD>
411 */
412int iwl_mvm_rx_rx_phy_cmd(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
413 struct iwl_device_cmd *cmd);
414int iwl_mvm_rx_rx_mpdu(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
415 struct iwl_device_cmd *cmd);
416int iwl_mvm_rx_tx_cmd(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
417 struct iwl_device_cmd *cmd);
418int iwl_mvm_rx_ba_notif(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
419 struct iwl_device_cmd *cmd);
420int iwl_mvm_rx_radio_ver(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
421 struct iwl_device_cmd *cmd);
422int iwl_mvm_rx_fw_error(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
423 struct iwl_device_cmd *cmd);
424int iwl_mvm_rx_card_state_notif(struct iwl_mvm *mvm,
425 struct iwl_rx_cmd_buffer *rxb,
426 struct iwl_device_cmd *cmd);
427int iwl_mvm_rx_radio_ver(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
428 struct iwl_device_cmd *cmd);
429
430/* MVM PHY */
431int iwl_mvm_phy_ctxt_add(struct iwl_mvm *mvm, struct iwl_mvm_phy_ctxt *ctxt,
432 struct cfg80211_chan_def *chandef,
433 u8 chains_static, u8 chains_dynamic);
434int iwl_mvm_phy_ctxt_changed(struct iwl_mvm *mvm, struct iwl_mvm_phy_ctxt *ctxt,
435 struct cfg80211_chan_def *chandef,
436 u8 chains_static, u8 chains_dynamic);
437void iwl_mvm_phy_ctxt_remove(struct iwl_mvm *mvm,
438 struct iwl_mvm_phy_ctxt *ctxt);
439
440/* MAC (virtual interface) programming */
441int iwl_mvm_mac_ctxt_init(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
442void iwl_mvm_mac_ctxt_release(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
443int iwl_mvm_mac_ctxt_add(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
444int iwl_mvm_mac_ctxt_changed(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
445int iwl_mvm_mac_ctxt_remove(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
446u32 iwl_mvm_mac_get_queues_mask(struct iwl_mvm *mvm,
447 struct ieee80211_vif *vif);
448int iwl_mvm_mac_ctxt_beacon_changed(struct iwl_mvm *mvm,
449 struct ieee80211_vif *vif);
571765c8
IP
450int iwl_mvm_rx_beacon_notif(struct iwl_mvm *mvm,
451 struct iwl_rx_cmd_buffer *rxb,
452 struct iwl_device_cmd *cmd);
8ca151b5
JB
453
454/* Bindings */
455int iwl_mvm_binding_add_vif(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
456int iwl_mvm_binding_remove_vif(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
457
458/* Quota management */
459int iwl_mvm_update_quotas(struct iwl_mvm *mvm, struct ieee80211_vif *newvif);
460
461/* Scanning */
462int iwl_mvm_scan_request(struct iwl_mvm *mvm,
463 struct ieee80211_vif *vif,
464 struct cfg80211_scan_request *req);
465int iwl_mvm_rx_scan_response(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
466 struct iwl_device_cmd *cmd);
467int iwl_mvm_rx_scan_complete(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
468 struct iwl_device_cmd *cmd);
469void iwl_mvm_cancel_scan(struct iwl_mvm *mvm);
470
471/* MVM debugfs */
472#ifdef CONFIG_IWLWIFI_DEBUGFS
473int iwl_mvm_dbgfs_register(struct iwl_mvm *mvm, struct dentry *dbgfs_dir);
474int iwl_mvm_vif_dbgfs_register(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
475 struct dentry *dbgfs_dir);
476void iwl_power_get_params(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
477 struct iwl_powertable_cmd *cmd);
478#else
479static inline int iwl_mvm_dbgfs_register(struct iwl_mvm *mvm,
480 struct dentry *dbgfs_dir)
481{
482 return 0;
483}
484#endif /* CONFIG_IWLWIFI_DEBUGFS */
485
486/* rate scaling */
487int iwl_mvm_send_lq_cmd(struct iwl_mvm *mvm, struct iwl_lq_cmd *lq,
488 u8 flags, bool init);
489
490/* power managment */
491int iwl_mvm_power_update_mode(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
492int iwl_mvm_power_disable(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
493
494int iwl_mvm_leds_init(struct iwl_mvm *mvm);
495void iwl_mvm_leds_exit(struct iwl_mvm *mvm);
496
497/* D3 (WoWLAN, NetDetect) */
498int iwl_mvm_suspend(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
499int iwl_mvm_resume(struct ieee80211_hw *hw);
500void iwl_mvm_set_wakeup(struct ieee80211_hw *hw, bool enabled);
501void iwl_mvm_set_rekey_data(struct ieee80211_hw *hw,
502 struct ieee80211_vif *vif,
503 struct cfg80211_gtk_rekey_data *data);
504void iwl_mvm_ipv6_addr_change(struct ieee80211_hw *hw,
505 struct ieee80211_vif *vif,
506 struct inet6_dev *idev);
507void iwl_mvm_set_default_unicast_key(struct ieee80211_hw *hw,
508 struct ieee80211_vif *vif, int idx);
509
931d4160
EG
510/* BT Coex */
511int iwl_send_bt_prio_tbl(struct iwl_mvm *mvm);
512int iwl_send_bt_init_conf(struct iwl_mvm *mvm);
f421f9c3
EG
513int iwl_mvm_rx_bt_coex_notif(struct iwl_mvm *mvm,
514 struct iwl_rx_cmd_buffer *rxb,
515 struct iwl_device_cmd *cmd);
931d4160 516
8ca151b5 517#endif /* __IWL_MVM_H__ */