linux/drivers/net/wireless/ath/ath11k/hal_desc.h

/* SPDX-License-Identifier: BSD-3-Clause-Clear */
/*
 * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
 * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
 */
#include "core.h"

#ifndef ATH11K_HAL_DESC_H
#define ATH11K_HAL_DESC_H

#define BUFFER_ADDR_INFO0_ADDR

#define BUFFER_ADDR_INFO1_ADDR
#define BUFFER_ADDR_INFO1_RET_BUF_MGR
#define BUFFER_ADDR_INFO1_SW_COOKIE

struct ath11k_buffer_addr {} __packed;

/* ath11k_buffer_addr
 *
 * info0
 *		Address (lower 32 bits) of the msdu buffer or msdu extension
 *		descriptor or Link descriptor
 *
 * addr
 *		Address (upper 8 bits) of the msdu buffer or msdu extension
 *		descriptor or Link descriptor
 *
 * return_buffer_manager (RBM)
 *		Consumer: WBM
 *		Producer: SW/FW
 *		Indicates to which buffer manager the buffer or MSDU_EXTENSION
 *		descriptor or link descriptor that is being pointed to shall be
 *		returned after the frame has been processed. It is used by WBM
 *		for routing purposes.
 *
 *		Values are defined in enum %HAL_RX_BUF_RBM_
 *
 * sw_buffer_cookie
 *		Cookie field exclusively used by SW. HW ignores the contents,
 *		accept that it passes the programmed value on to other
 *		descriptors together with the physical address.
 *
 *		Field can be used by SW to for example associate the buffers
 *		physical address with the virtual address.
 */

enum hal_tlv_tag {};

#define HAL_TLV_HDR_TAG
#define HAL_TLV_HDR_LEN
#define HAL_TLV_USR_ID

#define HAL_TLV_ALIGN

struct hal_tlv_hdr {} __packed;

#define RX_MPDU_DESC_INFO0_MSDU_COUNT
#define RX_MPDU_DESC_INFO0_SEQ_NUM
#define RX_MPDU_DESC_INFO0_FRAG_FLAG
#define RX_MPDU_DESC_INFO0_MPDU_RETRY
#define RX_MPDU_DESC_INFO0_AMPDU_FLAG
#define RX_MPDU_DESC_INFO0_BAR_FRAME
#define RX_MPDU_DESC_INFO0_VALID_PN
#define RX_MPDU_DESC_INFO0_VALID_SA
#define RX_MPDU_DESC_INFO0_SA_IDX_TIMEOUT
#define RX_MPDU_DESC_INFO0_VALID_DA
#define RX_MPDU_DESC_INFO0_DA_MCBC
#define RX_MPDU_DESC_INFO0_DA_IDX_TIMEOUT
#define RX_MPDU_DESC_INFO0_RAW_MPDU

#define RX_MPDU_DESC_META_DATA_PEER_ID

struct rx_mpdu_desc {} __packed;

/* rx_mpdu_desc
 *		Producer: RXDMA
 *		Consumer: REO/SW/FW
 *
 * msdu_count
 *		The number of MSDUs within the MPDU
 *
 * mpdu_sequence_number
 *		The field can have two different meanings based on the setting
 *		of field 'bar_frame'. If 'bar_frame' is set, it means the MPDU
 *		start sequence number from the BAR frame otherwise it means
 *		the MPDU sequence number of the received frame.
 *
 * fragment_flag
 *		When set, this MPDU is a fragment and REO should forward this
 *		fragment MPDU to the REO destination ring without any reorder
 *		checks, pn checks or bitmap update. This implies that REO is
 *		forwarding the pointer to the MSDU link descriptor.
 *
 * mpdu_retry_bit
 *		The retry bit setting from the MPDU header of the received frame
 *
 * ampdu_flag
 *		Indicates the MPDU was received as part of an A-MPDU.
 *
 * bar_frame
 *		Indicates the received frame is a BAR frame. After processing,
 *		this frame shall be pushed to SW or deleted.
 *
 * valid_pn
 *		When not set, REO will not perform a PN sequence number check.
 *
 * valid_sa
 *		Indicates OLE found a valid SA entry for all MSDUs in this MPDU.
 *
 * sa_idx_timeout
 *		Indicates, at least 1 MSDU within the MPDU has an unsuccessful
 *		MAC source address search due to the expiration of search timer.
 *
 * valid_da
 *		When set, OLE found a valid DA entry for all MSDUs in this MPDU.
 *
 * da_mcbc
 *		Field Only valid if valid_da is set. Indicates at least one of
 *		the DA addresses is a Multicast or Broadcast address.
 *
 * da_idx_timeout
 *		Indicates, at least 1 MSDU within the MPDU has an unsuccessful
 *		MAC destination address search due to the expiration of search
 *		timer.
 *
 * raw_mpdu
 *		Field only valid when first_msdu_in_mpdu_flag is set. Indicates
 *		the contents in the MSDU buffer contains a 'RAW' MPDU.
 */

enum hal_rx_msdu_desc_reo_dest_ind {};

#define RX_MSDU_DESC_INFO0_FIRST_MSDU_IN_MPDU
#define RX_MSDU_DESC_INFO0_LAST_MSDU_IN_MPDU
#define RX_MSDU_DESC_INFO0_MSDU_CONTINUATION
#define RX_MSDU_DESC_INFO0_MSDU_LENGTH
#define RX_MSDU_DESC_INFO0_REO_DEST_IND
#define RX_MSDU_DESC_INFO0_MSDU_DROP
#define RX_MSDU_DESC_INFO0_VALID_SA
#define RX_MSDU_DESC_INFO0_SA_IDX_TIMEOUT
#define RX_MSDU_DESC_INFO0_VALID_DA
#define RX_MSDU_DESC_INFO0_DA_MCBC
#define RX_MSDU_DESC_INFO0_DA_IDX_TIMEOUT

#define HAL_RX_MSDU_PKT_LENGTH_GET(val)

struct rx_msdu_desc {} __packed;

/* rx_msdu_desc
 *
 * first_msdu_in_mpdu
 *		Indicates first msdu in mpdu.
 *
 * last_msdu_in_mpdu
 *		Indicates last msdu in mpdu. This flag can be true only when
 *		'Msdu_continuation' set to 0. This implies that when an msdu
 *		is spread out over multiple buffers and thus msdu_continuation
 *		is set, only for the very last buffer of the msdu, can the
 *		'last_msdu_in_mpdu' be set.
 *
 *		When both first_msdu_in_mpdu and last_msdu_in_mpdu are set,
 *		the MPDU that this MSDU belongs to only contains a single MSDU.
 *
 * msdu_continuation
 *		When set, this MSDU buffer was not able to hold the entire MSDU.
 *		The next buffer will therefore contain additional information
 *		related to this MSDU.
 *
 * msdu_length
 *		Field is only valid in combination with the 'first_msdu_in_mpdu'
 *		being set. Full MSDU length in bytes after decapsulation. This
 *		field is still valid for MPDU frames without A-MSDU. It still
 *		represents MSDU length after decapsulation Or in case of RAW
 *		MPDUs, it indicates the length of the entire MPDU (without FCS
 *		field).
 *
 * reo_destination_indication
 *		The id of the reo exit ring where the msdu frame shall push
 *		after (MPDU level) reordering has finished. Values are defined
 *		in enum %HAL_RX_MSDU_DESC_REO_DEST_IND_.
 *
 * msdu_drop
 *		Indicates that REO shall drop this MSDU and not forward it to
 *		any other ring.
 *
 * valid_sa
 *		Indicates OLE found a valid SA entry for this MSDU.
 *
 * sa_idx_timeout
 *		Indicates, an unsuccessful MAC source address search due to
 *		the expiration of search timer for this MSDU.
 *
 * valid_da
 *		When set, OLE found a valid DA entry for this MSDU.
 *
 * da_mcbc
 *		Field Only valid if valid_da is set. Indicates the DA address
 *		is a Multicast or Broadcast address for this MSDU.
 *
 * da_idx_timeout
 *		Indicates, an unsuccessful MAC destination address search due
 *		to the expiration of search timer for this MSDU.
 */

enum hal_reo_dest_ring_buffer_type {};

enum hal_reo_dest_ring_push_reason {};

enum hal_reo_dest_ring_error_code {};

