android_kernel_samsung_sm8650-modules/hal/wifi3.0/hal_internal.h

/*
 * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
 * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _HAL_INTERNAL_H_
#define _HAL_INTERNAL_H_

#include "qdf_types.h"
#include "qdf_atomic.h"
#include "qdf_lock.h"
#include "qdf_mem.h"
#include "qdf_nbuf.h"
#include "pld_common.h"
#if defined(FEATURE_HAL_DELAYED_REG_WRITE)
#include "qdf_defer.h"
#include "qdf_timer.h"
#endif

#define hal_alert(params...) QDF_TRACE_FATAL(QDF_MODULE_ID_HAL, params)
#define hal_err(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_HAL, params)
#define hal_warn(params...) QDF_TRACE_WARN(QDF_MODULE_ID_HAL, params)
#define hal_info(params...) QDF_TRACE_INFO(QDF_MODULE_ID_HAL, params)
#define hal_debug(params...) QDF_TRACE_DEBUG(QDF_MODULE_ID_HAL, params)

#define hal_alert_rl(params...) QDF_TRACE_FATAL_RL(QDF_MODULE_ID_HAL, params)
#define hal_err_rl(params...) QDF_TRACE_ERROR_RL(QDF_MODULE_ID_HAL, params)
#define hal_warn_rl(params...) QDF_TRACE_WARN_RL(QDF_MODULE_ID_HAL, params)
#define hal_info_rl(params...) QDF_TRACE_INFO_RL(QDF_MODULE_ID_HAL, params)
#define hal_debug_rl(params...) QDF_TRACE_DEBUG_RL(QDF_MODULE_ID_HAL, params)

#ifdef ENABLE_VERBOSE_DEBUG
extern bool is_hal_verbose_debug_enabled;
#define hal_verbose_debug(params...) \
	if (unlikely(is_hal_verbose_debug_enabled)) \
		do {\
			QDF_TRACE_DEBUG(QDF_MODULE_ID_HAL, params); \
		} while (0)
#define hal_verbose_hex_dump(params...) \
	if (unlikely(is_hal_verbose_debug_enabled)) \
		do {\
			QDF_TRACE_HEX_DUMP(QDF_MODULE_ID_HAL, \
					   QDF_TRACE_LEVEL_DEBUG, \
					   params); \
		} while (0)
#else
#define hal_verbose_debug(params...) QDF_TRACE_DEBUG(QDF_MODULE_ID_HAL, params)
#define hal_verbose_hex_dump(params...) \
		QDF_TRACE_HEX_DUMP(QDF_MODULE_ID_HAL, QDF_TRACE_LEVEL_DEBUG, \
				   params)
#endif

/*
 * Given the offset of a field in bytes, returns uint8_t *
 */
#define _OFFSET_TO_BYTE_PTR(_ptr, _off_in_bytes)	\
	(((uint8_t *)(_ptr)) + (_off_in_bytes))

/*
 * Given the offset of a field in bytes, returns uint32_t *
 */
#define _OFFSET_TO_WORD_PTR(_ptr, _off_in_bytes)	\
	(((uint32_t *)(_ptr)) + ((_off_in_bytes) >> 2))

/*
 * Given the offset of a field in bytes, returns uint64_t *
 */
#define _OFFSET_TO_QWORD_PTR(_ptr, _off_in_bytes)	\
	(((uint64_t *)(_ptr)) + ((_off_in_bytes) >> 3))

#define _HAL_MS(_word, _mask, _shift)		\
	(((_word) & (_mask)) >> (_shift))

/*
 * Get number of QWORDS possible for num.
 * Its the caller's duty to make sure num is a multiple of QWORD (8)
 */
#define HAL_GET_NUM_QWORDS(num)	((num) >> 3)

/*
 * Get number of DWORDS possible for num.
 * Its the caller's duty to make sure num is a multiple of DWORD (8)
 */
#define HAL_GET_NUM_DWORDS(num)	((num) >> 2)

struct hal_hw_cc_config {
	uint32_t lut_base_addr_31_0;
	uint32_t cc_global_en:1,
		 page_4k_align:1,
		 cookie_offset_msb:5,
		 cookie_page_msb:5,
		 lut_base_addr_39_32:8,
		 wbm2sw6_cc_en:1,
		 wbm2sw5_cc_en:1,
		 wbm2sw4_cc_en:1,
		 wbm2sw3_cc_en:1,
		 wbm2sw2_cc_en:1,
		 wbm2sw1_cc_en:1,
		 wbm2sw0_cc_en:1,
		 wbm2fw_cc_en:1,
		 error_path_cookie_conv_en:1,
		 release_path_cookie_conv_en:1,
		 reserved:2;
};

/*
 * dp_hal_soc - opaque handle for DP HAL soc
 */
struct hal_soc_handle;
typedef struct hal_soc_handle *hal_soc_handle_t;

/**
 * hal_ring_desc - opaque handle for DP ring descriptor
 */
struct hal_ring_desc;
typedef struct hal_ring_desc *hal_ring_desc_t;

/**
 * hal_link_desc - opaque handle for DP link descriptor
 */
struct hal_link_desc;
typedef struct hal_link_desc *hal_link_desc_t;

/**
 * hal_rxdma_desc - opaque handle for DP rxdma dst ring descriptor
 */
struct hal_rxdma_desc;
typedef struct hal_rxdma_desc *hal_rxdma_desc_t;

/**
 * hal_buff_addrinfo - opaque handle for DP buffer address info
 */
struct hal_buff_addrinfo;
typedef struct hal_buff_addrinfo *hal_buff_addrinfo_t;

/**
 * hal_rx_mon_desc_info - opaque handle for sw monitor ring desc info
 */
struct hal_rx_mon_desc_info;
typedef struct hal_rx_mon_desc_info *hal_rx_mon_desc_info_t;

struct hal_buf_info;
typedef struct hal_buf_info *hal_buf_info_t;

struct rx_msdu_desc_info;
typedef struct rx_msdu_desc_info *rx_msdu_desc_info_t;

/**
 * Opaque handler for PPE VP config.
 */
union hal_tx_ppe_vp_config;
union hal_tx_cmn_config_ppe;
union hal_tx_bank_config;

