ath/ath12k/hal_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-2022, 2024 Qualcomm Innovation Center, Inc. All rights reserved.
34  *		Producer: SW/FW
43  *		Cookie field exclusively used by SW. HW ignores the contents,
47  *		Field can be used by SW to for example associate the buffers
634  *		Consumer: REO/SW/FW
649  *		Indicates the MPDU was received as part of an A-MPDU.
653  *		this frame shall be pushed to SW or deleted.
739  *		field is still valid for MPDU frames without A-MSDU. It still
780  *		This packet needs intra-BSS routing by SW as the 'vdev_id'
786  *		to support intra-BSS routing with multi-chip multi-link operation.
810  *		Opaque service code between PPE and Wi-Fi
874  *		Consumer: REO/SW/FW
890  *		Lower 32 bits of the 64-bit virtual address corresponding
895  *		Upper 32 bits of the 64-bit virtual address corresponding
913  *		and copied into the ring for easy FW/SW access.
920  *		- NO re-order function is needed.
921  *		- MPDU delinking is determined by the setting of Entrance
923  *		- Destination ring selection is based on the setting of
934  *		0 - Idle ring
935  *		1 - N refers to other rings.
973  *		RX-Descriptor ring can fetch free buffer from specific
975  *		will be released to; POOL_ID Zero returned to SW
1114  *		NO re-order function is needed.
1128  *		Field only valid when fields SW_exception and SW
1134  *		of sub-field Reo level mpdu frame info.
1149  *		0 - Idle ring
1150  *		1 - N refers to other rings.
1176  *		Producer: SW
1342  *		module (SW, TCL or TQM) that sees the frames first.
1373  *		which can be overridden by SW for pre-encrypted raw WiFi packets
1375  *		0 - FP_PARSE_IP: Use the flow-pointer based on parsing the IPv4
1377  *		1 - FP_USE_OVERRIDE: Use the who_classify_info_sel and
1378  *				     flow_override fields to select the flow-pointer
1400  *		which can be overridden by SW for pre-encrypted raw WiFi packets
1402  *		0 - FP_USE_NON_UDP: Use the non-UDP flow pointer (flow 0)
1403  *		1 - FP_USE_UDP: Use the UDP flow pointer (flow 1)
1440  *		1 - N refers to other rings
1453  *		In case SW is the consumer of the ring entries, it can
1457  *		the SW starts processing an interrupt indicating that new
1460  *		Also note that SW if it wants only needs to look at the
1551  *		Enable generation of 32-bit Toeplitz-LFSR hash for
1556  *		Treats source memory organization as big-endian. For
1563  *		Treats destination memory organization as big-endian.
1595  *		1 - N refers to other rings
1608  *		In case SW is the consumer of the ring entries, it can
1612  *		the SW starts processing an interrupt indicating that new
1615  *		Also note that SW if it wants only needs to look at the
1644  *		1 - N refers to other rings
1657  *		In case SW is the consumer of the ring entries, it can
1661  *		the SW starts processing an interrupt indicating that new
1664  *		Also note that SW if it wants only needs to look at the
1726  *		1 - N refers to other rings
1739  *		In case SW is the consumer of the ring entries, it can
1743  *		the SW starts processing an interrupt indicating that new
1746  *		Also note that SW if it wants only needs to look at the
2014  *	Producer: SW/TQM/RXDMA/REO/SWITCH
2015  *	Consumer: WBM/SW/FW
2017  * HTT tx status is overlaid on wbm_release ring on 4-byte words 2, 3, 4 and 5
2048  *	In case SW is the consumer of the ring entries, it can
2052  *	the SW starts processing an interrupt indicating that new
2055  *	Also note that SW if it wants only needs to look at the
2060  * enum hal_wbm_tqm_rel_reason - TQM release reason code
2062  * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_MPDU: Command remove_mpdus initiated by SW
2064  *	initiated by sw.
2066  *	initiated by sw.
2078  *	fw to remove all mpdu until 1st non-match.
2140  *		Consumer: REO/SW/FW
2146  *              Details related to the MPDU being pushed to SW, valid
2152  *		MPDU being pushed to SW if end_of_ppdu = 0, or the PPDU
2200  *		<enum 9 rxdma_amsdu_parse_err>RX OLE reported an A-MSDU
2215  *		<enum 14 rxdma_amsdu_fragment_err>Rx PCU reported A-MSDU
2230  *		When set, this SW monitor ring struct contains BAR info
2248  *		(either the PPDU that included the MPDU being pushed to SW
2289  *		In case SW is the consumer of the ring entries, it can
2293  *		the SW starts processing an interrupt indicating that new
2459  *	When set, REO has been instructed to not perform the actual re-ordering
2476  *	A value 255 means 256 bitmap, 63 means 64 bitmap, 0 (means non-BA
2482  *	A BA window size of 1 - 105, means that there is 1 rx_reo_queue_ext.
2483  *	A BA window size of 106 - 210, means that there are 2 rx_reo_queue_ext.
2484  *	A BA window size of 211 - 256, means that there are 3 rx_reo_queue_ext.
2597  *		Consumer: SW
2651  *		Consumer: SW
2659  *		window moves (can be filled by SW then maintained by REO).
2674  *		in the re-order queue. The bitmap  is Fully managed by HW.
2708  *		(Window SSN - 256) - (Window SSN - 1).
2736  *		Consumer: SW
2745  *		0 - No error has been detected while executing this command
2746  *		1 - Error detected. The resource to be used for blocking was
2771  *		Consumer: SW
2780  *		0 - No error has been detected while executing this command
2781  *		1 - An error in the blocking resource management was detected
2786  *		0 - No blocking related errors found
2787  *		1 - Blocking resource is already in use
2788  *		2 - Resource requested to be unblocked, was not blocked
2794  *		0 - miss; 1 - hit
2807  *		0 - No error found
2808  *		1 - HW interface is still busy
2809  *		2 - Line currently locked. Used for one line flush command
2810  *		3 - At least one line is still locked.
2833  *		Consumer: SW
2840  *		0 - No error has been detected while executing this command
2841  *		1 - The blocking resource was not in use, and therefore it could
2846  *		0 - Unblock a blocking resource
2847  *		1 - The entire cache usage is unblock
2870  *		Consumer: SW
2877  *		0 - No error has been detected while executing this command
2878  *		1 - Command not properly executed and returned with error
2885  *		Producer: SW; Consumer: REO
2889  *		Producer: SW; Consumer: REO
2916  *		Consumer: SW
2957  *	Producer : SW
2961  *	Lower 32-bit physical address of the buffer pointer from the source ring.
2963  *	bit range 7-0 : upper 8 bit of the physical address.
2964  *	bit range 31-8 : reserved.
2987  *	Consumer : SW
2989  *	bit 0 -17 buf_id to track the skb's vaddr.
3025  *		2 ~ 3 - Reserved
3031  *		Any time firmware uses TQM-BYPASS for Data