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