#define HAL_REO_DEST_RING_INFO0_QUEUE_ADDR_HI
#define HAL_REO_DEST_RING_INFO0_BUFFER_TYPE
#define HAL_REO_DEST_RING_INFO0_PUSH_REASON
#define HAL_REO_DEST_RING_INFO0_ERROR_CODE
#define HAL_REO_DEST_RING_INFO0_RX_QUEUE_NUM

#define HAL_REO_DEST_RING_INFO1_REORDER_INFO_VALID
#define HAL_REO_DEST_RING_INFO1_REORDER_OPCODE
#define HAL_REO_DEST_RING_INFO1_REORDER_SLOT_IDX

#define HAL_REO_DEST_RING_INFO2_RING_ID
#define HAL_REO_DEST_RING_INFO2_LOOPING_COUNT

struct hal_reo_dest_ring {} __packed;

/* hal_reo_dest_ring
 *
 *		Producer: RXDMA
 *		Consumer: REO/SW/FW
 *
 * buf_addr_info
 *		Details of the physical address of a buffer or MSDU
 *		link descriptor.
 *
 * rx_mpdu_info
 *		General information related to the MPDU that is passed
 *		on from REO entrance ring to the REO destination ring.
 *
 * rx_msdu_info
 *		General information related to the MSDU that is passed
 *		on from RXDMA all the way to the REO destination ring.
 *
 * queue_addr_lo
 *		Address (lower 32 bits) of the REO queue descriptor.
 *
 * queue_addr_hi
 *		Address (upper 8 bits) of the REO queue descriptor.
 *
 * buffer_type
 *		Indicates the type of address provided in the buf_addr_info.
 *		Values are defined in enum %HAL_REO_DEST_RING_BUFFER_TYPE_.
 *
 * push_reason
 *		Reason for pushing this frame to this exit ring. Values are
 *		defined in enum %HAL_REO_DEST_RING_PUSH_REASON_.
 *
 * error_code
 *		Valid only when 'push_reason' is set. All error codes are
 *		defined in enum %HAL_REO_DEST_RING_ERROR_CODE_.
 *
 * rx_queue_num
 *		Indicates the REO MPDU reorder queue id from which this frame
 *		originated.
 *
 * reorder_info_valid
 *		When set, REO has been instructed to not perform the actual
 *		re-ordering of frames for this queue, but just to insert
 *		the reorder opcodes.
 *
 * reorder_opcode
 *		Field is valid when 'reorder_info_valid' is set. This field is
 *		always valid for debug purpose as well.
 *
 * reorder_slot_idx
 *		Valid only when 'reorder_info_valid' is set.
 *
 * ring_id
 *		The buffer pointer ring id.
 *		0 - Idle ring
 *		1 - N refers to other rings.
 *
 * looping_count
 *		Indicates the number of times the producer of entries into
 *		this ring has looped around the ring.
 */

enum hal_reo_entr_rxdma_ecode {};

#define HAL_REO_ENTR_RING_INFO0_QUEUE_ADDR_HI
#define HAL_REO_ENTR_RING_INFO0_MPDU_BYTE_COUNT
#define HAL_REO_ENTR_RING_INFO0_DEST_IND
#define HAL_REO_ENTR_RING_INFO0_FRAMELESS_BAR

#define HAL_REO_ENTR_RING_INFO1_RXDMA_PUSH_REASON
#define HAL_REO_ENTR_RING_INFO1_RXDMA_ERROR_CODE

struct hal_reo_entrance_ring {} __packed;

/* hal_reo_entrance_ring
 *
 *		Producer: RXDMA
 *		Consumer: REO
 *
 * buf_addr_info
 *		Details of the physical address of a buffer or MSDU
 *		link descriptor.
 *
 * rx_mpdu_info
 *		General information related to the MPDU that is passed
 *		on from REO entrance ring to the REO destination ring.
 *
 * queue_addr_lo
 *		Address (lower 32 bits) of the REO queue descriptor.
 *
 * queue_addr_hi
 *		Address (upper 8 bits) of the REO queue descriptor.
 *
 * mpdu_byte_count
 *		An approximation of the number of bytes received in this MPDU.
 *		Used to keeps stats on the amount of data flowing
 *		through a queue.
 *
 * reo_destination_indication
 *		The id of the reo exit ring where the msdu frame shall push
 *		after (MPDU level) reordering has finished. Values are defined
 *		in enum %HAL_RX_MSDU_DESC_REO_DEST_IND_.
 *
 * frameless_bar
 *		Indicates that this REO entrance ring struct contains BAR info
 *		from a multi TID BAR frame. The original multi TID BAR frame
 *		itself contained all the REO info for the first TID, but all
 *		the subsequent TID info and their linkage to the REO descriptors
 *		is passed down as 'frameless' BAR info.
 *
 *		The only fields valid in this descriptor when this bit is set
 *		are queue_addr_lo, queue_addr_hi, mpdu_sequence_number,
 *		bar_frame and peer_meta_data.
 *
 * rxdma_push_reason
 *		Reason for pushing this frame to this exit ring. Values are
 *		defined in enum %HAL_REO_DEST_RING_PUSH_REASON_.
 *
 * rxdma_error_code
 *		Valid only when 'push_reason' is set. All error codes are
 *		defined in enum %HAL_REO_ENTR_RING_RXDMA_ECODE_.
 *
 * ring_id
 *		The buffer pointer ring id.
 *		0 - Idle ring
 *		1 - N refers to other rings.
 *
 * looping_count
 *		Indicates the number of times the producer of entries into
 *		this ring has looped around the ring.
 */

#define HAL_SW_MON_RING_INFO0_RXDMA_PUSH_REASON
#define HAL_SW_MON_RING_INFO0_RXDMA_ERROR_CODE
#define HAL_SW_MON_RING_INFO0_MPDU_FRAG_NUMBER
#define HAL_SW_MON_RING_INFO0_FRAMELESS_BAR
#define HAL_SW_MON_RING_INFO0_STATUS_BUF_CNT
#define HAL_SW_MON_RING_INFO0_END_OF_PPDU

#define HAL_SW_MON_RING_INFO1_PHY_PPDU_ID
#define HAL_SW_MON_RING_INFO1_RING_ID
#define HAL_SW_MON_RING_INFO1_LOOPING_COUNT

struct hal_sw_monitor_ring {} __packed;

#define HAL_REO_CMD_HDR_INFO0_CMD_NUMBER
#define HAL_REO_CMD_HDR_INFO0_STATUS_REQUIRED

struct hal_reo_cmd_hdr {} __packed;

#define HAL_REO_GET_QUEUE_STATS_INFO0_QUEUE_ADDR_HI
#define HAL_REO_GET_QUEUE_STATS_INFO0_CLEAR_STATS

struct hal_reo_get_queue_stats {} __packed;

/* hal_reo_get_queue_stats
 *		Producer: SW
 *		Consumer: REO
 *
 * cmd
 *		Details for command execution tracking purposes.
 *
 * queue_addr_lo
 *		Address (lower 32 bits) of the REO queue descriptor.
 *
 * queue_addr_hi
 *		Address (upper 8 bits) of the REO queue descriptor.
 *
 * clear_stats
 *		Clear stats settings. When set, Clear the stats after
 *		generating the status.
 *
 *		Following stats will be cleared.
 *		Timeout_count
 *		Forward_due_to_bar_count
 *		Duplicate_count
 *		Frames_in_order_count
 *		BAR_received_count
 *		MPDU_Frames_processed_count
 *		MSDU_Frames_processed_count
 *		Total_processed_byte_count
 *		Late_receive_MPDU_count
 *		window_jump_2k
 *		Hole_count
 */

#define HAL_REO_FLUSH_QUEUE_INFO0_DESC_ADDR_HI
#define HAL_REO_FLUSH_QUEUE_INFO0_BLOCK_DESC_ADDR
#define HAL_REO_FLUSH_QUEUE_INFO0_BLOCK_RESRC_IDX

struct hal_reo_flush_queue {} __packed;

#define HAL_REO_FLUSH_CACHE_INFO0_CACHE_ADDR_HI
#define HAL_REO_FLUSH_CACHE_INFO0_FWD_ALL_MPDUS
#define HAL_REO_FLUSH_CACHE_INFO0_RELEASE_BLOCK_IDX
#define HAL_REO_FLUSH_CACHE_INFO0_BLOCK_RESRC_IDX
#define HAL_REO_FLUSH_CACHE_INFO0_FLUSH_WO_INVALIDATE
#define HAL_REO_FLUSH_CACHE_INFO0_BLOCK_CACHE_USAGE
#define HAL_REO_FLUSH_CACHE_INFO0_FLUSH_ALL

