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-2024 Qualcomm Innovation Center, Inc. All rights reserved.
208  *		The id of the reo exit ring where the msdu frame shall push
229  *		Filter pass Unicast data frame (matching rxpcu_filter_pass
233  *		Filter pass Multicast data frame (matching rxpcu_filter_pass
237  *		Filter pass BAR frame (matching rxpcu_filter_pass
241  *		Field only valid when for the received frame type the corresponding
245  *		Field only valid when for the received frame type the corresponding
257  *		field in address search failure cache-only entry should
261  *		If set, intra-BSS routing detection is enabled
279  *		buffer management for WiFi-to-PPE routing.
282  *		by a different subsystem, completely disabling WiFi-to-PPE
306  *		The PN number.
337  *		When set, the BSSID of the incoming frame matched one of
341  *		This number indicates which one out of the 8 BSSID register
342  *		values matched the incoming frame
353  *		Field indicates what the reason was that this mpdu frame
362  *		When set, the received frame was an NDP frame, and thus
373  *		Set when RXPCU detected a version error in the Frame control
377  *		When set, AST based lookup for this frame has found a valid
432  *		AND Fragment_flag is set. The fragment number from the 802.11 header
437  *		received frame
442  *		Set if the from DS bit is set in the frame control.
447  *		Set if the to DS bit is set in the frame control.
452  *		Protected bit from the frame control.
456  *		Retry bit from the frame control.  Only valid when first_msdu is set
461  *		The sequence number from the 802.11 header.
490  *		The number of delimiters before this MPDU. Note that this
491  *		number is cleared at PPDU start. If this MPDU is the first
492  *		received MPDU in the PPDU and this MPDU gets filtered-in,
493  *		this field will indicate the number of delimiters located
497  *		an PPDU, this field will indicate the number of delimiters
501  *		Received frame was part of an A-MPDU.
504  *		Received frame is a BAR frame
515  *		A-MPDU frame but a stand alone MPDU.  Interior MPDU in an
516  *		A-MPDU shall have both first_mpdu and last_mpdu bits set to
539  *		Set if packet is not a non-QoS data frame.  Only set when
543  *		Set if frame type indicates either null data or QoS null
555  *		Set if more bit in frame control is set.  Only set when
567  *		Set if the order bit in the frame control is set.  Only
571  *		U-APSD trigger frame
574  *		Indicates that this data type frame is not encrypted even if
587  *		Frame control field in header. Only valid when the field is marked valid.
593  *		MAC addresses in the received frame. Only valid when corresponding
602  *		RXOLE uses this to determine intra-BSS routing.
605  *		Opaque service code between PPE and Wi-Fi
621  *		data frames to multi-link addresses during decapsulation to eth/nwifi
624  *		Multi-link receiver address1,2. Only valid when corresponding
628  *		If not set, RXDMA shall perform error-routing for WDS packets
629  *		as the sender is not authorized and might misuse WDS frame
954  *		Field indicates what the reason was that this mpdu frame
973  *		A-MPDU delimiter or the preamble length field for non-A-MPDU
980  *		Classification failed due to truncated frame.
1004  *		of a dynamic A-MSDU when DA is compressed.
1008  *		of a dynamic A-MSDU when SA is compressed.
1011  *		The 16-bit type value indicating the type of L3 later
1016  *		TCP sequence number.
1019  *		TCP acknowledge number.
1044  *		Set if the to DS bit is set in the frame control.
1060  *		Number of bytes padded  to make sure that the L3 header will
1064  *		Indicates the first MSDU of A-MSDU. If both first_msdu and
1065  *		last_msdu are set in the MSDU then this is a non-aggregated MSDU
1066  *		frame: normal MPDU. Interior MSDU in an A-MSDU shall have both
1070  *		Indicates the last MSDU of the A-MSDU. MPDU end status is only
1074  *		Set if the from DS bit is set in the frame control.
1096  *		The id of the reo exit ring where the msdu frame shall push
1112  *		Set by RXOLE if it stripped 4-bytes of C-VLAN Tag from the
1116  *		Set by RXOLE if it stripped 4-bytes of S-VLAN Tag from the
1120  *		Indicates that this is an 802.11 fragment frame.  This is
1121  *		set when either the more_frag bit is set in the frame control
1122  *		or the fragment number is not zero.  Only set when first_msdu
1137  *		Number of MSDU's aggregated so far
1170  *		A-MSDU could not be properly de-agregated.
1180  *		Opaque service code between PPE and Wi-Fi
1186  *		This packet needs intra-BSS routing by SW as the 'vdev_id'
1192  *		to support intra-BSS routing with multi-chip multi-link
1220  *		This field is still valid for MPDU frames without A-MSDU.
1249  *		Indicates the MSDU number within a MPDU.  This value is
1250  *		reset to zero at the start of each MPDU.  If the number of
1251  *		MSDU exceeds 255 this number will wrap using modulo 256.
1273  *		number is non-zero.  If set indicates that this is a fragmented
1285  *		0 - Toeplitz hash of 2-tuple (IP source address, IP
1287  *		1 - Toeplitz hash of 4-tuple (IP source	address,
1290  *		2 - Toeplitz of flow_id
1291  *		3 - Zero is used
1294  *		Fixed 20-byte IPv4 header or 40-byte IPv6 header parsed
1303  *		Fixed 20-byte TCP (excluding TCP options) or 8-byte UDP
1317  *		2 bytes of C-VLAN Tag Control Information from WHO_L2_LLC
1320  *		2 bytes of S-VLAN Tag Control Information from WHO_L2_LLC
1358  *		0 - spatial stream not used for this reception
1359  *		1 - spatial stream used for this reception
1365  *		are all valid.  This bit is in the last 64-bit of the descriptor
1369  *		Toeplitz hash of 5-tuple
1371  *		destination port, L4 protocol}  in case of non-IPSec.
1373  *		In case of IPSec - Toeplitz hash of 4-tuple
1392  *		IPv4/IPv6 - Either, Toeplitz hash computed over 2-tuple
1394  *		hash computed over 4-tuple IPv4 or IPv6 src/dest addresses
1397  *		is the one used for hash-based REO routing (see use_flow_id_toeplitz_clfy
1406  *		A-MPDU frame but a stand alone MPDU.  Interior MPDU in an
1407  *		A-MPDU shall have both first_mpdu and last_mpdu bits set to
1430  *		Set if packet is not a non-QoS data frame.  Only set when
1434  *		Set if frame type indicates either null data or QoS null
1446  *		Set if more bit in frame control is set.  Only set when
1454  *		Set if number of MSDUs in A-MSDU is above a threshold or if the
1459  *		Set if the order bit in the frame control is set.  Only
1463  *		Indicates that the WiFi frame has one of the following errors
1476  *		with the actually received number of bytes in the MPDU.
1495  *		Indicates that an A-MSDU with 'from DS = 0' had an SA mismatching
1496  *		TA or an A-MDU with 'to DS = 0' had a DA mismatching RA
1503  *		Indicates that this data type frame is not encrypted even if
1519  *		Indicates that the MPDU was pre-maturely terminated
1544  *		Frame is received, but RXPCU could not update the receive bitmap