/* TBD: This should be movded to shared HW header file */
enum hal_srng_ring_id {
	/* UMAC rings */
	HAL_SRNG_REO2SW0 = 0,
	HAL_SRNG_REO2SW1 = 1,
	HAL_SRNG_REO2SW2 = 2,
	HAL_SRNG_REO2SW3 = 3,
	HAL_SRNG_REO2SW4 = 4,
	HAL_SRNG_REO2SW5 = 5,
	HAL_SRNG_REO2SW6 = 6,
	HAL_SRNG_REO2SW7 = 7,
	HAL_SRNG_REO2SW8 = 8,
	HAL_SRNG_REO2TCL = 9,
	HAL_SRNG_REO2PPE = 10,
	/* 11-15 unused */
	HAL_SRNG_SW2REO = 16,
	HAL_SRNG_SW2REO1 = 17,
	HAL_SRNG_SW2REO2 = 18,
	HAL_SRNG_SW2REO3 = 19,
	HAL_SRNG_REO_CMD = 20,
	HAL_SRNG_REO_STATUS = 21,
	/* 22-23 unused */
	HAL_SRNG_SW2TCL1 = 24,
	HAL_SRNG_SW2TCL2 = 25,
	HAL_SRNG_SW2TCL3 = 26,
	HAL_SRNG_SW2TCL4 = 27,
	HAL_SRNG_SW2TCL5 = 28,
	HAL_SRNG_SW2TCL6 = 29,
	HAL_SRNG_PPE2TCL1 = 30,
	/* 31-39 unused */
	HAL_SRNG_SW2TCL_CMD = 40,
	HAL_SRNG_TCL_STATUS = 41,
	HAL_SRNG_SW2TCL_CREDIT = 42,
	/* 43-63 unused */
	HAL_SRNG_CE_0_SRC = 64,
	HAL_SRNG_CE_1_SRC = 65,
	HAL_SRNG_CE_2_SRC = 66,
	HAL_SRNG_CE_3_SRC = 67,
	HAL_SRNG_CE_4_SRC = 68,
	HAL_SRNG_CE_5_SRC = 69,
	HAL_SRNG_CE_6_SRC = 70,
	HAL_SRNG_CE_7_SRC = 71,
	HAL_SRNG_CE_8_SRC = 72,
	HAL_SRNG_CE_9_SRC = 73,
	HAL_SRNG_CE_10_SRC = 74,
	HAL_SRNG_CE_11_SRC = 75,
	HAL_SRNG_CE_12_SRC = 76,
	HAL_SRNG_CE_13_SRC = 77,
	HAL_SRNG_CE_14_SRC = 78,
	HAL_SRNG_CE_15_SRC = 79,
	/* 80 */
	HAL_SRNG_CE_0_DST = 81,
	HAL_SRNG_CE_1_DST = 82,
	HAL_SRNG_CE_2_DST = 83,
	HAL_SRNG_CE_3_DST = 84,
	HAL_SRNG_CE_4_DST = 85,
	HAL_SRNG_CE_5_DST = 86,
	HAL_SRNG_CE_6_DST = 87,
	HAL_SRNG_CE_7_DST = 89,
	HAL_SRNG_CE_8_DST = 90,
	HAL_SRNG_CE_9_DST = 91,
	HAL_SRNG_CE_10_DST = 92,
	HAL_SRNG_CE_11_DST = 93,
	HAL_SRNG_CE_12_DST = 94,
	HAL_SRNG_CE_13_DST = 95,
	HAL_SRNG_CE_14_DST = 96,
	HAL_SRNG_CE_15_DST = 97,
	/* 98-99 unused */
	HAL_SRNG_CE_0_DST_STATUS = 100,
	HAL_SRNG_CE_1_DST_STATUS = 101,
	HAL_SRNG_CE_2_DST_STATUS = 102,
	HAL_SRNG_CE_3_DST_STATUS = 103,
	HAL_SRNG_CE_4_DST_STATUS = 104,
	HAL_SRNG_CE_5_DST_STATUS = 105,
	HAL_SRNG_CE_6_DST_STATUS = 106,
	HAL_SRNG_CE_7_DST_STATUS = 107,
	HAL_SRNG_CE_8_DST_STATUS = 108,
	HAL_SRNG_CE_9_DST_STATUS = 109,
	HAL_SRNG_CE_10_DST_STATUS = 110,
	HAL_SRNG_CE_11_DST_STATUS = 111,
	HAL_SRNG_CE_12_DST_STATUS = 112,
	HAL_SRNG_CE_13_DST_STATUS = 113,
	HAL_SRNG_CE_14_DST_STATUS = 114,
	HAL_SRNG_CE_15_DST_STATUS = 115,
	/* 116-119 unused */
	HAL_SRNG_WBM_IDLE_LINK = 120,
	HAL_SRNG_WBM_SW_RELEASE = 121,
	HAL_SRNG_WBM_SW1_RELEASE = 122,
	HAL_SRNG_WBM_PPE_RELEASE = 123,
	/* 124-127 unused */
	HAL_SRNG_WBM2SW0_RELEASE = 128,
	HAL_SRNG_WBM2SW1_RELEASE = 129,
	HAL_SRNG_WBM2SW2_RELEASE = 130,
	HAL_SRNG_WBM2SW3_RELEASE = 131,
	HAL_SRNG_WBM2SW4_RELEASE = 132,
	HAL_SRNG_WBM2SW5_RELEASE = 133,
	HAL_SRNG_WBM2SW6_RELEASE = 134,
	HAL_SRNG_WBM_ERROR_RELEASE = 135,
	/* 136-158 unused */
	HAL_SRNG_UMAC_ID_END = 159,
	/* Common DMAC rings shared by all LMACs */
	HAL_SRNG_SW2RXDMA_BUF0 = 160,
	HAL_SRNG_SW2RXDMA_BUF1 = 161,
	HAL_SRNG_SW2RXDMA_BUF2 = 162,
	/* 163-167 unused */
	HAL_SRNG_SW2RXMON_BUF0 = 168,
	/* 169-175 unused */
	/* 177-183 unused */
	HAL_SRNG_DMAC_CMN_ID_END = 183,
	/* LMAC rings - The following set will be replicated for each LMAC */
	HAL_SRNG_LMAC1_ID_START = 184,
	HAL_SRNG_WMAC1_SW2RXDMA0_BUF0 = HAL_SRNG_LMAC1_ID_START,
#ifdef IPA_OFFLOAD
	HAL_SRNG_WMAC1_SW2RXDMA0_BUF1,
	HAL_SRNG_WMAC1_SW2RXDMA0_BUF2,
#ifdef IPA_WDI3_VLAN_SUPPORT
	HAL_SRNG_WMAC1_SW2RXDMA0_BUF3,
#endif
#endif
	HAL_SRNG_WMAC1_SW2RXDMA1_BUF,
#ifdef FEATURE_DIRECT_LINK
	HAL_SRNG_WMAC1_RX_DIRECT_LINK_SW_REFILL_RING,
#endif
	HAL_SRNG_WMAC1_SW2RXDMA2_BUF,
	HAL_SRNG_WMAC1_SW2RXDMA0_STATBUF,
	HAL_SRNG_WMAC1_SW2RXDMA1_STATBUF,
	HAL_SRNG_WMAC1_RXDMA2SW0,
	HAL_SRNG_WMAC1_RXDMA2SW1,
	HAL_SRNG_WMAC1_RXMON2SW0 = HAL_SRNG_WMAC1_RXDMA2SW1,
	HAL_SRNG_WMAC1_SW2RXDMA1_DESC,
#ifdef WLAN_FEATURE_CIF_CFR
	HAL_SRNG_WIFI_POS_SRC_DMA_RING,
	HAL_SRNG_DIR_BUF_RX_SRC_DMA_RING,
	HAL_SRNG_DIR_BUF_RX_SRC_DMA_RING1,
#else
	HAL_SRNG_DIR_BUF_RX_SRC_DMA_RING,
	HAL_SRNG_DIR_BUF_RX_SRC_DMA_RING1,
#endif
	HAL_SRNG_WMAC1_TXMON2SW0,
	HAL_SRNG_SW2TXMON_BUF0,
	HAL_SRNG_LMAC1_ID_END = (HAL_SRNG_SW2TXMON_BUF0 + 2),
};

#define HAL_RXDMA_MAX_RING_SIZE 0xFFFF
#define HAL_MAX_LMACS 3
#define HAL_MAX_RINGS_PER_LMAC (HAL_SRNG_LMAC1_ID_END - HAL_SRNG_LMAC1_ID_START)
#define HAL_MAX_LMAC_RINGS (HAL_MAX_LMACS * HAL_MAX_RINGS_PER_LMAC)

#define HAL_SRNG_ID_MAX (HAL_SRNG_DMAC_CMN_ID_END + HAL_MAX_LMAC_RINGS)

/* SRNG type to be passed in APIs hal_srng_get_entrysize and hal_srng_setup */
enum hal_ring_type {
	REO_DST = 0,
	REO_EXCEPTION = 1,
	REO_REINJECT = 2,
	REO_CMD = 3,
	REO_STATUS = 4,
	TCL_DATA = 5,
	TCL_CMD_CREDIT = 6,
	TCL_STATUS = 7,
	CE_SRC = 8,
	CE_DST = 9,
	CE_DST_STATUS = 10,
	WBM_IDLE_LINK = 11,
	SW2WBM_RELEASE = 12,
	WBM2SW_RELEASE = 13,
	RXDMA_BUF = 14,
	RXDMA_DST = 15,
	RXDMA_MONITOR_BUF = 16,
	RXDMA_MONITOR_STATUS = 17,
	RXDMA_MONITOR_DST = 18,
	RXDMA_MONITOR_DESC = 19,
	DIR_BUF_RX_DMA_SRC = 20,
#ifdef WLAN_FEATURE_CIF_CFR
	WIFI_POS_SRC,
#endif
	REO2PPE,
	PPE2TCL,
	PPE_RELEASE,
	TX_MONITOR_BUF,
	TX_MONITOR_DST,
	SW2RXDMA_NEW,
	MAX_RING_TYPES
};

enum SRNG_REGISTERS {
	DST_HP = 0,
	DST_TP,
	DST_ID,
	DST_MISC,
	DST_HP_ADDR_LSB,
	DST_HP_ADDR_MSB,
	DST_MSI1_BASE_LSB,
	DST_MSI1_BASE_MSB,
	DST_MSI1_DATA,
#ifdef CONFIG_BERYLLIUM
	DST_MSI2_BASE_LSB,
	DST_MSI2_BASE_MSB,
	DST_MSI2_DATA,
#endif
	DST_BASE_LSB,
	DST_BASE_MSB,
	DST_PRODUCER_INT_SETUP,
#ifdef CONFIG_BERYLLIUM
	DST_PRODUCER_INT2_SETUP,
#endif

	SRC_HP,
	SRC_TP,
	SRC_ID,
	SRC_MISC,
	SRC_TP_ADDR_LSB,
	SRC_TP_ADDR_MSB,
	SRC_MSI1_BASE_LSB,
	SRC_MSI1_BASE_MSB,
	SRC_MSI1_DATA,
	SRC_BASE_LSB,
	SRC_BASE_MSB,
	SRC_CONSUMER_INT_SETUP_IX0,
	SRC_CONSUMER_INT_SETUP_IX1,
#ifdef DP_UMAC_HW_RESET_SUPPORT
	SRC_CONSUMER_PREFETCH_TIMER,
#endif
	SRNG_REGISTER_MAX,
};