struct hal_reo_flush_cache {} __packed;

#define HAL_TCL_DATA_CMD_INFO0_DESC_TYPE
#define HAL_TCL_DATA_CMD_INFO0_EPD
#define HAL_TCL_DATA_CMD_INFO0_ENCAP_TYPE
#define HAL_TCL_DATA_CMD_INFO0_ENCRYPT_TYPE
#define HAL_TCL_DATA_CMD_INFO0_SRC_BUF_SWAP
#define HAL_TCL_DATA_CMD_INFO0_LNK_META_SWAP
#define HAL_TCL_DATA_CMD_INFO0_SEARCH_TYPE
#define HAL_TCL_DATA_CMD_INFO0_ADDR_EN
#define HAL_TCL_DATA_CMD_INFO0_CMD_NUM

#define HAL_TCL_DATA_CMD_INFO1_DATA_LEN
#define HAL_TCL_DATA_CMD_INFO1_IP4_CKSUM_EN
#define HAL_TCL_DATA_CMD_INFO1_UDP4_CKSUM_EN
#define HAL_TCL_DATA_CMD_INFO1_UDP6_CKSUM_EN
#define HAL_TCL_DATA_CMD_INFO1_TCP4_CKSUM_EN
#define HAL_TCL_DATA_CMD_INFO1_TCP6_CKSUM_EN
#define HAL_TCL_DATA_CMD_INFO1_TO_FW
#define HAL_TCL_DATA_CMD_INFO1_PKT_OFFSET

#define HAL_TCL_DATA_CMD_INFO2_BUF_TIMESTAMP
#define HAL_TCL_DATA_CMD_INFO2_BUF_T_VALID
#define HAL_IPQ8074_TCL_DATA_CMD_INFO2_MESH_ENABLE
#define HAL_TCL_DATA_CMD_INFO2_TID_OVERWRITE
#define HAL_TCL_DATA_CMD_INFO2_TID
#define HAL_TCL_DATA_CMD_INFO2_LMAC_ID

#define HAL_TCL_DATA_CMD_INFO3_DSCP_TID_TABLE_IDX
#define HAL_TCL_DATA_CMD_INFO3_SEARCH_INDEX
#define HAL_TCL_DATA_CMD_INFO3_CACHE_SET_NUM
#define HAL_QCN9074_TCL_DATA_CMD_INFO3_MESH_ENABLE

#define HAL_TCL_DATA_CMD_INFO4_RING_ID
#define HAL_TCL_DATA_CMD_INFO4_LOOPING_COUNT

enum hal_encrypt_type {};

enum hal_tcl_encap_type {};

enum hal_tcl_desc_type {};

enum hal_wbm_htt_tx_comp_status {};

struct hal_tcl_data_cmd {} __packed;

/* hal_tcl_data_cmd
 *
 * buf_addr_info
 *		Details of the physical address of a buffer or MSDU
 *		link descriptor.
 *
 * desc_type
 *		Indicates the type of address provided in the buf_addr_info.
 *		Values are defined in enum %HAL_REO_DEST_RING_BUFFER_TYPE_.
 *
 * epd
 *		When this bit is set then input packet is an EPD type.
 *
 * encap_type
 *		Indicates the encapsulation that HW will perform. Values are
 *		defined in enum %HAL_TCL_ENCAP_TYPE_.
 *
 * encrypt_type
 *		Field only valid for encap_type: RAW
 *		Values are defined in enum %HAL_ENCRYPT_TYPE_.
 *
 * src_buffer_swap
 *		Treats source memory (packet buffer) organization as big-endian.
 *		1'b0: Source memory is little endian
 *		1'b1: Source memory is big endian
 *
 * link_meta_swap
 *		Treats link descriptor and Metadata as big-endian.
 *		1'b0: memory is little endian
 *		1'b1: memory is big endian
 *
 * search_type
 *		Search type select
 *		0 - Normal search, 1 - Index based address search,
 *		2 - Index based flow search
 *
 * addrx_en
 * addry_en
 *		Address X/Y search enable in ASE correspondingly.
 *		1'b0: Search disable
 *		1'b1: Search Enable
 *
 * cmd_num
 *		This number can be used to match against status.
 *
 * data_length
 *		MSDU length in case of direct descriptor. Length of link
 *		extension descriptor in case of Link extension descriptor.
 *
 * *_checksum_en
 *		Enable checksum replacement for ipv4, udp_over_ipv4, ipv6,
 *		udp_over_ipv6, tcp_over_ipv4 and tcp_over_ipv6.
 *
 * to_fw
 *		Forward packet to FW along with classification result. The
 *		packet will not be forward to TQM when this bit is set.
 *		1'b0: Use classification result to forward the packet.
 *		1'b1: Override classification result & forward packet only to fw
 *
 * packet_offset
 *		Packet offset from Metadata in case of direct buffer descriptor.
 *
 * buffer_timestamp
 * buffer_timestamp_valid
 *		Frame system entrance timestamp. It shall be filled by first
 *		module (SW, TCL or TQM) that sees the frames first.
 *
 * mesh_enable
 *		For raw WiFi frames, this indicates transmission to a mesh STA,
 *		enabling the interpretation of the 'Mesh Control Present' bit
 *		(bit 8) of QoS Control.
 *		For native WiFi frames, this indicates that a 'Mesh Control'
 *		field is present between the header and the LLC.
 *
 * hlos_tid_overwrite
 *
 *		When set, TCL shall ignore the IP DSCP and VLAN PCP
 *		fields and use HLOS_TID as the final TID. Otherwise TCL
 *		shall consider the DSCP and PCP fields as well as HLOS_TID
 *		and choose a final TID based on the configured priority
 *
 * hlos_tid
 *		HLOS MSDU priority
 *		Field is used when HLOS_TID_overwrite is set.
 *
 * lmac_id
 *		TCL uses this LMAC_ID in address search, i.e, while
 *		finding matching entry for the packet in AST corresponding
 *		to given LMAC_ID
 *
 *		If LMAC ID is all 1s (=> value 3), it indicates wildcard
 *		match for any MAC
 *
 * dscp_tid_table_num
 *		DSCP to TID mapping table number that need to be used
 *		for the MSDU.
 *
 * search_index
 *		The index that will be used for index based address or
 *		flow search. The field is valid when 'search_type' is  1 or 2.
 *
 * cache_set_num
 *
 *		Cache set number that should be used to cache the index
 *		based search results, for address and flow search. This
 *		value should be equal to LSB four bits of the hash value of
 *		match data, in case of search index points to an entry which
 *		may be used in content based search also. The value can be
 *		anything when the entry pointed by search index will not be
 *		used for content based search.
 *
 * ring_id
 *		The buffer pointer ring ID.
 *		0 refers to the IDLE ring
 *		1 - N refers to other rings
 *
 * looping_count
 *
 *		A count value that indicates the number of times the
 *		producer of entries into the Ring has looped around the
 *		ring.
 *
 *		At initialization time, this value is set to 0. On the
 *		first loop, this value is set to 1. After the max value is
 *		reached allowed by the number of bits for this field, the
 *		count value continues with 0 again.
 *
 *		In case SW is the consumer of the ring entries, it can
 *		use this field to figure out up to where the producer of
 *		entries has created new entries. This eliminates the need to
 *		check where the head pointer' of the ring is located once
 *		the SW starts processing an interrupt indicating that new
 *		entries have been put into this ring...
 *
 *		Also note that SW if it wants only needs to look at the
 *		LSB bit of this count value.
 */

#define HAL_TCL_DESC_LEN

enum hal_tcl_gse_ctrl {};

/* hal_tcl_gse_ctrl
 *
 * rd_stat
 *		Report or Read statistics
 * srch_dis
 *		Search disable. Report only Hash.
 * wr_bk_single
 *		Write Back single entry
 * wr_bk_all
 *		Write Back entire cache entry
 * inval_single
 *		Invalidate single cache entry
 * inval_all
 *		Invalidate entire cache
 * wr_bk_inval_single
 *		Write back and invalidate single entry in cache
 * wr_bk_inval_all
 *		Write back and invalidate entire cache
 * clr_stat_single
 *		Clear statistics for single entry
 */

