ath/ath12k/rx_desc.h

1 /* SPDX-License-Identifier: BSD-3-Clause-Clear */
3  * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved.
4  * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
159  *		If use_flow_id_toeplitz_clfy is set and lmac_peer_id_'sb
163  *		If use_flow_id_toeplitz_clfy is set and lmac_peer_id_msb
187  *		pkt_selection_fp_... bit is set
191  *		pkt_selection_fp_... bit is set
194  *		If set, for multicast packets, multicast echo check (i.e.
200  *		If set, WDS learning detection based on SA search and notification
202  *		field in address search failure cache-only entry should
206  *		If set, intra-BSS routing detection is enabled
222  *		This is set by SW for peers which are being handled by a
224  *		buffer management for WiFi-to-PPE routing.
227  *		by a different subsystem, completely disabling WiFi-to-PPE
256  *		this field will be set to 0
257  *		If set to one use EPD instead of LPD
258  *		In case of ndp or phy_err, this field will never be set.
262  *		this field will be set to 0
264  *		When set, all frames (data only ?) shall be encrypted. If
265  *		not, RX CRYPTO shall set an error flag.
270  *		this field will be set to 0
277  *		Field only valid when key_type is set to wep_varied_width.
282  *		When set, the BSSID of the incoming frame matched one of
285  *		Field only valid when bssid_hit is set.
290  *		Field only valid when mpdu_qos_control_valid is set
307  *		When set, the received frame was an NDP frame, and thus
310  *		When set, a PHY error was received before MAC received any
314  *		When set, a PHY error was received before MAC received the
318  *		Set when RXPCU detected a version error in the Frame control
322  *		When set, AST based lookup for this frame has found a valid
326  *		When set, a ranging NDPA or a ranging NDP was received.
342  *		this field will be set to 0
343  *		This field indicates a unique peer identifier. It is set
347  *		When set, the field Mpdu_Frame_control_field has valid information
350  *		When set, the field Mpdu_duration_field has valid information
353  *		When set, the fields mac_addr_adx_..... have valid information
357  *		When set, the fields mpdu_sequence_control_field and mpdu_sequence_number
360  *		not be set.
364  *		When set, the field mpdu_qos_control_field, mpdu_ht_control has valid
366  *		will not be set.
370  *		When set, the encryption related info fields, like IV and
372  *		For MPDUs that are not encrypted, this will not be set.
376  *		Field only valid when Mpdu_sequence_control_valid is set
377  *		AND Fragment_flag is set. The fragment number from the 802.11 header
386  *		Field only valid when Mpdu_frame_control_valid is set
387  *		Set if the from DS bit is set in the frame control.
391  *		Field only valid when Mpdu_frame_control_valid is set
392  *		Set if the to DS bit is set in the frame control.
396  *		Field only valid when Mpdu_frame_control_valid is set.
400  *		Field only valid when Mpdu_frame_control_valid is set.
401  *		Retry bit from the frame control.  Only valid when first_msdu is set
404  *		Field only valid when Mpdu_sequence_control_valid is set.
409  *		Field only valid when Frame_encryption_info_valid is set
412  *		Set if new RX_PEER_ENTRY TLV follows. If clear, RX_PEER_ENTRY
418  *		RXPCU will also ensure that this bit is NOT set. CRYPTO for that
437  *		received MPDU in the PPDU and this MPDU gets filtered-in,
446  *		Received frame was part of an A-MPDU.
452  *		Set when no 802.11 to nwifi/ethernet hdr conversion is done
459  *		and last_mpdu are set in the MSDU then this is a not an
460  *		A-MPDU frame but a stand alone MPDU.  Interior MPDU in an
461  *		A-MPDU shall have both first_mpdu and last_mpdu bits set to
463  *		is set.
466  *		Multicast / broadcast indicator.  Only set when the MAC
467  *		address 1 bit 0 is set indicating mcast/bcast and the BSSID
468  *		matches one of the 4 BSSID registers. Only set when
469  *		first_msdu is set.
472  *		Only valid when first_msdu is set. Indicates no AST matching
476  *		Only valid when first_msdu is set. Indicates an unsuccessful
480  *		Power management bit set in the 802.11 header.  Only set
481  *		when first_msdu is set.
484  *		Set if packet is not a non-QoS data frame.  Only set when
485  *		first_msdu is set.
488  *		Set if frame type indicates either null data or QoS null
489  *		data format.  Only set when first_msdu is set.
492  *		Set if packet is a management packet.  Only set when
493  *		first_msdu is set.
496  *		Set if packet is a control packet.  Only set when first_msdu
497  *		is set.
500  *		Set if more bit in frame control is set.  Only set when
501  *		first_msdu is set.
504  *		Set if the EOSP (end of service period) bit in the QoS
505  *		control field is set.  Only set when first_msdu is set.
512  *		Set if the order bit in the frame control is set.  Only
513  *		set when first_msdu is set.
516  *		U-APSD trigger frame
539  *		address valid bit is set
547  *		RXOLE uses this to determine intra-BSS routing.
550  *		Opaque service code between PPE and Wi-Fi
565  *		If set, Rx OLE shall convert Address1 and Address2 of received
566  *		data frames to multi-link addresses during decapsulation to eth/nwifi
569  *		Multi-link receiver address1,2. Only valid when corresponding
570  *		valid bit is set
573  *		If not set, RXDMA shall perform error-routing for WDS packets
869  *		set. This field is taken directly from the length field of the
870  *		A-MPDU delimiter or the preamble length field for non-A-MPDU
885  *		'RXOLE_R0_FISA_CTRL. CHKSUM_CUM_IP_LEN_EN' is set
900  *		da_offset field is valid. This will be set to 0 in case
901  *		of a dynamic A-MSDU when DA is compressed.
904  *		sa_offset field is valid. This will be set to 0 in case
905  *		of a dynamic A-MSDU when SA is compressed.
908  *		The 16-bit type value indicating the type of L3 later
909  *		extracted from LLC/SNAP, set to zero if SNAP is not
941  *		Set if the to DS bit is set in the frame control.
953  *		Field Only valid if da_is_valid is set. Indicates the DA address
961  *		Indicates the first MSDU of A-MSDU. If both first_msdu and
962  *		last_msdu are set in the MSDU then this is a non-aggregated MSDU
963  *		frame: normal MPDU. Interior MSDU in an A-MSDU shall have both
964  *		first_mpdu and last_mpdu bits set to 0.
967  *		Indicates the last MSDU of the A-MSDU. MPDU end status is only
968  *		valid when last_msdu is set.
971  *		Set if the from DS bit is set in the frame control.
1006  *		When set, this is a Mesh (11s) STA.
1009  *		Set by RXOLE if it stripped 4-bytes of C-VLAN Tag from the
1013  *		Set by RXOLE if it stripped 4-bytes of S-VLAN Tag from the
1018  *		set when either the more_frag bit is set in the frame control
1019  *		or the fragment number is not zero.  Only set when first_msdu
1020  *		is set.
1067  *		A-MSDU could not be properly de-agregated.
1074  *		The key ID octet from the IV. Only valid when first_msdu is set.
1077  *		Opaque service code between PPE and Wi-Fi
1083  *		This packet needs intra-BSS routing by SW as the 'vdev_id'
1088  *		If intra_bss is set, copied by RXOLE from 'ADDR_SEARCH_ENTRY'
1089  *		to support intra-BSS routing with multi-chip multi-link
1094  *		If set, this packet is a multicast echo, i.e. the DA is
1099  *		If set, this packet has an SA search failure with WDS learning
1104  *		If set, this packet's SA 'Sw_peer_id' mismatches the 'Sw_peer_id'
1110  *		If set, the AST timestamp for this packet's SA is older
1117  *		This field is still valid for MPDU frames without A-MSDU.
1121  *		When set, use STBC transmission rates.
1124  *		Set if IPv4/v6 packet is using IPsec ESP.
1131  *		ipv6_proto is set.
1134  *		Set if IPv4/v6 packet is using IPsec AH
1139  *		if either ipv4_proto or ipv6_proto is set to 1) or indicates
1142  *		tcp_proto or udp_proto is set). The value 0 indicates that
1155  *		Set if L2 layer indicates IPv4 protocol.
1158  *		Set if L2 layer indicates IPv6 protocol.
1161  *		Set if the ipv4_proto or ipv6_proto are set and the IP protocol
1165  *		Set if the ipv4_proto or ipv6_proto are set and the IP protocol
1169  *		Indicates that either the IP More frag bit is set or IP frag
1170  *		number is non-zero.  If set indicates that this is a fragmented
1174  *		Set if only the TCP Ack bit is set in the TCP flags and if
1182  *		0 - Toeplitz hash of 2-tuple (IP source address, IP
1184  *		1 - Toeplitz hash of 4-tuple (IP source	address,
1187  *		2 - Toeplitz of flow_id
1188  *		3 - Zero is used
1191  *		Fixed 20-byte IPv4 header or 40-byte IPv6 header parsed
1200  *		Fixed 20-byte TCP (excluding TCP options) or 8-byte UDP
1204  *		When set, this MSDU includes the 'Mesh Control' field
1209  *		For IPv4, this is the 8 bit protocol field set). For IPv6 this
1214  *		2 bytes of C-VLAN Tag Control Information from WHO_L2_LLC
1217  *		2 bytes of S-VLAN Tag Control Information from WHO_L2_LLC
1255  *		0 - spatial stream not used for this reception
1256  *		1 - spatial stream used for this reception
1259  *		If set indicates that the RX packet data, RX header data,
1262  *		are all valid.  This bit is in the last 64-bit of the descriptor
1266  *		Toeplitz hash of 5-tuple
1268  *		destination port, L4 protocol}  in case of non-IPSec.
1270  *		In case of IPSec - Toeplitz hash of 4-tuple
1289  *		IPv4/IPv6 - Either, Toeplitz hash computed over 2-tuple
1291  *		hash computed over 4-tuple IPv4 or IPv6 src/dest addresses
1294  *		is the one used for hash-based REO routing (see use_flow_id_toeplitz_clfy
1302  *		and last_mpdu are set in the MSDU then this is a not an
1303  *		A-MPDU frame but a stand alone MPDU.  Interior MPDU in an
1304  *		A-MPDU shall have both first_mpdu and last_mpdu bits set to
1306  *		is set.
1309  *		Multicast / broadcast indicator.  Only set when the MAC
1310  *		address 1 bit 0 is set indicating mcast/bcast and the BSSID
1311  *		matches one of the 4 BSSID registers. Only set when
1312  *		first_msdu is set.
1315  *		Only valid when first_msdu is set. Indicates no AST matching
1319  *		Only valid when first_msdu is set. Indicates an unsuccessful
1323  *		Power management bit set in the 802.11 header.  Only set
1324  *		when first_msdu is set.
1327  *		Set if packet is not a non-QoS data frame.  Only set when
1328  *		first_msdu is set.
1331  *		Set if frame type indicates either null data or QoS null
1332  *		data format.  Only set when first_msdu is set.
1335  *		Set if packet is a management packet.  Only set when
1336  *		first_msdu is set.
1339  *		Set if packet is a control packet.  Only set when first_msdu
1340  *		is set.
1343  *		Set if more bit in frame control is set.  Only set when
1344  *		first_msdu is set.
1347  *		Set if the EOSP (end of service period) bit in the QoS
1348  *		control field is set.  Only set when first_msdu is set.
1351  *		Set if number of MSDUs in A-MSDU is above a threshold or if the
1356  *		Set if the order bit in the frame control is set.  Only
1357  *		set when first_msdu is set.
1372  *		Set by RXPCU if the expected MPDU length does not correspond
1392  *		Indicates that an A-MSDU with 'from DS = 0' had an SA mismatching
1393  *		TA or an A-MDU with 'to DS = 0' had a DA mismatching RA
1412  *		fragmented.  If set the FW should look at the rx_frag_info
1416  *		Indicates that the MPDU was pre-maturely terminated
1445  *		If set indicates that the RX packet data, RX header data, RX