1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2/* 3 * Copyright (C) 2012-2014, 2018-2023 Intel Corporation 4 * Copyright (C) 2016-2017 Intel Deutschland GmbH 5 */ 6#ifndef __iwl_fw_api_tx_h__ 7#define __iwl_fw_api_tx_h__ 8#include <linux/ieee80211.h> 9 10/** 11 * enum iwl_tx_flags - bitmasks for tx_flags in TX command 12 * @TX_CMD_FLG_PROT_REQUIRE: use RTS or CTS-to-self to protect the frame 13 * @TX_CMD_FLG_WRITE_TX_POWER: update current tx power value in the mgmt frame 14 * @TX_CMD_FLG_ACK: expect ACK from receiving station 15 * @TX_CMD_FLG_STA_RATE: use RS table with initial index from the TX command. 16 * Otherwise, use rate_n_flags from the TX command 17 * @TX_CMD_FLG_BAR: this frame is a BA request, immediate BAR is expected 18 * Must set TX_CMD_FLG_ACK with this flag. 19 * @TX_CMD_FLG_TXOP_PROT: TXOP protection requested 20 * @TX_CMD_FLG_VHT_NDPA: mark frame is NDPA for VHT beamformer sequence 21 * @TX_CMD_FLG_HT_NDPA: mark frame is NDPA for HT beamformer sequence 22 * @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC) 23 * @TX_CMD_FLG_BT_PRIO_MASK: BT priority value 24 * @TX_CMD_FLG_BT_PRIO_POS: the position of the BT priority (bit 11 is ignored 25 * on old firmwares). 26 * @TX_CMD_FLG_BT_DIS: disable BT priority for this frame 27 * @TX_CMD_FLG_SEQ_CTL: set if FW should override the sequence control. 28 * Should be set for mgmt, non-QOS data, mcast, bcast and in scan command 29 * @TX_CMD_FLG_MORE_FRAG: this frame is non-last MPDU 30 * @TX_CMD_FLG_TSF: FW should calculate and insert TSF in the frame 31 * Should be set for beacons and probe responses 32 * @TX_CMD_FLG_CALIB: activate PA TX power calibrations 33 * @TX_CMD_FLG_KEEP_SEQ_CTL: if seq_ctl is set, don't increase inner seq count 34 * @TX_CMD_FLG_MH_PAD: driver inserted 2 byte padding after MAC header. 35 * Should be set for 26/30 length MAC headers 36 * @TX_CMD_FLG_RESP_TO_DRV: zero this if the response should go only to FW 37 * @TX_CMD_FLG_TKIP_MIC_DONE: FW already performed TKIP MIC calculation 38 * @TX_CMD_FLG_DUR: disable duration overwriting used in PS-Poll Assoc-id 39 * @TX_CMD_FLG_FW_DROP: FW should mark frame to be dropped 40 * @TX_CMD_FLG_EXEC_PAPD: execute PAPD 41 * @TX_CMD_FLG_PAPD_TYPE: 0 for reference power, 1 for nominal power 42 * @TX_CMD_FLG_HCCA_CHUNK: mark start of TSPEC chunk 43 */ 44enum iwl_tx_flags { 45 TX_CMD_FLG_PROT_REQUIRE = BIT(0), 46 TX_CMD_FLG_WRITE_TX_POWER = BIT(1), 47 TX_CMD_FLG_ACK = BIT(3), 48 TX_CMD_FLG_STA_RATE = BIT(4), 49 TX_CMD_FLG_BAR = BIT(6), 50 TX_CMD_FLG_TXOP_PROT = BIT(7), 51 TX_CMD_FLG_VHT_NDPA = BIT(8), 52 TX_CMD_FLG_HT_NDPA = BIT(9), 53 TX_CMD_FLG_CSI_FDBK2HOST = BIT(10), 54 TX_CMD_FLG_BT_PRIO_POS = 11, 55 TX_CMD_FLG_BT_PRIO_MASK = BIT(11) | BIT(12), 56 TX_CMD_FLG_BT_DIS = BIT(12), 57 TX_CMD_FLG_SEQ_CTL = BIT(13), 58 TX_CMD_FLG_MORE_FRAG = BIT(14), 59 TX_CMD_FLG_TSF = BIT(16), 60 TX_CMD_FLG_CALIB = BIT(17), 61 TX_CMD_FLG_KEEP_SEQ_CTL = BIT(18), 62 TX_CMD_FLG_MH_PAD = BIT(20), 63 TX_CMD_FLG_RESP_TO_DRV = BIT(21), 64 TX_CMD_FLG_TKIP_MIC_DONE = BIT(23), 65 TX_CMD_FLG_DUR = BIT(25), 66 TX_CMD_FLG_FW_DROP = BIT(26), 67 TX_CMD_FLG_EXEC_PAPD = BIT(27), 68 TX_CMD_FLG_PAPD_TYPE = BIT(28), 69 TX_CMD_FLG_HCCA_CHUNK = BIT(31) 70}; /* TX_FLAGS_BITS_API_S_VER_1 */ 71 72/** 73 * enum iwl_tx_cmd_flags - bitmasks for tx_flags in TX command for 22000 74 * @IWL_TX_FLAGS_CMD_RATE: use rate from the TX command 75 * @IWL_TX_FLAGS_ENCRYPT_DIS: frame should not be encrypted, even if it belongs 76 * to a secured STA 77 * @IWL_TX_FLAGS_HIGH_PRI: high priority frame (like EAPOL) - can affect rate 78 * selection, retry limits and BT kill 79 */ 80enum iwl_tx_cmd_flags { 81 IWL_TX_FLAGS_CMD_RATE = BIT(0), 82 IWL_TX_FLAGS_ENCRYPT_DIS = BIT(1), 83 IWL_TX_FLAGS_HIGH_PRI = BIT(2), 84 /* Use these flags only from 85 * TX_FLAGS_BITS_API_S_VER_4 and above */ 86 IWL_TX_FLAGS_RTS = BIT(3), 87 IWL_TX_FLAGS_CTS = BIT(4), 88}; /* TX_FLAGS_BITS_API_S_VER_3 */ 89 90/** 91 * enum iwl_tx_pm_timeouts - pm timeout values in TX command 92 * @PM_FRAME_NONE: no need to suspend sleep mode 93 * @PM_FRAME_MGMT: fw suspend sleep mode for 100TU 94 * @PM_FRAME_ASSOC: fw suspend sleep mode for 10sec 95 */ 96enum iwl_tx_pm_timeouts { 97 PM_FRAME_NONE = 0, 98 PM_FRAME_MGMT = 2, 99 PM_FRAME_ASSOC = 3, 100}; 101 102#define TX_CMD_SEC_MSK 0x07 103#define TX_CMD_SEC_WEP_KEY_IDX_POS 6 104#define TX_CMD_SEC_WEP_KEY_IDX_MSK 0xc0 105 106/** 107 * enum iwl_tx_cmd_sec_ctrl - bitmasks for security control in TX command 108 * @TX_CMD_SEC_WEP: WEP encryption algorithm. 109 * @TX_CMD_SEC_CCM: CCM encryption algorithm. 110 * @TX_CMD_SEC_TKIP: TKIP encryption algorithm. 111 * @TX_CMD_SEC_EXT: extended cipher algorithm. 112 * @TX_CMD_SEC_GCMP: GCMP encryption algorithm. 113 * @TX_CMD_SEC_KEY128: set for 104 bits WEP key. 114 * @TX_CMD_SEC_KEY_FROM_TABLE: for a non-WEP key, set if the key should be taken 115 * from the table instead of from the TX command. 116 * If the key is taken from the key table its index should be given by the 117 * first byte of the TX command key field. 118 */ 119enum iwl_tx_cmd_sec_ctrl { 120 TX_CMD_SEC_WEP = 0x01, 121 TX_CMD_SEC_CCM = 0x02, 122 TX_CMD_SEC_TKIP = 0x03, 123 TX_CMD_SEC_EXT = 0x04, 124 TX_CMD_SEC_GCMP = 0x05, 125 TX_CMD_SEC_KEY128 = 0x08, 126 TX_CMD_SEC_KEY_FROM_TABLE = 0x10, 127}; 128 129/* 130 * TX command Frame life time in us - to be written in pm_frame_timeout 131 */ 132#define TX_CMD_LIFE_TIME_INFINITE 0xFFFFFFFF 133#define TX_CMD_LIFE_TIME_DEFAULT 2000000 /* 2000 ms*/ 134#define TX_CMD_LIFE_TIME_PROBE_RESP 40000 /* 40 ms */ 135#define TX_CMD_LIFE_TIME_EXPIRED_FRAME 0 136 137/* 138 * TID for non QoS frames - to be written in tid_tspec 139 */ 140#define IWL_TID_NON_QOS 0 141 142/* 143 * Limits on the retransmissions - to be written in {data,rts}_retry_limit 144 */ 145#define IWL_DEFAULT_TX_RETRY 15 146#define IWL_MGMT_DFAULT_RETRY_LIMIT 3 147#define IWL_RTS_DFAULT_RETRY_LIMIT 60 148#define IWL_BAR_DFAULT_RETRY_LIMIT 60 149#define IWL_LOW_RETRY_LIMIT 7 150 151/** 152 * enum iwl_tx_offload_assist_flags_pos - set %iwl_tx_cmd offload_assist values 153 * @TX_CMD_OFFLD_IP_HDR: offset to start of IP header (in words) 154 * from mac header end. For normal case it is 4 words for SNAP. 155 * note: tx_cmd, mac header and pad are not counted in the offset. 156 * This is used to help the offload in case there is tunneling such as 157 * IPv6 in IPv4, in such case the ip header offset should point to the 158 * inner ip header and IPv4 checksum of the external header should be 159 * calculated by driver. 160 * @TX_CMD_OFFLD_L4_EN: enable TCP/UDP checksum 161 * @TX_CMD_OFFLD_L3_EN: enable IP header checksum 162 * @TX_CMD_OFFLD_MH_SIZE: size of the mac header in words. Includes the IV 163 * field. Doesn't include the pad. 164 * @TX_CMD_OFFLD_PAD: mark 2-byte pad was inserted after the mac header for 165 * alignment 166 * @TX_CMD_OFFLD_AMSDU: mark TX command is A-MSDU 167 */ 168enum iwl_tx_offload_assist_flags_pos { 169 TX_CMD_OFFLD_IP_HDR = 0, 170 TX_CMD_OFFLD_L4_EN = 6, 171 TX_CMD_OFFLD_L3_EN = 7, 172 TX_CMD_OFFLD_MH_SIZE = 8, 173 TX_CMD_OFFLD_PAD = 13, 174 TX_CMD_OFFLD_AMSDU = 14, 175}; 176 177#define IWL_TX_CMD_OFFLD_MH_MASK 0x1f 178#define IWL_TX_CMD_OFFLD_IP_HDR_MASK 0x3f 179 180/* TODO: complete documentation for try_cnt and btkill_cnt */ 181/** 182 * struct iwl_tx_cmd - TX command struct to FW 183 * ( TX_CMD = 0x1c ) 184 * @len: in bytes of the payload, see below for details 185 * @offload_assist: TX offload configuration 186 * @tx_flags: combination of TX_CMD_FLG_*, see &enum iwl_tx_flags 187 * @scratch: scratch buffer used by the device 188 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is 189 * cleared. Combination of RATE_MCS_* 190 * @sta_id: index of destination station in FW station table 191 * @sec_ctl: security control, TX_CMD_SEC_* 192 * @initial_rate_index: index into the the rate table for initial TX attempt. 193 * Applied if TX_CMD_FLG_STA_RATE_MSK is set, normally 0 for data frames. 194 * @reserved2: reserved 195 * @key: security key 196 * @reserved3: reserved 197 * @life_time: frame life time (usecs??) 198 * @dram_lsb_ptr: Physical address of scratch area in the command (try_cnt + 199 * btkill_cnd + reserved), first 32 bits. "0" disables usage. 200 * @dram_msb_ptr: upper bits of the scratch physical address 201 * @rts_retry_limit: max attempts for RTS 202 * @data_retry_limit: max attempts to send the data packet 203 * @tid_tspec: TID/tspec 204 * @pm_frame_timeout: PM TX frame timeout 205 * @reserved4: reserved 206 * @payload: payload (same as @hdr) 207 * @hdr: 802.11 header (same as @payload) 208 * 209 * The byte count (both len and next_frame_len) includes MAC header 210 * (24/26/30/32 bytes) 211 * + 2 bytes pad if 26/30 header size 212 * + 8 byte IV for CCM or TKIP (not used for WEP) 213 * + Data payload 214 * + 8-byte MIC (not used for CCM/WEP) 215 * It does not include post-MAC padding, i.e., 216 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes. 217 * Range of len: 14-2342 bytes. 218 * 219 * After the struct fields the MAC header is placed, plus any padding, 220 * and then the actial payload. 221 */ 222struct iwl_tx_cmd { 223 __le16 len; 224 __le16 offload_assist; 225 __le32 tx_flags; 226 struct { 227 u8 try_cnt; 228 u8 btkill_cnt; 229 __le16 reserved; 230 } scratch; /* DRAM_SCRATCH_API_U_VER_1 */ 231 __le32 rate_n_flags; 232 u8 sta_id; 233 u8 sec_ctl; 234 u8 initial_rate_index; 235 u8 reserved2; 236 u8 key[16]; 237 __le32 reserved3; 238 __le32 life_time; 239 __le32 dram_lsb_ptr; 240 u8 dram_msb_ptr; 241 u8 rts_retry_limit; 242 u8 data_retry_limit; 243 u8 tid_tspec; 244 __le16 pm_frame_timeout; 245 __le16 reserved4; 246 union { 247 DECLARE_FLEX_ARRAY(u8, payload); 248 DECLARE_FLEX_ARRAY(struct ieee80211_hdr, hdr); 249 }; 250} __packed; /* TX_CMD_API_S_VER_6 */ 251 252struct iwl_dram_sec_info { 253 __le32 pn_low; 254 __le16 pn_high; 255 __le16 aux_info; 256} __packed; /* DRAM_SEC_INFO_API_S_VER_1 */ 257 258/** 259 * struct iwl_tx_cmd_gen2 - TX command struct to FW for 22000 devices 260 * ( TX_CMD = 0x1c ) 261 * @len: in bytes of the payload, see below for details 262 * @offload_assist: TX offload configuration 263 * @flags: combination of &enum iwl_tx_cmd_flags 264 * @dram_info: FW internal DRAM storage 265 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is 266 * cleared. Combination of RATE_MCS_* 267 * @hdr: 802.11 header 268 */ 269struct iwl_tx_cmd_gen2 { 270 __le16 len; 271 __le16 offload_assist; 272 __le32 flags; 273 struct iwl_dram_sec_info dram_info; 274 __le32 rate_n_flags; 275 struct ieee80211_hdr hdr[]; 276} __packed; /* TX_CMD_API_S_VER_7, 277 TX_CMD_API_S_VER_9 */ 278 279/** 280 * struct iwl_tx_cmd_gen3 - TX command struct to FW for AX210+ devices 281 * ( TX_CMD = 0x1c ) 282 * @len: in bytes of the payload, see below for details 283 * @flags: combination of &enum iwl_tx_cmd_flags 284 * @offload_assist: TX offload configuration 285 * @dram_info: FW internal DRAM storage 286 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is 287 * cleared. Combination of RATE_MCS_* 288 * @reserved: reserved 289 * @hdr: 802.11 header 290 */ 291struct iwl_tx_cmd_gen3 { 292 __le16 len; 293 __le16 flags; 294 __le32 offload_assist; 295 struct iwl_dram_sec_info dram_info; 296 __le32 rate_n_flags; 297 u8 reserved[8]; 298 struct ieee80211_hdr hdr[]; 299} __packed; /* TX_CMD_API_S_VER_8, 300 TX_CMD_API_S_VER_10 */ 301 302/* 303 * TX response related data 304 */ 305 306/* 307 * enum iwl_tx_status - status that is returned by the fw after attempts to Tx 308 * @TX_STATUS_SUCCESS: 309 * @TX_STATUS_DIRECT_DONE: 310 * @TX_STATUS_POSTPONE_DELAY: 311 * @TX_STATUS_POSTPONE_FEW_BYTES: 312 * @TX_STATUS_POSTPONE_BT_PRIO: 313 * @TX_STATUS_POSTPONE_QUIET_PERIOD: 314 * @TX_STATUS_POSTPONE_CALC_TTAK: 315 * @TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY: 316 * @TX_STATUS_FAIL_SHORT_LIMIT: 317 * @TX_STATUS_FAIL_LONG_LIMIT: 318 * @TX_STATUS_FAIL_UNDERRUN: 319 * @TX_STATUS_FAIL_DRAIN_FLOW: 320 * @TX_STATUS_FAIL_RFKILL_FLUSH: 321 * @TX_STATUS_FAIL_LIFE_EXPIRE: 322 * @TX_STATUS_FAIL_DEST_PS: 323 * @TX_STATUS_FAIL_HOST_ABORTED: 324 * @TX_STATUS_FAIL_BT_RETRY: 325 * @TX_STATUS_FAIL_STA_INVALID: 326 * @TX_TATUS_FAIL_FRAG_DROPPED: 327 * @TX_STATUS_FAIL_TID_DISABLE: 328 * @TX_STATUS_FAIL_FIFO_FLUSHED: 329 * @TX_STATUS_FAIL_SMALL_CF_POLL: 330 * @TX_STATUS_FAIL_FW_DROP: 331 * @TX_STATUS_FAIL_STA_COLOR_MISMATCH: mismatch between color of Tx cmd and 332 * STA table 333 * @TX_FRAME_STATUS_INTERNAL_ABORT: 334 * @TX_MODE_MSK: 335 * @TX_MODE_NO_BURST: 336 * @TX_MODE_IN_BURST_SEQ: 337 * @TX_MODE_FIRST_IN_BURST: 338 * @TX_QUEUE_NUM_MSK: 339 * 340 * Valid only if frame_count =1 341 * TODO: complete documentation 342 */ 343enum iwl_tx_status { 344 TX_STATUS_MSK = 0x000000ff, 345 TX_STATUS_SUCCESS = 0x01, 346 TX_STATUS_DIRECT_DONE = 0x02, 347 /* postpone TX */ 348 TX_STATUS_POSTPONE_DELAY = 0x40, 349 TX_STATUS_POSTPONE_FEW_BYTES = 0x41, 350 TX_STATUS_POSTPONE_BT_PRIO = 0x42, 351 TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43, 352 TX_STATUS_POSTPONE_CALC_TTAK = 0x44, 353 /* abort TX */ 354 TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81, 355 TX_STATUS_FAIL_SHORT_LIMIT = 0x82, 356 TX_STATUS_FAIL_LONG_LIMIT = 0x83, 357 TX_STATUS_FAIL_UNDERRUN = 0x84, 358 TX_STATUS_FAIL_DRAIN_FLOW = 0x85, 359 TX_STATUS_FAIL_RFKILL_FLUSH = 0x86, 360 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87, 361 TX_STATUS_FAIL_DEST_PS = 0x88, 362 TX_STATUS_FAIL_HOST_ABORTED = 0x89, 363 TX_STATUS_FAIL_BT_RETRY = 0x8a, 364 TX_STATUS_FAIL_STA_INVALID = 0x8b, 365 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c, 366 TX_STATUS_FAIL_TID_DISABLE = 0x8d, 367 TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e, 368 TX_STATUS_FAIL_SMALL_CF_POLL = 0x8f, 369 TX_STATUS_FAIL_FW_DROP = 0x90, 370 TX_STATUS_FAIL_STA_COLOR_MISMATCH = 0x91, 371 TX_STATUS_INTERNAL_ABORT = 0x92, 372 TX_MODE_MSK = 0x00000f00, 373 TX_MODE_NO_BURST = 0x00000000, 374 TX_MODE_IN_BURST_SEQ = 0x00000100, 375 TX_MODE_FIRST_IN_BURST = 0x00000200, 376 TX_QUEUE_NUM_MSK = 0x0001f000, 377 TX_NARROW_BW_MSK = 0x00060000, 378 TX_NARROW_BW_1DIV2 = 0x00020000, 379 TX_NARROW_BW_1DIV4 = 0x00040000, 380 TX_NARROW_BW_1DIV8 = 0x00060000, 381}; 382 383/* 384 * enum iwl_tx_agg_status - TX aggregation status 385 * @AGG_TX_STATE_STATUS_MSK: 386 * @AGG_TX_STATE_TRANSMITTED: 387 * @AGG_TX_STATE_UNDERRUN: 388 * @AGG_TX_STATE_BT_PRIO: 389 * @AGG_TX_STATE_FEW_BYTES: 390 * @AGG_TX_STATE_ABORT: 391 * @AGG_TX_STATE_TX_ON_AIR_DROP: TX_ON_AIR signal drop without underrun or 392 * BT detection 393 * @AGG_TX_STATE_LAST_SENT_TRY_CNT: 394 * @AGG_TX_STATE_LAST_SENT_BT_KILL: 395 * @AGG_TX_STATE_SCD_QUERY: 396 * @AGG_TX_STATE_TEST_BAD_CRC32: 397 * @AGG_TX_STATE_RESPONSE: 398 * @AGG_TX_STATE_DUMP_TX: 399 * @AGG_TX_STATE_DELAY_TX: 400 * @AGG_TX_STATE_TRY_CNT_MSK: Retry count for 1st frame in aggregation (retries 401 * occur if tx failed for this frame when it was a member of a previous 402 * aggregation block). If rate scaling is used, retry count indicates the 403 * rate table entry used for all frames in the new agg. 404 * @AGG_TX_STATE_SEQ_NUM_MSK: Command ID and sequence number of Tx command for 405 * this frame 406 * 407 * TODO: complete documentation 408 */ 409enum iwl_tx_agg_status { 410 AGG_TX_STATE_STATUS_MSK = 0x00fff, 411 AGG_TX_STATE_TRANSMITTED = 0x000, 412 AGG_TX_STATE_UNDERRUN = 0x001, 413 AGG_TX_STATE_BT_PRIO = 0x002, 414 AGG_TX_STATE_FEW_BYTES = 0x004, 415 AGG_TX_STATE_ABORT = 0x008, 416 AGG_TX_STATE_TX_ON_AIR_DROP = 0x010, 417 AGG_TX_STATE_LAST_SENT_TRY_CNT = 0x020, 418 AGG_TX_STATE_LAST_SENT_BT_KILL = 0x040, 419 AGG_TX_STATE_SCD_QUERY = 0x080, 420 AGG_TX_STATE_TEST_BAD_CRC32 = 0x0100, 421 AGG_TX_STATE_RESPONSE = 0x1ff, 422 AGG_TX_STATE_DUMP_TX = 0x200, 423 AGG_TX_STATE_DELAY_TX = 0x400, 424 AGG_TX_STATE_TRY_CNT_POS = 12, 425 AGG_TX_STATE_TRY_CNT_MSK = 0xf << AGG_TX_STATE_TRY_CNT_POS, 426}; 427 428/* 429 * The mask below describes a status where we are absolutely sure that the MPDU 430 * wasn't sent. For BA/Underrun we cannot be that sure. All we know that we've 431 * written the bytes to the TXE, but we know nothing about what the DSP did. 432 */ 433#define AGG_TX_STAT_FRAME_NOT_SENT (AGG_TX_STATE_FEW_BYTES | \ 434 AGG_TX_STATE_ABORT | \ 435 AGG_TX_STATE_SCD_QUERY) 436 437/* 438 * REPLY_TX = 0x1c (response) 439 * 440 * This response may be in one of two slightly different formats, indicated 441 * by the frame_count field: 442 * 443 * 1) No aggregation (frame_count == 1). This reports Tx results for a single 444 * frame. Multiple attempts, at various bit rates, may have been made for 445 * this frame. 446 * 447 * 2) Aggregation (frame_count > 1). This reports Tx results for two or more 448 * frames that used block-acknowledge. All frames were transmitted at 449 * same rate. Rate scaling may have been used if first frame in this new 450 * agg block failed in previous agg block(s). 451 * 452 * Note that, for aggregation, ACK (block-ack) status is not delivered 453 * here; block-ack has not been received by the time the device records 454 * this status. 455 * This status relates to reasons the tx might have been blocked or aborted 456 * within the device, rather than whether it was received successfully by 457 * the destination station. 458 */ 459 460/** 461 * struct agg_tx_status - per packet TX aggregation status 462 * @status: See &enum iwl_tx_agg_status 463 * @sequence: Sequence # for this frame's Tx cmd (not SSN!) 464 */ 465struct agg_tx_status { 466 __le16 status; 467 __le16 sequence; 468} __packed; 469 470/* 471 * definitions for initial rate index field 472 * bits [3:0] initial rate index 473 * bits [6:4] rate table color, used for the initial rate 474 * bit-7 invalid rate indication 475 */ 476#define TX_RES_INIT_RATE_INDEX_MSK 0x0f 477#define TX_RES_RATE_TABLE_COLOR_POS 4 478#define TX_RES_RATE_TABLE_COLOR_MSK 0x70 479#define TX_RES_INV_RATE_INDEX_MSK 0x80 480#define TX_RES_RATE_TABLE_COL_GET(_f) (((_f) & TX_RES_RATE_TABLE_COLOR_MSK) >>\ 481 TX_RES_RATE_TABLE_COLOR_POS) 482 483#define IWL_MVM_TX_RES_GET_TID(_ra_tid) ((_ra_tid) & 0x0f) 484#define IWL_MVM_TX_RES_GET_RA(_ra_tid) ((_ra_tid) >> 4) 485 486/** 487 * struct iwl_mvm_tx_resp_v3 - notifies that fw is TXing a packet 488 * ( REPLY_TX = 0x1c ) 489 * @frame_count: 1 no aggregation, >1 aggregation 490 * @bt_kill_count: num of times blocked by bluetooth (unused for agg) 491 * @failure_rts: num of failures due to unsuccessful RTS 492 * @failure_frame: num failures due to no ACK (unused for agg) 493 * @initial_rate: for non-agg: rate of the successful Tx. For agg: rate of the 494 * Tx of all the batch. RATE_MCS_* 495 * @wireless_media_time: for non-agg: RTS + CTS + frame tx attempts time + ACK. 496 * for agg: RTS + CTS + aggregation tx time + block-ack time. 497 * in usec. 498 * @pa_status: tx power info 499 * @pa_integ_res_a: tx power info 500 * @pa_integ_res_b: tx power info 501 * @pa_integ_res_c: tx power info 502 * @measurement_req_id: tx power info 503 * @reduced_tpc: transmit power reduction used 504 * @reserved: reserved 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. Length in @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 */ 518struct iwl_mvm_tx_resp_v3 { 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 struct agg_tx_status status[]; 541} __packed; /* TX_RSP_API_S_VER_3 */ 542 543/** 544 * struct iwl_mvm_tx_resp - notifies that fw is TXing a packet 545 * ( REPLY_TX = 0x1c ) 546 * @frame_count: 1 no aggregation, >1 aggregation 547 * @bt_kill_count: num of times blocked by bluetooth (unused for agg) 548 * @failure_rts: num of failures due to unsuccessful RTS 549 * @failure_frame: num failures due to no ACK (unused for agg) 550 * @initial_rate: for non-agg: rate of the successful Tx. For agg: rate of the 551 * Tx of all the batch. RATE_MCS_* 552 * @wireless_media_time: for non-agg: RTS + CTS + frame tx attempts time + ACK. 553 * for agg: RTS + CTS + aggregation tx time + block-ack time. 554 * in usec. 555 * @pa_status: tx power info 556 * @pa_integ_res_a: tx power info 557 * @pa_integ_res_b: tx power info 558 * @pa_integ_res_c: tx power info 559 * @measurement_req_id: tx power info 560 * @reduced_tpc: transmit power reduction used 561 * @reserved: reserved 562 * @tfd_info: TFD information set by the FH 563 * @seq_ctl: sequence control from the Tx cmd 564 * @byte_cnt: byte count from the Tx cmd 565 * @tlc_info: TLC rate info 566 * @ra_tid: bits [3:0] = ra, bits [7:4] = tid 567 * @frame_ctrl: frame control 568 * @tx_queue: TX queue for this response 569 * @reserved2: reserved for padding/alignment 570 * @status: for non-agg: frame status TX_STATUS_* 571 * For version 6 TX response isn't received for aggregation at all. 572 * 573 * After the array of statuses comes the SSN of the SCD. Look at 574 * %iwl_mvm_get_scd_ssn for more details. 575 */ 576struct iwl_mvm_tx_resp { 577 u8 frame_count; 578 u8 bt_kill_count; 579 u8 failure_rts; 580 u8 failure_frame; 581 __le32 initial_rate; 582 __le16 wireless_media_time; 583 584 u8 pa_status; 585 u8 pa_integ_res_a[3]; 586 u8 pa_integ_res_b[3]; 587 u8 pa_integ_res_c[3]; 588 __le16 measurement_req_id; 589 u8 reduced_tpc; 590 u8 reserved; 591 592 __le32 tfd_info; 593 __le16 seq_ctl; 594 __le16 byte_cnt; 595 u8 tlc_info; 596 u8 ra_tid; 597 __le16 frame_ctrl; 598 __le16 tx_queue; 599 __le16 reserved2; 600 struct agg_tx_status status; 601} __packed; /* TX_RSP_API_S_VER_6, 602 TX_RSP_API_S_VER_7 */ 603 604/** 605 * struct iwl_mvm_ba_notif - notifies about reception of BA 606 * ( BA_NOTIF = 0xc5 ) 607 * @sta_addr: MAC address 608 * @reserved: reserved 609 * @sta_id: Index of recipient (BA-sending) station in fw's station table 610 * @tid: tid of the session 611 * @seq_ctl: sequence control field 612 * @bitmap: the bitmap of the BA notification as seen in the air 613 * @scd_flow: the tx queue this BA relates to 614 * @scd_ssn: the index of the last contiguously sent packet 615 * @txed: number of Txed frames in this batch 616 * @txed_2_done: number of Acked frames in this batch 617 * @reduced_txp: power reduced according to TPC. This is the actual value and 618 * not a copy from the LQ command. Thus, if not the first rate was used 619 * for Tx-ing then this value will be set to 0 by FW. 620 * @reserved1: reserved 621 */ 622struct iwl_mvm_ba_notif { 623 u8 sta_addr[ETH_ALEN]; 624 __le16 reserved; 625 626 u8 sta_id; 627 u8 tid; 628 __le16 seq_ctl; 629 __le64 bitmap; 630 __le16 scd_flow; 631 __le16 scd_ssn; 632 u8 txed; 633 u8 txed_2_done; 634 u8 reduced_txp; 635 u8 reserved1; 636} __packed; 637 638/** 639 * struct iwl_mvm_compressed_ba_tfd - progress of a TFD queue 640 * @q_num: TFD queue number 641 * @tfd_index: Index of first un-acked frame in the TFD queue 642 * @scd_queue: For debug only - the physical queue the TFD queue is bound to 643 * @tid: TID of the queue (0-7) 644 * @reserved: reserved for alignment 645 */ 646struct iwl_mvm_compressed_ba_tfd { 647 __le16 q_num; 648 __le16 tfd_index; 649 u8 scd_queue; 650 u8 tid; 651 u8 reserved[2]; 652} __packed; /* COMPRESSED_BA_TFD_API_S_VER_1 */ 653 654/** 655 * struct iwl_mvm_compressed_ba_ratid - progress of a RA TID queue 656 * @q_num: RA TID queue number 657 * @tid: TID of the queue 658 * @ssn: BA window current SSN 659 */ 660struct iwl_mvm_compressed_ba_ratid { 661 u8 q_num; 662 u8 tid; 663 __le16 ssn; 664} __packed; /* COMPRESSED_BA_RATID_API_S_VER_1 */ 665 666/* 667 * enum iwl_mvm_ba_resp_flags - TX aggregation status 668 * @IWL_MVM_BA_RESP_TX_AGG: generated due to BA 669 * @IWL_MVM_BA_RESP_TX_BAR: generated due to BA after BAR 670 * @IWL_MVM_BA_RESP_TX_AGG_FAIL: aggregation didn't receive BA 671 * @IWL_MVM_BA_RESP_TX_UNDERRUN: aggregation got underrun 672 * @IWL_MVM_BA_RESP_TX_BT_KILL: aggregation got BT-kill 673 * @IWL_MVM_BA_RESP_TX_DSP_TIMEOUT: aggregation didn't finish within the 674 * expected time 675 */ 676enum iwl_mvm_ba_resp_flags { 677 IWL_MVM_BA_RESP_TX_AGG, 678 IWL_MVM_BA_RESP_TX_BAR, 679 IWL_MVM_BA_RESP_TX_AGG_FAIL, 680 IWL_MVM_BA_RESP_TX_UNDERRUN, 681 IWL_MVM_BA_RESP_TX_BT_KILL, 682 IWL_MVM_BA_RESP_TX_DSP_TIMEOUT 683}; 684 685/** 686 * struct iwl_mvm_compressed_ba_notif - notifies about reception of BA 687 * ( BA_NOTIF = 0xc5 ) 688 * @flags: status flag, see the &iwl_mvm_ba_resp_flags 689 * @sta_id: Index of recipient (BA-sending) station in fw's station table 690 * @reduced_txp: power reduced according to TPC. This is the actual value and 691 * not a copy from the LQ command. Thus, if not the first rate was used 692 * for Tx-ing then this value will be set to 0 by FW. 693 * @tlc_rate_info: TLC rate info, initial rate index, TLC table color 694 * @retry_cnt: retry count 695 * @query_byte_cnt: SCD query byte count 696 * @query_frame_cnt: SCD query frame count 697 * @txed: number of frames sent in the aggregation (all-TIDs) 698 * @done: number of frames that were Acked by the BA (all-TIDs) 699 * @reserved: reserved (for alignment) 700 * @wireless_time: Wireless-media time 701 * @tx_rate: the rate the aggregation was sent at 702 * @tfd_cnt: number of TFD-Q elements 703 * @ra_tid_cnt: number of RATID-Q elements 704 * @tfd: array of TFD queue status updates. See &iwl_mvm_compressed_ba_tfd 705 * for details. Length in @tfd_cnt. 706 * @ra_tid: array of RA-TID queue status updates. For debug purposes only. See 707 * &iwl_mvm_compressed_ba_ratid for more details. Length in @ra_tid_cnt. 708 */ 709struct iwl_mvm_compressed_ba_notif { 710 __le32 flags; 711 u8 sta_id; 712 u8 reduced_txp; 713 u8 tlc_rate_info; 714 u8 retry_cnt; 715 __le32 query_byte_cnt; 716 __le16 query_frame_cnt; 717 __le16 txed; 718 __le16 done; 719 __le16 reserved; 720 __le32 wireless_time; 721 __le32 tx_rate; 722 __le16 tfd_cnt; 723 __le16 ra_tid_cnt; 724 union { 725 DECLARE_FLEX_ARRAY(struct iwl_mvm_compressed_ba_ratid, ra_tid); 726 DECLARE_FLEX_ARRAY(struct iwl_mvm_compressed_ba_tfd, tfd); 727 }; 728} __packed; /* COMPRESSED_BA_RES_API_S_VER_4, 729 COMPRESSED_BA_RES_API_S_VER_5 */ 730 731/** 732 * struct iwl_mac_beacon_cmd_v6 - beacon template command 733 * @tx: the tx commands associated with the beacon frame 734 * @template_id: currently equal to the mac context id of the coresponding 735 * mac. 736 * @tim_idx: the offset of the tim IE in the beacon 737 * @tim_size: the length of the tim IE 738 * @frame: the template of the beacon frame 739 */ 740struct iwl_mac_beacon_cmd_v6 { 741 struct iwl_tx_cmd tx; 742 __le32 template_id; 743 __le32 tim_idx; 744 __le32 tim_size; 745 struct ieee80211_hdr frame[]; 746} __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_6 */ 747 748/** 749 * struct iwl_mac_beacon_cmd_v7 - beacon template command with offloaded CSA 750 * @tx: the tx commands associated with the beacon frame 751 * @template_id: currently equal to the mac context id of the coresponding 752 * mac. 753 * @tim_idx: the offset of the tim IE in the beacon 754 * @tim_size: the length of the tim IE 755 * @ecsa_offset: offset to the ECSA IE if present 756 * @csa_offset: offset to the CSA IE if present 757 * @frame: the template of the beacon frame 758 */ 759struct iwl_mac_beacon_cmd_v7 { 760 struct iwl_tx_cmd tx; 761 __le32 template_id; 762 __le32 tim_idx; 763 __le32 tim_size; 764 __le32 ecsa_offset; 765 __le32 csa_offset; 766 struct ieee80211_hdr frame[]; 767} __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_7 */ 768 769/* Bit flags for BEACON_TEMPLATE_CMD_API until version 10 */ 770enum iwl_mac_beacon_flags_v1 { 771 IWL_MAC_BEACON_CCK_V1 = BIT(8), 772 IWL_MAC_BEACON_ANT_A_V1 = BIT(9), 773 IWL_MAC_BEACON_ANT_B_V1 = BIT(10), 774 IWL_MAC_BEACON_FILS_V1 = BIT(12), 775}; 776 777/* Bit flags for BEACON_TEMPLATE_CMD_API version 11 and above */ 778enum iwl_mac_beacon_flags { 779 IWL_MAC_BEACON_CCK = BIT(5), 780 IWL_MAC_BEACON_ANT_A = BIT(6), 781 IWL_MAC_BEACON_ANT_B = BIT(7), 782 IWL_MAC_BEACON_FILS = BIT(8), 783}; 784 785/** 786 * struct iwl_mac_beacon_cmd - beacon template command with offloaded CSA 787 * @byte_cnt: byte count of the beacon frame. 788 * @flags: least significant byte for rate code. The most significant byte 789 * is &enum iwl_mac_beacon_flags. 790 * @short_ssid: Short SSID 791 * @reserved: reserved 792 * @link_id: the firmware id of the link that will use this beacon 793 * @tim_idx: the offset of the tim IE in the beacon 794 * @tim_size: the length of the tim IE 795 * @ecsa_offset: offset to the ECSA IE if present 796 * @csa_offset: offset to the CSA IE if present 797 * @frame: the template of the beacon frame 798 */ 799struct iwl_mac_beacon_cmd { 800 __le16 byte_cnt; 801 __le16 flags; 802 __le32 short_ssid; 803 __le32 reserved; 804 __le32 link_id; 805 __le32 tim_idx; 806 __le32 tim_size; 807 __le32 ecsa_offset; 808 __le32 csa_offset; 809 struct ieee80211_hdr frame[]; 810} __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_10, 811 * BEACON_TEMPLATE_CMD_API_S_VER_11, 812 * BEACON_TEMPLATE_CMD_API_S_VER_12, 813 * BEACON_TEMPLATE_CMD_API_S_VER_13 814 */ 815 816struct iwl_beacon_notif { 817 struct iwl_mvm_tx_resp beacon_notify_hdr; 818 __le64 tsf; 819 __le32 ibss_mgr_status; 820} __packed; 821 822/** 823 * struct iwl_extended_beacon_notif_v5 - notifies about beacon transmission 824 * @beacon_notify_hdr: tx response command associated with the beacon 825 * @tsf: last beacon tsf 826 * @ibss_mgr_status: whether IBSS is manager 827 * @gp2: last beacon time in gp2 828 */ 829struct iwl_extended_beacon_notif_v5 { 830 struct iwl_mvm_tx_resp beacon_notify_hdr; 831 __le64 tsf; 832 __le32 ibss_mgr_status; 833 __le32 gp2; 834} __packed; /* BEACON_NTFY_API_S_VER_5 */ 835 836/** 837 * struct iwl_extended_beacon_notif - notifies about beacon transmission 838 * @status: the status of the Tx response of the beacon 839 * @tsf: last beacon tsf 840 * @ibss_mgr_status: whether IBSS is manager 841 * @gp2: last beacon time in gp2 842 */ 843struct iwl_extended_beacon_notif { 844 __le32 status; 845 __le64 tsf; 846 __le32 ibss_mgr_status; 847 __le32 gp2; 848} __packed; /* BEACON_NTFY_API_S_VER_6_ */ 849 850/** 851 * enum iwl_dump_control - dump (flush) control flags 852 * @DUMP_TX_FIFO_FLUSH: Dump MSDUs until the the FIFO is empty 853 * and the TFD queues are empty. 854 */ 855enum iwl_dump_control { 856 DUMP_TX_FIFO_FLUSH = BIT(1), 857}; 858 859/** 860 * struct iwl_tx_path_flush_cmd -- queue/FIFO flush command 861 * @queues_ctl: bitmap of queues to flush 862 * @flush_ctl: control flags 863 * @reserved: reserved 864 */ 865struct iwl_tx_path_flush_cmd_v1 { 866 __le32 queues_ctl; 867 __le16 flush_ctl; 868 __le16 reserved; 869} __packed; /* TX_PATH_FLUSH_CMD_API_S_VER_1 */ 870 871/** 872 * struct iwl_tx_path_flush_cmd -- queue/FIFO flush command 873 * @sta_id: station ID to flush 874 * @tid_mask: TID mask to flush 875 * @reserved: reserved 876 */ 877struct iwl_tx_path_flush_cmd { 878 __le32 sta_id; 879 __le16 tid_mask; 880 __le16 reserved; 881} __packed; /* TX_PATH_FLUSH_CMD_API_S_VER_2 */ 882 883#define IWL_TX_FLUSH_QUEUE_RSP 16 884 885/** 886 * struct iwl_flush_queue_info - virtual flush queue info 887 * @queue_num: virtual queue id 888 * @read_before_flush: read pointer before flush 889 * @read_after_flush: read pointer after flush 890 */ 891struct iwl_flush_queue_info { 892 __le16 tid; 893 __le16 queue_num; 894 __le16 read_before_flush; 895 __le16 read_after_flush; 896} __packed; /* TFDQ_FLUSH_INFO_API_S_VER_1 */ 897 898/** 899 * struct iwl_tx_path_flush_cmd_rsp -- queue/FIFO flush command response 900 * @num_flushed_queues: number of queues in queues array 901 * @queues: all flushed queues 902 */ 903struct iwl_tx_path_flush_cmd_rsp { 904 __le16 sta_id; 905 __le16 num_flushed_queues; 906 struct iwl_flush_queue_info queues[IWL_TX_FLUSH_QUEUE_RSP]; 907} __packed; /* TX_PATH_FLUSH_CMD_RSP_API_S_VER_1 */ 908 909/* Available options for the SCD_QUEUE_CFG HCMD */ 910enum iwl_scd_cfg_actions { 911 SCD_CFG_DISABLE_QUEUE = 0x0, 912 SCD_CFG_ENABLE_QUEUE = 0x1, 913 SCD_CFG_UPDATE_QUEUE_TID = 0x2, 914}; 915 916/** 917 * struct iwl_scd_txq_cfg_cmd - New txq hw scheduler config command 918 * @token: unused 919 * @sta_id: station id 920 * @tid: TID 921 * @scd_queue: scheduler queue to confiug 922 * @action: 1 queue enable, 0 queue disable, 2 change txq's tid owner 923 * Value is one of &enum iwl_scd_cfg_actions options 924 * @aggregate: 1 aggregated queue, 0 otherwise 925 * @tx_fifo: &enum iwl_mvm_tx_fifo 926 * @window: BA window size 927 * @ssn: SSN for the BA agreement 928 * @reserved: reserved 929 */ 930struct iwl_scd_txq_cfg_cmd { 931 u8 token; 932 u8 sta_id; 933 u8 tid; 934 u8 scd_queue; 935 u8 action; 936 u8 aggregate; 937 u8 tx_fifo; 938 u8 window; 939 __le16 ssn; 940 __le16 reserved; 941} __packed; /* SCD_QUEUE_CFG_CMD_API_S_VER_1 */ 942 943/** 944 * struct iwl_scd_txq_cfg_rsp 945 * @token: taken from the command 946 * @sta_id: station id from the command 947 * @tid: tid from the command 948 * @scd_queue: scd_queue from the command 949 */ 950struct iwl_scd_txq_cfg_rsp { 951 u8 token; 952 u8 sta_id; 953 u8 tid; 954 u8 scd_queue; 955} __packed; /* SCD_QUEUE_CFG_RSP_API_S_VER_1 */ 956 957#endif /* __iwl_fw_api_tx_h__ */ 958