enum hal_srng_dir {
	HAL_SRNG_SRC_RING,
	HAL_SRNG_DST_RING
};

/**
 * enum hal_reo_remap_reg - REO remap registers
 * @HAL_REO_REMAP_REG_IX0: reo remap reg IX0
 * @HAL_REO_REMAP_REG_IX1: reo remap reg IX1
 * @HAL_REO_REMAP_REG_IX2: reo remap reg IX2
 * @HAL_REO_REMAP_REG_IX3: reo remap reg IX3
 */
enum hal_reo_remap_reg {
	HAL_REO_REMAP_REG_IX0,
	HAL_REO_REMAP_REG_IX1,
	HAL_REO_REMAP_REG_IX2,
	HAL_REO_REMAP_REG_IX3
};

/* Lock wrappers for SRNG */
#define hal_srng_lock_t qdf_spinlock_t
#define SRNG_LOCK_INIT(_lock) qdf_spinlock_create(_lock)
#define SRNG_LOCK(_lock) qdf_spin_lock_bh(_lock)
#define SRNG_TRY_LOCK(_lock) qdf_spin_trylock_bh(_lock)
#define SRNG_UNLOCK(_lock) qdf_spin_unlock_bh(_lock)
#define SRNG_LOCK_DESTROY(_lock) qdf_spinlock_destroy(_lock)

struct hal_soc;

/**
 * dp_hal_ring - opaque handle for DP HAL SRNG
 */
struct hal_ring_handle;
typedef struct hal_ring_handle *hal_ring_handle_t;

#define MAX_SRNG_REG_GROUPS 2

/* Hal Srng bit mask
 * HAL_SRNG_FLUSH_EVENT: SRNG HP TP flush in case of link down
 */
#define HAL_SRNG_FLUSH_EVENT BIT(0)

#if defined(FEATURE_HAL_DELAYED_REG_WRITE)

/**
 * struct hal_reg_write_q_elem - delayed register write queue element
 * @srng: hal_srng queued for a delayed write
 * @addr: iomem address of the register
 * @enqueue_val: register value at the time of delayed write enqueue
 * @dequeue_val: register value at the time of delayed write dequeue
 * @valid: whether this entry is valid or not
 * @enqueue_time: enqueue time (qdf_log_timestamp)
 * @work_scheduled_time: work scheduled time (qdf_log_timestamp)
 * @dequeue_time: dequeue time (qdf_log_timestamp)
 * @cpu_id: record cpuid when schedule work
 */
struct hal_reg_write_q_elem {
	struct hal_srng *srng;
	void __iomem *addr;
	uint32_t enqueue_val;
	uint32_t dequeue_val;
	uint8_t valid;
	qdf_time_t enqueue_time;
	qdf_time_t work_scheduled_time;
	qdf_time_t dequeue_time;
	int cpu_id;
};

/**
 * struct hal_reg_write_srng_stats - srng stats to keep track of register writes
 * @enqueues: writes enqueued to delayed work
 * @dequeues: writes dequeued from delayed work (not written yet)
 * @coalesces: writes not enqueued since srng is already queued up
 * @direct: writes not enqueued and written to register directly
 * @dequeue_delay: dequeue operation be delayed
 */
struct hal_reg_write_srng_stats {
	uint32_t enqueues;
	uint32_t dequeues;
	uint32_t coalesces;
	uint32_t direct;
	uint32_t dequeue_delay;
};

/**
 * enum hal_reg_sched_delay - ENUM for write sched delay histogram
 * @REG_WRITE_SCHED_DELAY_SUB_100us: index for delay < 100us
 * @REG_WRITE_SCHED_DELAY_SUB_1000us: index for delay < 1000us
 * @REG_WRITE_SCHED_DELAY_SUB_5000us: index for delay < 5000us
 * @REG_WRITE_SCHED_DELAY_GT_5000us: index for delay >= 5000us
 * @REG_WRITE_SCHED_DELAY_HIST_MAX: Max value (nnsize of histogram array)
 */
enum hal_reg_sched_delay {
	REG_WRITE_SCHED_DELAY_SUB_100us,
	REG_WRITE_SCHED_DELAY_SUB_1000us,
	REG_WRITE_SCHED_DELAY_SUB_5000us,
	REG_WRITE_SCHED_DELAY_GT_5000us,
	REG_WRITE_SCHED_DELAY_HIST_MAX,
};

/**
 * struct hal_reg_write_soc_stats - soc stats to keep track of register writes
 * @enqueues: writes enqueued to delayed work
 * @dequeues: writes dequeued from delayed work (not written yet)
 * @coalesces: writes not enqueued since srng is already queued up
 * @direct: writes not enqueud and writted to register directly
 * @prevent_l1_fails: prevent l1 API failed
 * @q_depth: current queue depth in delayed register write queue
 * @max_q_depth: maximum queue for delayed register write queue
 * @sched_delay: = kernel work sched delay + bus wakeup delay, histogram
 * @dequeue_delay: dequeue operation be delayed
 */
struct hal_reg_write_soc_stats {
	qdf_atomic_t enqueues;
	uint32_t dequeues;
	qdf_atomic_t coalesces;
	qdf_atomic_t direct;
	uint32_t prevent_l1_fails;
	qdf_atomic_t q_depth;
	uint32_t max_q_depth;
	uint32_t sched_delay[REG_WRITE_SCHED_DELAY_HIST_MAX];
	uint32_t dequeue_delay;
};
#endif

struct hal_offload_info {
	uint8_t lro_eligible;
	uint8_t tcp_proto;
	uint8_t tcp_pure_ack;
	uint8_t ipv6_proto;
	uint8_t tcp_offset;
	uint16_t tcp_csum;
	uint16_t tcp_win;
	uint32_t tcp_seq_num;
	uint32_t tcp_ack_num;
	uint32_t flow_id;
};

#ifdef WLAN_DP_SRNG_USAGE_WM_TRACKING
/**
 * enum hal_srng_high_wm_bin - BIN for SRNG high watermark
 * @HAL_SRNG_HIGH_WM_BIN_BELOW_50_PERCENT: <50% SRNG entries used
 * @HAL_SRNG_HIGH_WM_BIN_50_to_60: 50-60% SRNG entries used
 * @HAL_SRNG_HIGH_WM_BIN_60_to_70: 60-70% SRNG entries used
 * @HAL_SRNG_HIGH_WM_BIN_70_to_80: 70-80% SRNG entries used
 * @HAL_SRNG_HIGH_WM_BIN_80_to_90: 80-90% SRNG entries used
 * @HAL_SRNG_HIGH_WM_BIN_90_to_100: 90-100% SRNG entries used
 */
enum hal_srng_high_wm_bin {
	HAL_SRNG_HIGH_WM_BIN_BELOW_50_PERCENT,
	HAL_SRNG_HIGH_WM_BIN_50_to_60,
	HAL_SRNG_HIGH_WM_BIN_60_to_70,
	HAL_SRNG_HIGH_WM_BIN_70_to_80,
	HAL_SRNG_HIGH_WM_BIN_80_to_90,
	HAL_SRNG_HIGH_WM_BIN_90_to_100,
	HAL_SRNG_HIGH_WM_BIN_MAX,
};

/**
 * struct hal_srng_high_wm_info - SRNG usage high watermark info
 * @val: highest number of entries used in SRNG
 * @timestamp: Timestamp when the max num entries were in used for a SRNG
 * @bin_thresh: threshold for each bins
 * @bins: Bins for srng usage
 */
struct hal_srng_high_wm_info {
	uint32_t val;
	uint64_t timestamp;
	uint32_t bin_thresh[HAL_SRNG_HIGH_WM_BIN_MAX];
	uint32_t bins[HAL_SRNG_HIGH_WM_BIN_MAX];
};
#endif

/* Common SRNG ring structure for source and destination rings */
struct hal_srng {
	/* Unique SRNG ring ID */
	uint8_t ring_id;

	/* Ring initialization done */
	uint8_t initialized;

	/* Interrupt/MSI value assigned to this ring */
	int irq;

	/* Physical base address of the ring */
	qdf_dma_addr_t ring_base_paddr;

	/* Virtual base address of the ring */
	uint32_t *ring_base_vaddr;

	/* virtual address end */
	uint32_t *ring_vaddr_end;

	/* Number of entries in ring */
	uint32_t num_entries;

	/* Ring size */
	uint32_t ring_size;

	/* Ring size mask */
	uint32_t ring_size_mask;

	/* Size of ring entry */
	uint32_t entry_size;

	/* Interrupt timer threshold – in micro seconds */
	uint32_t intr_timer_thres_us;

	/* Interrupt batch counter threshold – in number of ring entries */
	uint32_t intr_batch_cntr_thres_entries;

	/* Applicable only for CE dest ring */
	uint32_t prefetch_timer;

	/* MSI Address */
	qdf_dma_addr_t msi_addr;

