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.
214  *		If use_flow_id_toeplitz_clfy is set and lmac_peer_id_'sb
218  *		If use_flow_id_toeplitz_clfy is set and lmac_peer_id_msb
242  *		pkt_selection_fp_... bit is set
246  *		pkt_selection_fp_... bit is set
249  *		If set, for multicast packets, multicast echo check (i.e.
255  *		If set, WDS learning detection based on SA search and notification
257  *		field in address search failure cache-only entry should
261  *		If set, intra-BSS routing detection is enabled
277  *		This is set by SW for peers which are being handled by a
279  *		buffer management for WiFi-to-PPE routing.
282  *		by a different subsystem, completely disabling WiFi-to-PPE
311  *		this field will be set to 0
312  *		If set to one use EPD instead of LPD
313  *		In case of ndp or phy_err, this field will never be set.
317  *		this field will be set to 0
319  *		When set, all frames (data only ?) shall be encrypted. If
320  *		not, RX CRYPTO shall set an error flag.
325  *		this field will be set to 0
332  *		Field only valid when key_type is set to wep_varied_width.
337  *		When set, the BSSID of the incoming frame matched one of
340  *		Field only valid when bssid_hit is set.
345  *		Field only valid when mpdu_qos_control_valid is set
362  *		When set, the received frame was an NDP frame, and thus
365  *		When set, a PHY error was received before MAC received any
369  *		When set, a PHY error was received before MAC received the
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
381  *		When set, a ranging NDPA or a ranging NDP was received.
397  *		this field will be set to 0
398  *		This field indicates a unique peer identifier. It is set
402  *		When set, the field Mpdu_Frame_control_field has valid information
405  *		When set, the field Mpdu_duration_field has valid information
408  *		When set, the fields mac_addr_adx_..... have valid information
412  *		When set, the fields mpdu_sequence_control_field and mpdu_sequence_number
415  *		not be set.
419  *		When set, the field mpdu_qos_control_field, mpdu_ht_control has valid
421  *		will not be set.
425  *		When set, the encryption related info fields, like IV and
427  *		For MPDUs that are not encrypted, this will not be set.
431  *		Field only valid when Mpdu_sequence_control_valid is set
432  *		AND Fragment_flag is set. The fragment number from the 802.11 header
441  *		Field only valid when Mpdu_frame_control_valid is set
442  *		Set if the from DS bit is set in the frame control.
446  *		Field only valid when Mpdu_frame_control_valid is set
447  *		Set if the to DS bit is set in the frame control.
451  *		Field only valid when Mpdu_frame_control_valid is set.
455  *		Field only valid when Mpdu_frame_control_valid is set.
456  *		Retry bit from the frame control.  Only valid when first_msdu is set
459  *		Field only valid when Mpdu_sequence_control_valid is set.
464  *		Field only valid when Frame_encryption_info_valid is set
467  *		Set if new RX_PEER_ENTRY TLV follows. If clear, RX_PEER_ENTRY
473  *		RXPCU will also ensure that this bit is NOT set. CRYPTO for that
492  *		received MPDU in the PPDU and this MPDU gets filtered-in,
501  *		Received frame was part of an A-MPDU.
507  *		Set when no 802.11 to nwifi/ethernet hdr conversion is done
514  *		and last_mpdu are set in the MSDU then this is a not an
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
518  *		is set.
521  *		Multicast / broadcast indicator.  Only set when the MAC
522  *		address 1 bit 0 is set indicating mcast/bcast and the BSSID
523  *		matches one of the 4 BSSID registers. Only set when
524  *		first_msdu is set.
527  *		Only valid when first_msdu is set. Indicates no AST matching
531  *		Only valid when first_msdu is set. Indicates an unsuccessful
535  *		Power management bit set in the 802.11 header.  Only set
536  *		when first_msdu is set.
539  *		Set if packet is not a non-QoS data frame.  Only set when
540  *		first_msdu is set.
543  *		Set if frame type indicates either null data or QoS null
544  *		data format.  Only set when first_msdu is set.
547  *		Set if packet is a management packet.  Only set when
548  *		first_msdu is set.
551  *		Set if packet is a control packet.  Only set when first_msdu
552  *		is set.
555  *		Set if more bit in frame control is set.  Only set when
556  *		first_msdu is set.
559  *		Set if the EOSP (end of service period) bit in the QoS
560  *		control field is set.  Only set when first_msdu is set.
567  *		Set if the order bit in the frame control is set.  Only
568  *		set when first_msdu is set.
571  *		U-APSD trigger frame
594  *		address valid bit is set
602  *		RXOLE uses this to determine intra-BSS routing.
605  *		Opaque service code between PPE and Wi-Fi
620  *		If set, Rx OLE shall convert Address1 and Address2 of received
621  *		data frames to multi-link addresses during decapsulation to eth/nwifi
624  *		Multi-link receiver address1,2. Only valid when corresponding
625  *		valid bit is set
628  *		If not set, RXDMA shall perform error-routing for WDS packets
972  *		set. This field is taken directly from the length field of the
973  *		A-MPDU delimiter or the preamble length field for non-A-MPDU
988  *		'RXOLE_R0_FISA_CTRL. CHKSUM_CUM_IP_LEN_EN' is set
1003  *		da_offset field is valid. This will be set to 0 in case
1004  *		of a dynamic A-MSDU when DA is compressed.
1007  *		sa_offset field is valid. This will be set to 0 in case
1008  *		of a dynamic A-MSDU when SA is compressed.
1011  *		The 16-bit type value indicating the type of L3 later
1012  *		extracted from LLC/SNAP, set to zero if SNAP is not
1044  *		Set if the to DS bit is set in the frame control.
1056  *		Field Only valid if da_is_valid is set. Indicates the DA address
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
1067  *		first_mpdu and last_mpdu bits set to 0.
1070  *		Indicates the last MSDU of the A-MSDU. MPDU end status is only
1071  *		valid when last_msdu is set.
1074  *		Set if the from DS bit is set in the frame control.
1109  *		When set, this is a Mesh (11s) STA.
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
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
1123  *		is set.
1170  *		A-MSDU could not be properly de-agregated.
1177  *		The key ID octet from the IV. Only valid when first_msdu is set.
1180  *		Opaque service code between PPE and Wi-Fi
1186  *		This packet needs intra-BSS routing by SW as the 'vdev_id'
1191  *		If intra_bss is set, copied by RXOLE from 'ADDR_SEARCH_ENTRY'
1192  *		to support intra-BSS routing with multi-chip multi-link
1197  *		If set, this packet is a multicast echo, i.e. the DA is
1202  *		If set, this packet has an SA search failure with WDS learning
1207  *		If set, this packet's SA 'Sw_peer_id' mismatches the 'Sw_peer_id'
1213  *		If set, the AST timestamp for this packet's SA is older
1220  *		This field is still valid for MPDU frames without A-MSDU.
1224  *		When set, use STBC transmission rates.
1227  *		Set if IPv4/v6 packet is using IPsec ESP.
1234  *		ipv6_proto is set.
1237  *		Set if IPv4/v6 packet is using IPsec AH
1242  *		if either ipv4_proto or ipv6_proto is set to 1) or indicates
1245  *		tcp_proto or udp_proto is set). The value 0 indicates that
1258  *		Set if L2 layer indicates IPv4 protocol.
1261  *		Set if L2 layer indicates IPv6 protocol.
1264  *		Set if the ipv4_proto or ipv6_proto are set and the IP protocol
1268  *		Set if the ipv4_proto or ipv6_proto are set and the IP protocol
1272  *		Indicates that either the IP More frag bit is set or IP frag
1273  *		number is non-zero.  If set indicates that this is a fragmented
1277  *		Set if only the TCP Ack bit is set in the TCP flags and if
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
1307  *		When set, this MSDU includes the 'Mesh Control' field
1312  *		For IPv4, this is the 8 bit protocol field set). For IPv6 this
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
1362  *		If set indicates that the RX packet data, RX header data,
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
1405  *		and last_mpdu are set in the MSDU then this is a not an
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
1409  *		is set.
1412  *		Multicast / broadcast indicator.  Only set when the MAC
1413  *		address 1 bit 0 is set indicating mcast/bcast and the BSSID
1414  *		matches one of the 4 BSSID registers. Only set when
1415  *		first_msdu is set.
1418  *		Only valid when first_msdu is set. Indicates no AST matching
1422  *		Only valid when first_msdu is set. Indicates an unsuccessful
1426  *		Power management bit set in the 802.11 header.  Only set
1427  *		when first_msdu is set.
1430  *		Set if packet is not a non-QoS data frame.  Only set when
1431  *		first_msdu is set.
1434  *		Set if frame type indicates either null data or QoS null
1435  *		data format.  Only set when first_msdu is set.
1438  *		Set if packet is a management packet.  Only set when
1439  *		first_msdu is set.
1442  *		Set if packet is a control packet.  Only set when first_msdu
1443  *		is set.
1446  *		Set if more bit in frame control is set.  Only set when
1447  *		first_msdu is set.
1450  *		Set if the EOSP (end of service period) bit in the QoS
1451  *		control field is set.  Only set when first_msdu is set.
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
1460  *		set when first_msdu is set.
1475  *		Set by RXPCU if the expected MPDU length does not correspond
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
1515  *		fragmented.  If set the FW should look at the rx_frag_info
1519  *		Indicates that the MPDU was pre-maturely terminated
1548  *		If set indicates that the RX packet data, RX header data, RX