]> Pileus Git - ~andy/linux/blob - drivers/net/wireless/iwlwifi/mvm/fw-api-sta.h
Merge tag 'fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/arm...
[~andy/linux] / drivers / net / wireless / iwlwifi / mvm / fw-api-sta.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 - 2014 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 COPYING.
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 - 2014 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 #ifndef __fw_api_sta_h__
64 #define __fw_api_sta_h__
65
66 /**
67  * enum iwl_sta_flags - flags for the ADD_STA host command
68  * @STA_FLG_REDUCED_TX_PWR_CTRL:
69  * @STA_FLG_REDUCED_TX_PWR_DATA:
70  * @STA_FLG_FLG_ANT_MSK: Antenna selection
71  * @STA_FLG_PS: set if STA is in Power Save
72  * @STA_FLG_INVALID: set if STA is invalid
73  * @STA_FLG_DLP_EN: Direct Link Protocol is enabled
74  * @STA_FLG_SET_ALL_KEYS: the current key applies to all key IDs
75  * @STA_FLG_DRAIN_FLOW: drain flow
76  * @STA_FLG_PAN: STA is for PAN interface
77  * @STA_FLG_CLASS_AUTH:
78  * @STA_FLG_CLASS_ASSOC:
79  * @STA_FLG_CLASS_MIMO_PROT:
80  * @STA_FLG_MAX_AGG_SIZE_MSK: maximal size for A-MPDU
81  * @STA_FLG_AGG_MPDU_DENS_MSK: maximal MPDU density for Tx aggregation
82  * @STA_FLG_FAT_EN_MSK: support for channel width (for Tx). This flag is
83  *      initialised by driver and can be updated by fw upon reception of
84  *      action frames that can change the channel width. When cleared the fw
85  *      will send all the frames in 20MHz even when FAT channel is requested.
86  * @STA_FLG_MIMO_EN_MSK: support for MIMO. This flag is initialised by the
87  *      driver and can be updated by fw upon reception of action frames.
88  * @STA_FLG_MFP_EN: Management Frame Protection
89  */
90 enum iwl_sta_flags {
91         STA_FLG_REDUCED_TX_PWR_CTRL     = BIT(3),
92         STA_FLG_REDUCED_TX_PWR_DATA     = BIT(6),
93
94         STA_FLG_FLG_ANT_A               = (1 << 4),
95         STA_FLG_FLG_ANT_B               = (2 << 4),
96         STA_FLG_FLG_ANT_MSK             = (STA_FLG_FLG_ANT_A |
97                                            STA_FLG_FLG_ANT_B),
98
99         STA_FLG_PS                      = BIT(8),
100         STA_FLG_DRAIN_FLOW              = BIT(12),
101         STA_FLG_PAN                     = BIT(13),
102         STA_FLG_CLASS_AUTH              = BIT(14),
103         STA_FLG_CLASS_ASSOC             = BIT(15),
104         STA_FLG_RTS_MIMO_PROT           = BIT(17),
105
106         STA_FLG_MAX_AGG_SIZE_SHIFT      = 19,
107         STA_FLG_MAX_AGG_SIZE_8K         = (0 << STA_FLG_MAX_AGG_SIZE_SHIFT),
108         STA_FLG_MAX_AGG_SIZE_16K        = (1 << STA_FLG_MAX_AGG_SIZE_SHIFT),
109         STA_FLG_MAX_AGG_SIZE_32K        = (2 << STA_FLG_MAX_AGG_SIZE_SHIFT),
110         STA_FLG_MAX_AGG_SIZE_64K        = (3 << STA_FLG_MAX_AGG_SIZE_SHIFT),
111         STA_FLG_MAX_AGG_SIZE_128K       = (4 << STA_FLG_MAX_AGG_SIZE_SHIFT),
112         STA_FLG_MAX_AGG_SIZE_256K       = (5 << STA_FLG_MAX_AGG_SIZE_SHIFT),
113         STA_FLG_MAX_AGG_SIZE_512K       = (6 << STA_FLG_MAX_AGG_SIZE_SHIFT),
114         STA_FLG_MAX_AGG_SIZE_1024K      = (7 << STA_FLG_MAX_AGG_SIZE_SHIFT),
115         STA_FLG_MAX_AGG_SIZE_MSK        = (7 << STA_FLG_MAX_AGG_SIZE_SHIFT),
116
117         STA_FLG_AGG_MPDU_DENS_SHIFT     = 23,
118         STA_FLG_AGG_MPDU_DENS_2US       = (4 << STA_FLG_AGG_MPDU_DENS_SHIFT),
119         STA_FLG_AGG_MPDU_DENS_4US       = (5 << STA_FLG_AGG_MPDU_DENS_SHIFT),
120         STA_FLG_AGG_MPDU_DENS_8US       = (6 << STA_FLG_AGG_MPDU_DENS_SHIFT),
121         STA_FLG_AGG_MPDU_DENS_16US      = (7 << STA_FLG_AGG_MPDU_DENS_SHIFT),
122         STA_FLG_AGG_MPDU_DENS_MSK       = (7 << STA_FLG_AGG_MPDU_DENS_SHIFT),
123
124         STA_FLG_FAT_EN_20MHZ            = (0 << 26),
125         STA_FLG_FAT_EN_40MHZ            = (1 << 26),
126         STA_FLG_FAT_EN_80MHZ            = (2 << 26),
127         STA_FLG_FAT_EN_160MHZ           = (3 << 26),
128         STA_FLG_FAT_EN_MSK              = (3 << 26),
129
130         STA_FLG_MIMO_EN_SISO            = (0 << 28),
131         STA_FLG_MIMO_EN_MIMO2           = (1 << 28),
132         STA_FLG_MIMO_EN_MIMO3           = (2 << 28),
133         STA_FLG_MIMO_EN_MSK             = (3 << 28),
134 };
135
136 /**
137  * enum iwl_sta_key_flag - key flags for the ADD_STA host command
138  * @STA_KEY_FLG_NO_ENC: no encryption
139  * @STA_KEY_FLG_WEP: WEP encryption algorithm
140  * @STA_KEY_FLG_CCM: CCMP encryption algorithm
141  * @STA_KEY_FLG_TKIP: TKIP encryption algorithm
142  * @STA_KEY_FLG_EXT: extended cipher algorithm (depends on the FW support)
143  * @STA_KEY_FLG_CMAC: CMAC encryption algorithm
144  * @STA_KEY_FLG_ENC_UNKNOWN: unknown encryption algorithm
145  * @STA_KEY_FLG_EN_MSK: mask for encryption algorithmi value
146  * @STA_KEY_FLG_WEP_KEY_MAP: wep is either a group key (0 - legacy WEP) or from
147  *      station info array (1 - n 1X mode)
148  * @STA_KEY_FLG_KEYID_MSK: the index of the key
149  * @STA_KEY_NOT_VALID: key is invalid
150  * @STA_KEY_FLG_WEP_13BYTES: set for 13 bytes WEP key
151  * @STA_KEY_MULTICAST: set for multical key
152  * @STA_KEY_MFP: key is used for Management Frame Protection
153  */
154 enum iwl_sta_key_flag {
155         STA_KEY_FLG_NO_ENC              = (0 << 0),
156         STA_KEY_FLG_WEP                 = (1 << 0),
157         STA_KEY_FLG_CCM                 = (2 << 0),
158         STA_KEY_FLG_TKIP                = (3 << 0),
159         STA_KEY_FLG_EXT                 = (4 << 0),
160         STA_KEY_FLG_CMAC                = (6 << 0),
161         STA_KEY_FLG_ENC_UNKNOWN         = (7 << 0),
162         STA_KEY_FLG_EN_MSK              = (7 << 0),
163
164         STA_KEY_FLG_WEP_KEY_MAP         = BIT(3),
165         STA_KEY_FLG_KEYID_POS            = 8,
166         STA_KEY_FLG_KEYID_MSK           = (3 << STA_KEY_FLG_KEYID_POS),
167         STA_KEY_NOT_VALID               = BIT(11),
168         STA_KEY_FLG_WEP_13BYTES         = BIT(12),
169         STA_KEY_MULTICAST               = BIT(14),
170         STA_KEY_MFP                     = BIT(15),
171 };
172
173 /**
174  * enum iwl_sta_modify_flag - indicate to the fw what flag are being changed
175  * @STA_MODIFY_KEY: this command modifies %key
176  * @STA_MODIFY_TID_DISABLE_TX: this command modifies %tid_disable_tx
177  * @STA_MODIFY_TX_RATE: unused
178  * @STA_MODIFY_ADD_BA_TID: this command modifies %add_immediate_ba_tid
179  * @STA_MODIFY_REMOVE_BA_TID: this command modifies %remove_immediate_ba_tid
180  * @STA_MODIFY_SLEEPING_STA_TX_COUNT: this command modifies %sleep_tx_count
181  * @STA_MODIFY_PROT_TH:
182  * @STA_MODIFY_QUEUES: modify the queues used by this station
183  */
184 enum iwl_sta_modify_flag {
185         STA_MODIFY_KEY                          = BIT(0),
186         STA_MODIFY_TID_DISABLE_TX               = BIT(1),
187         STA_MODIFY_TX_RATE                      = BIT(2),
188         STA_MODIFY_ADD_BA_TID                   = BIT(3),
189         STA_MODIFY_REMOVE_BA_TID                = BIT(4),
190         STA_MODIFY_SLEEPING_STA_TX_COUNT        = BIT(5),
191         STA_MODIFY_PROT_TH                      = BIT(6),
192         STA_MODIFY_QUEUES                       = BIT(7),
193 };
194
195 #define STA_MODE_MODIFY 1
196
197 /**
198  * enum iwl_sta_sleep_flag - type of sleep of the station
199  * @STA_SLEEP_STATE_AWAKE:
200  * @STA_SLEEP_STATE_PS_POLL:
201  * @STA_SLEEP_STATE_UAPSD:
202  */
203 enum iwl_sta_sleep_flag {
204         STA_SLEEP_STATE_AWAKE   = 0,
205         STA_SLEEP_STATE_PS_POLL = BIT(0),
206         STA_SLEEP_STATE_UAPSD   = BIT(1),
207 };
208
209 /* STA ID and color bits definitions */
210 #define STA_ID_SEED             (0x0f)
211 #define STA_ID_POS              (0)
212 #define STA_ID_MSK              (STA_ID_SEED << STA_ID_POS)
213
214 #define STA_COLOR_SEED          (0x7)
215 #define STA_COLOR_POS           (4)
216 #define STA_COLOR_MSK           (STA_COLOR_SEED << STA_COLOR_POS)
217
218 #define STA_ID_N_COLOR_GET_COLOR(id_n_color) \
219         (((id_n_color) & STA_COLOR_MSK) >> STA_COLOR_POS)
220 #define STA_ID_N_COLOR_GET_ID(id_n_color)    \
221         (((id_n_color) & STA_ID_MSK) >> STA_ID_POS)
222
223 #define STA_KEY_MAX_NUM (16)
224 #define STA_KEY_IDX_INVALID (0xff)
225 #define STA_KEY_MAX_DATA_KEY_NUM (4)
226 #define IWL_MAX_GLOBAL_KEYS (4)
227 #define STA_KEY_LEN_WEP40 (5)
228 #define STA_KEY_LEN_WEP104 (13)
229
230 /**
231  * struct iwl_mvm_keyinfo - key information
232  * @key_flags: type %iwl_sta_key_flag
233  * @tkip_rx_tsc_byte2: TSC[2] for key mix ph1 detection
234  * @tkip_rx_ttak: 10-byte unicast TKIP TTAK for Rx
235  * @key_offset: key offset in the fw's key table
236  * @key: 16-byte unicast decryption key
237  * @tx_secur_seq_cnt: initial RSC / PN needed for replay check
238  * @hw_tkip_mic_rx_key: byte: MIC Rx Key - used for TKIP only
239  * @hw_tkip_mic_tx_key: byte: MIC Tx Key - used for TKIP only
240  */
241 struct iwl_mvm_keyinfo {
242         __le16 key_flags;
243         u8 tkip_rx_tsc_byte2;
244         u8 reserved1;
245         __le16 tkip_rx_ttak[5];
246         u8 key_offset;
247         u8 reserved2;
248         u8 key[16];
249         __le64 tx_secur_seq_cnt;
250         __le64 hw_tkip_mic_rx_key;
251         __le64 hw_tkip_mic_tx_key;
252 } __packed;
253
254 /**
255  * struct iwl_mvm_add_sta_cmd_v5 - Add/modify a station in the fw's sta table.
256  * ( REPLY_ADD_STA = 0x18 )
257  * @add_modify: 1: modify existing, 0: add new station
258  * @unicast_tx_key_id: unicast tx key id. Relevant only when unicast key sent
259  * @multicast_tx_key_id: multicast tx key id. Relevant only when multicast key
260  *      sent
261  * @mac_id_n_color: the Mac context this station belongs to
262  * @addr[ETH_ALEN]: station's MAC address
263  * @sta_id: index of station in uCode's station table
264  * @modify_mask: STA_MODIFY_*, selects which parameters to modify vs. leave
265  *      alone. 1 - modify, 0 - don't change.
266  * @key: look at %iwl_mvm_keyinfo
267  * @station_flags: look at %iwl_sta_flags
268  * @station_flags_msk: what of %station_flags have changed
269  * @tid_disable_tx: is tid BIT(tid) enabled for Tx. Clear BIT(x) to enable
270  *      AMPDU for tid x. Set %STA_MODIFY_TID_DISABLE_TX to change this field.
271  * @add_immediate_ba_tid: tid for which to add block-ack support (Rx)
272  *      Set %STA_MODIFY_ADD_BA_TID to use this field, and also set
273  *      add_immediate_ba_ssn.
274  * @remove_immediate_ba_tid: tid for which to remove block-ack support (Rx)
275  *      Set %STA_MODIFY_REMOVE_BA_TID to use this field
276  * @add_immediate_ba_ssn: ssn for the Rx block-ack session. Used together with
277  *      add_immediate_ba_tid.
278  * @sleep_tx_count: number of packets to transmit to station even though it is
279  *      asleep. Used to synchronise PS-poll and u-APSD responses while ucode
280  *      keeps track of STA sleep state.
281  * @sleep_state_flags: Look at %iwl_sta_sleep_flag.
282  * @assoc_id: assoc_id to be sent in VHT PLCP (9-bit), for grp use 0, for AP
283  *      mac-addr.
284  * @beamform_flags: beam forming controls
285  * @tfd_queue_msk: tfd queues used by this station
286  *
287  * The device contains an internal table of per-station information, with info
288  * on security keys, aggregation parameters, and Tx rates for initial Tx
289  * attempt and any retries (set by REPLY_TX_LINK_QUALITY_CMD).
290  *
291  * ADD_STA sets up the table entry for one station, either creating a new
292  * entry, or modifying a pre-existing one.
293  */
294 struct iwl_mvm_add_sta_cmd_v5 {
295         u8 add_modify;
296         u8 unicast_tx_key_id;
297         u8 multicast_tx_key_id;
298         u8 reserved1;
299         __le32 mac_id_n_color;
300         u8 addr[ETH_ALEN];
301         __le16 reserved2;
302         u8 sta_id;
303         u8 modify_mask;
304         __le16 reserved3;
305         struct iwl_mvm_keyinfo key;
306         __le32 station_flags;
307         __le32 station_flags_msk;
308         __le16 tid_disable_tx;
309         __le16 reserved4;
310         u8 add_immediate_ba_tid;
311         u8 remove_immediate_ba_tid;
312         __le16 add_immediate_ba_ssn;
313         __le16 sleep_tx_count;
314         __le16 sleep_state_flags;
315         __le16 assoc_id;
316         __le16 beamform_flags;
317         __le32 tfd_queue_msk;
318 } __packed; /* ADD_STA_CMD_API_S_VER_5 */
319
320 /**
321  * struct iwl_mvm_add_sta_cmd_v6 - Add / modify a station
322  * VER_6 of this command is quite similar to VER_5 except
323  * exclusion of all fields related to the security key installation.
324  */
325 struct iwl_mvm_add_sta_cmd_v6 {
326         u8 add_modify;
327         u8 reserved1;
328         __le16 tid_disable_tx;
329         __le32 mac_id_n_color;
330         u8 addr[ETH_ALEN];      /* _STA_ID_MODIFY_INFO_API_S_VER_1 */
331         __le16 reserved2;
332         u8 sta_id;
333         u8 modify_mask;
334         __le16 reserved3;
335         __le32 station_flags;
336         __le32 station_flags_msk;
337         u8 add_immediate_ba_tid;
338         u8 remove_immediate_ba_tid;
339         __le16 add_immediate_ba_ssn;
340         __le16 sleep_tx_count;
341         __le16 sleep_state_flags;
342         __le16 assoc_id;
343         __le16 beamform_flags;
344         __le32 tfd_queue_msk;
345 } __packed; /* ADD_STA_CMD_API_S_VER_6 */
346
347 /**
348  * struct iwl_mvm_add_sta_key_cmd - add/modify sta key
349  * ( REPLY_ADD_STA_KEY = 0x17 )
350  * @sta_id: index of station in uCode's station table
351  * @key_offset: key offset in key storage
352  * @key_flags: type %iwl_sta_key_flag
353  * @key: key material data
354  * @key2: key material data
355  * @rx_secur_seq_cnt: RX security sequence counter for the key
356  * @tkip_rx_tsc_byte2: TSC[2] for key mix ph1 detection
357  * @tkip_rx_ttak: 10-byte unicast TKIP TTAK for Rx
358  */
359 struct iwl_mvm_add_sta_key_cmd {
360         u8 sta_id;
361         u8 key_offset;
362         __le16 key_flags;
363         u8 key[16];
364         u8 key2[16];
365         u8 rx_secur_seq_cnt[16];
366         u8 tkip_rx_tsc_byte2;
367         u8 reserved;
368         __le16 tkip_rx_ttak[5];
369 } __packed; /* ADD_MODIFY_STA_KEY_API_S_VER_1 */
370
371 /**
372  * enum iwl_mvm_add_sta_rsp_status - status in the response to ADD_STA command
373  * @ADD_STA_SUCCESS: operation was executed successfully
374  * @ADD_STA_STATIONS_OVERLOAD: no room left in the fw's station table
375  * @ADD_STA_IMMEDIATE_BA_FAILURE: can't add Rx block ack session
376  * @ADD_STA_MODIFY_NON_EXISTING_STA: driver requested to modify a station that
377  *      doesn't exist.
378  */
379 enum iwl_mvm_add_sta_rsp_status {
380         ADD_STA_SUCCESS                 = 0x1,
381         ADD_STA_STATIONS_OVERLOAD       = 0x2,
382         ADD_STA_IMMEDIATE_BA_FAILURE    = 0x4,
383         ADD_STA_MODIFY_NON_EXISTING_STA = 0x8,
384 };
385
386 /**
387  * struct iwl_mvm_rm_sta_cmd - Add / modify a station in the fw's station table
388  * ( REMOVE_STA = 0x19 )
389  * @sta_id: the station id of the station to be removed
390  */
391 struct iwl_mvm_rm_sta_cmd {
392         u8 sta_id;
393         u8 reserved[3];
394 } __packed; /* REMOVE_STA_CMD_API_S_VER_2 */
395
396 /**
397  * struct iwl_mvm_mgmt_mcast_key_cmd
398  * ( MGMT_MCAST_KEY = 0x1f )
399  * @ctrl_flags: %iwl_sta_key_flag
400  * @IGTK:
401  * @K1: IGTK master key
402  * @K2: IGTK sub key
403  * @sta_id: station ID that support IGTK
404  * @key_id:
405  * @receive_seq_cnt: initial RSC/PN needed for replay check
406  */
407 struct iwl_mvm_mgmt_mcast_key_cmd {
408         __le32 ctrl_flags;
409         u8 IGTK[16];
410         u8 K1[16];
411         u8 K2[16];
412         __le32 key_id;
413         __le32 sta_id;
414         __le64 receive_seq_cnt;
415 } __packed; /* SEC_MGMT_MULTICAST_KEY_CMD_API_S_VER_1 */
416
417 struct iwl_mvm_wep_key {
418         u8 key_index;
419         u8 key_offset;
420         __le16 reserved1;
421         u8 key_size;
422         u8 reserved2[3];
423         u8 key[16];
424 } __packed;
425
426 struct iwl_mvm_wep_key_cmd {
427         __le32 mac_id_n_color;
428         u8 num_keys;
429         u8 decryption_type;
430         u8 flags;
431         u8 reserved;
432         struct iwl_mvm_wep_key wep_key[0];
433 } __packed; /* SEC_CURR_WEP_KEY_CMD_API_S_VER_2 */
434
435
436 #endif /* __fw_api_sta_h__ */