#define HAL_TCL_GSE_CMD_INFO0_CTRL_BUF_ADDR_HI
#define HAL_TCL_GSE_CMD_INFO0_GSE_CTRL
#define HAL_TCL_GSE_CMD_INFO0_GSE_SEL
#define HAL_TCL_GSE_CMD_INFO0_STATUS_DEST_RING_ID
#define HAL_TCL_GSE_CMD_INFO0_SWAP

#define HAL_TCL_GSE_CMD_INFO1_RING_ID
#define HAL_TCL_GSE_CMD_INFO1_LOOPING_COUNT

struct hal_tcl_gse_cmd {} __packed;

/* hal_tcl_gse_cmd
 *
 * ctrl_buf_addr_lo, ctrl_buf_addr_hi
 *		Address of a control buffer containing additional info needed
 *		for this command execution.
 *
 * gse_ctrl
 *		GSE control operations. This includes cache operations and table
 *		entry statistics read/clear operation. Values are defined in
 *		enum %HAL_TCL_GSE_CTRL.
 *
 * gse_sel
 *		To select the ASE/FSE to do the operation mention by GSE_ctrl.
 *		0: FSE select 1: ASE select
 *
 * status_destination_ring_id
 *		TCL status ring to which the GSE status needs to be send.
 *
 * swap
 *		Bit to enable byte swapping of contents of buffer.
 *
 * meta_data
 *		Meta data to be returned in the status descriptor
 */

enum hal_tcl_cache_op_res {};

#define HAL_TCL_STATUS_RING_INFO0_GSE_CTRL
#define HAL_TCL_STATUS_RING_INFO0_GSE_SEL
#define HAL_TCL_STATUS_RING_INFO0_CACHE_OP_RES
#define HAL_TCL_STATUS_RING_INFO0_MSDU_CNT

#define HAL_TCL_STATUS_RING_INFO1_HASH_IDX

#define HAL_TCL_STATUS_RING_INFO2_RING_ID
#define HAL_TCL_STATUS_RING_INFO2_LOOPING_COUNT

struct hal_tcl_status_ring {} __packed;

/* hal_tcl_status_ring
 *
 * gse_ctrl
 *		GSE control operations. This includes cache operations and table
 *		entry statistics read/clear operation. Values are defined in
 *		enum %HAL_TCL_GSE_CTRL.
 *
 * gse_sel
 *		To select the ASE/FSE to do the operation mention by GSE_ctrl.
 *		0: FSE select 1: ASE select
 *
 * cache_op_res
 *		Cache operation result. Values are defined in enum
 *		%HAL_TCL_CACHE_OP_RES_.
 *
 * msdu_cnt
 * msdu_byte_count
 *		MSDU count of Entry and MSDU byte count for entry 1.
 *
 * hash_indx
 *		Hash value of the entry in case of search failed or disabled.
 */

#define HAL_CE_SRC_DESC_ADDR_INFO_ADDR_HI
#define HAL_CE_SRC_DESC_ADDR_INFO_HASH_EN
#define HAL_CE_SRC_DESC_ADDR_INFO_BYTE_SWAP
#define HAL_CE_SRC_DESC_ADDR_INFO_DEST_SWAP
#define HAL_CE_SRC_DESC_ADDR_INFO_GATHER
#define HAL_CE_SRC_DESC_ADDR_INFO_LEN

#define HAL_CE_SRC_DESC_META_INFO_DATA

#define HAL_CE_SRC_DESC_FLAGS_RING_ID
#define HAL_CE_SRC_DESC_FLAGS_LOOP_CNT

struct hal_ce_srng_src_desc {} __packed;

/*
 * hal_ce_srng_src_desc
 *
 * buffer_addr_lo
 *		LSB 32 bits of the 40 Bit Pointer to the source buffer
 *
 * buffer_addr_hi
 *		MSB 8 bits of the 40 Bit Pointer to the source buffer
 *
 * toeplitz_en
 *		Enable generation of 32-bit Toeplitz-LFSR hash for
 *		data transfer. In case of gather field in first source
 *		ring entry of the gather copy cycle in taken into account.
 *
 * src_swap
 *		Treats source memory organization as big-endian. For
 *		each dword read (4 bytes), the byte 0 is swapped with byte 3
 *		and byte 1 is swapped with byte 2.
 *		In case of gather field in first source ring entry of
 *		the gather copy cycle in taken into account.
 *
 * dest_swap
 *		Treats destination memory organization as big-endian.
 *		For each dword write (4 bytes), the byte 0 is swapped with
 *		byte 3 and byte 1 is swapped with byte 2.
 *		In case of gather field in first source ring entry of
 *		the gather copy cycle in taken into account.
 *
 * gather
 *		Enables gather of multiple copy engine source
 *		descriptors to one destination.
 *
 * ce_res_0
 *		Reserved
 *
 *
 * length
 *		Length of the buffer in units of octets of the current
 *		descriptor
 *
 * fw_metadata
 *		Meta data used by FW.
 *		In case of gather field in first source ring entry of
 *		the gather copy cycle in taken into account.
 *
 * ce_res_1
 *		Reserved
 *
 * ce_res_2
 *		Reserved
 *
 * ring_id
 *		The buffer pointer ring ID.
 *		0 refers to the IDLE ring
 *		1 - N refers to other rings
 *		Helps with debugging when dumping ring contents.
 *
 * looping_count
 *		A count value that indicates the number of times the
 *		producer of entries into the Ring has looped around the
 *		ring.
 *
 *		At initialization time, this value is set to 0. On the
 *		first loop, this value is set to 1. After the max value is
 *		reached allowed by the number of bits for this field, the
 *		count value continues with 0 again.
 *
 *		In case SW is the consumer of the ring entries, it can
 *		use this field to figure out up to where the producer of
 *		entries has created new entries. This eliminates the need to
 *		check where the head pointer' of the ring is located once
 *		the SW starts processing an interrupt indicating that new
 *		entries have been put into this ring...
 *
 *		Also note that SW if it wants only needs to look at the
 *		LSB bit of this count value.
 */

#define HAL_CE_DEST_DESC_ADDR_INFO_ADDR_HI
#define HAL_CE_DEST_DESC_ADDR_INFO_RING_ID
#define HAL_CE_DEST_DESC_ADDR_INFO_LOOP_CNT

struct hal_ce_srng_dest_desc {} __packed;

/* hal_ce_srng_dest_desc
 *
 * dst_buffer_low
 *		LSB 32 bits of the 40 Bit Pointer to the Destination
 *		buffer
 *
 * dst_buffer_high
 *		MSB 8 bits of the 40 Bit Pointer to the Destination
 *		buffer
 *
 * ce_res_4
 *		Reserved
 *
 * ring_id
 *		The buffer pointer ring ID.
 *		0 refers to the IDLE ring
 *		1 - N refers to other rings
 *		Helps with debugging when dumping ring contents.
 *
 * looping_count
 *		A count value that indicates the number of times the
 *		producer of entries into the Ring has looped around the
 *		ring.
 *
 *		At initialization time, this value is set to 0. On the
 *		first loop, this value is set to 1. After the max value is
 *		reached allowed by the number of bits for this field, the
 *		count value continues with 0 again.
 *
 *		In case SW is the consumer of the ring entries, it can
 *		use this field to figure out up to where the producer of
 *		entries has created new entries. This eliminates the need to
 *		check where the head pointer' of the ring is located once
 *		the SW starts processing an interrupt indicating that new
 *		entries have been put into this ring...
 *
 *		Also note that SW if it wants only needs to look at the
 *		LSB bit of this count value.
 */

#define HAL_CE_DST_STATUS_DESC_FLAGS_HASH_EN
#define HAL_CE_DST_STATUS_DESC_FLAGS_BYTE_SWAP
#define HAL_CE_DST_STATUS_DESC_FLAGS_DEST_SWAP
#define HAL_CE_DST_STATUS_DESC_FLAGS_GATHER
#define HAL_CE_DST_STATUS_DESC_FLAGS_LEN

#define HAL_CE_DST_STATUS_DESC_META_INFO_DATA
#define HAL_CE_DST_STATUS_DESC_META_INFO_RING_ID
#define HAL_CE_DST_STATUS_DESC_META_INFO_LOOP_CNT

struct hal_ce_srng_dst_status_desc {} __packed;