	/* MSI data */
	uint32_t msi_data;

#ifdef WLAN_FEATURE_NEAR_FULL_IRQ
	/* MSI2 Address */
	qdf_dma_addr_t msi2_addr;

	/* MSI2 data */
	uint32_t msi2_data;
#endif

	/* Misc flags */
	uint32_t flags;

	/* Lock for serializing ring index updates */
	hal_srng_lock_t lock;

	/* Start offset of SRNG register groups for this ring
	 * TBD: See if this is required - register address can be derived
	 * from ring ID
	 */
	void *hwreg_base[MAX_SRNG_REG_GROUPS];

	/* Ring type/name */
	enum hal_ring_type ring_type;

	/* Source or Destination ring */
	enum hal_srng_dir ring_dir;

	union {
		struct {
			/* SW tail pointer */
			uint32_t tp;

			/* Shadow head pointer location to be updated by HW */
			uint32_t *hp_addr;

			/* Cached head pointer */
			uint32_t cached_hp;

			/* Tail pointer location to be updated by SW – This
			 * will be a register address and need not be
			 * accessed through SW structure */
			uint32_t *tp_addr;

			/* Current SW loop cnt */
			uint32_t loop_cnt;

			/* max transfer size */
			uint16_t max_buffer_length;

#ifdef WLAN_FEATURE_NEAR_FULL_IRQ
			/* near full IRQ supported */
			uint16_t nf_irq_support;

			/* High threshold for Near full IRQ */
			uint16_t high_thresh;
#endif
		} dst_ring;

		struct {
			/* SW head pointer */
			uint32_t hp;

			/* SW reap head pointer */
			uint32_t reap_hp;

			/* Shadow tail pointer location to be updated by HW */
			uint32_t *tp_addr;

			/* Cached tail pointer */
			uint32_t cached_tp;

			/* Head pointer location to be updated by SW – This
			 * will be a register address and need not be accessed
			 * through SW structure */
			uint32_t *hp_addr;

			/* Low threshold – in number of ring entries */
			uint32_t low_threshold;
		} src_ring;
	} u;

	struct hal_soc *hal_soc;

	/* Number of times hp/tp updated in runtime resume */
	uint32_t flush_count;
	/* hal srng event flag*/
	unsigned long srng_event;
	/* last flushed time stamp */
	uint64_t last_flush_ts;
#if defined(CLEAR_SW2TCL_CONSUMED_DESC)
	/* last ring desc entry cleared */
	uint32_t last_desc_cleared;
#endif
#if defined(FEATURE_HAL_DELAYED_REG_WRITE)
	/* flag to indicate whether srng is already queued for delayed write */
	uint8_t reg_write_in_progress;
	/* last dequeue elem time stamp */
	qdf_time_t last_dequeue_time;

	/* srng specific delayed write stats */
	struct hal_reg_write_srng_stats wstats;
#endif
#ifdef WLAN_DP_SRNG_USAGE_WM_TRACKING
	struct hal_srng_high_wm_info high_wm;
#endif
};

/* HW SRNG configuration table */
struct hal_hw_srng_config {
	int start_ring_id;
	uint16_t max_rings;
	uint16_t entry_size;
	uint32_t reg_start[MAX_SRNG_REG_GROUPS];
	uint16_t reg_size[MAX_SRNG_REG_GROUPS];
	uint8_t lmac_ring;
	enum hal_srng_dir ring_dir;
	uint32_t max_size;
	bool nf_irq_support;
	bool dmac_cmn_ring;
};

#define MAX_SHADOW_REGISTERS 40
#define MAX_GENERIC_SHADOW_REG 5

/**
 * struct shadow_reg_config - Hal soc structure that contains
 * the list of generic shadow registers
 * @target_register: target reg offset
 * @shadow_config_index: shadow config index in shadow config
 *				list sent to FW
 * @va: virtual addr of shadow reg
 *
 * This structure holds the generic registers that are mapped to
 * the shadow region and holds the mapping of the target
 * register offset to shadow config index provided to FW during
 * init
 */
struct shadow_reg_config {
	uint32_t target_register;
	int shadow_config_index;
	uint64_t va;
};

/* REO parameters to be passed to hal_reo_setup */
struct hal_reo_params {
	/** rx hash steering enabled or disabled */
	bool rx_hash_enabled;
	/** reo remap 0 register */
	uint32_t remap0;
	/** reo remap 1 register */
	uint32_t remap1;
	/** reo remap 2 register */
	uint32_t remap2;
	/** fragment destination ring */
	uint8_t frag_dst_ring;
	/* Destination for alternate */
	uint8_t alt_dst_ind_0;
	/** padding */
	uint8_t padding[2];
};

/**
 * enum hal_reo_cmd_type: Enum for REO command type
 * @CMD_GET_QUEUE_STATS: Get REO queue status/stats
 * @CMD_FLUSH_QUEUE: Flush all frames in REO queue
 * @CMD_FLUSH_CACHE: Flush descriptor entries in the cache
 * @CMD_UNBLOCK_CACHE: Unblock a descriptor’s address that was blocked
 *	earlier with a ‘REO_FLUSH_CACHE’ command
 * @CMD_FLUSH_TIMEOUT_LIST: Flush buffers/descriptors from timeout list
 * @CMD_UPDATE_RX_REO_QUEUE: Update REO queue settings
 */
enum hal_reo_cmd_type {
	CMD_GET_QUEUE_STATS	= 0,
	CMD_FLUSH_QUEUE		= 1,
	CMD_FLUSH_CACHE		= 2,
	CMD_UNBLOCK_CACHE	= 3,
	CMD_FLUSH_TIMEOUT_LIST	= 4,
	CMD_UPDATE_RX_REO_QUEUE = 5
};

/**
 * enum hal_tx_mcast_mlo_reinject_notify
 * @HAL_TX_MCAST_MLO_REINJECT_FW_NOTIFY: MLO Mcast reinject routed to FW
 * @HAL_TX_MCAST_MLO_REINJECT_TQM_NOTIFY: MLO Mcast reinject routed to TQM
 */
enum hal_tx_mcast_mlo_reinject_notify {
	HAL_TX_MCAST_MLO_REINJECT_FW_NOTIFY = 0,
	HAL_TX_MCAST_MLO_REINJECT_TQM_NOTIFY,
};

/**
 * enum hal_tx_vdev_mismatch_notify
 * @HAL_TX_VDEV_MISMATCH_TQM_NOTIFY: vdev mismatch exception routed to TQM
 * @HAL_TX_VDEV_MISMATCH_FW_NOTIFY: vdev mismatch exception routed to FW
 */
enum hal_tx_vdev_mismatch_notify {
	HAL_TX_VDEV_MISMATCH_TQM_NOTIFY = 0,
	HAL_TX_VDEV_MISMATCH_FW_NOTIFY,
};

struct hal_rx_pkt_capture_flags {
	uint8_t encrypt_type;
	uint8_t fragment_flag;
	uint8_t fcs_err;
	uint32_t chan_freq;
	uint32_t rssi_comb;
	uint64_t tsft;
};

struct hal_hw_txrx_ops {
	/* init and setup */
	void (*hal_srng_dst_hw_init)(struct hal_soc *hal,
				     struct hal_srng *srng, bool idle_check);
	void (*hal_srng_src_hw_init)(struct hal_soc *hal,
				     struct hal_srng *srng, bool idle_check);

	void (*hal_srng_hw_disable)(struct hal_soc *hal,
				    struct hal_srng *srng);
	void (*hal_get_hw_hptp)(struct hal_soc *hal,
				hal_ring_handle_t hal_ring_hdl,
				uint32_t *headp, uint32_t *tailp,
				uint8_t ring_type);
	void (*hal_reo_setup)(struct hal_soc *hal_soc, void *reoparams,
			      int qref_reset);
	void (*hal_setup_link_idle_list)(
				struct hal_soc *hal_soc,
				qdf_dma_addr_t scatter_bufs_base_paddr[],
				void *scatter_bufs_base_vaddr[],
				uint32_t num_scatter_bufs,
				uint32_t scatter_buf_size,
				uint32_t last_buf_end_offset,
				uint32_t num_entries);
	qdf_iomem_t (*hal_get_window_address)(struct hal_soc *hal_soc,
					      qdf_iomem_t addr);
	void (*hal_reo_set_err_dst_remap)(void *hal_soc);
	uint8_t (*hal_reo_enable_pn_in_dest)(void *hal_soc);
	void (*hal_reo_qdesc_setup)(hal_soc_handle_t hal_soc_hdl, int tid,
				    uint32_t ba_window_size,
				    uint32_t start_seq, void *hw_qdesc_vaddr,
				    qdf_dma_addr_t hw_qdesc_paddr,
				    int pn_type, uint8_t vdev_stats_id);
	uint32_t (*hal_gen_reo_remap_val)(enum hal_reo_remap_reg,
					  uint8_t *ix0_map);

