fw/api/tx.h

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
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
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
22  * @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC)
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
32  * @TX_CMD_FLG_CALIB: activate PA TX power calibrations
36  * @TX_CMD_FLG_RESP_TO_DRV: zero this if the response should go only to FW
38  * @TX_CMD_FLG_DUR: disable duration overwriting used in PS-Poll Assoc-id
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
77  * @IWL_TX_FLAGS_HIGH_PRI: high priority frame (like EAPOL) - can affect rate
80  * @IWL_TX_FLAGS_CTS: firmware used CTS-to-self
86 	/* Use these flags only from
93  * enum iwl_tx_pm_timeouts - pm timeout values in TX command
109  * enum iwl_tx_cmd_sec_ctrl - bitmasks for security control in TX command
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.
119  *	first byte of the TX command key field.
132  * TX command Frame life time in us - to be written in pm_frame_timeout
140  * TID for non QoS frames - to be written in tid_tspec
145  * Limits on the retransmissions - to be written in {data,rts}_retry_limit
154  * enum iwl_tx_offload_assist_flags_pos -  set %iwl_tx_cmd offload_assist values
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
184  * struct iwl_tx_cmd - TX command struct to FW
187  * @offload_assist: TX offload configuration
190  * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
194  * @initial_rate_index: index into the the rate table for initial TX attempt.
206  * @pm_frame_timeout: PM TX frame timeout
216  * + 8-byte MIC (not used for CCM/WEP)
217  * It does not include post-MAC padding, i.e.,
219  * Range of len: 14-2342 bytes.
261  * struct iwl_tx_cmd_gen2 - TX command struct to FW for 22000 devices
264  * @offload_assist: TX offload configuration
267  * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
282  * struct iwl_tx_cmd_gen3 - TX command struct to FW for AX210+ devices
286  * @offload_assist: TX offload configuration
288  * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
305  * TX response related data
309  * enum iwl_tx_status - status that is returned by the fw after attempts to Tx
333  * @TX_STATUS_FAIL_STA_COLOR_MISMATCH: mismatch between color of Tx cmd and
342  * Valid only if frame_count =1
349 	/* postpone TX */
355 	/* abort TX */
386  * enum iwl_tx_agg_status - TX aggregation status
403  *	occur if tx failed for this frame when it was a member of a previous
406  * @AGG_TX_STATE_SEQ_NUM_MSK: Command ID and sequence number of Tx command for
445  * 1)	No aggregation (frame_count == 1).  This reports Tx results for a single
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
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
463  * struct agg_tx_status - per packet TX aggregation status
465  * @sequence: Sequence # for this frame's Tx cmd (not SSN!)
476  * bit-7 invalid rate indication
489  * struct iwl_tx_resp_v3 - notifies that fw is TXing a packet
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
508  * @seq_ctl: sequence control from the Tx cmd
509  * @byte_cnt: byte count from the Tx cmd
513  * @status: for non-agg:  frame status TX_STATUS_*
546  * struct iwl_tx_resp - notifies that fw is TXing a packet
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
565  * @seq_ctl: sequence control from the Tx cmd
566  * @byte_cnt: byte count from the Tx cmd
570  * @tx_queue: TX queue for this response
572  * @status: for non-agg:  frame status TX_STATUS_*
573  *	For version 6 TX response isn't received for aggregation at all.
607  * struct iwl_mvm_ba_notif - notifies about reception of BA
611  * @sta_id: Index of recipient (BA-sending) station in fw's station table
615  * @scd_flow: the tx queue this BA relates to
621  *	for Tx-ing then this value will be set to 0 by FW.
641  * struct iwl_mvm_compressed_ba_tfd - progress of a TFD queue
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)
657  * struct iwl_mvm_compressed_ba_ratid - progress of a RA TID queue
669  * enum iwl_mvm_ba_resp_flags - TX aggregation status
674  * @IWL_MVM_BA_RESP_TX_BT_KILL: aggregation got BT-kill
688  * struct iwl_mvm_compressed_ba_notif - notifies about reception of BA
691  * @sta_id: Index of recipient (BA-sending) station in fw's station table
694  *	for Tx-ing then this value will be set to 0 by FW.
699  * @txed: number of frames sent in the aggregation (all-TIDs)
700  * @done: number of frames that were Acked by the BA (all-TIDs)
703  * @wireless_time: Wireless-media time
705  * @tfd_cnt: number of TFD-Q elements
706  * @ra_tid_cnt: number of RATID-Q elements
709  * @ra_tid: array of RA-TID queue status updates. For debug purposes only. See
736  * struct iwl_mac_beacon_cmd_v6 - beacon template command
737  * @tx: the tx commands associated with the beacon frame
745 	struct iwl_tx_cmd tx;  member
753  * struct iwl_mac_beacon_cmd_v7 - beacon template command with offloaded CSA
754  * @tx: the tx commands associated with the beacon frame
764 	struct iwl_tx_cmd tx;  member
790  * struct iwl_mac_beacon_cmd - beacon template command with offloaded CSA
832  * struct iwl_extended_beacon_notif_v5 - notifies about beacon transmission
833  * @beacon_notify_hdr: tx response command associated with the beacon
846  * struct iwl_extended_beacon_notif - notifies about beacon transmission
847  * @status: the status of the Tx response of the beacon
860  * enum iwl_dump_control - dump (flush) control flags
869  * struct iwl_tx_path_flush_cmd_v1 -- queue/FIFO flush command
881  * struct iwl_tx_path_flush_cmd -- queue/FIFO flush command
895  * struct iwl_flush_queue_info - virtual flush queue info
909  * struct iwl_tx_path_flush_cmd_rsp -- queue/FIFO flush command response
928  * struct iwl_scd_txq_cfg_cmd - New txq hw scheduler config command