1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
3 * Copyright (C) 2012-2014, 2018-2024 Intel Corporation
4 * Copyright (C) 2016-2017 Intel Deutschland GmbH
6 #ifndef __iwl_fw_api_tx_h__
7 #define __iwl_fw_api_tx_h__
8 #include <linux/ieee80211.h>
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
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
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 */
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
77 * @IWL_TX_FLAGS_HIGH_PRI: high priority frame (like EAPOL) - can affect rate
78 * selection, retry limits and BT kill
79 * @IWL_TX_FLAGS_RTS: firmware used an RTS
80 * @IWL_TX_FLAGS_CTS: firmware used CTS-to-self
82 enum iwl_tx_cmd_flags {
83 IWL_TX_FLAGS_CMD_RATE = BIT(0),
84 IWL_TX_FLAGS_ENCRYPT_DIS = BIT(1),
85 IWL_TX_FLAGS_HIGH_PRI = BIT(2),
86 /* Use these flags only from
87 * TX_FLAGS_BITS_API_S_VER_4 and above */
88 IWL_TX_FLAGS_RTS = BIT(3),
89 IWL_TX_FLAGS_CTS = BIT(4),
90 }; /* TX_FLAGS_BITS_API_S_VER_3 */
93 * enum iwl_tx_pm_timeouts - pm timeout values in TX command
94 * @PM_FRAME_NONE: no need to suspend sleep mode
95 * @PM_FRAME_MGMT: fw suspend sleep mode for 100TU
96 * @PM_FRAME_ASSOC: fw suspend sleep mode for 10sec
98 enum iwl_tx_pm_timeouts {
104 #define TX_CMD_SEC_MSK 0x07
105 #define TX_CMD_SEC_WEP_KEY_IDX_POS 6
106 #define TX_CMD_SEC_WEP_KEY_IDX_MSK 0xc0
109 * enum iwl_tx_cmd_sec_ctrl - bitmasks for security control in TX command
110 * @TX_CMD_SEC_WEP: WEP encryption algorithm.
111 * @TX_CMD_SEC_CCM: CCM encryption algorithm.
112 * @TX_CMD_SEC_TKIP: TKIP encryption algorithm.
113 * @TX_CMD_SEC_EXT: extended cipher algorithm.
114 * @TX_CMD_SEC_GCMP: GCMP encryption algorithm.
115 * @TX_CMD_SEC_KEY128: set for 104 bits WEP key.
116 * @TX_CMD_SEC_KEY_FROM_TABLE: for a non-WEP key, set if the key should be taken
117 * from the table instead of from the TX command.
118 * If the key is taken from the key table its index should be given by the
119 * first byte of the TX command key field.
121 enum iwl_tx_cmd_sec_ctrl {
122 TX_CMD_SEC_WEP = 0x01,
123 TX_CMD_SEC_CCM = 0x02,
124 TX_CMD_SEC_TKIP = 0x03,
125 TX_CMD_SEC_EXT = 0x04,
126 TX_CMD_SEC_GCMP = 0x05,
127 TX_CMD_SEC_KEY128 = 0x08,
128 TX_CMD_SEC_KEY_FROM_TABLE = 0x10,
132 * TX command Frame life time in us - to be written in pm_frame_timeout
134 #define TX_CMD_LIFE_TIME_INFINITE 0xFFFFFFFF
135 #define TX_CMD_LIFE_TIME_DEFAULT 2000000 /* 2000 ms*/
136 #define TX_CMD_LIFE_TIME_PROBE_RESP 40000 /* 40 ms */
137 #define TX_CMD_LIFE_TIME_EXPIRED_FRAME 0
140 * TID for non QoS frames - to be written in tid_tspec
142 #define IWL_TID_NON_QOS 0
145 * Limits on the retransmissions - to be written in {data,rts}_retry_limit
147 #define IWL_DEFAULT_TX_RETRY 15
148 #define IWL_MGMT_DFAULT_RETRY_LIMIT 3
149 #define IWL_RTS_DFAULT_RETRY_LIMIT 60
150 #define IWL_BAR_DFAULT_RETRY_LIMIT 60
151 #define IWL_LOW_RETRY_LIMIT 7
154 * enum iwl_tx_offload_assist_flags_pos - set %iwl_tx_cmd offload_assist values
155 * @TX_CMD_OFFLD_IP_HDR: offset to start of IP header (in words)
156 * from mac header end. For normal case it is 4 words for SNAP.
157 * note: tx_cmd, mac header and pad are not counted in the offset.
158 * This is used to help the offload in case there is tunneling such as
159 * IPv6 in IPv4, in such case the ip header offset should point to the
160 * inner ip header and IPv4 checksum of the external header should be
161 * calculated by driver.
162 * @TX_CMD_OFFLD_L4_EN: enable TCP/UDP checksum
163 * @TX_CMD_OFFLD_L3_EN: enable IP header checksum
164 * @TX_CMD_OFFLD_MH_SIZE: size of the mac header in words. Includes the IV
165 * field. Doesn't include the pad.
166 * @TX_CMD_OFFLD_PAD: mark 2-byte pad was inserted after the mac header for
168 * @TX_CMD_OFFLD_AMSDU: mark TX command is A-MSDU
170 enum iwl_tx_offload_assist_flags_pos {
171 TX_CMD_OFFLD_IP_HDR = 0,
172 TX_CMD_OFFLD_L4_EN = 6,
173 TX_CMD_OFFLD_L3_EN = 7,
174 TX_CMD_OFFLD_MH_SIZE = 8,
175 TX_CMD_OFFLD_PAD = 13,
176 TX_CMD_OFFLD_AMSDU = 14,
179 #define IWL_TX_CMD_OFFLD_MH_MASK 0x1f
180 #define IWL_TX_CMD_OFFLD_IP_HDR_MASK 0x3f
182 /* TODO: complete documentation for try_cnt and btkill_cnt */
184 * struct iwl_tx_cmd - TX command struct to FW
186 * @len: in bytes of the payload, see below for details
187 * @offload_assist: TX offload configuration
188 * @tx_flags: combination of TX_CMD_FLG_*, see &enum iwl_tx_flags
189 * @scratch: scratch buffer used by the device
190 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
191 * cleared. Combination of RATE_MCS_*
192 * @sta_id: index of destination station in FW station table
193 * @sec_ctl: security control, TX_CMD_SEC_*
194 * @initial_rate_index: index into the the rate table for initial TX attempt.
195 * Applied if TX_CMD_FLG_STA_RATE_MSK is set, normally 0 for data frames.
196 * @reserved2: reserved
198 * @reserved3: reserved
199 * @life_time: frame life time (usecs??)
200 * @dram_lsb_ptr: Physical address of scratch area in the command (try_cnt +
201 * btkill_cnd + reserved), first 32 bits. "0" disables usage.
202 * @dram_msb_ptr: upper bits of the scratch physical address
203 * @rts_retry_limit: max attempts for RTS
204 * @data_retry_limit: max attempts to send the data packet
205 * @tid_tspec: TID/tspec
206 * @pm_frame_timeout: PM TX frame timeout
207 * @reserved4: reserved
208 * @payload: payload (same as @hdr)
209 * @hdr: 802.11 header (same as @payload)
211 * The byte count (both len and next_frame_len) includes MAC header
212 * (24/26/30/32 bytes)
213 * + 2 bytes pad if 26/30 header size
214 * + 8 byte IV for CCM or TKIP (not used for WEP)
216 * + 8-byte MIC (not used for CCM/WEP)
217 * It does not include post-MAC padding, i.e.,
218 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.
219 * Range of len: 14-2342 bytes.
221 * After the struct fields the MAC header is placed, plus any padding,
222 * and then the actial payload.
226 __le16 offload_assist;
232 } scratch; /* DRAM_SCRATCH_API_U_VER_1 */
236 u8 initial_rate_index;
246 __le16 pm_frame_timeout;
249 DECLARE_FLEX_ARRAY(u8, payload);
250 DECLARE_FLEX_ARRAY(struct ieee80211_hdr, hdr);
252 } __packed; /* TX_CMD_API_S_VER_6 */
254 struct iwl_dram_sec_info {
258 } __packed; /* DRAM_SEC_INFO_API_S_VER_1 */
261 * struct iwl_tx_cmd_gen2 - TX command struct to FW for 22000 devices
263 * @len: in bytes of the payload, see below for details
264 * @offload_assist: TX offload configuration
265 * @flags: combination of &enum iwl_tx_cmd_flags
266 * @dram_info: FW internal DRAM storage
267 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
268 * cleared. Combination of RATE_MCS_*
269 * @hdr: 802.11 header
271 struct iwl_tx_cmd_gen2 {
273 __le16 offload_assist;
275 struct iwl_dram_sec_info dram_info;
277 struct ieee80211_hdr hdr[];
278 } __packed; /* TX_CMD_API_S_VER_7,
279 TX_CMD_API_S_VER_9 */
282 * struct iwl_tx_cmd_gen3 - TX command struct to FW for AX210+ devices
284 * @len: in bytes of the payload, see below for details
285 * @flags: combination of &enum iwl_tx_cmd_flags
286 * @offload_assist: TX offload configuration
287 * @dram_info: FW internal DRAM storage
288 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
289 * cleared. Combination of RATE_MCS_*
290 * @reserved: reserved
291 * @hdr: 802.11 header
293 struct iwl_tx_cmd_gen3 {
296 __le32 offload_assist;
297 struct iwl_dram_sec_info dram_info;
300 struct ieee80211_hdr hdr[];
301 } __packed; /* TX_CMD_API_S_VER_8,
302 TX_CMD_API_S_VER_10 */
305 * TX response related data
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
335 * @TX_FRAME_STATUS_INTERNAL_ABORT:
338 * @TX_MODE_IN_BURST_SEQ:
339 * @TX_MODE_FIRST_IN_BURST:
342 * Valid only if frame_count =1
343 * TODO: complete documentation
346 TX_STATUS_MSK = 0x000000ff,
347 TX_STATUS_SUCCESS = 0x01,
348 TX_STATUS_DIRECT_DONE = 0x02,
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,
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,
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_TX_ON_AIR_DROP: TX_ON_AIR signal drop without underrun or
395 * @AGG_TX_STATE_LAST_SENT_TRY_CNT:
396 * @AGG_TX_STATE_LAST_SENT_BT_KILL:
397 * @AGG_TX_STATE_SCD_QUERY:
398 * @AGG_TX_STATE_TEST_BAD_CRC32:
399 * @AGG_TX_STATE_RESPONSE:
400 * @AGG_TX_STATE_DUMP_TX:
401 * @AGG_TX_STATE_DELAY_TX:
402 * @AGG_TX_STATE_TRY_CNT_MSK: Retry count for 1st frame in aggregation (retries
403 * occur if tx failed for this frame when it was a member of a previous
404 * aggregation block). If rate scaling is used, retry count indicates the
405 * rate table entry used for all frames in the new agg.
406 * @AGG_TX_STATE_SEQ_NUM_MSK: Command ID and sequence number of Tx command for
409 * TODO: complete documentation
411 enum iwl_tx_agg_status {
412 AGG_TX_STATE_STATUS_MSK = 0x00fff,
413 AGG_TX_STATE_TRANSMITTED = 0x000,
414 AGG_TX_STATE_UNDERRUN = 0x001,
415 AGG_TX_STATE_BT_PRIO = 0x002,
416 AGG_TX_STATE_FEW_BYTES = 0x004,
417 AGG_TX_STATE_ABORT = 0x008,
418 AGG_TX_STATE_TX_ON_AIR_DROP = 0x010,
419 AGG_TX_STATE_LAST_SENT_TRY_CNT = 0x020,
420 AGG_TX_STATE_LAST_SENT_BT_KILL = 0x040,
421 AGG_TX_STATE_SCD_QUERY = 0x080,
422 AGG_TX_STATE_TEST_BAD_CRC32 = 0x0100,
423 AGG_TX_STATE_RESPONSE = 0x1ff,
424 AGG_TX_STATE_DUMP_TX = 0x200,
425 AGG_TX_STATE_DELAY_TX = 0x400,
426 AGG_TX_STATE_TRY_CNT_POS = 12,
427 AGG_TX_STATE_TRY_CNT_MSK = 0xf << AGG_TX_STATE_TRY_CNT_POS,
431 * The mask below describes a status where we are absolutely sure that the MPDU
432 * wasn't sent. For BA/Underrun we cannot be that sure. All we know that we've
433 * written the bytes to the TXE, but we know nothing about what the DSP did.
435 #define AGG_TX_STAT_FRAME_NOT_SENT (AGG_TX_STATE_FEW_BYTES | \
436 AGG_TX_STATE_ABORT | \
437 AGG_TX_STATE_SCD_QUERY)
440 * REPLY_TX = 0x1c (response)
442 * This response may be in one of two slightly different formats, indicated
443 * by the frame_count field:
445 * 1) No aggregation (frame_count == 1). This reports Tx results for a single
446 * frame. Multiple attempts, at various bit rates, may have been made for
449 * 2) Aggregation (frame_count > 1). This reports Tx results for two or more
450 * frames that used block-acknowledge. All frames were transmitted at
451 * same rate. Rate scaling may have been used if first frame in this new
452 * agg block failed in previous agg block(s).
454 * Note that, for aggregation, ACK (block-ack) status is not delivered
455 * here; block-ack has not been received by the time the device records
457 * This status relates to reasons the tx might have been blocked or aborted
458 * within the device, rather than whether it was received successfully by
459 * the destination station.
463 * struct agg_tx_status - per packet TX aggregation status
464 * @status: See &enum iwl_tx_agg_status
465 * @sequence: Sequence # for this frame's Tx cmd (not SSN!)
467 struct agg_tx_status {
473 * definitions for initial rate index field
474 * bits [3:0] initial rate index
475 * bits [6:4] rate table color, used for the initial rate
476 * bit-7 invalid rate indication
478 #define TX_RES_INIT_RATE_INDEX_MSK 0x0f
479 #define TX_RES_RATE_TABLE_COLOR_POS 4
480 #define TX_RES_RATE_TABLE_COLOR_MSK 0x70
481 #define TX_RES_INV_RATE_INDEX_MSK 0x80
482 #define TX_RES_RATE_TABLE_COL_GET(_f) (((_f) & TX_RES_RATE_TABLE_COLOR_MSK) >>\
483 TX_RES_RATE_TABLE_COLOR_POS)
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)
489 * struct iwl_tx_resp_v3 - 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.
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 * @reduced_tpc: transmit power reduction used
506 * @reserved: reserved
507 * @tfd_info: TFD information set by the FH
508 * @seq_ctl: sequence control from the Tx cmd
509 * @byte_cnt: byte count from the Tx cmd
510 * @tlc_info: TLC rate info
511 * @ra_tid: bits [3:0] = ra, bits [7:4] = tid
512 * @frame_ctrl: frame control
513 * @status: for non-agg: frame status TX_STATUS_*
514 * for agg: status of 1st frame, AGG_TX_STATE_*; other frame status fields
515 * follow this one, up to frame_count. Length in @frame_count.
517 * After the array of statuses comes the SSN of the SCD. Look at
518 * %iwl_mvm_get_scd_ssn for more details.
520 struct iwl_tx_resp_v3 {
526 __le16 wireless_media_time;
529 u8 pa_integ_res_a[3];
530 u8 pa_integ_res_b[3];
531 u8 pa_integ_res_c[3];
532 __le16 measurement_req_id;
542 struct agg_tx_status status[];
543 } __packed; /* TX_RSP_API_S_VER_3 */
546 * struct iwl_tx_resp - notifies that fw is TXing a packet
547 * ( REPLY_TX = 0x1c )
548 * @frame_count: 1 no aggregation, >1 aggregation
549 * @bt_kill_count: num of times blocked by bluetooth (unused for agg)
550 * @failure_rts: num of failures due to unsuccessful RTS
551 * @failure_frame: num failures due to no ACK (unused for agg)
552 * @initial_rate: for non-agg: rate of the successful Tx. For agg: rate of the
553 * Tx of all the batch. RATE_MCS_*
554 * @wireless_media_time: for non-agg: RTS + CTS + frame tx attempts time + ACK.
555 * for agg: RTS + CTS + aggregation tx time + block-ack time.
557 * @pa_status: tx power info
558 * @pa_integ_res_a: tx power info
559 * @pa_integ_res_b: tx power info
560 * @pa_integ_res_c: tx power info
561 * @measurement_req_id: tx power info
562 * @reduced_tpc: transmit power reduction used
563 * @reserved: reserved
564 * @tfd_info: TFD information set by the FH
565 * @seq_ctl: sequence control from the Tx cmd
566 * @byte_cnt: byte count from the Tx cmd
567 * @tlc_info: TLC rate info
568 * @ra_tid: bits [3:0] = ra, bits [7:4] = tid
569 * @frame_ctrl: frame control
570 * @tx_queue: TX queue for this response
571 * @reserved2: reserved for padding/alignment
572 * @status: for non-agg: frame status TX_STATUS_*
573 * For version 6 TX response isn't received for aggregation at all.
575 * After the array of statuses comes the SSN of the SCD. Look at
576 * %iwl_mvm_get_scd_ssn for more details.
584 __le16 wireless_media_time;
587 u8 pa_integ_res_a[3];
588 u8 pa_integ_res_b[3];
589 u8 pa_integ_res_c[3];
590 __le16 measurement_req_id;
602 struct agg_tx_status status;
603 } __packed; /* TX_RSP_API_S_VER_6,
604 TX_RSP_API_S_VER_7 */
607 * struct iwl_mvm_ba_notif - notifies about reception of BA
608 * ( BA_NOTIF = 0xc5 )
609 * @sta_addr: MAC address
610 * @reserved: reserved
611 * @sta_id: Index of recipient (BA-sending) station in fw's station table
612 * @tid: tid of the session
613 * @seq_ctl: sequence control field
614 * @bitmap: the bitmap of the BA notification as seen in the air
615 * @scd_flow: the tx queue this BA relates to
616 * @scd_ssn: the index of the last contiguously sent packet
617 * @txed: number of Txed frames in this batch
618 * @txed_2_done: number of Acked frames in this batch
619 * @reduced_txp: power reduced according to TPC. This is the actual value and
620 * not a copy from the LQ command. Thus, if not the first rate was used
621 * for Tx-ing then this value will be set to 0 by FW.
622 * @reserved1: reserved
624 struct iwl_mvm_ba_notif {
625 u8 sta_addr[ETH_ALEN];
641 * struct iwl_mvm_compressed_ba_tfd - progress of a TFD queue
642 * @q_num: TFD queue number
643 * @tfd_index: Index of first un-acked frame in the TFD queue
644 * @scd_queue: For debug only - the physical queue the TFD queue is bound to
645 * @tid: TID of the queue (0-7)
646 * @reserved: reserved for alignment
648 struct iwl_mvm_compressed_ba_tfd {
654 } __packed; /* COMPRESSED_BA_TFD_API_S_VER_1 */
657 * struct iwl_mvm_compressed_ba_ratid - progress of a RA TID queue
658 * @q_num: RA TID queue number
659 * @tid: TID of the queue
660 * @ssn: BA window current SSN
662 struct iwl_mvm_compressed_ba_ratid {
666 } __packed; /* COMPRESSED_BA_RATID_API_S_VER_1 */
669 * enum iwl_mvm_ba_resp_flags - TX aggregation status
670 * @IWL_MVM_BA_RESP_TX_AGG: generated due to BA
671 * @IWL_MVM_BA_RESP_TX_BAR: generated due to BA after BAR
672 * @IWL_MVM_BA_RESP_TX_AGG_FAIL: aggregation didn't receive BA
673 * @IWL_MVM_BA_RESP_TX_UNDERRUN: aggregation got underrun
674 * @IWL_MVM_BA_RESP_TX_BT_KILL: aggregation got BT-kill
675 * @IWL_MVM_BA_RESP_TX_DSP_TIMEOUT: aggregation didn't finish within the
678 enum iwl_mvm_ba_resp_flags {
679 IWL_MVM_BA_RESP_TX_AGG,
680 IWL_MVM_BA_RESP_TX_BAR,
681 IWL_MVM_BA_RESP_TX_AGG_FAIL,
682 IWL_MVM_BA_RESP_TX_UNDERRUN,
683 IWL_MVM_BA_RESP_TX_BT_KILL,
684 IWL_MVM_BA_RESP_TX_DSP_TIMEOUT
688 * struct iwl_mvm_compressed_ba_notif - notifies about reception of BA
689 * ( BA_NOTIF = 0xc5 )
690 * @flags: status flag, see the &iwl_mvm_ba_resp_flags
691 * @sta_id: Index of recipient (BA-sending) station in fw's station table
692 * @reduced_txp: power reduced according to TPC. This is the actual value and
693 * not a copy from the LQ command. Thus, if not the first rate was used
694 * for Tx-ing then this value will be set to 0 by FW.
695 * @tlc_rate_info: TLC rate info, initial rate index, TLC table color
696 * @retry_cnt: retry count
697 * @query_byte_cnt: SCD query byte count
698 * @query_frame_cnt: SCD query frame count
699 * @txed: number of frames sent in the aggregation (all-TIDs)
700 * @done: number of frames that were Acked by the BA (all-TIDs)
701 * @rts_retry_cnt: RTS retry count
702 * @reserved: reserved (for alignment)
703 * @wireless_time: Wireless-media time
704 * @tx_rate: the rate the aggregation was sent at
705 * @tfd_cnt: number of TFD-Q elements
706 * @ra_tid_cnt: number of RATID-Q elements
707 * @tfd: array of TFD queue status updates. See &iwl_mvm_compressed_ba_tfd
708 * for details. Length in @tfd_cnt.
709 * @ra_tid: array of RA-TID queue status updates. For debug purposes only. See
710 * &iwl_mvm_compressed_ba_ratid for more details. Length in @ra_tid_cnt.
712 struct iwl_mvm_compressed_ba_notif {
718 __le32 query_byte_cnt;
719 __le16 query_frame_cnt;
724 __le32 wireless_time;
729 DECLARE_FLEX_ARRAY(struct iwl_mvm_compressed_ba_ratid, ra_tid);
730 DECLARE_FLEX_ARRAY(struct iwl_mvm_compressed_ba_tfd, tfd);
732 } __packed; /* COMPRESSED_BA_RES_API_S_VER_4,
733 COMPRESSED_BA_RES_API_S_VER_5 */
736 * struct iwl_mac_beacon_cmd_v6 - beacon template command
737 * @tx: the tx commands associated with the beacon frame
738 * @template_id: currently equal to the mac context id of the coresponding
740 * @tim_idx: the offset of the tim IE in the beacon
741 * @tim_size: the length of the tim IE
742 * @frame: the template of the beacon frame
744 struct iwl_mac_beacon_cmd_v6 {
745 struct iwl_tx_cmd tx;
749 struct ieee80211_hdr frame[];
750 } __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_6 */
753 * struct iwl_mac_beacon_cmd_v7 - beacon template command with offloaded CSA
754 * @tx: the tx commands associated with the beacon frame
755 * @template_id: currently equal to the mac context id of the coresponding
757 * @tim_idx: the offset of the tim IE in the beacon
758 * @tim_size: the length of the tim IE
759 * @ecsa_offset: offset to the ECSA IE if present
760 * @csa_offset: offset to the CSA IE if present
761 * @frame: the template of the beacon frame
763 struct iwl_mac_beacon_cmd_v7 {
764 struct iwl_tx_cmd tx;
770 struct ieee80211_hdr frame[];
771 } __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_7 */
773 /* Bit flags for BEACON_TEMPLATE_CMD_API until version 10 */
774 enum iwl_mac_beacon_flags_v1 {
775 IWL_MAC_BEACON_CCK_V1 = BIT(8),
776 IWL_MAC_BEACON_ANT_A_V1 = BIT(9),
777 IWL_MAC_BEACON_ANT_B_V1 = BIT(10),
778 IWL_MAC_BEACON_FILS_V1 = BIT(12),
781 /* Bit flags for BEACON_TEMPLATE_CMD_API version 11 and above */
782 enum iwl_mac_beacon_flags {
783 IWL_MAC_BEACON_CCK = BIT(5),
784 IWL_MAC_BEACON_ANT_A = BIT(6),
785 IWL_MAC_BEACON_ANT_B = BIT(7),
786 IWL_MAC_BEACON_FILS = BIT(8),
790 * struct iwl_mac_beacon_cmd - beacon template command with offloaded CSA
791 * @byte_cnt: byte count of the beacon frame.
792 * @flags: least significant byte for rate code. The most significant byte
793 * is &enum iwl_mac_beacon_flags.
794 * @short_ssid: Short SSID
795 * @reserved: reserved
796 * @link_id: the firmware id of the link that will use this beacon
797 * @tim_idx: the offset of the tim IE in the beacon
798 * @tim_size: the length of the tim IE (version < 14)
799 * @btwt_offset: offset to the broadcast TWT IE if present (version >= 14)
800 * @ecsa_offset: offset to the ECSA IE if present
801 * @csa_offset: offset to the CSA IE if present
802 * @frame: the template of the beacon frame
804 struct iwl_mac_beacon_cmd {
817 struct ieee80211_hdr frame[];
818 } __packed; /* BEACON_TEMPLATE_CMD_API_S_VER_10,
819 * BEACON_TEMPLATE_CMD_API_S_VER_11,
820 * BEACON_TEMPLATE_CMD_API_S_VER_12,
821 * BEACON_TEMPLATE_CMD_API_S_VER_13,
822 * BEACON_TEMPLATE_CMD_API_S_VER_14
825 struct iwl_beacon_notif {
826 struct iwl_tx_resp beacon_notify_hdr;
828 __le32 ibss_mgr_status;
832 * struct iwl_extended_beacon_notif_v5 - notifies about beacon transmission
833 * @beacon_notify_hdr: tx response command associated with the beacon
834 * @tsf: last beacon tsf
835 * @ibss_mgr_status: whether IBSS is manager
836 * @gp2: last beacon time in gp2
838 struct iwl_extended_beacon_notif_v5 {
839 struct iwl_tx_resp beacon_notify_hdr;
841 __le32 ibss_mgr_status;
843 } __packed; /* BEACON_NTFY_API_S_VER_5 */
846 * struct iwl_extended_beacon_notif - notifies about beacon transmission
847 * @status: the status of the Tx response of the beacon
848 * @tsf: last beacon tsf
849 * @ibss_mgr_status: whether IBSS is manager
850 * @gp2: last beacon time in gp2
852 struct iwl_extended_beacon_notif {
855 __le32 ibss_mgr_status;
857 } __packed; /* BEACON_NTFY_API_S_VER_6_ */
860 * enum iwl_dump_control - dump (flush) control flags
861 * @DUMP_TX_FIFO_FLUSH: Dump MSDUs until the the FIFO is empty
862 * and the TFD queues are empty.
864 enum iwl_dump_control {
865 DUMP_TX_FIFO_FLUSH = BIT(1),
869 * struct iwl_tx_path_flush_cmd_v1 -- queue/FIFO flush command
870 * @queues_ctl: bitmap of queues to flush
871 * @flush_ctl: control flags
872 * @reserved: reserved
874 struct iwl_tx_path_flush_cmd_v1 {
878 } __packed; /* TX_PATH_FLUSH_CMD_API_S_VER_1 */
881 * struct iwl_tx_path_flush_cmd -- queue/FIFO flush command
882 * @sta_id: station ID to flush
883 * @tid_mask: TID mask to flush
884 * @reserved: reserved
886 struct iwl_tx_path_flush_cmd {
890 } __packed; /* TX_PATH_FLUSH_CMD_API_S_VER_2 */
892 #define IWL_TX_FLUSH_QUEUE_RSP 16
895 * struct iwl_flush_queue_info - virtual flush queue info
896 * @tid: the tid to flush
897 * @queue_num: virtual queue id
898 * @read_before_flush: read pointer before flush
899 * @read_after_flush: read pointer after flush
901 struct iwl_flush_queue_info {
904 __le16 read_before_flush;
905 __le16 read_after_flush;
906 } __packed; /* TFDQ_FLUSH_INFO_API_S_VER_1 */
909 * struct iwl_tx_path_flush_cmd_rsp -- queue/FIFO flush command response
910 * @sta_id: the station for which the queue was flushed
911 * @num_flushed_queues: number of queues in queues array
912 * @queues: all flushed queues
914 struct iwl_tx_path_flush_cmd_rsp {
916 __le16 num_flushed_queues;
917 struct iwl_flush_queue_info queues[IWL_TX_FLUSH_QUEUE_RSP];
918 } __packed; /* TX_PATH_FLUSH_CMD_RSP_API_S_VER_1 */
920 /* Available options for the SCD_QUEUE_CFG HCMD */
921 enum iwl_scd_cfg_actions {
922 SCD_CFG_DISABLE_QUEUE = 0x0,
923 SCD_CFG_ENABLE_QUEUE = 0x1,
924 SCD_CFG_UPDATE_QUEUE_TID = 0x2,
928 * struct iwl_scd_txq_cfg_cmd - New txq hw scheduler config command
930 * @sta_id: station id
932 * @scd_queue: scheduler queue to confiug
933 * @action: 1 queue enable, 0 queue disable, 2 change txq's tid owner
934 * Value is one of &enum iwl_scd_cfg_actions options
935 * @aggregate: 1 aggregated queue, 0 otherwise
936 * @tx_fifo: &enum iwl_mvm_tx_fifo
937 * @window: BA window size
938 * @ssn: SSN for the BA agreement
939 * @reserved: reserved
941 struct iwl_scd_txq_cfg_cmd {
952 } __packed; /* SCD_QUEUE_CFG_CMD_API_S_VER_1 */
955 * struct iwl_scd_txq_cfg_rsp
956 * @token: taken from the command
957 * @sta_id: station id from the command
958 * @tid: tid from the command
959 * @scd_queue: scd_queue from the command
961 struct iwl_scd_txq_cfg_rsp {
966 } __packed; /* SCD_QUEUE_CFG_RSP_API_S_VER_1 */
968 #endif /* __iwl_fw_api_tx_h__ */