	/* tx */
	void (*hal_tx_desc_set_dscp_tid_table_id)(void *desc, uint8_t id);
	void (*hal_tx_set_dscp_tid_map)(struct hal_soc *hal_soc, uint8_t *map,
					uint8_t id);
	void (*hal_tx_update_dscp_tid)(struct hal_soc *hal_soc, uint8_t tid,
				       uint8_t id,
				       uint8_t dscp);
	void (*hal_tx_desc_set_lmac_id)(void *desc, uint8_t lmac_id);
	void (*hal_tx_desc_set_buf_addr)(void *desc, dma_addr_t paddr,
					 uint8_t pool_id, uint32_t desc_id,
					 uint8_t type);
	void (*hal_tx_desc_set_search_type)(void *desc, uint8_t search_type);
	void (*hal_tx_desc_set_search_index)(void *desc, uint32_t search_index);
	void (*hal_tx_desc_set_cache_set_num)(void *desc, uint8_t search_index);
	void (*hal_tx_comp_get_status)(void *desc, void *ts,
				       struct hal_soc *hal);
	uint8_t (*hal_tx_comp_get_release_reason)(void *hal_desc);
	uint8_t (*hal_get_wbm_internal_error)(void *hal_desc);
	void (*hal_tx_desc_set_mesh_en)(void *desc, uint8_t en);
	void (*hal_tx_init_cmd_credit_ring)(hal_soc_handle_t hal_soc_hdl,
					    hal_ring_handle_t hal_ring_hdl);
	uint32_t (*hal_tx_comp_get_buffer_source)(void *hal_desc);
	uint32_t (*hal_tx_get_num_ppe_vp_tbl_entries)(
					hal_soc_handle_t hal_soc_hdl);

	void (*hal_reo_config_reo2ppe_dest_info)(hal_soc_handle_t hal_soc_hdl);

	void (*hal_tx_set_ppe_cmn_cfg)(hal_soc_handle_t hal_soc_hdl,
				       union hal_tx_cmn_config_ppe *cmn_cfg);
	void (*hal_tx_set_ppe_vp_entry)(hal_soc_handle_t hal_soc_hdl,
					union hal_tx_ppe_vp_config *vp_cfg,
					int ppe_vp_idx);
	void (*hal_tx_set_ppe_pri2tid)(hal_soc_handle_t hal_soc_hdl,
				       uint32_t val,
				       uint8_t map_no);
	void (*hal_tx_update_ppe_pri2tid)(hal_soc_handle_t hal_soc_hdl,
					  uint8_t pri,
					  uint8_t tid);
	void (*hal_tx_dump_ppe_vp_entry)(hal_soc_handle_t hal_soc_hdl);
	void (*hal_tx_enable_pri2tid_map)(hal_soc_handle_t hal_soc_hdl,
					  bool value, uint8_t ppe_vp_idx);
	void (*hal_tx_config_rbm_mapping_be)(hal_soc_handle_t hal_soc_hdl,
					     hal_ring_handle_t hal_ring_hdl,
					     uint8_t rbm_id);

	/* rx */
	uint32_t (*hal_rx_msdu_start_nss_get)(uint8_t *);
	void (*hal_rx_mon_hw_desc_get_mpdu_status)(void *hw_desc_addr,
						   struct mon_rx_status *rs);
	uint8_t (*hal_rx_get_tlv)(void *rx_tlv);
	void (*hal_rx_proc_phyrx_other_receive_info_tlv)(void *rx_tlv_hdr,
							void *ppdu_info_handle);
	void (*hal_rx_dump_msdu_start_tlv)(void *msdu_start, uint8_t dbg_level);
	void (*hal_rx_dump_msdu_end_tlv)(void *msdu_end,
					 uint8_t dbg_level);
	uint32_t (*hal_get_link_desc_size)(void);
	uint32_t (*hal_rx_mpdu_start_tid_get)(uint8_t *buf);
	uint32_t (*hal_rx_msdu_start_reception_type_get)(uint8_t *buf);
	uint16_t (*hal_rx_msdu_end_da_idx_get)(uint8_t *buf);
	void* (*hal_rx_msdu_desc_info_get_ptr)(void *msdu_details_ptr);
	void* (*hal_rx_link_desc_msdu0_ptr)(void *msdu_link_ptr);
	void (*hal_reo_status_get_header)(hal_ring_desc_t ring_desc, int b,
					  void *h);
	uint32_t (*hal_rx_status_get_tlv_info)(void *rx_tlv_hdr,
					       void *ppdu_info,
					       hal_soc_handle_t hal_soc_hdl,
					       qdf_nbuf_t nbuf);

	void (*hal_rx_wbm_rel_buf_paddr_get)(hal_ring_desc_t rx_desc,
					     struct hal_buf_info *buf_info);

	void (*hal_rx_wbm_err_info_get)(void *wbm_desc,
				void *wbm_er_info);
	void (*hal_rx_dump_mpdu_start_tlv)(void *mpdustart,
						uint8_t dbg_level);

	void (*hal_tx_set_pcp_tid_map)(struct hal_soc *hal_soc, uint8_t *map);
	void (*hal_tx_update_pcp_tid_map)(struct hal_soc *hal_soc, uint8_t pcp,
					  uint8_t id);
	void (*hal_tx_set_tidmap_prty)(struct hal_soc *hal_soc, uint8_t prio);