/* hal_ce_srng_dst_status_desc
 *
 * ce_res_5
 *		Reserved
 *
 * toeplitz_en
 *
 * src_swap
 *		Source memory buffer swapped
 *
 * dest_swap
 *		Destination  memory buffer swapped
 *
 * gather
 *		Gather of multiple copy engine source descriptors to one
 *		destination enabled
 *
 * ce_res_6
 *		Reserved
 *
 * length
 *		Sum of all the Lengths of the source descriptor in the
 *		gather chain
 *
 * toeplitz_hash_0
 *		32 LS bits of 64 bit Toeplitz LFSR hash result
 *
 * toeplitz_hash_1
 *		32 MS bits of 64 bit Toeplitz LFSR hash result
 *
 * fw_metadata
 *		Meta data used by FW
 *		In case of gather field in first source ring entry of
 *		the gather copy cycle in taken into account.
 *
 * ce_res_7
 *		Reserved
 *
 * ring_id
 *		The buffer pointer ring ID.
 *		0 refers to the IDLE ring
 *		1 - N refers to other rings
 *		Helps with debugging when dumping ring contents.
 *
 * looping_count
 *		A count value that indicates the number of times the
 *		producer of entries into the Ring has looped around the
 *		ring.
 *
 *		At initialization time, this value is set to 0. On the
 *		first loop, this value is set to 1. After the max value is
 *		reached allowed by the number of bits for this field, the
 *		count value continues with 0 again.
 *
 *		In case SW is the consumer of the ring entries, it can
 *		use this field to figure out up to where the producer of
 *		entries has created new entries. This eliminates the need to
 *		check where the head pointer' of the ring is located once
 *		the SW starts processing an interrupt indicating that new
 *		entries have been put into this ring...
 *
 *		Also note that SW if it wants only needs to look at the
 *			LSB bit of this count value.
 */

#define HAL_TX_RATE_STATS_INFO0_VALID
#define HAL_TX_RATE_STATS_INFO0_BW
#define HAL_TX_RATE_STATS_INFO0_PKT_TYPE
#define HAL_TX_RATE_STATS_INFO0_STBC
#define HAL_TX_RATE_STATS_INFO0_LDPC
#define HAL_TX_RATE_STATS_INFO0_SGI
#define HAL_TX_RATE_STATS_INFO0_MCS
#define HAL_TX_RATE_STATS_INFO0_OFDMA_TX
#define HAL_TX_RATE_STATS_INFO0_TONES_IN_RU

enum hal_tx_rate_stats_bw {};

enum hal_tx_rate_stats_pkt_type {};

enum hal_tx_rate_stats_sgi {};

struct hal_tx_rate_stats {} __packed;

struct hal_wbm_link_desc {} __packed;

/* hal_wbm_link_desc
 *
 *	Producer: WBM
 *	Consumer: WBM
 *
 * buf_addr_info
 *		Details of the physical address of a buffer or MSDU
 *		link descriptor.
 */

enum hal_wbm_rel_src_module {};

enum hal_wbm_rel_desc_type {};

/* hal_wbm_rel_desc_type
 *
 * msdu_buffer
 *	The address points to an MSDU buffer
 *
 * msdu_link_descriptor
 *	The address points to an Tx MSDU link descriptor
 *
 * mpdu_link_descriptor
 *	The address points to an MPDU link descriptor
 *
 * msdu_ext_descriptor
 *	The address points to an MSDU extension descriptor
 *
 * queue_ext_descriptor
 *	The address points to an TQM queue extension descriptor. WBM should
 *	treat this is the same way as a link descriptor.
 */

enum hal_wbm_rel_bm_act {};

/* hal_wbm_rel_bm_act
 *
 * put_in_idle_list
 *	Put the buffer or descriptor back in the idle list. In case of MSDU or
 *	MDPU link descriptor, BM does not need to check to release any
 *	individual MSDU buffers.
 *
 * release_msdu_list
 *	This BM action can only be used in combination with desc_type being
 *	msdu_link_descriptor. Field first_msdu_index points out which MSDU
 *	pointer in the MSDU link descriptor is the first of an MPDU that is
 *	released. BM shall release all the MSDU buffers linked to this first
 *	MSDU buffer pointer. All related MSDU buffer pointer entries shall be
 *	set to value 0, which represents the 'NULL' pointer. When all MSDU
 *	buffer pointers in the MSDU link descriptor are 'NULL', the MSDU link
 *	descriptor itself shall also be released.
 */

#define HAL_WBM_RELEASE_INFO0_REL_SRC_MODULE
#define HAL_WBM_RELEASE_INFO0_BM_ACTION
#define HAL_WBM_RELEASE_INFO0_DESC_TYPE
#define HAL_WBM_RELEASE_INFO0_FIRST_MSDU_IDX
#define HAL_WBM_RELEASE_INFO0_TQM_RELEASE_REASON
#define HAL_WBM_RELEASE_INFO0_RXDMA_PUSH_REASON
#define HAL_WBM_RELEASE_INFO0_RXDMA_ERROR_CODE
#define HAL_WBM_RELEASE_INFO0_REO_PUSH_REASON
#define HAL_WBM_RELEASE_INFO0_REO_ERROR_CODE
#define HAL_WBM_RELEASE_INFO0_WBM_INTERNAL_ERROR

#define HAL_WBM_RELEASE_INFO1_TQM_STATUS_NUMBER
#define HAL_WBM_RELEASE_INFO1_TRANSMIT_COUNT

#define HAL_WBM_RELEASE_INFO2_ACK_FRAME_RSSI
#define HAL_WBM_RELEASE_INFO2_SW_REL_DETAILS_VALID
#define HAL_WBM_RELEASE_INFO2_FIRST_MSDU
#define HAL_WBM_RELEASE_INFO2_LAST_MSDU
#define HAL_WBM_RELEASE_INFO2_MSDU_IN_AMSDU
#define HAL_WBM_RELEASE_INFO2_FW_TX_NOTIF_FRAME
#define HAL_WBM_RELEASE_INFO2_BUFFER_TIMESTAMP

#define HAL_WBM_RELEASE_INFO3_PEER_ID
#define HAL_WBM_RELEASE_INFO3_TID
#define HAL_WBM_RELEASE_INFO3_RING_ID
#define HAL_WBM_RELEASE_INFO3_LOOPING_COUNT

#define HAL_WBM_REL_HTT_TX_COMP_INFO0_STATUS
#define HAL_WBM_REL_HTT_TX_COMP_INFO0_REINJ_REASON
#define HAL_WBM_REL_HTT_TX_COMP_INFO0_EXP_FRAME

struct hal_wbm_release_ring {} __packed;

