drivers/net/wireless/intel/iwlwifi/mvm/fw-api-tx.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) 2016 Intel Deutschland GmbH
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of version 2 of the GNU General Public License as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23  * USA
  24  *
  25  * The full GNU General Public License is included in this distribution
  26  * in the file called COPYING.
  27  *
  28  * Contact Information:
  29  *  Intel Linux Wireless <linuxwifi@intel.com>
  30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31  *
  32  * BSD LICENSE
  33  *
  34  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  35  * All rights reserved.
  36  *
  37  * Redistribution and use in source and binary forms, with or without
  38  * modification, are permitted provided that the following conditions
  39  * are met:
  40  *
  41  *  * Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  *  * Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in
  45  *    the documentation and/or other materials provided with the
  46  *    distribution.
  47  *  * Neither the name Intel Corporation nor the names of its
  48  *    contributors may be used to endorse or promote products derived
  49  *    from this software without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  52  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  53  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  54  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  55  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  56  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  57  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  61  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  62  *****************************************************************************/
  63
  64 #ifndef __fw_api_tx_h__
  65 #define __fw_api_tx_h__
  66
  67 /**
  68  * enum iwl_tx_flags - bitmasks for tx_flags in TX command
  69  * @TX_CMD_FLG_PROT_REQUIRE: use RTS or CTS-to-self to protect the frame
  70  * @TX_CMD_FLG_WRITE_TX_POWER: update current tx power value in the mgmt frame
  71  * @TX_CMD_FLG_ACK: expect ACK from receiving station
  72  * @TX_CMD_FLG_STA_RATE: use RS table with initial index from the TX command.
  73  *      Otherwise, use rate_n_flags from the TX command
  74  * @TX_CMD_FLG_BAR: this frame is a BA request, immediate BAR is expected
  75  *      Must set TX_CMD_FLG_ACK with this flag.
  76  * @TX_CMD_FLG_VHT_NDPA: mark frame is NDPA for VHT beamformer sequence
  77  * @TX_CMD_FLG_HT_NDPA: mark frame is NDPA for HT beamformer sequence
  78  * @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC)
  79  * @TX_CMD_FLG_BT_PRIO_POS: the position of the BT priority (bit 11 is ignored
  80  *      on old firmwares).
  81  * @TX_CMD_FLG_BT_DIS: disable BT priority for this frame
  82  * @TX_CMD_FLG_SEQ_CTL: set if FW should override the sequence control.
  83  *      Should be set for mgmt, non-QOS data, mcast, bcast and in scan command
  84  * @TX_CMD_FLG_MORE_FRAG: this frame is non-last MPDU
  85  * @TX_CMD_FLG_TSF: FW should calculate and insert TSF in the frame
  86  *      Should be set for beacons and probe responses
  87  * @TX_CMD_FLG_CALIB: activate PA TX power calibrations
  88  * @TX_CMD_FLG_KEEP_SEQ_CTL: if seq_ctl is set, don't increase inner seq count
  89  * @TX_CMD_FLG_MH_PAD: driver inserted 2 byte padding after MAC header.
  90  *      Should be set for 26/30 length MAC headers
  91  * @TX_CMD_FLG_RESP_TO_DRV: zero this if the response should go only to FW
  92  * @TX_CMD_FLG_TKIP_MIC_DONE: FW already performed TKIP MIC calculation
  93  * @TX_CMD_FLG_DUR: disable duration overwriting used in PS-Poll Assoc-id
  94  * @TX_CMD_FLG_FW_DROP: FW should mark frame to be dropped
  95  * @TX_CMD_FLG_EXEC_PAPD: execute PAPD
  96  * @TX_CMD_FLG_PAPD_TYPE: 0 for reference power, 1 for nominal power
  97  * @TX_CMD_FLG_HCCA_CHUNK: mark start of TSPEC chunk
  98  */
  99 enum iwl_tx_flags {
 100         TX_CMD_FLG_PROT_REQUIRE         = BIT(0),
 101         TX_CMD_FLG_WRITE_TX_POWER       = BIT(1),
 102         TX_CMD_FLG_ACK                  = BIT(3),
 103         TX_CMD_FLG_STA_RATE             = BIT(4),
 104         TX_CMD_FLG_BAR                  = BIT(6),
 105         TX_CMD_FLG_TXOP_PROT            = BIT(7),
 106         TX_CMD_FLG_VHT_NDPA             = BIT(8),
 107         TX_CMD_FLG_HT_NDPA              = BIT(9),
 108         TX_CMD_FLG_CSI_FDBK2HOST        = BIT(10),
 109         TX_CMD_FLG_BT_PRIO_POS          = 11,
 110         TX_CMD_FLG_BT_DIS               = BIT(12),
 111         TX_CMD_FLG_SEQ_CTL              = BIT(13),
 112         TX_CMD_FLG_MORE_FRAG            = BIT(14),
 113         TX_CMD_FLG_TSF                  = BIT(16),
 114         TX_CMD_FLG_CALIB                = BIT(17),
 115         TX_CMD_FLG_KEEP_SEQ_CTL         = BIT(18),
 116         TX_CMD_FLG_MH_PAD               = BIT(20),
 117         TX_CMD_FLG_RESP_TO_DRV          = BIT(21),
 118         TX_CMD_FLG_TKIP_MIC_DONE        = BIT(23),
 119         TX_CMD_FLG_DUR                  = BIT(25),
 120         TX_CMD_FLG_FW_DROP              = BIT(26),
 121         TX_CMD_FLG_EXEC_PAPD            = BIT(27),
 122         TX_CMD_FLG_PAPD_TYPE            = BIT(28),
 123         TX_CMD_FLG_HCCA_CHUNK           = BIT(31)
 124 }; /* TX_FLAGS_BITS_API_S_VER_1 */
 125
 126 /**
 127  * enum iwl_tx_pm_timeouts - pm timeout values in TX command
 128  * @PM_FRAME_NONE: no need to suspend sleep mode
 129  * @PM_FRAME_MGMT: fw suspend sleep mode for 100TU
 130  * @PM_FRAME_ASSOC: fw suspend sleep mode for 10sec
 131  */
 132 enum iwl_tx_pm_timeouts {
 133         PM_FRAME_NONE           = 0,
 134         PM_FRAME_MGMT           = 2,
 135         PM_FRAME_ASSOC          = 3,
 136 };
 137
 138 #define TX_CMD_SEC_MSK                  0x07
 139 #define TX_CMD_SEC_WEP_KEY_IDX_POS      6
 140 #define TX_CMD_SEC_WEP_KEY_IDX_MSK      0xc0
 141
 142 /**
 143  * enum iwl_tx_cmd_sec_ctrl - bitmasks for security control in TX command
 144  * @TX_CMD_SEC_WEP: WEP encryption algorithm.
 145  * @TX_CMD_SEC_CCM: CCM encryption algorithm.
 146  * @TX_CMD_SEC_TKIP: TKIP encryption algorithm.
 147  * @TX_CMD_SEC_EXT: extended cipher algorithm.
 148  * @TX_CMD_SEC_GCMP: GCMP encryption algorithm.
 149  * @TX_CMD_SEC_KEY128: set for 104 bits WEP key.
 150  * @TX_CMD_SEC_KEY_FROM_TABLE: for a non-WEP key, set if the key should be taken
 151  *      from the table instead of from the TX command.
 152  *      If the key is taken from the key table its index should be given by the
 153  *      first byte of the TX command key field.
 154  */
 155 enum iwl_tx_cmd_sec_ctrl {
 156         TX_CMD_SEC_WEP                  = 0x01,
 157         TX_CMD_SEC_CCM                  = 0x02,
 158         TX_CMD_SEC_TKIP                 = 0x03,
 159         TX_CMD_SEC_EXT                  = 0x04,
 160         TX_CMD_SEC_GCMP                 = 0x05,
 161         TX_CMD_SEC_KEY128               = 0x08,
 162         TX_CMD_SEC_KEY_FROM_TABLE       = 0x08,
 163 };
 164
 165 /* TODO: how does these values are OK with only 16 bit variable??? */
 166 /*
 167  * TX command next frame info
 168  *
 169  * bits 0:2 - security control (TX_CMD_SEC_*)
 170  * bit 3 - immediate ACK required
 171  * bit 4 - rate is taken from STA table
 172  * bit 5 - frame belongs to BA stream
 173  * bit 6 - immediate BA response expected
 174  * bit 7 - unused
 175  * bits 8:15 - Station ID
 176  * bits 16:31 - rate
 177  */
 178 #define TX_CMD_NEXT_FRAME_ACK_MSK               (0x8)
 179 #define TX_CMD_NEXT_FRAME_STA_RATE_MSK          (0x10)
 180 #define TX_CMD_NEXT_FRAME_BA_MSK                (0x20)
 181 #define TX_CMD_NEXT_FRAME_IMM_BA_RSP_MSK        (0x40)
 182 #define TX_CMD_NEXT_FRAME_FLAGS_MSK             (0xf8)
 183 #define TX_CMD_NEXT_FRAME_STA_ID_MSK            (0xff00)
 184 #define TX_CMD_NEXT_FRAME_STA_ID_POS            (8)
 185 #define TX_CMD_NEXT_FRAME_RATE_MSK              (0xffff0000)
 186 #define TX_CMD_NEXT_FRAME_RATE_POS              (16)
 187
 188 /*
 189  * TX command Frame life time in us - to be written in pm_frame_timeout
 190  */
 191 #define TX_CMD_LIFE_TIME_INFINITE       0xFFFFFFFF
 192 #define TX_CMD_LIFE_TIME_DEFAULT        2000000 /* 2000 ms*/
 193 #define TX_CMD_LIFE_TIME_PROBE_RESP     40000 /* 40 ms */
 194 #define TX_CMD_LIFE_TIME_EXPIRED_FRAME  0
 195
 196 /*
 197  * TID for non QoS frames - to be written in tid_tspec
 198  */
 199 #define IWL_TID_NON_QOS IWL_MAX_TID_COUNT
 200
 201 /*
 202  * Limits on the retransmissions - to be written in {data,rts}_retry_limit
 203  */
 204 #define IWL_DEFAULT_TX_RETRY                    15
 205 #define IWL_MGMT_DFAULT_RETRY_LIMIT             3
 206 #define IWL_RTS_DFAULT_RETRY_LIMIT              60
 207 #define IWL_BAR_DFAULT_RETRY_LIMIT              60
 208 #define IWL_LOW_RETRY_LIMIT                     7
 209
 210 /**
 211  * enum iwl_tx_offload_assist_flags_pos -  set %iwl_tx_cmd offload_assist values
 212  * @TX_CMD_OFFLD_IP_HDR_OFFSET: offset to start of IP header (in words)
 213  *      from mac header end. For normal case it is 4 words for SNAP.
 214  *      note: tx_cmd, mac header and pad are not counted in the offset.
 215  *      This is used to help the offload in case there is tunneling such as
 216  *      IPv6 in IPv4, in such case the ip header offset should point to the
 217  *      inner ip header and IPv4 checksum of the external header should be
 218  *      calculated by driver.
 219  * @TX_CMD_OFFLD_L4_EN: enable TCP/UDP checksum
 220  * @TX_CMD_OFFLD_L3_EN: enable IP header checksum
 221  * @TX_CMD_OFFLD_MH_SIZE: size of the mac header in words. Includes the IV
 222  *      field. Doesn't include the pad.
 223  * @TX_CMD_OFFLD_PAD: mark 2-byte pad was inserted after the mac header for
 224  *      alignment
 225  * @TX_CMD_OFFLD_AMSDU: mark TX command is A-MSDU
 226  */
 227 enum iwl_tx_offload_assist_flags_pos {
 228         TX_CMD_OFFLD_IP_HDR =           0,
 229         TX_CMD_OFFLD_L4_EN =            6,
 230         TX_CMD_OFFLD_L3_EN =            7,
 231         TX_CMD_OFFLD_MH_SIZE =          8,
 232         TX_CMD_OFFLD_PAD =              13,
 233         TX_CMD_OFFLD_AMSDU =            14,
 234 };
 235
 236 #define IWL_TX_CMD_OFFLD_MH_MASK        0x1f
 237 #define IWL_TX_CMD_OFFLD_IP_HDR_MASK    0x3f
 238
 239 /* TODO: complete documentation for try_cnt and btkill_cnt */
 240 /**
 241  * struct iwl_tx_cmd - TX command struct to FW
 242  * ( TX_CMD = 0x1c )
 243  * @len: in bytes of the payload, see below for details
 244  * @offload_assist: TX offload configuration
 245  * @tx_flags: combination of TX_CMD_FLG_*
 246  * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
 247  *      cleared. Combination of RATE_MCS_*
 248  * @sta_id: index of destination station in FW station table
 249  * @sec_ctl: security control, TX_CMD_SEC_*
 250  * @initial_rate_index: index into the the rate table for initial TX attempt.
 251  *      Applied if TX_CMD_FLG_STA_RATE_MSK is set, normally 0 for data frames.
 252  * @key: security key
 253  * @next_frame_flags: TX_CMD_SEC_* and TX_CMD_NEXT_FRAME_*
 254  * @life_time: frame life time (usecs??)
 255  * @dram_lsb_ptr: Physical address of scratch area in the command (try_cnt +
 256  *      btkill_cnd + reserved), first 32 bits. "0" disables usage.
 257  * @dram_msb_ptr: upper bits of the scratch physical address
 258  * @rts_retry_limit: max attempts for RTS
 259  * @data_retry_limit: max attempts to send the data packet
 260  * @tid_spec: TID/tspec
 261  * @pm_frame_timeout: PM TX frame timeout
 262  *
 263  * The byte count (both len and next_frame_len) includes MAC header
 264  * (24/26/30/32 bytes)
 265  * + 2 bytes pad if 26/30 header size
 266  * + 8 byte IV for CCM or TKIP (not used for WEP)
 267  * + Data payload
 268  * + 8-byte MIC (not used for CCM/WEP)
 269  * It does not include post-MAC padding, i.e.,
 270  * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.
 271  * Range of len: 14-2342 bytes.
 272  *
 273  * After the struct fields the MAC header is placed, plus any padding,
 274  * and then the actial payload.
 275  */
 276 struct iwl_tx_cmd {
 277         __le16 len;
 278         __le16 offload_assist;
 279         __le32 tx_flags;
 280         struct {
 281                 u8 try_cnt;
 282                 u8 btkill_cnt;
 283                 __le16 reserved;
 284         } scratch; /* DRAM_SCRATCH_API_U_VER_1 */
 285         __le32 rate_n_flags;
 286         u8 sta_id;
 287         u8 sec_ctl;
 288         u8 initial_rate_index;
 289         u8 reserved2;
 290         u8 key[16];
 291         __le32 reserved3;
 292         __le32 life_time;
 293         __le32 dram_lsb_ptr;
 294         u8 dram_msb_ptr;
 295         u8 rts_retry_limit;
 296         u8 data_retry_limit;
 297         u8 tid_tspec;
 298         __le16 pm_frame_timeout;
 299         __le16 reserved4;
 300         u8 payload[0];
 301         struct ieee80211_hdr hdr[0];
 302 } __packed; /* TX_CMD_API_S_VER_6 */
 303
 304 /*
 305  * TX response related data
 306  */
 307
 308 /*
 309  * enum iwl_tx_status - status that is returned by the fw after attempts to Tx
 310  * @TX_STATUS_SUCCESS:
 311  * @TX_STATUS_DIRECT_DONE:
 312  * @TX_STATUS_POSTPONE_DELAY:
 313  * @TX_STATUS_POSTPONE_FEW_BYTES:
 314  * @TX_STATUS_POSTPONE_BT_PRIO:
 315  * @TX_STATUS_POSTPONE_QUIET_PERIOD:
 316  * @TX_STATUS_POSTPONE_CALC_TTAK:
 317  * @TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY:
 318  * @TX_STATUS_FAIL_SHORT_LIMIT:
 319  * @TX_STATUS_FAIL_LONG_LIMIT:
 320  * @TX_STATUS_FAIL_UNDERRUN:
 321  * @TX_STATUS_FAIL_DRAIN_FLOW:
 322  * @TX_STATUS_FAIL_RFKILL_FLUSH:
 323  * @TX_STATUS_FAIL_LIFE_EXPIRE:
 324  * @TX_STATUS_FAIL_DEST_PS:
 325  * @TX_STATUS_FAIL_HOST_ABORTED:
 326  * @TX_STATUS_FAIL_BT_RETRY:
 327  * @TX_STATUS_FAIL_STA_INVALID:
 328  * @TX_TATUS_FAIL_FRAG_DROPPED:
 329  * @TX_STATUS_FAIL_TID_DISABLE:
 330  * @TX_STATUS_FAIL_FIFO_FLUSHED:
 331  * @TX_STATUS_FAIL_SMALL_CF_POLL:
 332  * @TX_STATUS_FAIL_FW_DROP:
 333  * @TX_STATUS_FAIL_STA_COLOR_MISMATCH: mismatch between color of Tx cmd and
 334  *      STA table
 335  * @TX_FRAME_STATUS_INTERNAL_ABORT:
 336  * @TX_MODE_MSK:
 337  * @TX_MODE_NO_BURST:
 338  * @TX_MODE_IN_BURST_SEQ:
 339  * @TX_MODE_FIRST_IN_BURST:
 340  * @TX_QUEUE_NUM_MSK:
 341  *
 342  * Valid only if frame_count =1
 343  * TODO: complete documentation
 344  */
 345 enum iwl_tx_status {
 346         TX_STATUS_MSK = 0x000000ff,
 347         TX_STATUS_SUCCESS = 0x01,
 348         TX_STATUS_DIRECT_DONE = 0x02,
 349         /* postpone TX */
 350         TX_STATUS_POSTPONE_DELAY = 0x40,
 351         TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
 352         TX_STATUS_POSTPONE_BT_PRIO = 0x42,
 353         TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
 354         TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
 355         /* abort TX */
 356         TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
 357         TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
 358         TX_STATUS_FAIL_LONG_LIMIT = 0x83,
 359         TX_STATUS_FAIL_UNDERRUN = 0x84,
 360         TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
 361         TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
 362         TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
 363         TX_STATUS_FAIL_DEST_PS = 0x88,
 364         TX_STATUS_FAIL_HOST_ABORTED = 0x89,
 365         TX_STATUS_FAIL_BT_RETRY = 0x8a,
 366         TX_STATUS_FAIL_STA_INVALID = 0x8b,
 367         TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
 368         TX_STATUS_FAIL_TID_DISABLE = 0x8d,
 369         TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
 370         TX_STATUS_FAIL_SMALL_CF_POLL = 0x8f,
 371         TX_STATUS_FAIL_FW_DROP = 0x90,
 372         TX_STATUS_FAIL_STA_COLOR_MISMATCH = 0x91,
 373         TX_STATUS_INTERNAL_ABORT = 0x92,
 374         TX_MODE_MSK = 0x00000f00,
 375         TX_MODE_NO_BURST = 0x00000000,
 376         TX_MODE_IN_BURST_SEQ = 0x00000100,
 377         TX_MODE_FIRST_IN_BURST = 0x00000200,
 378         TX_QUEUE_NUM_MSK = 0x0001f000,
 379         TX_NARROW_BW_MSK = 0x00060000,
 380         TX_NARROW_BW_1DIV2 = 0x00020000,
 381         TX_NARROW_BW_1DIV4 = 0x00040000,
 382         TX_NARROW_BW_1DIV8 = 0x00060000,
 383 };
 384
 385 /*
 386  * enum iwl_tx_agg_status - TX aggregation status
 387  * @AGG_TX_STATE_STATUS_MSK:
 388  * @AGG_TX_STATE_TRANSMITTED:
 389  * @AGG_TX_STATE_UNDERRUN:
 390  * @AGG_TX_STATE_BT_PRIO:
 391  * @AGG_TX_STATE_FEW_BYTES:
 392  * @AGG_TX_STATE_ABORT:
 393  * @AGG_TX_STATE_LAST_SENT_TTL:
 394  * @AGG_TX_STATE_LAST_SENT_TRY_CNT:
 395  * @AGG_TX_STATE_LAST_SENT_BT_KILL:
 396  * @AGG_TX_STATE_SCD_QUERY:
 397  * @AGG_TX_STATE_TEST_BAD_CRC32:
 398  * @AGG_TX_STATE_RESPONSE:
 399  * @AGG_TX_STATE_DUMP_TX:
 400  * @AGG_TX_STATE_DELAY_TX:
 401  * @AGG_TX_STATE_TRY_CNT_MSK: Retry count for 1st frame in aggregation (retries
 402  *      occur if tx failed for this frame when it was a member of a previous
 403  *      aggregation block). If rate scaling is used, retry count indicates the
 404  *      rate table entry used for all frames in the new agg.
 405  *@ AGG_TX_STATE_SEQ_NUM_MSK: Command ID and sequence number of Tx command for
 406  *      this frame
 407  *
 408  * TODO: complete documentation
 409  */
 410 enum iwl_tx_agg_status {
 411         AGG_TX_STATE_STATUS_MSK = 0x00fff,
 412         AGG_TX_STATE_TRANSMITTED = 0x000,
 413         AGG_TX_STATE_UNDERRUN = 0x001,
 414         AGG_TX_STATE_BT_PRIO = 0x002,
 415         AGG_TX_STATE_FEW_BYTES = 0x004,
 416         AGG_TX_STATE_ABORT = 0x008,
 417         AGG_TX_STATE_LAST_SENT_TTL = 0x010,
 418         AGG_TX_STATE_LAST_SENT_TRY_CNT = 0x020,
 419         AGG_TX_STATE_LAST_SENT_BT_KILL = 0x040,
 420         AGG_TX_STATE_SCD_QUERY = 0x080,
 421         AGG_TX_STATE_TEST_BAD_CRC32 = 0x0100,
 422         AGG_TX_STATE_RESPONSE = 0x1ff,
 423         AGG_TX_STATE_DUMP_TX = 0x200,
 424         AGG_TX_STATE_DELAY_TX = 0x400,
 425         AGG_TX_STATE_TRY_CNT_POS = 12,
 426         AGG_TX_STATE_TRY_CNT_MSK = 0xf << AGG_TX_STATE_TRY_CNT_POS,
 427 };
 428
 429 #define AGG_TX_STATE_LAST_SENT_MSK  (AGG_TX_STATE_LAST_SENT_TTL| \
 430                                      AGG_TX_STATE_LAST_SENT_TRY_CNT| \
 431                                      AGG_TX_STATE_LAST_SENT_BT_KILL)
 432
 433 /*
 434  * The mask below describes a status where we are absolutely sure that the MPDU
 435  * wasn't sent. For BA/Underrun we cannot be that sure. All we know that we've
 436  * written the bytes to the TXE, but we know nothing about what the DSP did.
 437  */
 438 #define AGG_TX_STAT_FRAME_NOT_SENT (AGG_TX_STATE_FEW_BYTES | \
 439                                     AGG_TX_STATE_ABORT | \
 440                                     AGG_TX_STATE_SCD_QUERY)
 441
 442 /*
 443  * REPLY_TX = 0x1c (response)
 444  *
 445  * This response may be in one of two slightly different formats, indicated
 446  * by the frame_count field:
 447  *
 448  * 1)   No aggregation (frame_count == 1).  This reports Tx results for a single
 449  *      frame. Multiple attempts, at various bit rates, may have been made for
 450  *      this frame.
 451  *
 452  * 2)   Aggregation (frame_count > 1).  This reports Tx results for two or more
 453  *      frames that used block-acknowledge.  All frames were transmitted at
 454  *      same rate. Rate scaling may have been used if first frame in this new
 455  *      agg block failed in previous agg block(s).
 456  *
 457  *      Note that, for aggregation, ACK (block-ack) status is not delivered
 458  *      here; block-ack has not been received by the time the device records
 459  *      this status.
 460  *      This status relates to reasons the tx might have been blocked or aborted
 461  *      within the device, rather than whether it was received successfully by
 462  *      the destination station.
 463  */
 464
 465 /**
 466  * struct agg_tx_status - per packet TX aggregation status
 467  * @status: enum iwl_tx_agg_status
 468  * @sequence: Sequence # for this frame's Tx cmd (not SSN!)
 469  */
 470 struct agg_tx_status {
 471         __le16 status;
 472         __le16 sequence;
 473 } __packed;
 474
 475 /*
 476  * definitions for initial rate index field
 477  * bits [3:0] initial rate index
 478  * bits [6:4] rate table color, used for the initial rate
 479  * bit-7 invalid rate indication
 480  */
 481 #define TX_RES_INIT_RATE_INDEX_MSK 0x0f
 482 #define TX_RES_RATE_TABLE_COLOR_MSK 0x70
 483 #define TX_RES_INV_RATE_INDEX_MSK 0x80
 484
 485 #define IWL_MVM_TX_RES_GET_TID(_ra_tid) ((_ra_tid) & 0x0f)
 486 #define IWL_MVM_TX_RES_GET_RA(_ra_tid) ((_ra_tid) >> 4)
 487
 488 /**
 489  * struct iwl_mvm_tx_resp - notifies that fw is TXing a packet
 490  * ( REPLY_TX = 0x1c )
 491  * @frame_count: 1 no aggregation, >1 aggregation
 492  * @bt_kill_count: num of times blocked by bluetooth (unused for agg)
 493  * @failure_rts: num of failures due to unsuccessful RTS
 494  * @failure_frame: num failures due to no ACK (unused for agg)
 495  * @initial_rate: for non-agg: rate of the successful Tx. For agg: rate of the
 496  *      Tx of all the batch. RATE_MCS_*
 497  * @wireless_media_time: for non-agg: RTS + CTS + frame tx attempts time + ACK.
 498  *      for agg: RTS + CTS + aggregation tx time + block-ack time.
 499  *      in usec.
 500  * @pa_status: tx power info
 501  * @pa_integ_res_a: tx power info
 502  * @pa_integ_res_b: tx power info
 503  * @pa_integ_res_c: tx power info
 504  * @measurement_req_id: tx power info
 505  * @tfd_info: TFD information set by the FH
 506  * @seq_ctl: sequence control from the Tx cmd
 507  * @byte_cnt: byte count from the Tx cmd
 508  * @tlc_info: TLC rate info
 509  * @ra_tid: bits [3:0] = ra, bits [7:4] = tid
 510  * @frame_ctrl: frame control
 511  * @status: for non-agg:  frame status TX_STATUS_*
 512  *      for agg: status of 1st frame, AGG_TX_STATE_*; other frame status fields
 513  *      follow this one, up to frame_count.
 514  *
 515  * After the array of statuses comes the SSN of the SCD. Look at
 516  * %iwl_mvm_get_scd_ssn for more details.
 517  */
 518 struct iwl_mvm_tx_resp {
 519         u8 frame_count;
 520         u8 bt_kill_count;
 521         u8 failure_rts;
 522         u8 failure_frame;
 523         __le32 initial_rate;
 524         __le16 wireless_media_time;
 525
 526         u8 pa_status;
 527         u8 pa_integ_res_a[3];
 528         u8 pa_integ_res_b[3];
 529         u8 pa_integ_res_c[3];
 530         __le16 measurement_req_id;
 531         u8 reduced_tpc;
 532         u8 reserved;
 533
 534         __le32 tfd_info;
 535         __le16 seq_ctl;
 536         __le16 byte_cnt;
 537         u8 tlc_info;
 538         u8 ra_tid;
 539         __le16 frame_ctrl;
 540
 541         struct agg_tx_status status;
 542 } __packed; /* TX_RSP_API_S_VER_3 */
 543
 544 /**
 545  * struct iwl_mvm_ba_notif - notifies about reception of BA
 546  * ( BA_NOTIF = 0xc5 )
 547  * @sta_addr_lo32: lower 32 bits of the MAC address
 548  * @sta_addr_hi16: upper 16 bits of the MAC address
 549  * @sta_id: Index of recipient (BA-sending) station in fw's station table
 550  * @tid: tid of the session
 551  * @seq_ctl:
 552  * @bitmap: the bitmap of the BA notification as seen in the air
 553  * @scd_flow: the tx queue this BA relates to
 554  * @scd_ssn: the index of the last contiguously sent packet
 555  * @txed: number of Txed frames in this batch
 556  * @txed_2_done: number of Acked frames in this batch
 557  * @reduced_txp: power reduced according to TPC. This is the actual value and
 558  *      not a copy from the LQ command. Thus, if not the first rate was used
 559  *      for Tx-ing then this value will be set to 0 by FW.
 560  */
 561 struct iwl_mvm_ba_notif {
 562         __le32 sta_addr_lo32;
 563         __le16 sta_addr_hi16;
 564         __le16 reserved;
 565
 566         u8 sta_id;
 567         u8 tid;
 568         __le16 seq_ctl;
 569         __le64 bitmap;
 570         __le16 scd_flow;
 571         __le16 scd_ssn;
 572         u8 txed;
 573         u8 txed_2_done;
 574         u8 reduced_txp;
 575         u8 reserved1;
 576 } __packed;
 577
 578 /**
 579  * struct iwl_mvm_compressed_ba_tfd - progress of a TFD queue
 580  * @q_num: TFD queue number
 581  * @tfd_index: Index of first un-acked frame in the  TFD queue
 582  */
 583 struct iwl_mvm_compressed_ba_tfd {
 584         u8 q_num;
 585         u8 reserved;
 586         __le16 tfd_index;
 587 } __packed; /* COMPRESSED_BA_TFD_API_S_VER_1 */
 588
 589 /**
 590  * struct iwl_mvm_compressed_ba_ratid - progress of a RA TID queue
 591  * @q_num: RA TID queue number
 592  * @tid: TID of the queue
 593  * @ssn: BA window current SSN
 594  */
 595 struct iwl_mvm_compressed_ba_ratid {
 596         u8 q_num;
 597         u8 tid;
 598         __le16 ssn;
 599 } __packed; /* COMPRESSED_BA_RATID_API_S_VER_1 */
 600
 601 /*
 602  * enum iwl_mvm_ba_resp_flags - TX aggregation status
 603  * @IWL_MVM_BA_RESP_TX_AGG: generated due to BA
 604  * @IWL_MVM_BA_RESP_TX_BAR: generated due to BA after BAR
 605  * @IWL_MVM_BA_RESP_TX_AGG_FAIL: aggregation didn't receive BA
 606  * @IWL_MVM_BA_RESP_TX_UNDERRUN: aggregation got underrun
 607  * @IWL_MVM_BA_RESP_TX_BT_KILL: aggregation got BT-kill
 608  * @IWL_MVM_BA_RESP_TX_DSP_TIMEOUT: aggregation didn't finish within the
 609  *      expected time
 610  */
 611 enum iwl_mvm_ba_resp_flags {
 612         IWL_MVM_BA_RESP_TX_AGG,
 613         IWL_MVM_BA_RESP_TX_BAR,
 614         IWL_MVM_BA_RESP_TX_AGG_FAIL,
 615         IWL_MVM_BA_RESP_TX_UNDERRUN,
 616         IWL_MVM_BA_RESP_TX_BT_KILL,
 617         IWL_MVM_BA_RESP_TX_DSP_TIMEOUT
 618 };
 619
 620 /**
 621  * struct iwl_mvm_compressed_ba_notif - notifies about reception of BA
 622  * ( BA_NOTIF = 0xc5 )
 623  * @flags: status flag, see the &iwl_mvm_ba_resp_flags
 624  * @sta_id: Index of recipient (BA-sending) station in fw's station table
 625  * @reduced_txp: power reduced according to TPC. This is the actual value and
 626  *      not a copy from the LQ command. Thus, if not the first rate was used
 627  *      for Tx-ing then this value will be set to 0 by FW.
 628  * @initial_rate: TLC rate info, initial rate index, TLC table color
 629  * @retry_cnt: retry count
 630  * @query_byte_cnt: SCD query byte count
 631  * @query_frame_cnt: SCD query frame count
 632  * @txed: number of frames sent in the aggregation (all-TIDs)
 633  * @done: number of frames that were Acked by the BA (all-TIDs)
 634  * @wireless_time: Wireless-media time
 635  * @tx_rate: the rate the aggregation was sent at
 636  * @tfd_cnt: number of TFD-Q elements
 637  * @ra_tid_cnt: number of RATID-Q elements
 638  */
 639 struct iwl_mvm_compressed_ba_notif {
 640         __le32 flags;
 641         u8 sta_id;
 642         u8 reduced_txp;
 643         u8 initial_rate;
 644         u8 retry_cnt;
 645         __le32 query_byte_cnt;
 646         __le16 query_frame_cnt;
 647         __le16 txed;
 648         __le16 done;
 649         __le32 wireless_time;
 650         __le32 tx_rate;
 651         __le16 tfd_cnt;
 652         __le16 ra_tid_cnt;
 653         struct iwl_mvm_compressed_ba_tfd tfd[1];
 654         struct iwl_mvm_compressed_ba_ratid ra_tid[0];
 655 } __packed; /* COMPRESSED_BA_RES_API_S_VER_4 */
 656
 657 /**
 658  * struct iwl_mac_beacon_cmd_v6 - beacon template command
 659  * @tx: the tx commands associated with the beacon frame
 660  * @template_id: currently equal to the mac context id of the coresponding
 661  *  mac.
 662  * @tim_idx: the offset of the tim IE in the beacon
 663  * @tim_size: the length of the tim IE
 664  * @frame: the template of the beacon frame
 665  */
 666 struct iwl_mac_beacon_cmd_v6 {
 667         struct iwl_tx_cmd tx;
 668         __le32 template_id;
 669         __le32 tim_idx;
 670         __le32 tim_size;
 671         struct ieee80211_hdr frame[0];
 672 } __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_6 */
 673
 674 /**
 675  * struct iwl_mac_beacon_cmd - beacon template command with offloaded CSA
 676  * @tx: the tx commands associated with the beacon frame
 677  * @template_id: currently equal to the mac context id of the coresponding
 678  *  mac.
 679  * @tim_idx: the offset of the tim IE in the beacon
 680  * @tim_size: the length of the tim IE
 681  * @ecsa_offset: offset to the ECSA IE if present
 682  * @csa_offset: offset to the CSA IE if present
 683  * @frame: the template of the beacon frame
 684  */
 685 struct iwl_mac_beacon_cmd {
 686         struct iwl_tx_cmd tx;
 687         __le32 template_id;
 688         __le32 tim_idx;
 689         __le32 tim_size;
 690         __le32 ecsa_offset;
 691         __le32 csa_offset;
 692         struct ieee80211_hdr frame[0];
 693 } __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_7 */
 694
 695 struct iwl_beacon_notif {
 696         struct iwl_mvm_tx_resp beacon_notify_hdr;
 697         __le64 tsf;
 698         __le32 ibss_mgr_status;
 699 } __packed;
 700
 701 /**
 702  * struct iwl_extended_beacon_notif - notifies about beacon transmission
 703  * @beacon_notify_hdr: tx response command associated with the beacon
 704  * @tsf: last beacon tsf
 705  * @ibss_mgr_status: whether IBSS is manager
 706  * @gp2: last beacon time in gp2
 707  */
 708 struct iwl_extended_beacon_notif {
 709         struct iwl_mvm_tx_resp beacon_notify_hdr;
 710         __le64 tsf;
 711         __le32 ibss_mgr_status;
 712         __le32 gp2;
 713 } __packed; /* BEACON_NTFY_API_S_VER_5 */
 714
 715 /**
 716  * enum iwl_dump_control - dump (flush) control flags
 717  * @DUMP_TX_FIFO_FLUSH: Dump MSDUs until the the FIFO is empty
 718  *      and the TFD queues are empty.
 719  */
 720 enum iwl_dump_control {
 721         DUMP_TX_FIFO_FLUSH      = BIT(1),
 722 };
 723
 724 /**
 725  * struct iwl_tx_path_flush_cmd -- queue/FIFO flush command
 726  * @queues_ctl: bitmap of queues to flush
 727  * @flush_ctl: control flags
 728  * @reserved: reserved
 729  */
 730 struct iwl_tx_path_flush_cmd {
 731         __le32 queues_ctl;
 732         __le16 flush_ctl;
 733         __le16 reserved;
 734 } __packed; /* TX_PATH_FLUSH_CMD_API_S_VER_1 */
 735
 736 /**
 737  * iwl_mvm_get_scd_ssn - returns the SSN of the SCD
 738  * @tx_resp: the Tx response from the fw (agg or non-agg)
 739  *
 740  * When the fw sends an AMPDU, it fetches the MPDUs one after the other. Since
 741  * it can't know that everything will go well until the end of the AMPDU, it
 742  * can't know in advance the number of MPDUs that will be sent in the current
 743  * batch. This is why it writes the agg Tx response while it fetches the MPDUs.
 744  * Hence, it can't know in advance what the SSN of the SCD will be at the end
 745  * of the batch. This is why the SSN of the SCD is written at the end of the
 746  * whole struct at a variable offset. This function knows how to cope with the
 747  * variable offset and returns the SSN of the SCD.
 748  */
 749 static inline u32 iwl_mvm_get_scd_ssn(struct iwl_mvm_tx_resp *tx_resp)
 750 {
 751         return le32_to_cpup((__le32 *)&tx_resp->status +
 752                             tx_resp->frame_count) & 0xfff;
 753 }
 754
 755 /* Available options for the SCD_QUEUE_CFG HCMD */
 756 enum iwl_scd_cfg_actions {
 757         SCD_CFG_DISABLE_QUEUE           = 0x0,
 758         SCD_CFG_ENABLE_QUEUE            = 0x1,
 759         SCD_CFG_UPDATE_QUEUE_TID        = 0x2,
 760 };
 761
 762 /**
 763  * struct iwl_scd_txq_cfg_cmd - New txq hw scheduler config command
 764  * @token:
 765  * @sta_id: station id
 766  * @tid:
 767  * @scd_queue: scheduler queue to confiug
 768  * @action: 1 queue enable, 0 queue disable, 2 change txq's tid owner
 769  *      Value is one of %iwl_scd_cfg_actions options
 770  * @aggregate: 1 aggregated queue, 0 otherwise
 771  * @tx_fifo: %enum iwl_mvm_tx_fifo
 772  * @window: BA window size
 773  * @ssn: SSN for the BA agreement
 774  */
 775 struct iwl_scd_txq_cfg_cmd {
 776         u8 token;
 777         u8 sta_id;
 778         u8 tid;
 779         u8 scd_queue;
 780         u8 action;
 781         u8 aggregate;
 782         u8 tx_fifo;
 783         u8 window;
 784         __le16 ssn;
 785         __le16 reserved;
 786 } __packed; /* SCD_QUEUE_CFG_CMD_API_S_VER_1 */
 787
 788 /**
 789  * struct iwl_scd_txq_cfg_rsp
 790  * @token: taken from the command
 791  * @sta_id: station id from the command
 792  * @tid: tid from the command
 793  * @scd_queue: scd_queue from the command
 794  */
 795 struct iwl_scd_txq_cfg_rsp {
 796         u8 token;
 797         u8 sta_id;
 798         u8 tid;
 799         u8 scd_queue;
 800 } __packed; /* SCD_QUEUE_CFG_RSP_API_S_VER_1 */
 801
 802 #endif /* __fw_api_tx_h__ */