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