/* hal_wbm_release_ring
 *
 *	Producer: SW/TQM/RXDMA/REO/SWITCH
 *	Consumer: WBM/SW/FW
 *
 * HTT tx status is overlaid on wbm_release ring on 4-byte words 2, 3, 4 and 5
 * for software based completions.
 *
 * buf_addr_info
 *	Details of the physical address of the buffer or link descriptor.
 *
 * release_source_module
 *	Indicates which module initiated the release of this buffer/descriptor.
 *	Values are defined in enum %HAL_WBM_REL_SRC_MODULE_.
 *
 * bm_action
 *	Field only valid when the field return_buffer_manager in
 *	Released_buff_or_desc_addr_info indicates:
 *		WBM_IDLE_BUF_LIST / WBM_IDLE_DESC_LIST
 *	Values are defined in enum %HAL_WBM_REL_BM_ACT_.
 *
 * buffer_or_desc_type
 *	Field only valid when WBM is marked as the return_buffer_manager in
 *	the Released_Buffer_address_info. Indicates that type of buffer or
 *	descriptor is being released. Values are in enum %HAL_WBM_REL_DESC_TYPE.
 *
 * first_msdu_index
 *	Field only valid for the bm_action release_msdu_list. The index of the
 *	first MSDU in an MSDU link descriptor all belonging to the same MPDU.
 *
 * tqm_release_reason
 *	Field only valid when Release_source_module is set to release_source_TQM
 *	Release reasons are defined in enum %HAL_WBM_TQM_REL_REASON_.
 *
 * rxdma_push_reason
 * reo_push_reason
 *	Indicates why rxdma/reo pushed the frame to this ring and values are
 *	defined in enum %HAL_REO_DEST_RING_PUSH_REASON_.
 *
 * rxdma_error_code
 *	Field only valid when 'rxdma_push_reason' set to 'error_detected'.
 *	Values are defined in enum %HAL_REO_ENTR_RING_RXDMA_ECODE_.
 *
 * reo_error_code
 *	Field only valid when 'reo_push_reason' set to 'error_detected'. Values
 *	are defined in enum %HAL_REO_DEST_RING_ERROR_CODE_.
 *
 * wbm_internal_error
 *	Is set when WBM got a buffer pointer but the action was to push it to
 *	the idle link descriptor ring or do link related activity OR
 *	Is set when WBM got a link buffer pointer but the action was to push it
 *	to the buffer descriptor ring.
 *
 * tqm_status_number
 *	The value in this field is equal to tqm_cmd_number in TQM command. It is
 *	used to correlate the statu with TQM commands. Only valid when
 *	release_source_module is TQM.
 *
 * transmit_count
 *	The number of times the frame has been transmitted, valid only when
 *	release source in TQM.
 *
 * ack_frame_rssi
 *	This field is only valid when the source is TQM. If this frame is
 *	removed as the result of the reception of an ACK or BA, this field
 *	indicates the RSSI of the received ACK or BA frame.
 *
 * sw_release_details_valid
 *	This is set when WMB got a 'release_msdu_list' command from TQM and
 *	return buffer manager is not WMB. WBM will then de-aggregate all MSDUs
 *	and pass them one at a time on to the 'buffer owner'.
 *
 * first_msdu
 *	Field only valid when SW_release_details_valid is set.
 *	When set, this MSDU is the first MSDU pointed to in the
 *	'release_msdu_list' command.
 *
 * last_msdu
 *	Field only valid when SW_release_details_valid is set.
 *	When set, this MSDU is the last MSDU pointed to in the
 *	'release_msdu_list' command.
 *
 * msdu_part_of_amsdu
 *	Field only valid when SW_release_details_valid is set.
 *	When set, this MSDU was part of an A-MSDU in MPDU
 *
 * fw_tx_notify_frame
 *	Field only valid when SW_release_details_valid is set.
 *
 * buffer_timestamp
 *	Field only valid when SW_release_details_valid is set.
 *	This is the Buffer_timestamp field from the
 *	Timestamp in units of 1024 us
 *
 * struct hal_tx_rate_stats rate_stats
 *	Details for command execution tracking purposes.
 *
 * sw_peer_id
 * tid
 *	Field only valid when Release_source_module is set to
 *	release_source_TQM
 *
 *	1) Release of msdu buffer due to drop_frame = 1. Flow is
 *	not fetched and hence sw_peer_id and tid = 0
 *
 *	buffer_or_desc_type = e_num 0
 *	MSDU_rel_buffertqm_release_reason = e_num 1
 *	tqm_rr_rem_cmd_rem
 *
 *	2) Release of msdu buffer due to Flow is not fetched and
 *	hence sw_peer_id and tid = 0
 *
 *	buffer_or_desc_type = e_num 0
 *	MSDU_rel_buffertqm_release_reason = e_num 1
 *	tqm_rr_rem_cmd_rem
 *
 *	3) Release of msdu link due to remove_mpdu or acked_mpdu
 *	command.
 *
 *	buffer_or_desc_type = e_num1
 *	msdu_link_descriptortqm_release_reason can be:e_num 1
 *	tqm_rr_rem_cmd_reme_num 2 tqm_rr_rem_cmd_tx
 *	e_num 3 tqm_rr_rem_cmd_notxe_num 4 tqm_rr_rem_cmd_aged
 *
 *	This field represents the TID from the TX_MSDU_FLOW
 *	descriptor or TX_MPDU_QUEUE descriptor
 *
 * rind_id
 *	For debugging.
 *	This field is filled in by the SRNG module.
 *	It help to identify the ring that is being looked
 *
 * looping_count
 *	A count value that indicates the number of times the
 *	producer of entries into the Buffer Manager Ring has looped
 *	around the ring.
 *
 *	At initialization time, this value is set to 0. On the
 *	first loop, this value is set to 1. After the max value is
 *	reached allowed by the number of bits for this field, the
 *	count value continues with 0 again.
 *
 *	In case SW is the consumer of the ring entries, it can
 *	use this field to figure out up to where the producer of
 *	entries has created new entries. This eliminates the need to
 *	check where the head pointer' of the ring is located once
 *	the SW starts processing an interrupt indicating that new
 *	entries have been put into this ring...
 *
 *	Also note that SW if it wants only needs to look at the
 *	LSB bit of this count value.
 */

/**
 * enum hal_wbm_tqm_rel_reason - TQM release reason code
 * @HAL_WBM_TQM_REL_REASON_FRAME_ACKED: ACK or BACK received for the frame
 * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_MPDU: Command remove_mpdus initiated by SW
 * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_TX: Command remove transmitted_mpdus
 *	initiated by sw.
 * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_NOTX: Command remove untransmitted_mpdus
 *	initiated by sw.
 * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_AGED_FRAMES: Command remove aged msdus or
 *	mpdus.
 * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_RESEAON1: Remove command initiated by
 *	fw with fw_reason1.
 * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_RESEAON2: Remove command initiated by
 *	fw with fw_reason2.
 * @HAL_WBM_TQM_REL_REASON_CMD_REMOVE_RESEAON3: Remove command initiated by
 *	fw with fw_reason3.
 */
enum hal_wbm_tqm_rel_reason {};

struct hal_wbm_buffer_ring {};

enum hal_desc_owner {};

enum hal_desc_buf_type {};

#define HAL_DESC_REO_OWNED
#define HAL_DESC_REO_QUEUE_DESC
#define HAL_DESC_REO_QUEUE_EXT_DESC
#define HAL_DESC_REO_NON_QOS_TID

#define HAL_DESC_HDR_INFO0_OWNER
#define HAL_DESC_HDR_INFO0_BUF_TYPE
#define HAL_DESC_HDR_INFO0_DBG_RESERVED

struct hal_desc_header {} __packed;

struct hal_rx_mpdu_link_ptr {} __packed;

struct hal_rx_msdu_details {} __packed;

#define HAL_RX_MSDU_LNK_INFO0_RX_QUEUE_NUMBER
#define HAL_RX_MSDU_LNK_INFO0_FIRST_MSDU_LNK

struct hal_rx_msdu_link {} __packed;

struct hal_rx_reo_queue_ext {} __packed;

/* hal_rx_reo_queue_ext
 *	Consumer: REO
 *	Producer: REO
 *
 * descriptor_header
 *	Details about which module owns this struct.
 *
 * mpdu_link
 *	Pointer to the next MPDU_link descriptor in the MPDU queue.
 */

enum hal_rx_reo_queue_pn_size {};

#define HAL_RX_REO_QUEUE_RX_QUEUE_NUMBER

#define HAL_RX_REO_QUEUE_INFO0_VLD
#define HAL_RX_REO_QUEUE_INFO0_ASSOC_LNK_DESC_COUNTER
#define HAL_RX_REO_QUEUE_INFO0_DIS_DUP_DETECTION
#define HAL_RX_REO_QUEUE_INFO0_SOFT_REORDER_EN
#define HAL_RX_REO_QUEUE_INFO0_AC
#define HAL_RX_REO_QUEUE_INFO0_BAR
#define HAL_RX_REO_QUEUE_INFO0_RETRY
#define HAL_RX_REO_QUEUE_INFO0_CHECK_2K_MODE
#define HAL_RX_REO_QUEUE_INFO0_OOR_MODE
#define HAL_RX_REO_QUEUE_INFO0_BA_WINDOW_SIZE
#define HAL_RX_REO_QUEUE_INFO0_PN_CHECK
#define HAL_RX_REO_QUEUE_INFO0_EVEN_PN
#define HAL_RX_REO_QUEUE_INFO0_UNEVEN_PN
#define HAL_RX_REO_QUEUE_INFO0_PN_HANDLE_ENABLE
#define HAL_RX_REO_QUEUE_INFO0_PN_SIZE
#define HAL_RX_REO_QUEUE_INFO0_IGNORE_AMPDU_FLG

#define HAL_RX_REO_QUEUE_INFO1_SVLD
#define HAL_RX_REO_QUEUE_INFO1_SSN
#define HAL_RX_REO_QUEUE_INFO1_CURRENT_IDX
#define HAL_RX_REO_QUEUE_INFO1_SEQ_2K_ERR
#define HAL_RX_REO_QUEUE_INFO1_PN_ERR
#define HAL_RX_REO_QUEUE_INFO1_PN_VALID

#define HAL_RX_REO_QUEUE_INFO2_MPDU_COUNT
#define HAL_RX_REO_QUEUE_INFO2_MSDU_COUNT