	/* rx */
	uint8_t (*hal_rx_get_rx_fragment_number)(uint8_t *buf);
	uint8_t (*hal_rx_msdu_end_da_is_mcbc_get)(uint8_t *buf);
	uint8_t (*hal_rx_msdu_end_is_tkip_mic_err)(uint8_t *buf);
	uint8_t (*hal_rx_msdu_end_sa_is_valid_get)(uint8_t *buf);
	uint16_t (*hal_rx_msdu_end_sa_idx_get)(uint8_t *buf);
	uint32_t (*hal_rx_desc_is_first_msdu)(void *hw_desc_addr);
	uint32_t (*hal_rx_msdu_end_l3_hdr_padding_get)(uint8_t *buf);
	uint32_t (*hal_rx_encryption_info_valid)(uint8_t *buf);
	void (*hal_rx_print_pn)(uint8_t *buf);
	uint8_t (*hal_rx_msdu_end_first_msdu_get)(uint8_t *buf);
	uint8_t (*hal_rx_msdu_end_da_is_valid_get)(uint8_t *buf);
	uint8_t (*hal_rx_msdu_end_last_msdu_get)(uint8_t *buf);
	bool (*hal_rx_get_mpdu_mac_ad4_valid)(uint8_t *buf);
	uint32_t (*hal_rx_mpdu_start_sw_peer_id_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_peer_meta_data_get)(uint8_t *buf);
	uint32_t (*hal_rx_mpdu_get_to_ds)(uint8_t *buf);
	uint32_t (*hal_rx_mpdu_get_fr_ds)(uint8_t *buf);
	uint8_t (*hal_rx_get_mpdu_frame_control_valid)(uint8_t *buf);
	QDF_STATUS
		(*hal_rx_mpdu_get_addr1)(uint8_t *buf, uint8_t *mac_addr);
	QDF_STATUS
		(*hal_rx_mpdu_get_addr2)(uint8_t *buf, uint8_t *mac_addr);
	QDF_STATUS
		(*hal_rx_mpdu_get_addr3)(uint8_t *buf, uint8_t *mac_addr);
	QDF_STATUS
		(*hal_rx_mpdu_get_addr4)(uint8_t *buf, uint8_t *mac_addr);
	uint8_t (*hal_rx_get_mpdu_sequence_control_valid)(uint8_t *buf);
	bool (*hal_rx_is_unicast)(uint8_t *buf);
	uint32_t (*hal_rx_tid_get)(hal_soc_handle_t hal_soc_hdl, uint8_t *buf);
	uint32_t (*hal_rx_hw_desc_get_ppduid_get)(void *rx_tlv_hdr,
						  void *rxdma_dst_ring_desc);
	uint32_t (*hal_rx_mpdu_start_mpdu_qos_control_valid_get)(uint8_t *buf);
	uint32_t (*hal_rx_msdu_end_sa_sw_peer_id_get)(uint8_t *buf);
	void * (*hal_rx_msdu0_buffer_addr_lsb)(void *link_desc_addr);
	void * (*hal_rx_msdu_desc_info_ptr_get)(void *msdu0);
	void * (*hal_ent_mpdu_desc_info)(void *hw_addr);
	void * (*hal_dst_mpdu_desc_info)(void *hw_addr);
	uint8_t (*hal_rx_get_fc_valid)(uint8_t *buf);
	uint8_t (*hal_rx_get_to_ds_flag)(uint8_t *buf);
	uint8_t (*hal_rx_get_mac_addr2_valid)(uint8_t *buf);
	uint8_t (*hal_rx_get_filter_category)(uint8_t *buf);
	uint32_t (*hal_rx_get_ppdu_id)(uint8_t *buf);
	void (*hal_reo_config)(struct hal_soc *soc,
			       uint32_t reg_val,
			       struct hal_reo_params *reo_params);
	uint32_t (*hal_rx_msdu_flow_idx_get)(uint8_t *buf);
	bool (*hal_rx_msdu_flow_idx_invalid)(uint8_t *buf);
	bool (*hal_rx_msdu_flow_idx_timeout)(uint8_t *buf);
	uint32_t (*hal_rx_msdu_fse_metadata_get)(uint8_t *buf);
	bool (*hal_rx_msdu_cce_match_get)(uint8_t *buf);
	uint16_t (*hal_rx_msdu_cce_metadata_get)(uint8_t *buf);
	void
	    (*hal_rx_msdu_get_flow_params)(
					  uint8_t *buf,
					  bool *flow_invalid,
					  bool *flow_timeout,
					  uint32_t *flow_index);
	uint16_t (*hal_rx_tlv_get_tcp_chksum)(uint8_t *buf);
	uint16_t (*hal_rx_get_rx_sequence)(uint8_t *buf);
	void (*hal_rx_get_bb_info)(void *rx_tlv, void *ppdu_info_handle);
	void (*hal_rx_get_rtt_info)(void *rx_tlv, void *ppdu_info_handle);
	void (*hal_rx_msdu_packet_metadata_get)(uint8_t *buf,
						void *msdu_pkt_metadata);
	uint16_t (*hal_rx_get_fisa_cumulative_l4_checksum)(uint8_t *buf);
	uint16_t (*hal_rx_get_fisa_cumulative_ip_length)(uint8_t *buf);
	bool (*hal_rx_get_udp_proto)(uint8_t *buf);
	bool (*hal_rx_get_fisa_flow_agg_continuation)(uint8_t *buf);
	uint8_t (*hal_rx_get_fisa_flow_agg_count)(uint8_t *buf);
	bool (*hal_rx_get_fisa_timeout)(uint8_t *buf);
	uint8_t (*hal_rx_mpdu_start_tlv_tag_valid)(void *rx_tlv_hdr);
	void (*hal_rx_sw_mon_desc_info_get)(hal_ring_desc_t rxdma_dst_ring_desc,
					    hal_rx_mon_desc_info_t mon_desc_info);
	uint8_t (*hal_rx_wbm_err_msdu_continuation_get)(void *ring_desc);
	uint32_t (*hal_rx_msdu_end_offset_get)(void);
	uint32_t (*hal_rx_attn_offset_get)(void);
	uint32_t (*hal_rx_msdu_start_offset_get)(void);
	uint32_t (*hal_rx_mpdu_start_offset_get)(void);
	uint32_t (*hal_rx_mpdu_end_offset_get)(void);
	uint32_t (*hal_rx_pkt_tlv_offset_get)(void);
	uint32_t (*hal_rx_msdu_end_wmask_get)(void);
	uint32_t (*hal_rx_mpdu_start_wmask_get)(void);
	void * (*hal_rx_flow_setup_fse)(uint8_t *rx_fst,
					uint32_t table_offset,
					uint8_t *rx_flow);
	void * (*hal_rx_flow_get_tuple_info)(uint8_t *rx_fst,
					     uint32_t hal_hash,
					     uint8_t *tuple_info);
	QDF_STATUS (*hal_rx_flow_delete_entry)(uint8_t *fst,
					       void *fse);
	uint32_t (*hal_rx_fst_get_fse_size)(void);
	void (*hal_compute_reo_remap_ix2_ix3)(uint32_t *ring,
					      uint32_t num_rings,
					      uint32_t *remap1,
					      uint32_t *remap2);
	void (*hal_compute_reo_remap_ix0)(uint32_t *remap0);
	uint32_t (*hal_rx_flow_setup_cmem_fse)(
				struct hal_soc *soc, uint32_t cmem_ba,
				uint32_t table_offset, uint8_t *rx_flow);
	uint32_t (*hal_rx_flow_get_cmem_fse_ts)(struct hal_soc *soc,
						uint32_t fse_offset);
	void (*hal_rx_flow_get_cmem_fse)(struct hal_soc *soc,
					 uint32_t fse_offset,
					 uint32_t *fse, qdf_size_t len);

	void (*hal_cmem_write)(hal_soc_handle_t hal_soc_hdl, uint32_t offset,
			       uint32_t value);

	void (*hal_rx_msdu_get_reo_destination_indication)(uint8_t *buf,
							   uint32_t *reo_destination_indication);
	uint8_t (*hal_tx_get_num_tcl_banks)(void);
	uint32_t (*hal_get_reo_qdesc_size)(uint32_t ba_window_size, int tid);
	uint16_t (*hal_get_rx_max_ba_window)(int tid);

	void (*hal_set_link_desc_addr)(void *desc, uint32_t cookie,
				       qdf_dma_addr_t link_desc_paddr,
				       uint8_t bm_id);
	void (*hal_tx_init_data_ring)(hal_soc_handle_t hal_soc_hdl,
				      hal_ring_handle_t hal_ring_hdl);
	void* (*hal_rx_msdu_ext_desc_info_get_ptr)(void *msdu_details_ptr);
	void (*hal_get_ba_aging_timeout)(hal_soc_handle_t hal_soc_hdl,
					 uint8_t ac, uint32_t *value);
	void (*hal_set_ba_aging_timeout)(hal_soc_handle_t hal_soc_hdl,
					 uint8_t ac, uint32_t value);
	uint32_t (*hal_get_reo_reg_base_offset)(void);
	void (*hal_rx_get_tlv_size)(uint16_t *rx_pkt_tlv_size,
				    uint16_t *rx_mon_pkt_tlv_size);
	uint32_t (*hal_rx_msdu_is_wlan_mcast)(qdf_nbuf_t nbuf);
	uint32_t (*hal_rx_tlv_decap_format_get)(void *hw_desc_addr);
	void (*hal_rx_dump_pkt_tlvs)(hal_soc_handle_t hal_soc_hdl,
				     uint8_t *buf, uint8_t dbg_level);
	int (*hal_rx_tlv_get_offload_info)(uint8_t *rx_tlv,
					   struct hal_offload_info *offload_info);
	uint16_t (*hal_rx_tlv_phy_ppdu_id_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_msdu_done_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_msdu_len_get)(uint8_t *buf);
	uint16_t (*hal_rx_get_frame_ctrl_field)(uint8_t *buf);
	int (*hal_rx_get_proto_params)(uint8_t *buf, void *fisa_params);
	int (*hal_rx_get_l3_l4_offsets)(uint8_t *buf, uint32_t *l3_hdr_offset,
					uint32_t *l4_hdr_offset);
	uint32_t (*hal_rx_tlv_mic_err_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_get_pkt_type)(uint8_t *buf);
	void (*hal_rx_tlv_get_pn_num)(uint8_t *buf, uint64_t *pn_num);
	void (*hal_rx_reo_prev_pn_get)(void *ring_desc, uint64_t *prev_pn);
	uint8_t * (*hal_rx_pkt_hdr_get)(uint8_t *buf);
	uint32_t (*hal_rx_msdu_reo_dst_ind_get)(hal_soc_handle_t hal_soc_hdl,
						void *msdu_link_desc);
	void (*hal_msdu_desc_info_set)(hal_soc_handle_t hal_soc_hdl,
				       void *msdu_desc_info, uint32_t dst_ind,
				       uint32_t nbuf_len);
	void (*hal_mpdu_desc_info_set)(hal_soc_handle_t hal_soc_hdl,
				       void *ent_desc,
				       void *mpdu_desc_info,
				       uint32_t seq_no);
#ifdef DP_UMAC_HW_RESET_SUPPORT
	void (*hal_unregister_reo_send_cmd)(struct hal_soc *hal_soc);
	void (*hal_register_reo_send_cmd)(struct hal_soc *hal_soc);
	void (*hal_reset_rx_reo_tid_q)(struct hal_soc *hal_soc,
				       void *hw_qdesc_vaddr, uint32_t size);
#endif
	uint32_t (*hal_rx_tlv_sgi_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_get_freq)(uint8_t *buf);
	uint8_t (*hal_rx_msdu_get_keyid)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_rate_mcs_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_decrypt_err_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_first_mpdu_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_bw_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_get_is_decrypted)(uint8_t *buf);

	uint32_t (*hal_rx_wbm_err_src_get)(hal_ring_desc_t ring_desc);
	uint8_t (*hal_rx_ret_buf_manager_get)(hal_ring_desc_t ring_desc);
	void (*hal_rx_msdu_link_desc_set)(hal_soc_handle_t hal_soc_hdl,
					  void *src_srng_desc,
					  hal_buff_addrinfo_t buf_addr_info,
					  uint8_t bm_action);

	void (*hal_rx_buf_cookie_rbm_get)(uint32_t *buf_addr_info_hdl,
					  hal_buf_info_t buf_info_hdl);
	void (*hal_rx_reo_buf_paddr_get)(hal_ring_desc_t rx_desc,
					 struct hal_buf_info *buf_info);
	void (*hal_rxdma_buff_addr_info_set)(void *rxdma_entry,
					     qdf_dma_addr_t paddr,
					     uint32_t cookie, uint8_t manager);
	uint32_t (*hal_rx_msdu_flags_get)(rx_msdu_desc_info_t msdu_desc_info_hdl);
	uint32_t (*hal_rx_get_reo_error_code)(hal_ring_desc_t rx_desc);
	void (*hal_rx_tlv_csum_err_get)(uint8_t *rx_tlv_hdr,
					uint32_t *ip_csum_err,
					uint32_t *tcp_udp_csum_err);
	void (*hal_rx_mpdu_desc_info_get)(void *desc_addr,
					  void *mpdu_desc_info_hdl);
	uint8_t (*hal_rx_err_status_get)(hal_ring_desc_t rx_desc);
	uint8_t (*hal_rx_reo_buf_type_get)(hal_ring_desc_t rx_desc);
	bool (*hal_rx_mpdu_info_ampdu_flag_get)(uint8_t *buf);
	uint32_t (*hal_rx_tlv_mpdu_len_err_get)(void *hw_desc_addr);
	uint32_t (*hal_rx_tlv_mpdu_fcs_err_get)(void *hw_desc_addr);
	void (*hal_rx_tlv_get_pkt_capture_flags)(uint8_t *rx_tlv_hdr,
						 struct hal_rx_pkt_capture_flags *flags);
	uint8_t *(*hal_rx_desc_get_80211_hdr)(void *hw_desc_addr);
	uint32_t (*hal_rx_hw_desc_mpdu_user_id)(void *hw_desc_addr);
	void (*hal_rx_priv_info_set_in_tlv)(uint8_t *buf,
					    uint8_t *priv_data,
					    uint32_t len);
	void (*hal_rx_priv_info_get_from_tlv)(uint8_t *buf,
					      uint8_t *priv_data,
					      uint32_t len);
	void (*hal_rx_tlv_msdu_len_set)(uint8_t *buf, uint32_t len);
	void (*hal_rx_tlv_populate_mpdu_desc_info)(uint8_t *buf,
						   void *mpdu_desc_info_hdl);
	uint8_t *(*hal_get_reo_ent_desc_qdesc_addr)(uint8_t *desc);
	uint64_t (*hal_rx_get_qdesc_addr)(uint8_t *dst_ring_desc,
					  uint8_t *buf);
	void (*hal_set_reo_ent_desc_reo_dest_ind)(uint8_t *desc,
						  uint32_t dst_ind);
	QDF_STATUS
	(*hal_rx_reo_ent_get_src_link_id)(hal_rxdma_desc_t rx_desc,
					  uint8_t *src_link_id);

	/* REO CMD and STATUS */
	int (*hal_reo_send_cmd)(hal_soc_handle_t hal_soc_hdl,
				hal_ring_handle_t  hal_ring_hdl,
				enum hal_reo_cmd_type cmd,
				void *params);
	QDF_STATUS (*hal_reo_status_update)(hal_soc_handle_t hal_soc_hdl,
					    hal_ring_desc_t reo_desc,
					    void *st_handle,
					    uint32_t tlv, int *num_ref);
	uint8_t (*hal_get_tlv_hdr_size)(void);
	uint8_t (*hal_get_idle_link_bm_id)(uint8_t chip_id);

	bool (*hal_txmon_is_mon_buf_addr_tlv)(void *tx_tlv_hdr);
	void (*hal_txmon_populate_packet_info)(void *tx_tlv_hdr,
					       void *pkt_info);
	/* TX MONITOR */
