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