#define HAL_RX_REO_QUEUE_INFO3_TIMEOUT_COUNT
#define HAL_RX_REO_QUEUE_INFO3_FWD_DUE_TO_BAR_CNT
#define HAL_RX_REO_QUEUE_INFO3_DUPLICATE_COUNT

#define HAL_RX_REO_QUEUE_INFO4_FRAME_IN_ORD_COUNT
#define HAL_RX_REO_QUEUE_INFO4_BAR_RECVD_COUNT

#define HAL_RX_REO_QUEUE_INFO5_LATE_RX_MPDU_COUNT
#define HAL_RX_REO_QUEUE_INFO5_WINDOW_JUMP_2K
#define HAL_RX_REO_QUEUE_INFO5_HOLE_COUNT

struct hal_rx_reo_queue {} __packed;

/* hal_rx_reo_queue
 *
 * descriptor_header
 *	Details about which module owns this struct. Note that sub field
 *	Buffer_type shall be set to receive_reo_queue_descriptor.
 *
 * receive_queue_number
 *	Indicates the MPDU queue ID to which this MPDU link descriptor belongs.
 *
 * vld
 *	Valid bit indicating a session is established and the queue descriptor
 *	is valid.
 * associated_link_descriptor_counter
 *	Indicates which of the 3 link descriptor counters shall be incremented
 *	or decremented when link descriptors are added or removed from this
 *	flow queue.
 * disable_duplicate_detection
 *	When set, do not perform any duplicate detection.
 * soft_reorder_enable
 *	When set, REO has been instructed to not perform the actual re-ordering
 *	of frames for this queue, but just to insert the reorder opcodes.
 * ac
 *	Indicates the access category of the queue descriptor.
 * bar
 *	Indicates if BAR has been received.
 * retry
 *	Retry bit is checked if this bit is set.
 * chk_2k_mode
 *	Indicates what type of operation is expected from Reo when the received
 *	frame SN falls within the 2K window.
 * oor_mode
 *	Indicates what type of operation is expected when the received frame
 *	falls within the OOR window.
 * ba_window_size
 *	Indicates the negotiated (window size + 1). Max of 256 bits.
 *
 *	A value 255 means 256 bitmap, 63 means 64 bitmap, 0 (means non-BA
 *	session, with window size of 0). The 3 values here are the main values
 *	validated, but other values should work as well.
 *
 *	A BA window size of 0 (=> one frame entry bitmat), means that there is
 *	no additional rx_reo_queue_ext desc. following rx_reo_queue in memory.
 *	A BA window size of 1 - 105, means that there is 1 rx_reo_queue_ext.
 *	A BA window size of 106 - 210, means that there are 2 rx_reo_queue_ext.
 *	A BA window size of 211 - 256, means that there are 3 rx_reo_queue_ext.
 * pn_check_needed, pn_shall_be_even, pn_shall_be_uneven, pn_handling_enable,
 * pn_size
 *	REO shall perform the PN increment check, even number check, uneven
 *	number check, PN error check and size of the PN field check.
 * ignore_ampdu_flag
 *	REO shall ignore the ampdu_flag on entrance descriptor for this queue.
 *
 * svld
 *	Sequence number in next field is valid one.
 * ssn
 *	 Starting Sequence number of the session.
 * current_index
 *	Points to last forwarded packet
 * seq_2k_error_detected_flag
 *	REO has detected a 2k error jump in the sequence number and from that
 *	moment forward, all new frames are forwarded directly to FW, without
 *	duplicate detect, reordering, etc.
 * pn_error_detected_flag
 *	REO has detected a PN error.
 */

#define HAL_REO_UPD_RX_QUEUE_INFO0_QUEUE_ADDR_HI
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_RX_QUEUE_NUM
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_VLD
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_ASSOC_LNK_DESC_CNT
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_DIS_DUP_DETECTION
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_SOFT_REORDER_EN
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_AC
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_BAR
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_RETRY
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_CHECK_2K_MODE
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_OOR_MODE
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_BA_WINDOW_SIZE
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_PN_CHECK
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_EVEN_PN
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_UNEVEN_PN
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_PN_HANDLE_ENABLE
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_PN_SIZE
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_IGNORE_AMPDU_FLG
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_SVLD
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_SSN
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_SEQ_2K_ERR
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_PN_ERR
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_PN_VALID
#define HAL_REO_UPD_RX_QUEUE_INFO0_UPD_PN

#define HAL_REO_UPD_RX_QUEUE_INFO1_RX_QUEUE_NUMBER
#define HAL_REO_UPD_RX_QUEUE_INFO1_VLD
#define HAL_REO_UPD_RX_QUEUE_INFO1_ASSOC_LNK_DESC_COUNTER
#define HAL_REO_UPD_RX_QUEUE_INFO1_DIS_DUP_DETECTION
#define HAL_REO_UPD_RX_QUEUE_INFO1_SOFT_REORDER_EN
#define HAL_REO_UPD_RX_QUEUE_INFO1_AC
#define HAL_REO_UPD_RX_QUEUE_INFO1_BAR
#define HAL_REO_UPD_RX_QUEUE_INFO1_RETRY
#define HAL_REO_UPD_RX_QUEUE_INFO1_CHECK_2K_MODE
#define HAL_REO_UPD_RX_QUEUE_INFO1_OOR_MODE
#define HAL_REO_UPD_RX_QUEUE_INFO1_PN_CHECK
#define HAL_REO_UPD_RX_QUEUE_INFO1_EVEN_PN
#define HAL_REO_UPD_RX_QUEUE_INFO1_UNEVEN_PN
#define HAL_REO_UPD_RX_QUEUE_INFO1_PN_HANDLE_ENABLE
#define HAL_REO_UPD_RX_QUEUE_INFO1_IGNORE_AMPDU_FLG

#define HAL_REO_UPD_RX_QUEUE_INFO2_BA_WINDOW_SIZE
#define HAL_REO_UPD_RX_QUEUE_INFO2_PN_SIZE
#define HAL_REO_UPD_RX_QUEUE_INFO2_SVLD
#define HAL_REO_UPD_RX_QUEUE_INFO2_SSN
#define HAL_REO_UPD_RX_QUEUE_INFO2_SEQ_2K_ERR
#define HAL_REO_UPD_RX_QUEUE_INFO2_PN_ERR
#define HAL_REO_UPD_RX_QUEUE_INFO2_PN_VALID

struct hal_reo_update_rx_queue {} __packed;

#define HAL_REO_UNBLOCK_CACHE_INFO0_UNBLK_CACHE
#define HAL_REO_UNBLOCK_CACHE_INFO0_RESOURCE_IDX

struct hal_reo_unblock_cache {} __packed;

enum hal_reo_exec_status {};

#define HAL_REO_STATUS_HDR_INFO0_STATUS_NUM
#define HAL_REO_STATUS_HDR_INFO0_EXEC_TIME
#define HAL_REO_STATUS_HDR_INFO0_EXEC_STATUS

struct hal_reo_status_hdr {} __packed;

/* hal_reo_status_hdr
 *		Producer: REO
 *		Consumer: SW
 *
 * status_num
 *		The value in this field is equal to value of the reo command
 *		number. This field helps to correlate the statuses with the REO
 *		commands.
 *
 * execution_time (in us)
 *		The amount of time REO took to execute the command. Note that
 *		this time does not include the duration of the command waiting
 *		in the command ring, before the execution started.
 *
 * execution_status
 *		Execution status of the command. Values are defined in
 *		enum %HAL_REO_EXEC_STATUS_.
 */
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO0_SSN
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO0_CUR_IDX

#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO1_MPDU_COUNT
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO1_MSDU_COUNT

#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO2_TIMEOUT_COUNT
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO2_FDTB_COUNT
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO2_DUPLICATE_COUNT

#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO3_FIO_COUNT
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO3_BAR_RCVD_CNT

#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO4_LATE_RX_MPDU
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO4_WINDOW_JMP2K
#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO4_HOLE_COUNT

#define HAL_REO_GET_QUEUE_STATS_STATUS_INFO5_LOOPING_CNT

struct hal_reo_get_queue_stats_status {} __packed;

