drivers/net/wireless/intel/iwlwifi/fw/api/mac.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  * Copyright(c) 2017        Intel Deutschland GmbH
  10  * Copyright(c) 2018 Intel Corporation
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of version 2 of the GNU General Public License as
  14  * published by the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called COPYING.
  23  *
  24  * Contact Information:
  25  *  Intel Linux Wireless <linuxwifi@intel.com>
  26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27  *
  28  * BSD LICENSE
  29  *
  30  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  31  * Copyright(c) 2017        Intel Deutschland GmbH
  32  * Copyright(c) 2018 Intel Corporation
  33  * All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  *
  39  *  * Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  *  * Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in
  43  *    the documentation and/or other materials provided with the
  44  *    distribution.
  45  *  * Neither the name Intel Corporation nor the names of its
  46  *    contributors may be used to endorse or promote products derived
  47  *    from this software without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  50  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  51  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  52  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  53  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  54  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  55  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  59  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  *****************************************************************************/
  61
  62 #ifndef __iwl_fw_api_mac_h__
  63 #define __iwl_fw_api_mac_h__
  64
  65 /*
  66  * The first MAC indices (starting from 0) are available to the driver,
  67  * AUX indices follows - 1 for non-CDB, 2 for CDB.
  68  */
  69 #define MAC_INDEX_AUX           4
  70 #define MAC_INDEX_MIN_DRIVER    0
  71 #define NUM_MAC_INDEX_DRIVER    MAC_INDEX_AUX
  72 #define NUM_MAC_INDEX           (NUM_MAC_INDEX_DRIVER + 1)
  73 #define NUM_MAC_INDEX_CDB       (NUM_MAC_INDEX_DRIVER + 2)
  74
  75 #define IWL_MVM_STATION_COUNT           16
  76 #define IWL_MVM_INVALID_STA             0xFF
  77
  78 enum iwl_ac {
  79         AC_BK,
  80         AC_BE,
  81         AC_VI,
  82         AC_VO,
  83         AC_NUM,
  84 };
  85
  86 /**
  87  * enum iwl_mac_protection_flags - MAC context flags
  88  * @MAC_PROT_FLG_TGG_PROTECT: 11g protection when transmitting OFDM frames,
  89  *      this will require CCK RTS/CTS2self.
  90  *      RTS/CTS will protect full burst time.
  91  * @MAC_PROT_FLG_HT_PROT: enable HT protection
  92  * @MAC_PROT_FLG_FAT_PROT: protect 40 MHz transmissions
  93  * @MAC_PROT_FLG_SELF_CTS_EN: allow CTS2self
  94  */
  95 enum iwl_mac_protection_flags {
  96         MAC_PROT_FLG_TGG_PROTECT        = BIT(3),
  97         MAC_PROT_FLG_HT_PROT            = BIT(23),
  98         MAC_PROT_FLG_FAT_PROT           = BIT(24),
  99         MAC_PROT_FLG_SELF_CTS_EN        = BIT(30),
 100 };
 101
 102 #define MAC_FLG_SHORT_SLOT              BIT(4)
 103 #define MAC_FLG_SHORT_PREAMBLE          BIT(5)
 104
 105 /**
 106  * enum iwl_mac_types - Supported MAC types
 107  * @FW_MAC_TYPE_FIRST: lowest supported MAC type
 108  * @FW_MAC_TYPE_AUX: Auxiliary MAC (internal)
 109  * @FW_MAC_TYPE_LISTENER: monitor MAC type (?)
 110  * @FW_MAC_TYPE_PIBSS: Pseudo-IBSS
 111  * @FW_MAC_TYPE_IBSS: IBSS
 112  * @FW_MAC_TYPE_BSS_STA: BSS (managed) station
 113  * @FW_MAC_TYPE_P2P_DEVICE: P2P Device
 114  * @FW_MAC_TYPE_P2P_STA: P2P client
 115  * @FW_MAC_TYPE_GO: P2P GO
 116  * @FW_MAC_TYPE_TEST: ?
 117  * @FW_MAC_TYPE_MAX: highest support MAC type
 118  */
 119 enum iwl_mac_types {
 120         FW_MAC_TYPE_FIRST = 1,
 121         FW_MAC_TYPE_AUX = FW_MAC_TYPE_FIRST,
 122         FW_MAC_TYPE_LISTENER,
 123         FW_MAC_TYPE_PIBSS,
 124         FW_MAC_TYPE_IBSS,
 125         FW_MAC_TYPE_BSS_STA,
 126         FW_MAC_TYPE_P2P_DEVICE,
 127         FW_MAC_TYPE_P2P_STA,
 128         FW_MAC_TYPE_GO,
 129         FW_MAC_TYPE_TEST,
 130         FW_MAC_TYPE_MAX = FW_MAC_TYPE_TEST
 131 }; /* MAC_CONTEXT_TYPE_API_E_VER_1 */
 132
 133 /**
 134  * enum iwl_tsf_id - TSF hw timer ID
 135  * @TSF_ID_A: use TSF A
 136  * @TSF_ID_B: use TSF B
 137  * @TSF_ID_C: use TSF C
 138  * @TSF_ID_D: use TSF D
 139  * @NUM_TSF_IDS: number of TSF timers available
 140  */
 141 enum iwl_tsf_id {
 142         TSF_ID_A = 0,
 143         TSF_ID_B = 1,
 144         TSF_ID_C = 2,
 145         TSF_ID_D = 3,
 146         NUM_TSF_IDS = 4,
 147 }; /* TSF_ID_API_E_VER_1 */
 148
 149 /**
 150  * struct iwl_mac_data_ap - configuration data for AP MAC context
 151  * @beacon_time: beacon transmit time in system time
 152  * @beacon_tsf: beacon transmit time in TSF
 153  * @bi: beacon interval in TU
 154  * @bi_reciprocal: 2^32 / bi
 155  * @dtim_interval: dtim transmit time in TU
 156  * @dtim_reciprocal: 2^32 / dtim_interval
 157  * @mcast_qid: queue ID for multicast traffic.
 158  *      NOTE: obsolete from VER2 and on
 159  * @beacon_template: beacon template ID
 160  */
 161 struct iwl_mac_data_ap {
 162         __le32 beacon_time;
 163         __le64 beacon_tsf;
 164         __le32 bi;
 165         __le32 bi_reciprocal;
 166         __le32 dtim_interval;
 167         __le32 dtim_reciprocal;
 168         __le32 mcast_qid;
 169         __le32 beacon_template;
 170 } __packed; /* AP_MAC_DATA_API_S_VER_2 */
 171
 172 /**
 173  * struct iwl_mac_data_ibss - configuration data for IBSS MAC context
 174  * @beacon_time: beacon transmit time in system time
 175  * @beacon_tsf: beacon transmit time in TSF
 176  * @bi: beacon interval in TU
 177  * @bi_reciprocal: 2^32 / bi
 178  * @beacon_template: beacon template ID
 179  */
 180 struct iwl_mac_data_ibss {
 181         __le32 beacon_time;
 182         __le64 beacon_tsf;
 183         __le32 bi;
 184         __le32 bi_reciprocal;
 185         __le32 beacon_template;
 186 } __packed; /* IBSS_MAC_DATA_API_S_VER_1 */
 187
 188 /**
 189  * struct iwl_mac_data_sta - configuration data for station MAC context
 190  * @is_assoc: 1 for associated state, 0 otherwise
 191  * @dtim_time: DTIM arrival time in system time
 192  * @dtim_tsf: DTIM arrival time in TSF
 193  * @bi: beacon interval in TU, applicable only when associated
 194  * @bi_reciprocal: 2^32 / bi , applicable only when associated
 195  * @dtim_interval: DTIM interval in TU, applicable only when associated
 196  * @dtim_reciprocal: 2^32 / dtim_interval , applicable only when associated
 197  * @listen_interval: in beacon intervals, applicable only when associated
 198  * @assoc_id: unique ID assigned by the AP during association
 199  * @assoc_beacon_arrive_time: TSF of first beacon after association
 200  */
 201 struct iwl_mac_data_sta {
 202         __le32 is_assoc;
 203         __le32 dtim_time;
 204         __le64 dtim_tsf;
 205         __le32 bi;
 206         __le32 bi_reciprocal;
 207         __le32 dtim_interval;
 208         __le32 dtim_reciprocal;
 209         __le32 listen_interval;
 210         __le32 assoc_id;
 211         __le32 assoc_beacon_arrive_time;
 212 } __packed; /* STA_MAC_DATA_API_S_VER_1 */
 213
 214 /**
 215  * struct iwl_mac_data_go - configuration data for P2P GO MAC context
 216  * @ap: iwl_mac_data_ap struct with most config data
 217  * @ctwin: client traffic window in TU (period after TBTT when GO is present).
 218  *      0 indicates that there is no CT window.
 219  * @opp_ps_enabled: indicate that opportunistic PS allowed
 220  */
 221 struct iwl_mac_data_go {
 222         struct iwl_mac_data_ap ap;
 223         __le32 ctwin;
 224         __le32 opp_ps_enabled;
 225 } __packed; /* GO_MAC_DATA_API_S_VER_1 */
 226
 227 /**
 228  * struct iwl_mac_data_p2p_sta - configuration data for P2P client MAC context
 229  * @sta: iwl_mac_data_sta struct with most config data
 230  * @ctwin: client traffic window in TU (period after TBTT when GO is present).
 231  *      0 indicates that there is no CT window.
 232  */
 233 struct iwl_mac_data_p2p_sta {
 234         struct iwl_mac_data_sta sta;
 235         __le32 ctwin;
 236 } __packed; /* P2P_STA_MAC_DATA_API_S_VER_1 */
 237
 238 /**
 239  * struct iwl_mac_data_pibss - Pseudo IBSS config data
 240  * @stats_interval: interval in TU between statistics notifications to host.
 241  */
 242 struct iwl_mac_data_pibss {
 243         __le32 stats_interval;
 244 } __packed; /* PIBSS_MAC_DATA_API_S_VER_1 */
 245
 246 /*
 247  * struct iwl_mac_data_p2p_dev - configuration data for the P2P Device MAC
 248  * context.
 249  * @is_disc_extended: if set to true, P2P Device discoverability is enabled on
 250  *      other channels as well. This should be to true only in case that the
 251  *      device is discoverable and there is an active GO. Note that setting this
 252  *      field when not needed, will increase the number of interrupts and have
 253  *      effect on the platform power, as this setting opens the Rx filters on
 254  *      all macs.
 255  */
 256 struct iwl_mac_data_p2p_dev {
 257         __le32 is_disc_extended;
 258 } __packed; /* _P2P_DEV_MAC_DATA_API_S_VER_1 */
 259
 260 /**
 261  * enum iwl_mac_filter_flags - MAC context filter flags
 262  * @MAC_FILTER_IN_PROMISC: accept all data frames
 263  * @MAC_FILTER_IN_CONTROL_AND_MGMT: pass all management and
 264  *      control frames to the host
 265  * @MAC_FILTER_ACCEPT_GRP: accept multicast frames
 266  * @MAC_FILTER_DIS_DECRYPT: don't decrypt unicast frames
 267  * @MAC_FILTER_DIS_GRP_DECRYPT: don't decrypt multicast frames
 268  * @MAC_FILTER_IN_BEACON: transfer foreign BSS's beacons to host
 269  *      (in station mode when associated)
 270  * @MAC_FILTER_OUT_BCAST: filter out all broadcast frames
 271  * @MAC_FILTER_IN_CRC32: extract FCS and append it to frames
 272  * @MAC_FILTER_IN_PROBE_REQUEST: pass probe requests to host
 273  */
 274 enum iwl_mac_filter_flags {
 275         MAC_FILTER_IN_PROMISC           = BIT(0),
 276         MAC_FILTER_IN_CONTROL_AND_MGMT  = BIT(1),
 277         MAC_FILTER_ACCEPT_GRP           = BIT(2),
 278         MAC_FILTER_DIS_DECRYPT          = BIT(3),
 279         MAC_FILTER_DIS_GRP_DECRYPT      = BIT(4),
 280         MAC_FILTER_IN_BEACON            = BIT(6),
 281         MAC_FILTER_OUT_BCAST            = BIT(8),
 282         MAC_FILTER_IN_CRC32             = BIT(11),
 283         MAC_FILTER_IN_PROBE_REQUEST     = BIT(12),
 284         /**
 285          * @MAC_FILTER_IN_11AX: mark BSS as supporting 802.11ax
 286          */
 287         MAC_FILTER_IN_11AX              = BIT(14),
 288 };
 289
 290 /**
 291  * enum iwl_mac_qos_flags - QoS flags
 292  * @MAC_QOS_FLG_UPDATE_EDCA: ?
 293  * @MAC_QOS_FLG_TGN: HT is enabled
 294  * @MAC_QOS_FLG_TXOP_TYPE: ?
 295  *
 296  */
 297 enum iwl_mac_qos_flags {
 298         MAC_QOS_FLG_UPDATE_EDCA = BIT(0),
 299         MAC_QOS_FLG_TGN         = BIT(1),
 300         MAC_QOS_FLG_TXOP_TYPE   = BIT(4),
 301 };
 302
 303 /**
 304  * struct iwl_ac_qos - QOS timing params for MAC_CONTEXT_CMD
 305  * @cw_min: Contention window, start value in numbers of slots.
 306  *      Should be a power-of-2, minus 1.  Device's default is 0x0f.
 307  * @cw_max: Contention window, max value in numbers of slots.
 308  *      Should be a power-of-2, minus 1.  Device's default is 0x3f.
 309  * @aifsn:  Number of slots in Arbitration Interframe Space (before
 310  *      performing random backoff timing prior to Tx).  Device default 1.
 311  * @fifos_mask: FIFOs used by this MAC for this AC
 312  * @edca_txop:  Length of Tx opportunity, in uSecs.  Device default is 0.
 313  *
 314  * One instance of this config struct for each of 4 EDCA access categories
 315  * in struct iwl_qosparam_cmd.
 316  *
 317  * Device will automatically increase contention window by (2*CW) + 1 for each
 318  * transmission retry.  Device uses cw_max as a bit mask, ANDed with new CW
 319  * value, to cap the CW value.
 320  */
 321 struct iwl_ac_qos {
 322         __le16 cw_min;
 323         __le16 cw_max;
 324         u8 aifsn;
 325         u8 fifos_mask;
 326         __le16 edca_txop;
 327 } __packed; /* AC_QOS_API_S_VER_2 */
 328
 329 /**
 330  * struct iwl_mac_ctx_cmd - command structure to configure MAC contexts
 331  * ( MAC_CONTEXT_CMD = 0x28 )
 332  * @id_and_color: ID and color of the MAC
 333  * @action: action to perform, one of FW_CTXT_ACTION_*
 334  * @mac_type: one of &enum iwl_mac_types
 335  * @tsf_id: TSF HW timer, one of &enum iwl_tsf_id
 336  * @node_addr: MAC address
 337  * @reserved_for_node_addr: reserved
 338  * @bssid_addr: BSSID
 339  * @reserved_for_bssid_addr: reserved
 340  * @cck_rates: basic rates available for CCK
 341  * @ofdm_rates: basic rates available for OFDM
 342  * @protection_flags: combination of &enum iwl_mac_protection_flags
 343  * @cck_short_preamble: 0x20 for enabling short preamble, 0 otherwise
 344  * @short_slot: 0x10 for enabling short slots, 0 otherwise
 345  * @filter_flags: combination of &enum iwl_mac_filter_flags
 346  * @qos_flags: from &enum iwl_mac_qos_flags
 347  * @ac: one iwl_mac_qos configuration for each AC
 348  */
 349 struct iwl_mac_ctx_cmd {
 350         /* COMMON_INDEX_HDR_API_S_VER_1 */
 351         __le32 id_and_color;
 352         __le32 action;
 353         /* MAC_CONTEXT_COMMON_DATA_API_S_VER_1 */
 354         __le32 mac_type;
 355         __le32 tsf_id;
 356         u8 node_addr[6];
 357         __le16 reserved_for_node_addr;
 358         u8 bssid_addr[6];
 359         __le16 reserved_for_bssid_addr;
 360         __le32 cck_rates;
 361         __le32 ofdm_rates;
 362         __le32 protection_flags;
 363         __le32 cck_short_preamble;
 364         __le32 short_slot;
 365         __le32 filter_flags;
 366         /* MAC_QOS_PARAM_API_S_VER_1 */
 367         __le32 qos_flags;
 368         struct iwl_ac_qos ac[AC_NUM+1];
 369         /* MAC_CONTEXT_COMMON_DATA_API_S */
 370         union {
 371                 struct iwl_mac_data_ap ap;
 372                 struct iwl_mac_data_go go;
 373                 struct iwl_mac_data_sta sta;
 374                 struct iwl_mac_data_p2p_sta p2p_sta;
 375                 struct iwl_mac_data_p2p_dev p2p_dev;
 376                 struct iwl_mac_data_pibss pibss;
 377                 struct iwl_mac_data_ibss ibss;
 378         };
 379 } __packed; /* MAC_CONTEXT_CMD_API_S_VER_1 */
 380
 381 static inline u32 iwl_mvm_reciprocal(u32 v)
 382 {
 383         if (!v)
 384                 return 0;
 385         return 0xFFFFFFFF / v;
 386 }
 387
 388 #define IWL_NONQOS_SEQ_GET      0x1
 389 #define IWL_NONQOS_SEQ_SET      0x2
 390 struct iwl_nonqos_seq_query_cmd {
 391         __le32 get_set_flag;
 392         __le32 mac_id_n_color;
 393         __le16 value;
 394         __le16 reserved;
 395 } __packed; /* NON_QOS_TX_COUNTER_GET_SET_API_S_VER_1 */
 396
 397 /**
 398  * struct iwl_missed_beacons_notif - information on missed beacons
 399  * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
 400  * @mac_id: interface ID
 401  * @consec_missed_beacons_since_last_rx: number of consecutive missed
 402  *      beacons since last RX.
 403  * @consec_missed_beacons: number of consecutive missed beacons
 404  * @num_expected_beacons: number of expected beacons
 405  * @num_recvd_beacons: number of received beacons
 406  */
 407 struct iwl_missed_beacons_notif {
 408         __le32 mac_id;
 409         __le32 consec_missed_beacons_since_last_rx;
 410         __le32 consec_missed_beacons;
 411         __le32 num_expected_beacons;
 412         __le32 num_recvd_beacons;
 413 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
 414
 415 /**
 416  * struct iwl_he_backoff_conf - used for backoff configuration
 417  * Per each trigger-based AC, (set by MU EDCA Parameter set info-element)
 418  * used for backoff configuration of TXF5..TXF8 trigger based.
 419  * The MU-TIMER is reloaded w/ MU_TIME each time a frame from the AC is sent via
 420  * trigger-based TX.
 421  * @cwmin: CW min
 422  * @cwmax: CW max
 423  * @aifsn: AIFSN
 424  *      AIFSN=0, means that no backoff from the specified TRIG-BASED AC is
 425  *      allowed till the MU-TIMER is 0
 426  * @mu_time: MU time in 8TU units
 427  */
 428 struct iwl_he_backoff_conf {
 429         __le16 cwmin;
 430         __le16 cwmax;
 431         __le16 aifsn;
 432         __le16 mu_time;
 433 } __packed; /* AC_QOS_DOT11AX_API_S */
 434
 435 #define MAX_HE_SUPP_NSS 2
 436 #define MAX_HE_CHANNEL_BW_INDX  4
 437
 438 /**
 439  * struct iwl_he_pkt_ext - QAM thresholds
 440  * The required PPE is set via HE Capabilities IE, per Nss x BW x MCS
 441  * The IE is organized in the following way:
 442  * Support for Nss x BW (or RU) matrix:
 443  *      (0=SISO, 1=MIMO2) x (0-20MHz, 1-40MHz, 2-80MHz, 3-160MHz)
 444  * Each entry contains 2 QAM thresholds for 8us and 16us:
 445  *      0=BPSK, 1=QPSK, 2=16QAM, 3=64QAM, 4=256QAM, 5=1024QAM, 6/7=RES
 446  * i.e. QAM_th1 < QAM_th2 such if TX uses QAM_tx:
 447  *      QAM_tx < QAM_th1            --> PPE=0us
 448  *      QAM_th1 <= QAM_tx < QAM_th2 --> PPE=8us
 449  *      QAM_th2 <= QAM_tx           --> PPE=16us
 450  * @pkt_ext_qam_th: QAM thresholds
 451  *      For each Nss/Bw define 2 QAM thrsholds (0..5)
 452  *      For rates below the low_th, no need for PPE
 453  *      For rates between low_th and high_th, need 8us PPE
 454  *      For rates equal or higher then the high_th, need 16us PPE
 455  *      Nss (0-siso, 1-mimo2) x BW (0-20MHz, 1-40MHz, 2-80MHz, 3-160MHz) x
 456  *              (0-low_th, 1-high_th)
 457  */
 458 struct iwl_he_pkt_ext {
 459         u8 pkt_ext_qam_th[MAX_HE_SUPP_NSS][MAX_HE_CHANNEL_BW_INDX][2];
 460 } __packed; /* PKT_EXT_DOT11AX_API_S */
 461
 462 /**
 463  * enum iwl_he_sta_ctxt_flags - HE STA context flags
 464  * @STA_CTXT_HE_REF_BSSID_VALID: ref bssid addr valid (for receiving specific
 465  *      control frames such as TRIG, NDPA, BACK)
 466  * @STA_CTXT_HE_BSS_COLOR_DIS: BSS color disable, don't use the BSS
 467  *      color for RX filter but use MAC header
 468  * @STA_CTXT_HE_PARTIAL_BSS_COLOR: partial BSS color allocation
 469  * @STA_CTXT_HE_32BIT_BA_BITMAP: indicates the receiver supports BA bitmap
 470  *      of 32-bits
 471  * @STA_CTXT_HE_PACKET_EXT: indicates that the packet-extension info is valid
 472  *      and should be used
 473  * @STA_CTXT_HE_TRIG_RND_ALLOC: indicates that trigger based random allocation
 474  *      is enabled according to UORA element existence
 475  * @STA_CTXT_HE_CONST_TRIG_RND_ALLOC: used for AV testing
 476  * @STA_CTXT_HE_ACK_ENABLED: indicates that the AP supports receiving ACK-
 477  *      enabled AGG, i.e. both BACK and non-BACK frames in a single AGG
 478  * @STA_CTXT_HE_MU_EDCA_CW: indicates that there is an element of MU EDCA
 479  *      parameter set, i.e. the backoff counters for trig-based ACs
 480  */
 481 enum iwl_he_sta_ctxt_flags {
 482         STA_CTXT_HE_REF_BSSID_VALID             = BIT(4),
 483         STA_CTXT_HE_BSS_COLOR_DIS               = BIT(5),
 484         STA_CTXT_HE_PARTIAL_BSS_COLOR           = BIT(6),
 485         STA_CTXT_HE_32BIT_BA_BITMAP             = BIT(7),
 486         STA_CTXT_HE_PACKET_EXT                  = BIT(8),
 487         STA_CTXT_HE_TRIG_RND_ALLOC              = BIT(9),
 488         STA_CTXT_HE_CONST_TRIG_RND_ALLOC        = BIT(10),
 489         STA_CTXT_HE_ACK_ENABLED                 = BIT(11),
 490         STA_CTXT_HE_MU_EDCA_CW                  = BIT(12),
 491 };
 492
 493 /**
 494  * enum iwl_he_htc_flags - HE HTC support flags
 495  * @IWL_HE_HTC_SUPPORT: HE-HTC support
 496  * @IWL_HE_HTC_UL_MU_RESP_SCHED: HE UL MU response schedule
 497  *      support via A-control field
 498  * @IWL_HE_HTC_BSR_SUPP: BSR support in A-control field
 499  * @IWL_HE_HTC_OMI_SUPP: A-OMI support in A-control field
 500  * @IWL_HE_HTC_BQR_SUPP: A-BQR support in A-control field
 501  */
 502 enum iwl_he_htc_flags {
 503         IWL_HE_HTC_SUPPORT                      = BIT(0),
 504         IWL_HE_HTC_UL_MU_RESP_SCHED             = BIT(3),
 505         IWL_HE_HTC_BSR_SUPP                     = BIT(4),
 506         IWL_HE_HTC_OMI_SUPP                     = BIT(5),
 507         IWL_HE_HTC_BQR_SUPP                     = BIT(6),
 508 };
 509
 510 /*
 511  * @IWL_HE_HTC_LINK_ADAP_NO_FEEDBACK: the STA does not provide HE MFB
 512  * @IWL_HE_HTC_LINK_ADAP_UNSOLICITED: the STA provides only unsolicited HE MFB
 513  * @IWL_HE_HTC_LINK_ADAP_BOTH: the STA is capable of providing HE MFB in
 514  *      response to HE MRQ and if the STA provides unsolicited HE MFB
 515  */
 516 #define IWL_HE_HTC_LINK_ADAP_POS                (1)
 517 #define IWL_HE_HTC_LINK_ADAP_NO_FEEDBACK        (0)
 518 #define IWL_HE_HTC_LINK_ADAP_UNSOLICITED        (2 << IWL_HE_HTC_LINK_ADAP_POS)
 519 #define IWL_HE_HTC_LINK_ADAP_BOTH               (3 << IWL_HE_HTC_LINK_ADAP_POS)
 520
 521 /**
 522  * struct iwl_he_sta_context_cmd - configure FW to work with HE AP
 523  * @sta_id: STA id
 524  * @tid_limit: max num of TIDs in TX HE-SU multi-TID agg
 525  *      0 - bad value, 1 - multi-tid not supported, 2..8 - tid limit
 526  * @reserved1: reserved byte for future use
 527  * @reserved2: reserved byte for future use
 528  * @flags: see %iwl_11ax_sta_ctxt_flags
 529  * @ref_bssid_addr: reference BSSID used by the AP
 530  * @reserved0: reserved 2 bytes for aligning the ref_bssid_addr field to 8 bytes
 531  * @htc_flags: which features are supported in HTC
 532  * @frag_flags: frag support in A-MSDU
 533  * @frag_level: frag support level
 534  * @frag_max_num: max num of "open" MSDUs in the receiver (in power of 2)
 535  * @frag_min_size: min frag size (except last frag)
 536  * @pkt_ext: optional, exists according to PPE-present bit in the HE-PHY capa
 537  * @bss_color: 11ax AP ID that is used in the HE SIG-A to mark inter BSS frame
 538  * @htc_trig_based_pkt_ext: default PE in 4us units
 539  * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
 540  * @rand_alloc_ecwmin: random CWmin = 2**ECWmin-1
 541  * @rand_alloc_ecwmax: random CWmax = 2**ECWmax-1
 542  * @reserved3: reserved byte for future use
 543  * @trig_based_txf: MU EDCA Parameter set for the trigger based traffic queues
 544  */
 545 struct iwl_he_sta_context_cmd {
 546         u8 sta_id;
 547         u8 tid_limit;
 548         u8 reserved1;
 549         u8 reserved2;
 550         __le32 flags;
 551
 552         /* The below fields are set via Multiple BSSID IE */
 553         u8 ref_bssid_addr[6];
 554         __le16 reserved0;
 555
 556         /* The below fields are set via HE-capabilities IE */
 557         __le32 htc_flags;
 558
 559         u8 frag_flags;
 560         u8 frag_level;
 561         u8 frag_max_num;
 562         u8 frag_min_size;
 563
 564         /* The below fields are set via PPE thresholds element */
 565         struct iwl_he_pkt_ext pkt_ext;
 566
 567         /* The below fields are set via HE-Operation IE */
 568         u8 bss_color;
 569         u8 htc_trig_based_pkt_ext;
 570         __le16 frame_time_rts_th;
 571
 572         /* Random access parameter set (i.e. RAPS) */
 573         u8 rand_alloc_ecwmin;
 574         u8 rand_alloc_ecwmax;
 575         __le16 reserved3;
 576
 577         /* The below fields are set via MU EDCA parameter set element */
 578         struct iwl_he_backoff_conf trig_based_txf[AC_NUM];
 579 } __packed; /* STA_CONTEXT_DOT11AX_API_S */
 580
 581 /**
 582  * struct iwl_he_monitor_cmd - configure air sniffer for HE
 583  * @bssid: the BSSID to sniff for
 584  * @reserved1: reserved for dword alignment
 585  * @aid: the AID to track on for HE MU
 586  * @reserved2: reserved for future use
 587  */
 588 struct iwl_he_monitor_cmd {
 589         u8 bssid[6];
 590         __le16 reserved1;
 591         __le16 aid;
 592         u8 reserved2[6];
 593 } __packed; /* HE_AIR_SNIFFER_CONFIG_CMD_API_S_VER_1 */
 594
 595 #endif /* __iwl_fw_api_mac_h__ */