#ifdef QCA_MONITOR_2_0_SUPPORT
	uint32_t (*hal_txmon_status_parse_tlv)(void *data_ppdu_info,
					       void *prot_ppdu_info,
					       void *data_status_info,
					       void *prot_status_info,
					       void *tx_tlv_hdr,
					       qdf_frag_t status_frag);
	uint32_t (*hal_txmon_status_get_num_users)(void *tx_tlv_hdr,
						   uint8_t *num_users);
#endif /* QCA_MONITOR_2_0_SUPPORT */
	void (*hal_reo_shared_qaddr_setup)(hal_soc_handle_t hal_soc_hdl);
	void (*hal_reo_shared_qaddr_init)(hal_soc_handle_t hal_soc_hdl,
					  int qref_reset);
	void (*hal_reo_shared_qaddr_detach)(hal_soc_handle_t hal_soc_hdl);
	void (*hal_reo_shared_qaddr_write)(hal_soc_handle_t hal_soc_hdl,
					   uint16_t peer_id,
					   int tid,
					   qdf_dma_addr_t hw_qdesc_paddr);
#ifdef WLAN_FEATURE_MARK_FIRST_WAKEUP_PACKET
	uint8_t (*hal_get_first_wow_wakeup_packet)(uint8_t *buf);
#endif
	void (*hal_reo_shared_qaddr_cache_clear)(hal_soc_handle_t hal_soc_hdl);
	uint32_t (*hal_rx_tlv_l3_type_get)(uint8_t *buf);
	void (*hal_tx_vdev_mismatch_routing_set)(hal_soc_handle_t hal_soc_hdl,
			enum hal_tx_vdev_mismatch_notify config);
	void (*hal_tx_mcast_mlo_reinject_routing_set)(
			hal_soc_handle_t hal_soc_hdl,
			enum hal_tx_mcast_mlo_reinject_notify config);
	void (*hal_cookie_conversion_reg_cfg_be)(hal_soc_handle_t hal_soc_hdl,
						 struct hal_hw_cc_config
						 *cc_cfg);
	void (*hal_tx_populate_bank_register)(hal_soc_handle_t hal_soc_hdl,
					      union hal_tx_bank_config *config,
					      uint8_t bank_id);
	void (*hal_tx_vdev_mcast_ctrl_set)(hal_soc_handle_t hal_soc_hdl,
					   uint8_t vdev_id,
					   uint8_t mcast_ctrl_val);
	void (*hal_get_tsf_time)(hal_soc_handle_t hal_soc_hdl, uint32_t tsf_id,
				 uint32_t mac_id, uint64_t *tsf,
				 uint64_t *tsf_sync_soc_time);
	void (*hal_get_tsf2_scratch_reg)(hal_soc_handle_t hal_soc_hdl,
					 uint8_t mac_id, uint64_t *value);
	void (*hal_get_tqm_scratch_reg)(hal_soc_handle_t hal_soc_hdl,
					uint64_t *value);
#ifdef FEATURE_DIRECT_LINK
	QDF_STATUS (*hal_srng_set_msi_config)(hal_ring_handle_t ring_hdl,
					      void *ring_params);
#endif
};

/**
 * struct hal_soc_stats - Hal layer stats
 * @reg_write_fail: number of failed register writes
 * @wstats: delayed register write stats
 * @shadow_reg_write_fail: shadow reg write failure stats
 * @shadow_reg_write_succ: shadow reg write success stats
 *
 * This structure holds all the statistics at HAL layer.
 */
struct hal_soc_stats {
	uint32_t reg_write_fail;
#if defined(FEATURE_HAL_DELAYED_REG_WRITE)
	struct hal_reg_write_soc_stats wstats;
#endif
#ifdef GENERIC_SHADOW_REGISTER_ACCESS_ENABLE
	uint32_t shadow_reg_write_fail;
	uint32_t shadow_reg_write_succ;
#endif
};

#ifdef ENABLE_HAL_REG_WR_HISTORY
/* The history size should always be a power of 2 */
#define HAL_REG_WRITE_HIST_SIZE 8

/**
 * struct hal_reg_write_fail_entry - Record of
 *		register write which failed.
 * @timestamp: timestamp of reg write failure
 * @reg_offset: offset of register where the write failed
 * @write_val: the value which was to be written
 * @read_val: the value read back from the register after write
 */
struct hal_reg_write_fail_entry {
	uint64_t timestamp;
	uint32_t reg_offset;
	uint32_t write_val;
	uint32_t read_val;
};

/**
 * struct hal_reg_write_fail_history - Hal layer history
 *		of all the register write failures.
 * @index: index to add the new record
 * @record: array of all the records in history
 *
 * This structure holds the history of register write
 * failures at HAL layer.
 */
struct hal_reg_write_fail_history {
	qdf_atomic_t index;
	struct hal_reg_write_fail_entry record[HAL_REG_WRITE_HIST_SIZE];
};
#endif

/**
 * struct reo_queue_ref_table - Reo qref LUT addr
 * @mlo_reo_qref_table_vaddr: MLO table vaddr
 * @non_mlo_reo_qref_table_vaddr: Non MLO table vaddr
 * @mlo_reo_qref_table_paddr: MLO table paddr
 * @non_mlo_reo_qref_table_paddr: Non MLO table paddr
 * @reo_qref_table_en: Enable flag
 */