/* hal_reo_get_queue_stats_status
 *		Producer: REO
 *		Consumer: SW
 *
 * status_hdr
 *		Details that can link this status with the original command. It
 *		also contains info on how long REO took to execute this command.
 *
 * ssn
 *		Starting Sequence number of the session, this changes whenever
 *		window moves (can be filled by SW then maintained by REO).
 *
 * current_index
 *		Points to last forwarded packet.
 *
 * pn
 *		Bits of the PN number.
 *
 * last_rx_enqueue_timestamp
 * last_rx_dequeue_timestamp
 *		Timestamp of arrival of the last MPDU for this queue and
 *		Timestamp of forwarding an MPDU accordingly.
 *
 * rx_bitmap
 *		When a bit is set, the corresponding frame is currently held
 *		in the re-order queue. The bitmap  is Fully managed by HW.
 *
 * current_mpdu_count
 * current_msdu_count
 *		The number of MPDUs and MSDUs in the queue.
 *
 * timeout_count
 *		The number of times REO started forwarding frames even though
 *		there is a hole in the bitmap. Forwarding reason is timeout.
 *
 * forward_due_to_bar_count
 *		The number of times REO started forwarding frames even though
 *		there is a hole in the bitmap. Fwd reason is reception of BAR.
 *
 * duplicate_count
 *		The number of duplicate frames that have been detected.
 *
 * frames_in_order_count
 *		The number of frames that have been received in order (without
 *		a hole that prevented them from being forwarded immediately).
 *
 * bar_received_count
 *		The number of times a BAR frame is received.
 *
 * mpdu_frames_processed_count
 * msdu_frames_processed_count
 *		The total number of MPDU/MSDU frames that have been processed.
 *
 * total_bytes
 *		An approximation of the number of bytes received for this queue.
 *
 * late_receive_mpdu_count
 *		The number of MPDUs received after the window had already moved
 *		on. The 'late' sequence window is defined as
 *		(Window SSN - 256) - (Window SSN - 1).
 *
 * window_jump_2k
 *		The number of times the window moved more than 2K
 *
 * hole_count
 *		The number of times a hole was created in the receive bitmap.
 *
 * looping_count
 *		A count value that indicates the number of times the producer of
 *		entries into this Ring has looped around the ring.
 */

#define HAL_REO_STATUS_LOOP_CNT

#define HAL_REO_FLUSH_QUEUE_INFO0_ERR_DETECTED
#define HAL_REO_FLUSH_QUEUE_INFO0_RSVD
#define HAL_REO_FLUSH_QUEUE_INFO1_RSVD

struct hal_reo_flush_queue_status {} __packed;

/* hal_reo_flush_queue_status
 *		Producer: REO
 *		Consumer: SW
 *
 * status_hdr
 *		Details that can link this status with the original command. It
 *		also contains info on how long REO took to execute this command.
 *
 * error_detected
 *		Status of blocking resource
 *
 *		0 - No error has been detected while executing this command
 *		1 - Error detected. The resource to be used for blocking was
 *		    already in use.
 *
 * looping_count
 *		A count value that indicates the number of times the producer of
 *		entries into this Ring has looped around the ring.
 */

#define HAL_REO_FLUSH_CACHE_STATUS_INFO0_IS_ERR
#define HAL_REO_FLUSH_CACHE_STATUS_INFO0_BLOCK_ERR_CODE
#define HAL_REO_FLUSH_CACHE_STATUS_INFO0_FLUSH_STATUS_HIT
#define HAL_REO_FLUSH_CACHE_STATUS_INFO0_FLUSH_DESC_TYPE
#define HAL_REO_FLUSH_CACHE_STATUS_INFO0_FLUSH_CLIENT_ID
#define HAL_REO_FLUSH_CACHE_STATUS_INFO0_FLUSH_ERR
#define HAL_REO_FLUSH_CACHE_STATUS_INFO0_FLUSH_COUNT

struct hal_reo_flush_cache_status {} __packed;

/* hal_reo_flush_cache_status
 *		Producer: REO
 *		Consumer: SW
 *
 * status_hdr
 *		Details that can link this status with the original command. It
 *		also contains info on how long REO took to execute this command.
 *
 * error_detected
 *		Status for blocking resource handling
 *
 *		0 - No error has been detected while executing this command
 *		1 - An error in the blocking resource management was detected
 *
 * block_error_details
 *		only valid when error_detected is set
 *
 *		0 - No blocking related errors found
 *		1 - Blocking resource is already in use
 *		2 - Resource requested to be unblocked, was not blocked
 *
 * cache_controller_flush_status_hit
 *		The status that the cache controller returned on executing the
 *		flush command.
 *
 *		0 - miss; 1 - hit
 *
 * cache_controller_flush_status_desc_type
 *		Flush descriptor type
 *
 * cache_controller_flush_status_client_id
 *		Module who made the flush request
 *
 *		In REO, this is always 0
 *
 * cache_controller_flush_status_error
 *		Error condition
 *
 *		0 - No error found
 *		1 - HW interface is still busy
 *		2 - Line currently locked. Used for one line flush command
 *		3 - At least one line is still locked.
 *		    Used for cache flush command.
 *
 * cache_controller_flush_count
 *		The number of lines that were actually flushed out
 *
 * looping_count
 *		A count value that indicates the number of times the producer of
 *		entries into this Ring has looped around the ring.
 */

#define HAL_REO_UNBLOCK_CACHE_STATUS_INFO0_IS_ERR
#define HAL_REO_UNBLOCK_CACHE_STATUS_INFO0_TYPE

struct hal_reo_unblock_cache_status {} __packed;

/* hal_reo_unblock_cache_status
 *		Producer: REO
 *		Consumer: SW
 *
 * status_hdr
 *		Details that can link this status with the original command. It
 *		also contains info on how long REO took to execute this command.
 *
 * error_detected
 *		0 - No error has been detected while executing this command
 *		1 - The blocking resource was not in use, and therefore it could
 *		    not be unblocked.
 *
 * unblock_type
 *		Reference to the type of unblock command
 *		0 - Unblock a blocking resource
 *		1 - The entire cache usage is unblock
 *
 * looping_count
 *		A count value that indicates the number of times the producer of
 *		entries into this Ring has looped around the ring.
 */

#define HAL_REO_FLUSH_TIMEOUT_STATUS_INFO0_IS_ERR
#define HAL_REO_FLUSH_TIMEOUT_STATUS_INFO0_LIST_EMPTY

#define HAL_REO_FLUSH_TIMEOUT_STATUS_INFO1_REL_DESC_COUNT
#define HAL_REO_FLUSH_TIMEOUT_STATUS_INFO1_FWD_BUF_COUNT

struct hal_reo_flush_timeout_list_status {} __packed;

/* hal_reo_flush_timeout_list_status
 *		Producer: REO
 *		Consumer: SW
 *
 * status_hdr
 *		Details that can link this status with the original command. It
 *		also contains info on how long REO took to execute this command.
 *
 * error_detected
 *		0 - No error has been detected while executing this command
 *		1 - Command not properly executed and returned with error
 *
 * timeout_list_empty
 *		When set, REO has depleted the timeout list and all entries are
 *		gone.
 *
 * release_desc_count
 *		Producer: SW; Consumer: REO
 *		The number of link descriptor released
 *
 * forward_buf_count
 *		Producer: SW; Consumer: REO
 *		The number of buffers forwarded to the REO destination rings
 *
 * looping_count
 *		A count value that indicates the number of times the producer of
 *		entries into this Ring has looped around the ring.
 */

#define HAL_REO_DESC_THRESH_STATUS_INFO0_THRESH_INDEX
#define HAL_REO_DESC_THRESH_STATUS_INFO1_LINK_DESC_COUNTER0
#define HAL_REO_DESC_THRESH_STATUS_INFO2_LINK_DESC_COUNTER1
#define HAL_REO_DESC_THRESH_STATUS_INFO3_LINK_DESC_COUNTER2
#define HAL_REO_DESC_THRESH_STATUS_INFO4_LINK_DESC_COUNTER_SUM

struct hal_reo_desc_thresh_reached_status {} __packed;

/* hal_reo_desc_thresh_reached_status
 *		Producer: REO
 *		Consumer: SW
 *
 * status_hdr
 *		Details that can link this status with the original command. It
 *		also contains info on how long REO took to execute this command.
 *
 * threshold_index
 *		The index of the threshold register whose value got reached
 *
 * link_descriptor_counter0
 * link_descriptor_counter1
 * link_descriptor_counter2
 * link_descriptor_counter_sum
 *		Value of the respective counters at generation of this message
 *
 * looping_count
 *		A count value that indicates the number of times the producer of
 *		entries into this Ring has looped around the ring.
 */

#endif /* ATH11K_HAL_DESC_H */