xref: /linux/drivers/net/wireless/ath/ath12k/hw.h (revision 0b897fbd900e12a08baa3d1a0457944046a882ea)
1 /* SPDX-License-Identifier: BSD-3-Clause-Clear */
2 /*
3  * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved.
4  * Copyright (c) 2021-2025 Qualcomm Innovation Center, Inc. All rights reserved.
5  */
6 
7 #ifndef ATH12K_HW_H
8 #define ATH12K_HW_H
9 
10 #include <linux/mhi.h>
11 #include <linux/uuid.h>
12 
13 #include "wmi.h"
14 #include "hal.h"
15 
16 /* Target configuration defines */
17 
18 /* Num VDEVS per radio */
19 #define TARGET_NUM_VDEVS	(16 + 1)
20 
21 #define TARGET_NUM_PEERS_PDEV_SINGLE	(TARGET_NUM_STATIONS_SINGLE + \
22 					 TARGET_NUM_VDEVS)
23 #define TARGET_NUM_PEERS_PDEV_DBS	(TARGET_NUM_STATIONS_DBS + \
24 					 TARGET_NUM_VDEVS)
25 #define TARGET_NUM_PEERS_PDEV_DBS_SBS	(TARGET_NUM_STATIONS_DBS_SBS + \
26 					 TARGET_NUM_VDEVS)
27 
28 /* Num of peers for Single Radio mode */
29 #define TARGET_NUM_PEERS_SINGLE		(TARGET_NUM_PEERS_PDEV_SINGLE)
30 
31 /* Num of peers for DBS */
32 #define TARGET_NUM_PEERS_DBS		(2 * TARGET_NUM_PEERS_PDEV_DBS)
33 
34 /* Num of peers for DBS_SBS */
35 #define TARGET_NUM_PEERS_DBS_SBS	(3 * TARGET_NUM_PEERS_PDEV_DBS_SBS)
36 
37 /* Max num of stations for Single Radio mode */
38 #define TARGET_NUM_STATIONS_SINGLE	512
39 
40 /* Max num of stations for DBS */
41 #define TARGET_NUM_STATIONS_DBS		128
42 
43 /* Max num of stations for DBS_SBS */
44 #define TARGET_NUM_STATIONS_DBS_SBS	128
45 
46 #define TARGET_NUM_PEERS(x)	TARGET_NUM_PEERS_##x
47 #define TARGET_NUM_PEER_KEYS	2
48 #define TARGET_NUM_TIDS(x)	(2 * TARGET_NUM_PEERS(x) + \
49 				 4 * TARGET_NUM_VDEVS + 8)
50 
51 #define TARGET_AST_SKID_LIMIT	16
52 #define TARGET_NUM_OFFLD_PEERS	4
53 #define TARGET_NUM_OFFLD_REORDER_BUFFS 4
54 
55 #define TARGET_TX_CHAIN_MASK	(BIT(0) | BIT(1) | BIT(2) | BIT(4))
56 #define TARGET_RX_CHAIN_MASK	(BIT(0) | BIT(1) | BIT(2) | BIT(4))
57 #define TARGET_RX_TIMEOUT_LO_PRI	100
58 #define TARGET_RX_TIMEOUT_HI_PRI	40
59 
60 #define TARGET_DECAP_MODE_RAW		0
61 #define TARGET_DECAP_MODE_NATIVE_WIFI	1
62 #define TARGET_DECAP_MODE_ETH		2
63 
64 #define TARGET_SCAN_MAX_PENDING_REQS	4
65 #define TARGET_BMISS_OFFLOAD_MAX_VDEV	3
66 #define TARGET_ROAM_OFFLOAD_MAX_VDEV	3
67 #define TARGET_ROAM_OFFLOAD_MAX_AP_PROFILES	8
68 #define TARGET_GTK_OFFLOAD_MAX_VDEV	3
69 #define TARGET_NUM_MCAST_GROUPS		12
70 #define TARGET_NUM_MCAST_TABLE_ELEMS	64
71 #define TARGET_MCAST2UCAST_MODE		2
72 #define TARGET_TX_DBG_LOG_SIZE		1024
73 #define TARGET_RX_SKIP_DEFRAG_TIMEOUT_DUP_DETECTION_CHECK 1
74 #define TARGET_VOW_CONFIG		0
75 #define TARGET_NUM_MSDU_DESC		(2500)
76 #define TARGET_MAX_FRAG_ENTRIES		6
77 #define TARGET_MAX_BCN_OFFLD		16
78 #define TARGET_NUM_WDS_ENTRIES		32
79 #define TARGET_DMA_BURST_SIZE		1
80 #define TARGET_RX_BATCHMODE		1
81 #define TARGET_EMA_MAX_PROFILE_PERIOD	8
82 
83 #define ATH12K_HW_DEFAULT_QUEUE		0
84 #define ATH12K_HW_MAX_QUEUES		4
85 #define ATH12K_QUEUE_LEN		4096
86 
87 #define ATH12K_HW_RATECODE_CCK_SHORT_PREAM_MASK  0x4
88 
89 #define ATH12K_FW_DIR			"ath12k"
90 
91 #define ATH12K_BOARD_MAGIC		"QCA-ATH12K-BOARD"
92 #define ATH12K_BOARD_API2_FILE		"board-2.bin"
93 #define ATH12K_DEFAULT_BOARD_FILE	"board.bin"
94 #define ATH12K_DEFAULT_CAL_FILE		"caldata.bin"
95 #define ATH12K_AMSS_FILE		"amss.bin"
96 #define ATH12K_M3_FILE			"m3.bin"
97 #define ATH12K_REGDB_FILE_NAME		"regdb.bin"
98 
99 #define ATH12K_PCIE_MAX_PAYLOAD_SIZE	128
100 #define ATH12K_IPQ5332_USERPD_ID	1
101 
102 enum ath12k_hw_rate_cck {
103 	ATH12K_HW_RATE_CCK_LP_11M = 0,
104 	ATH12K_HW_RATE_CCK_LP_5_5M,
105 	ATH12K_HW_RATE_CCK_LP_2M,
106 	ATH12K_HW_RATE_CCK_LP_1M,
107 	ATH12K_HW_RATE_CCK_SP_11M,
108 	ATH12K_HW_RATE_CCK_SP_5_5M,
109 	ATH12K_HW_RATE_CCK_SP_2M,
110 };
111 
112 enum ath12k_hw_rate_ofdm {
113 	ATH12K_HW_RATE_OFDM_48M = 0,
114 	ATH12K_HW_RATE_OFDM_24M,
115 	ATH12K_HW_RATE_OFDM_12M,
116 	ATH12K_HW_RATE_OFDM_6M,
117 	ATH12K_HW_RATE_OFDM_54M,
118 	ATH12K_HW_RATE_OFDM_36M,
119 	ATH12K_HW_RATE_OFDM_18M,
120 	ATH12K_HW_RATE_OFDM_9M,
121 };
122 
123 enum ath12k_bus {
124 	ATH12K_BUS_PCI,
125 	ATH12K_BUS_AHB,
126 };
127 
128 #define ATH12K_EXT_IRQ_GRP_NUM_MAX 11
129 
130 struct hal_rx_desc;
131 struct hal_tcl_data_cmd;
132 struct htt_rx_ring_tlv_filter;
133 enum hal_encrypt_type;
134 
135 struct ath12k_hw_ring_mask {
136 	u8 tx[ATH12K_EXT_IRQ_GRP_NUM_MAX];
137 	u8 rx_mon_dest[ATH12K_EXT_IRQ_GRP_NUM_MAX];
138 	u8 rx[ATH12K_EXT_IRQ_GRP_NUM_MAX];
139 	u8 rx_err[ATH12K_EXT_IRQ_GRP_NUM_MAX];
140 	u8 rx_wbm_rel[ATH12K_EXT_IRQ_GRP_NUM_MAX];
141 	u8 reo_status[ATH12K_EXT_IRQ_GRP_NUM_MAX];
142 	u8 host2rxdma[ATH12K_EXT_IRQ_GRP_NUM_MAX];
143 	u8 tx_mon_dest[ATH12K_EXT_IRQ_GRP_NUM_MAX];
144 };
145 
146 struct ath12k_hw_hal_params {
147 	enum hal_rx_buf_return_buf_manager rx_buf_rbm;
148 	u32	  wbm2sw_cc_enable;
149 };
150 
151 enum ath12k_m3_fw_loaders {
152 	ath12k_m3_fw_loader_driver,
153 	ath12k_m3_fw_loader_remoteproc,
154 };
155 
156 struct ath12k_hw_params {
157 	const char *name;
158 	u16 hw_rev;
159 
160 	struct {
161 		const char *dir;
162 		size_t board_size;
163 		size_t cal_offset;
164 		enum ath12k_m3_fw_loaders m3_loader;
165 	} fw;
166 
167 	u8 max_radios;
168 	bool single_pdev_only:1;
169 	u32 qmi_service_ins_id;
170 	bool internal_sleep_clock:1;
171 
172 	const struct ath12k_hw_ops *hw_ops;
173 	const struct ath12k_hw_ring_mask *ring_mask;
174 	const struct ath12k_hw_regs *regs;
175 
176 	const struct ce_attr *host_ce_config;
177 	u32 ce_count;
178 	const struct ce_pipe_config *target_ce_config;
179 	u32 target_ce_count;
180 	const struct service_to_pipe *svc_to_ce_map;
181 	u32 svc_to_ce_map_len;
182 
183 	const struct ath12k_hw_hal_params *hal_params;
184 
185 	bool rxdma1_enable:1;
186 	int num_rxdma_per_pdev;
187 	int num_rxdma_dst_ring;
188 	bool rx_mac_buf_ring:1;
189 	bool vdev_start_delay:1;
190 
191 	u16 interface_modes;
192 	bool supports_monitor:1;
193 
194 	bool idle_ps:1;
195 	bool download_calib:1;
196 	bool supports_suspend:1;
197 	bool tcl_ring_retry:1;
198 	bool reoq_lut_support:1;
199 	bool supports_shadow_regs:1;
200 	bool supports_aspm:1;
201 	bool current_cc_support:1;
202 
203 	u32 num_tcl_banks;
204 	u32 max_tx_ring;
205 
206 	const struct mhi_controller_config *mhi_config;
207 
208 	void (*wmi_init)(struct ath12k_base *ab,
209 			 struct ath12k_wmi_resource_config_arg *config);
210 
211 	const struct hal_ops *hal_ops;
212 
213 	u64 qmi_cnss_feature_bitmap;
214 
215 	u32 rfkill_pin;
216 	u32 rfkill_cfg;
217 	u32 rfkill_on_level;
218 
219 	u32 rddm_size;
220 
221 	u8 def_num_link;
222 	u16 max_mlo_peer;
223 
224 	u32 otp_board_id_register;
225 
226 	bool supports_sta_ps;
227 
228 	const guid_t *acpi_guid;
229 	bool supports_dynamic_smps_6ghz;
230 
231 	u32 iova_mask;
232 
233 	const struct ce_ie_addr *ce_ie_addr;
234 	const struct ce_remap *ce_remap;
235 	u32 bdf_addr_offset;
236 
237 	/* setup REO queue, frag etc only for primary link peer */
238 	bool dp_primary_link_only:1;
239 };
240 
241 struct ath12k_hw_ops {
242 	u8 (*get_hw_mac_from_pdev_id)(int pdev_id);
243 	int (*mac_id_to_pdev_id)(const struct ath12k_hw_params *hw, int mac_id);
244 	int (*mac_id_to_srng_id)(const struct ath12k_hw_params *hw, int mac_id);
245 	int (*rxdma_ring_sel_config)(struct ath12k_base *ab);
246 	u8 (*get_ring_selector)(struct sk_buff *skb);
247 	bool (*dp_srng_is_tx_comp_ring)(int ring_num);
248 };
249 
250 static inline
251 int ath12k_hw_get_mac_from_pdev_id(const struct ath12k_hw_params *hw,
252 				   int pdev_idx)
253 {
254 	if (hw->hw_ops->get_hw_mac_from_pdev_id)
255 		return hw->hw_ops->get_hw_mac_from_pdev_id(pdev_idx);
256 
257 	return 0;
258 }
259 
260 static inline int ath12k_hw_mac_id_to_pdev_id(const struct ath12k_hw_params *hw,
261 					      int mac_id)
262 {
263 	if (hw->hw_ops->mac_id_to_pdev_id)
264 		return hw->hw_ops->mac_id_to_pdev_id(hw, mac_id);
265 
266 	return 0;
267 }
268 
269 static inline int ath12k_hw_mac_id_to_srng_id(const struct ath12k_hw_params *hw,
270 					      int mac_id)
271 {
272 	if (hw->hw_ops->mac_id_to_srng_id)
273 		return hw->hw_ops->mac_id_to_srng_id(hw, mac_id);
274 
275 	return 0;
276 }
277 
278 struct ath12k_fw_ie {
279 	__le32 id;
280 	__le32 len;
281 	u8 data[];
282 };
283 
284 enum ath12k_bd_ie_board_type {
285 	ATH12K_BD_IE_BOARD_NAME = 0,
286 	ATH12K_BD_IE_BOARD_DATA = 1,
287 };
288 
289 enum ath12k_bd_ie_regdb_type {
290 	ATH12K_BD_IE_REGDB_NAME = 0,
291 	ATH12K_BD_IE_REGDB_DATA = 1,
292 };
293 
294 enum ath12k_bd_ie_type {
295 	/* contains sub IEs of enum ath12k_bd_ie_board_type */
296 	ATH12K_BD_IE_BOARD = 0,
297 	/* contains sub IEs of enum ath12k_bd_ie_regdb_type */
298 	ATH12K_BD_IE_REGDB = 1,
299 };
300 
301 struct ath12k_hw_regs {
302 	u32 hal_tcl1_ring_id;
303 	u32 hal_tcl1_ring_misc;
304 	u32 hal_tcl1_ring_tp_addr_lsb;
305 	u32 hal_tcl1_ring_tp_addr_msb;
306 	u32 hal_tcl1_ring_consumer_int_setup_ix0;
307 	u32 hal_tcl1_ring_consumer_int_setup_ix1;
308 	u32 hal_tcl1_ring_msi1_base_lsb;
309 	u32 hal_tcl1_ring_msi1_base_msb;
310 	u32 hal_tcl1_ring_msi1_data;
311 	u32 hal_tcl_ring_base_lsb;
312 	u32 hal_tcl1_ring_base_lsb;
313 	u32 hal_tcl1_ring_base_msb;
314 	u32 hal_tcl2_ring_base_lsb;
315 
316 	u32 hal_tcl_status_ring_base_lsb;
317 
318 	u32 hal_reo1_qdesc_addr;
319 	u32 hal_reo1_qdesc_max_peerid;
320 
321 	u32 hal_wbm_idle_ring_base_lsb;
322 	u32 hal_wbm_idle_ring_misc_addr;
323 	u32 hal_wbm_r0_idle_list_cntl_addr;
324 	u32 hal_wbm_r0_idle_list_size_addr;
325 	u32 hal_wbm_scattered_ring_base_lsb;
326 	u32 hal_wbm_scattered_ring_base_msb;
327 	u32 hal_wbm_scattered_desc_head_info_ix0;
328 	u32 hal_wbm_scattered_desc_head_info_ix1;
329 	u32 hal_wbm_scattered_desc_tail_info_ix0;
330 	u32 hal_wbm_scattered_desc_tail_info_ix1;
331 	u32 hal_wbm_scattered_desc_ptr_hp_addr;
332 
333 	u32 hal_wbm_sw_release_ring_base_lsb;
334 	u32 hal_wbm_sw1_release_ring_base_lsb;
335 	u32 hal_wbm0_release_ring_base_lsb;
336 	u32 hal_wbm1_release_ring_base_lsb;
337 
338 	u32 pcie_qserdes_sysclk_en_sel;
339 	u32 pcie_pcs_osc_dtct_config_base;
340 
341 	u32 hal_umac_ce0_src_reg_base;
342 	u32 hal_umac_ce0_dest_reg_base;
343 	u32 hal_umac_ce1_src_reg_base;
344 	u32 hal_umac_ce1_dest_reg_base;
345 
346 	u32 hal_ppe_rel_ring_base;
347 
348 	u32 hal_reo2_ring_base;
349 	u32 hal_reo1_misc_ctrl_addr;
350 	u32 hal_reo1_sw_cookie_cfg0;
351 	u32 hal_reo1_sw_cookie_cfg1;
352 	u32 hal_reo1_qdesc_lut_base0;
353 	u32 hal_reo1_qdesc_lut_base1;
354 	u32 hal_reo1_ring_base_lsb;
355 	u32 hal_reo1_ring_base_msb;
356 	u32 hal_reo1_ring_id;
357 	u32 hal_reo1_ring_misc;
358 	u32 hal_reo1_ring_hp_addr_lsb;
359 	u32 hal_reo1_ring_hp_addr_msb;
360 	u32 hal_reo1_ring_producer_int_setup;
361 	u32 hal_reo1_ring_msi1_base_lsb;
362 	u32 hal_reo1_ring_msi1_base_msb;
363 	u32 hal_reo1_ring_msi1_data;
364 	u32 hal_reo1_aging_thres_ix0;
365 	u32 hal_reo1_aging_thres_ix1;
366 	u32 hal_reo1_aging_thres_ix2;
367 	u32 hal_reo1_aging_thres_ix3;
368 
369 	u32 hal_reo2_sw0_ring_base;
370 
371 	u32 hal_sw2reo_ring_base;
372 	u32 hal_sw2reo1_ring_base;
373 
374 	u32 hal_reo_cmd_ring_base;
375 
376 	u32 hal_reo_status_ring_base;
377 };
378 
379 static inline const char *ath12k_bd_ie_type_str(enum ath12k_bd_ie_type type)
380 {
381 	switch (type) {
382 	case ATH12K_BD_IE_BOARD:
383 		return "board data";
384 	case ATH12K_BD_IE_REGDB:
385 		return "regdb data";
386 	}
387 
388 	return "unknown";
389 }
390 
391 int ath12k_hw_init(struct ath12k_base *ab);
392 
393 #endif
394