struct reo_queue_ref_table {
	uint64_t *mlo_reo_qref_table_vaddr;
	uint64_t *non_mlo_reo_qref_table_vaddr;
	qdf_dma_addr_t mlo_reo_qref_table_paddr;
	qdf_dma_addr_t non_mlo_reo_qref_table_paddr;
	uint8_t reo_qref_table_en;
};

/**
 * union hal_shadow_reg_cfg - Shadow register config
 * @addr: Place holder where shadow address is saved
 * @v2: shadow config v2 format
 * @v3: shadow config v3 format
 */
union hal_shadow_reg_cfg {
	uint32_t addr;
	struct pld_shadow_reg_v2_cfg v2;
#ifdef CONFIG_SHADOW_V3
	struct pld_shadow_reg_v3_cfg v3;
#endif
};

#ifdef HAL_RECORD_SUSPEND_WRITE
#define HAL_SUSPEND_WRITE_HISTORY_MAX 256

struct hal_suspend_write_record {
	uint64_t ts;
	uint8_t ring_id;
	uit32_t value;
	uint32_t direct_wcount;
};

struct hal_suspend_write_history {
	qdf_atomic_t index;
	struct hal_suspend_write_record record[HAL_SUSPEND_WRITE_HISTORY_MAX];

};
#endif

/**
 * struct hal_soc - HAL context to be used to access SRNG APIs
 *		    (currently used by data path and
 *		    transport (CE) modules)
 * @list_shadow_reg_config: array of generic regs mapped to
 *			    shadow regs
 * @num_generic_shadow_regs_configured: number of generic regs
 *					mapped to shadow regs
 */
struct hal_soc {
	/* HIF handle to access HW registers */
	struct hif_opaque_softc *hif_handle;

	/* QDF device handle */
	qdf_device_t qdf_dev;

	/* Device base address */
	void *dev_base_addr;
	/* Device base address for ce - qca5018 target */
	void *dev_base_addr_ce;

	void *dev_base_addr_cmem;
	/* HAL internal state for all SRNG rings.
	 * TODO: See if this is required
	 */
	struct hal_srng srng_list[HAL_SRNG_ID_MAX];

	/* Remote pointer memory for HW/FW updates */
	uint32_t *shadow_rdptr_mem_vaddr;
	qdf_dma_addr_t shadow_rdptr_mem_paddr;

	/* Shared memory for ring pointer updates from host to FW */
	uint32_t *shadow_wrptr_mem_vaddr;
	qdf_dma_addr_t shadow_wrptr_mem_paddr;

	/* REO blocking resource index */
	uint8_t reo_res_bitmap;
	uint8_t index;
	uint32_t target_type;
	uint32_t version;

	/* shadow register configuration */
	union hal_shadow_reg_cfg shadow_config[MAX_SHADOW_REGISTERS];
	int num_shadow_registers_configured;
	bool use_register_windowing;
	uint32_t register_window;
	qdf_spinlock_t register_access_lock;

	/* Static window map configuration for multiple window write*/
	bool static_window_map;

	/* srng table */
	struct hal_hw_srng_config *hw_srng_table;
	int32_t hal_hw_reg_offset[SRNG_REGISTER_MAX];
	struct hal_hw_txrx_ops *ops;

	/* Indicate srngs initialization */
	bool init_phase;
	/* Hal level stats */
	struct hal_soc_stats stats;
#ifdef ENABLE_HAL_REG_WR_HISTORY
	struct hal_reg_write_fail_history *reg_wr_fail_hist;
#endif
#ifdef FEATURE_HAL_DELAYED_REG_WRITE
	/* queue(array) to hold register writes */
	struct hal_reg_write_q_elem *reg_write_queue;
	/* delayed work to be queued into workqueue */
	qdf_work_t reg_write_work;
	/* workqueue for delayed register writes */
	qdf_workqueue_t *reg_write_wq;
	/* write index used by caller to enqueue delayed work */
	qdf_atomic_t write_idx;
	/* read index used by worker thread to dequeue/write registers */
	uint32_t read_idx;
#endif /*FEATURE_HAL_DELAYED_REG_WRITE */
	qdf_atomic_t active_work_cnt;
#ifdef GENERIC_SHADOW_REGISTER_ACCESS_ENABLE
	struct shadow_reg_config
		list_shadow_reg_config[MAX_GENERIC_SHADOW_REG];
	int num_generic_shadow_regs_configured;
#endif
	/* flag to indicate cmn dmac rings in berryllium */
	bool dmac_cmn_src_rxbuf_ring;
	/* Reo queue ref table items */
	struct reo_queue_ref_table reo_qref;
};

#if defined(FEATURE_HAL_DELAYED_REG_WRITE)
/**
 *  hal_delayed_reg_write() - delayed register write
 * @hal_soc: HAL soc handle
 * @srng: hal srng
 * @addr: iomem address
 * @value: value to be written
 *
 * Return: none
 */
void hal_delayed_reg_write(struct hal_soc *hal_soc,
			   struct hal_srng *srng,
			   void __iomem *addr,
			   uint32_t value);
#endif

void hal_qca6750_attach(struct hal_soc *hal_soc);
void hal_qca6490_attach(struct hal_soc *hal_soc);
void hal_qca6390_attach(struct hal_soc *hal_soc);
void hal_qca6290_attach(struct hal_soc *hal_soc);
void hal_qca8074_attach(struct hal_soc *hal_soc);
void hal_kiwi_attach(struct hal_soc *hal_soc);
void hal_qcn9224v1_attach(struct hal_soc *hal_soc);
void hal_qcn9224v2_attach(struct hal_soc *hal_soc);
/*
 * hal_soc_to_dp_hal_roc - API to convert hal_soc to opaque
 * dp_hal_soc handle type
 * @hal_soc - hal_soc type
 *
 * Return: hal_soc_handle_t type
 */
static inline
hal_soc_handle_t hal_soc_to_hal_soc_handle(struct hal_soc *hal_soc)
{
	return (hal_soc_handle_t)hal_soc;
}

/*
 * hal_srng_to_hal_ring_handle - API to convert hal_srng to opaque
 * dp_hal_ring handle type
 * @hal_srng - hal_srng type
 *
 * Return: hal_ring_handle_t type
 */
static inline
hal_ring_handle_t hal_srng_to_hal_ring_handle(struct hal_srng *hal_srng)
{
	return (hal_ring_handle_t)hal_srng;
}

/*
 * hal_ring_handle_to_hal_srng - API to convert dp_hal_ring to hal_srng handle
 * @hal_ring - hal_ring_handle_t type
 *
 * Return: hal_srng pointer type
 */
static inline
struct hal_srng *hal_ring_handle_to_hal_srng(hal_ring_handle_t hal_ring)
{
	return (struct hal_srng *)hal_ring;
}

/* Size of REO queue reference table in Host
 * 2k peers * 17 tids * 8bytes(rx_reo_queue_reference)
 * = 278528 bytes
 */
#define REO_QUEUE_REF_NON_ML_TABLE_SIZE 278528
/* Calculated based on 512 MLO peers */
#define REO_QUEUE_REF_ML_TABLE_SIZE 69632
#define HAL_ML_PEER_ID_START 0x2000
#define HAL_PEER_ID_IS_MLO(peer_id) ((peer_id) & HAL_ML_PEER_ID_START)

/*
 * REO2PPE destination indication
 */
#define REO2PPE_DST_IND 6
#define REO2PPE_DST_RING 11
#define REO2PPE_RULE_FAIL_FB 0x2000

/**
 * enum hal_pkt_type - Type of packet type reported by HW
 * @HAL_DOT11A: 802.11a PPDU type
 * @HAL_DOT11B: 802.11b PPDU type
 * @HAL_DOT11N_MM: 802.11n Mixed Mode PPDU type
 * @HAL_DOT11AC: 802.11ac PPDU type
 * @HAL_DOT11AX: 802.11ax PPDU type
 * @HAL_DOT11BA: 802.11ba (WUR) PPDU type
 * @HAL_DOT11BE: 802.11be PPDU type
 * @HAL_DOT11AZ: 802.11az (ranging) PPDU type
 * @HAL_DOT11N_GF: 802.11n Green Field PPDU type
 *
 * Enum indicating the packet type reported by HW in rx_pkt_tlvs (RX data)
 * or WBM2SW ring entry's descriptor (TX data completion)
 */
enum hal_pkt_type {
	HAL_DOT11A = 0,
	HAL_DOT11B = 1,
	HAL_DOT11N_MM = 2,
	HAL_DOT11AC = 3,
	HAL_DOT11AX = 4,
	HAL_DOT11BA = 5,
	HAL_DOT11BE = 6,
	HAL_DOT11AZ = 7,
	HAL_DOT11N_GF = 8,
	HAL_DOT11_MAX,
};

#endif /* _HAL_INTERNAL_H_ */