xref: /freebsd/sys/contrib/dev/athk/ath11k/hw.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /* SPDX-License-Identifier: BSD-3-Clause-Clear */
2 /*
3  * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
4  * Copyright (c) 2021-2022, Qualcomm Innovation Center, Inc. All rights reserved.
5  */
6 
7 #ifndef ATH11K_HW_H
8 #define ATH11K_HW_H
9 
10 #include "hal.h"
11 #include "wmi.h"
12 
13 /* Target configuration defines */
14 
15 /* Num VDEVS per radio */
16 #define TARGET_NUM_VDEVS(ab)	(ab->hw_params.num_vdevs)
17 
18 #define TARGET_NUM_PEERS_PDEV(ab) (ab->hw_params.num_peers + TARGET_NUM_VDEVS(ab))
19 
20 /* Num of peers for Single Radio mode */
21 #define TARGET_NUM_PEERS_SINGLE(ab) (TARGET_NUM_PEERS_PDEV(ab))
22 
23 /* Num of peers for DBS */
24 #define TARGET_NUM_PEERS_DBS(ab) (2 * TARGET_NUM_PEERS_PDEV(ab))
25 
26 /* Num of peers for DBS_SBS */
27 #define TARGET_NUM_PEERS_DBS_SBS(ab)	(3 * TARGET_NUM_PEERS_PDEV(ab))
28 
29 /* Max num of stations (per radio) */
30 #define TARGET_NUM_STATIONS(ab)	(ab->hw_params.num_peers)
31 
32 #define TARGET_NUM_PEERS(ab, x)	TARGET_NUM_PEERS_##x(ab)
33 #define TARGET_NUM_PEER_KEYS	2
34 #define TARGET_NUM_TIDS(ab, x)	(2 * TARGET_NUM_PEERS(ab, x) +	\
35 				 4 * TARGET_NUM_VDEVS(ab) + 8)
36 
37 #define TARGET_AST_SKID_LIMIT	16
38 #define TARGET_NUM_OFFLD_PEERS	4
39 #define TARGET_NUM_OFFLD_REORDER_BUFFS 4
40 
41 #define TARGET_TX_CHAIN_MASK	(BIT(0) | BIT(1) | BIT(2) | BIT(4))
42 #define TARGET_RX_CHAIN_MASK	(BIT(0) | BIT(1) | BIT(2) | BIT(4))
43 #define TARGET_RX_TIMEOUT_LO_PRI	100
44 #define TARGET_RX_TIMEOUT_HI_PRI	40
45 
46 #define TARGET_DECAP_MODE_RAW		0
47 #define TARGET_DECAP_MODE_NATIVE_WIFI	1
48 #define TARGET_DECAP_MODE_ETH		2
49 
50 #define TARGET_SCAN_MAX_PENDING_REQS	4
51 #define TARGET_BMISS_OFFLOAD_MAX_VDEV	3
52 #define TARGET_ROAM_OFFLOAD_MAX_VDEV	3
53 #define TARGET_ROAM_OFFLOAD_MAX_AP_PROFILES	8
54 #define TARGET_GTK_OFFLOAD_MAX_VDEV	3
55 #define TARGET_NUM_MCAST_GROUPS		12
56 #define TARGET_NUM_MCAST_TABLE_ELEMS	64
57 #define TARGET_MCAST2UCAST_MODE		2
58 #define TARGET_TX_DBG_LOG_SIZE		1024
59 #define TARGET_RX_SKIP_DEFRAG_TIMEOUT_DUP_DETECTION_CHECK 1
60 #define TARGET_VOW_CONFIG		0
61 #define TARGET_NUM_MSDU_DESC		(2500)
62 #define TARGET_MAX_FRAG_ENTRIES		6
63 #define TARGET_MAX_BCN_OFFLD		16
64 #define TARGET_NUM_WDS_ENTRIES		32
65 #define TARGET_DMA_BURST_SIZE		1
66 #define TARGET_RX_BATCHMODE		1
67 #define TARGET_EMA_MAX_PROFILE_PERIOD	8
68 
69 #define ATH11K_HW_MAX_QUEUES		4
70 #define ATH11K_QUEUE_LEN		4096
71 
72 #define ATH11k_HW_RATECODE_CCK_SHORT_PREAM_MASK  0x4
73 
74 #define ATH11K_FW_DIR			"ath11k"
75 
76 #define ATH11K_BOARD_MAGIC		"QCA-ATH11K-BOARD"
77 #define ATH11K_BOARD_API2_FILE		"board-2.bin"
78 #define ATH11K_DEFAULT_BOARD_FILE	"board.bin"
79 #define ATH11K_DEFAULT_CAL_FILE		"caldata.bin"
80 #define ATH11K_AMSS_FILE		"amss.bin"
81 #define ATH11K_M3_FILE			"m3.bin"
82 #define ATH11K_REGDB_FILE_NAME		"regdb.bin"
83 
84 #if defined(__linux__)
85 #define ATH11K_CE_OFFSET(ab)	(ab->mem_ce - ab->mem)
86 #elif defined(__FreeBSD__)
87 #define ATH11K_CE_OFFSET(ab)	((char *)ab->mem_ce - (char *)ab->mem)
88 #endif
89 
90 enum ath11k_hw_rate_cck {
91 	ATH11K_HW_RATE_CCK_LP_11M = 0,
92 	ATH11K_HW_RATE_CCK_LP_5_5M,
93 	ATH11K_HW_RATE_CCK_LP_2M,
94 	ATH11K_HW_RATE_CCK_LP_1M,
95 	ATH11K_HW_RATE_CCK_SP_11M,
96 	ATH11K_HW_RATE_CCK_SP_5_5M,
97 	ATH11K_HW_RATE_CCK_SP_2M,
98 };
99 
100 enum ath11k_hw_rate_ofdm {
101 	ATH11K_HW_RATE_OFDM_48M = 0,
102 	ATH11K_HW_RATE_OFDM_24M,
103 	ATH11K_HW_RATE_OFDM_12M,
104 	ATH11K_HW_RATE_OFDM_6M,
105 	ATH11K_HW_RATE_OFDM_54M,
106 	ATH11K_HW_RATE_OFDM_36M,
107 	ATH11K_HW_RATE_OFDM_18M,
108 	ATH11K_HW_RATE_OFDM_9M,
109 };
110 
111 enum ath11k_bus {
112 	ATH11K_BUS_AHB,
113 	ATH11K_BUS_PCI,
114 };
115 
116 #define ATH11K_EXT_IRQ_GRP_NUM_MAX 11
117 
118 struct hal_rx_desc;
119 struct hal_tcl_data_cmd;
120 
121 struct ath11k_hw_ring_mask {
122 	u8 tx[ATH11K_EXT_IRQ_GRP_NUM_MAX];
123 	u8 rx_mon_status[ATH11K_EXT_IRQ_GRP_NUM_MAX];
124 	u8 rx[ATH11K_EXT_IRQ_GRP_NUM_MAX];
125 	u8 rx_err[ATH11K_EXT_IRQ_GRP_NUM_MAX];
126 	u8 rx_wbm_rel[ATH11K_EXT_IRQ_GRP_NUM_MAX];
127 	u8 reo_status[ATH11K_EXT_IRQ_GRP_NUM_MAX];
128 	u8 rxdma2host[ATH11K_EXT_IRQ_GRP_NUM_MAX];
129 	u8 host2rxdma[ATH11K_EXT_IRQ_GRP_NUM_MAX];
130 };
131 
132 struct ath11k_hw_tcl2wbm_rbm_map {
133 	u8 tcl_ring_num;
134 	u8 wbm_ring_num;
135 	u8 rbm_id;
136 };
137 
138 struct ath11k_hw_hal_params {
139 	enum hal_rx_buf_return_buf_manager rx_buf_rbm;
140 	const struct ath11k_hw_tcl2wbm_rbm_map *tcl2wbm_rbm_map;
141 };
142 
143 struct ath11k_hw_params {
144 	const char *name;
145 	u16 hw_rev;
146 	u8 max_radios;
147 	u32 bdf_addr;
148 
149 	struct {
150 		const char *dir;
151 		size_t board_size;
152 		size_t cal_offset;
153 	} fw;
154 
155 	const struct ath11k_hw_ops *hw_ops;
156 	const struct ath11k_hw_ring_mask *ring_mask;
157 
158 	bool internal_sleep_clock;
159 
160 	const struct ath11k_hw_regs *regs;
161 	u32 qmi_service_ins_id;
162 	const struct ce_attr *host_ce_config;
163 	u32 ce_count;
164 	const struct ce_pipe_config *target_ce_config;
165 	u32 target_ce_count;
166 	const struct service_to_pipe *svc_to_ce_map;
167 	u32 svc_to_ce_map_len;
168 	const struct ce_ie_addr *ce_ie_addr;
169 	const struct ce_remap *ce_remap;
170 
171 	bool single_pdev_only;
172 
173 	bool rxdma1_enable;
174 	int num_rxmda_per_pdev;
175 	bool rx_mac_buf_ring;
176 	bool vdev_start_delay;
177 	bool htt_peer_map_v2;
178 
179 	struct {
180 		u8 fft_sz;
181 		u8 fft_pad_sz;
182 		u8 summary_pad_sz;
183 		u8 fft_hdr_len;
184 		u16 max_fft_bins;
185 		bool fragment_160mhz;
186 	} spectral;
187 
188 	u16 interface_modes;
189 	bool supports_monitor;
190 	bool full_monitor_mode;
191 	bool supports_shadow_regs;
192 	bool idle_ps;
193 	bool supports_sta_ps;
194 	bool coldboot_cal_mm;
195 	bool coldboot_cal_ftm;
196 	bool cbcal_restart_fw;
197 	int fw_mem_mode;
198 	u32 num_vdevs;
199 	u32 num_peers;
200 	bool supports_suspend;
201 	u32 hal_desc_sz;
202 	bool supports_regdb;
203 	bool fix_l1ss;
204 	bool credit_flow;
205 	u8 max_tx_ring;
206 	const struct ath11k_hw_hal_params *hal_params;
207 	bool supports_dynamic_smps_6ghz;
208 	bool alloc_cacheable_memory;
209 	bool supports_rssi_stats;
210 	bool fw_wmi_diag_event;
211 	bool current_cc_support;
212 	bool dbr_debug_support;
213 	bool global_reset;
214 	const struct cfg80211_sar_capa *bios_sar_capa;
215 	bool m3_fw_support;
216 	bool fixed_bdf_addr;
217 	bool fixed_mem_region;
218 	bool static_window_map;
219 	bool hybrid_bus_type;
220 	bool fixed_fw_mem;
221 	bool support_off_channel_tx;
222 	bool supports_multi_bssid;
223 
224 	struct {
225 		u32 start;
226 		u32 end;
227 	} sram_dump;
228 
229 	bool tcl_ring_retry;
230 	u32 tx_ring_size;
231 	bool smp2p_wow_exit;
232 	bool support_fw_mac_sequence;
233 };
234 
235 struct ath11k_hw_ops {
236 	u8 (*get_hw_mac_from_pdev_id)(int pdev_id);
237 	void (*wmi_init_config)(struct ath11k_base *ab,
238 				struct target_resource_config *config);
239 	int (*mac_id_to_pdev_id)(struct ath11k_hw_params *hw, int mac_id);
240 	int (*mac_id_to_srng_id)(struct ath11k_hw_params *hw, int mac_id);
241 	void (*tx_mesh_enable)(struct ath11k_base *ab,
242 			       struct hal_tcl_data_cmd *tcl_cmd);
243 	bool (*rx_desc_get_first_msdu)(struct hal_rx_desc *desc);
244 	bool (*rx_desc_get_last_msdu)(struct hal_rx_desc *desc);
245 	u8 (*rx_desc_get_l3_pad_bytes)(struct hal_rx_desc *desc);
246 	u8 *(*rx_desc_get_hdr_status)(struct hal_rx_desc *desc);
247 	bool (*rx_desc_encrypt_valid)(struct hal_rx_desc *desc);
248 	u32 (*rx_desc_get_encrypt_type)(struct hal_rx_desc *desc);
249 	u8 (*rx_desc_get_decap_type)(struct hal_rx_desc *desc);
250 	u8 (*rx_desc_get_mesh_ctl)(struct hal_rx_desc *desc);
251 	bool (*rx_desc_get_ldpc_support)(struct hal_rx_desc *desc);
252 	bool (*rx_desc_get_mpdu_seq_ctl_vld)(struct hal_rx_desc *desc);
253 	bool (*rx_desc_get_mpdu_fc_valid)(struct hal_rx_desc *desc);
254 	u16 (*rx_desc_get_mpdu_start_seq_no)(struct hal_rx_desc *desc);
255 	u16 (*rx_desc_get_msdu_len)(struct hal_rx_desc *desc);
256 	u8 (*rx_desc_get_msdu_sgi)(struct hal_rx_desc *desc);
257 	u8 (*rx_desc_get_msdu_rate_mcs)(struct hal_rx_desc *desc);
258 	u8 (*rx_desc_get_msdu_rx_bw)(struct hal_rx_desc *desc);
259 	u32 (*rx_desc_get_msdu_freq)(struct hal_rx_desc *desc);
260 	u8 (*rx_desc_get_msdu_pkt_type)(struct hal_rx_desc *desc);
261 	u8 (*rx_desc_get_msdu_nss)(struct hal_rx_desc *desc);
262 	u8 (*rx_desc_get_mpdu_tid)(struct hal_rx_desc *desc);
263 	u16 (*rx_desc_get_mpdu_peer_id)(struct hal_rx_desc *desc);
264 	void (*rx_desc_copy_attn_end_tlv)(struct hal_rx_desc *fdesc,
265 					  struct hal_rx_desc *ldesc);
266 	u32 (*rx_desc_get_mpdu_start_tag)(struct hal_rx_desc *desc);
267 	u32 (*rx_desc_get_mpdu_ppdu_id)(struct hal_rx_desc *desc);
268 	void (*rx_desc_set_msdu_len)(struct hal_rx_desc *desc, u16 len);
269 	struct rx_attention *(*rx_desc_get_attention)(struct hal_rx_desc *desc);
270 	u8 *(*rx_desc_get_msdu_payload)(struct hal_rx_desc *desc);
271 	void (*reo_setup)(struct ath11k_base *ab);
272 	u16 (*mpdu_info_get_peerid)(struct hal_rx_mpdu_info *mpdu_info);
273 	bool (*rx_desc_mac_addr2_valid)(struct hal_rx_desc *desc);
274 	u8* (*rx_desc_mpdu_start_addr2)(struct hal_rx_desc *desc);
275 	u32 (*get_ring_selector)(struct sk_buff *skb);
276 };
277 
278 extern const struct ath11k_hw_ops ipq8074_ops;
279 extern const struct ath11k_hw_ops ipq6018_ops;
280 extern const struct ath11k_hw_ops qca6390_ops;
281 extern const struct ath11k_hw_ops qcn9074_ops;
282 extern const struct ath11k_hw_ops wcn6855_ops;
283 extern const struct ath11k_hw_ops wcn6750_ops;
284 extern const struct ath11k_hw_ops ipq5018_ops;
285 
286 extern const struct ath11k_hw_ring_mask ath11k_hw_ring_mask_ipq8074;
287 extern const struct ath11k_hw_ring_mask ath11k_hw_ring_mask_qca6390;
288 extern const struct ath11k_hw_ring_mask ath11k_hw_ring_mask_qcn9074;
289 extern const struct ath11k_hw_ring_mask ath11k_hw_ring_mask_wcn6750;
290 
291 extern const struct ce_ie_addr ath11k_ce_ie_addr_ipq8074;
292 extern const struct ce_ie_addr ath11k_ce_ie_addr_ipq5018;
293 
294 extern const struct ce_remap ath11k_ce_remap_ipq5018;
295 
296 extern const struct ath11k_hw_hal_params ath11k_hw_hal_params_ipq8074;
297 extern const struct ath11k_hw_hal_params ath11k_hw_hal_params_qca6390;
298 extern const struct ath11k_hw_hal_params ath11k_hw_hal_params_wcn6750;
299 
300 static inline
301 int ath11k_hw_get_mac_from_pdev_id(struct ath11k_hw_params *hw,
302 				   int pdev_idx)
303 {
304 	if (hw->hw_ops->get_hw_mac_from_pdev_id)
305 		return hw->hw_ops->get_hw_mac_from_pdev_id(pdev_idx);
306 
307 	return 0;
308 }
309 
310 static inline int ath11k_hw_mac_id_to_pdev_id(struct ath11k_hw_params *hw,
311 					      int mac_id)
312 {
313 	if (hw->hw_ops->mac_id_to_pdev_id)
314 		return hw->hw_ops->mac_id_to_pdev_id(hw, mac_id);
315 
316 	return 0;
317 }
318 
319 static inline int ath11k_hw_mac_id_to_srng_id(struct ath11k_hw_params *hw,
320 					      int mac_id)
321 {
322 	if (hw->hw_ops->mac_id_to_srng_id)
323 		return hw->hw_ops->mac_id_to_srng_id(hw, mac_id);
324 
325 	return 0;
326 }
327 
328 struct ath11k_fw_ie {
329 	__le32 id;
330 	__le32 len;
331 	u8 data[];
332 };
333 
334 enum ath11k_bd_ie_board_type {
335 	ATH11K_BD_IE_BOARD_NAME = 0,
336 	ATH11K_BD_IE_BOARD_DATA = 1,
337 };
338 
339 enum ath11k_bd_ie_regdb_type {
340 	ATH11K_BD_IE_REGDB_NAME = 0,
341 	ATH11K_BD_IE_REGDB_DATA = 1,
342 };
343 
344 enum ath11k_bd_ie_type {
345 	/* contains sub IEs of enum ath11k_bd_ie_board_type */
346 	ATH11K_BD_IE_BOARD = 0,
347 	/* contains sub IEs of enum ath11k_bd_ie_regdb_type */
348 	ATH11K_BD_IE_REGDB = 1,
349 };
350 
351 struct ath11k_hw_regs {
352 	u32 hal_tcl1_ring_base_lsb;
353 	u32 hal_tcl1_ring_base_msb;
354 	u32 hal_tcl1_ring_id;
355 	u32 hal_tcl1_ring_misc;
356 	u32 hal_tcl1_ring_tp_addr_lsb;
357 	u32 hal_tcl1_ring_tp_addr_msb;
358 	u32 hal_tcl1_ring_consumer_int_setup_ix0;
359 	u32 hal_tcl1_ring_consumer_int_setup_ix1;
360 	u32 hal_tcl1_ring_msi1_base_lsb;
361 	u32 hal_tcl1_ring_msi1_base_msb;
362 	u32 hal_tcl1_ring_msi1_data;
363 	u32 hal_tcl2_ring_base_lsb;
364 	u32 hal_tcl_ring_base_lsb;
365 
366 	u32 hal_tcl_status_ring_base_lsb;
367 
368 	u32 hal_reo1_ring_base_lsb;
369 	u32 hal_reo1_ring_base_msb;
370 	u32 hal_reo1_ring_id;
371 	u32 hal_reo1_ring_misc;
372 	u32 hal_reo1_ring_hp_addr_lsb;
373 	u32 hal_reo1_ring_hp_addr_msb;
374 	u32 hal_reo1_ring_producer_int_setup;
375 	u32 hal_reo1_ring_msi1_base_lsb;
376 	u32 hal_reo1_ring_msi1_base_msb;
377 	u32 hal_reo1_ring_msi1_data;
378 	u32 hal_reo2_ring_base_lsb;
379 	u32 hal_reo1_aging_thresh_ix_0;
380 	u32 hal_reo1_aging_thresh_ix_1;
381 	u32 hal_reo1_aging_thresh_ix_2;
382 	u32 hal_reo1_aging_thresh_ix_3;
383 
384 	u32 hal_reo1_ring_hp;
385 	u32 hal_reo1_ring_tp;
386 	u32 hal_reo2_ring_hp;
387 
388 	u32 hal_reo_tcl_ring_base_lsb;
389 	u32 hal_reo_tcl_ring_hp;
390 
391 	u32 hal_reo_status_ring_base_lsb;
392 	u32 hal_reo_status_hp;
393 
394 	u32 hal_reo_cmd_ring_base_lsb;
395 	u32 hal_reo_cmd_ring_hp;
396 
397 	u32 hal_sw2reo_ring_base_lsb;
398 	u32 hal_sw2reo_ring_hp;
399 
400 	u32 hal_seq_wcss_umac_ce0_src_reg;
401 	u32 hal_seq_wcss_umac_ce0_dst_reg;
402 	u32 hal_seq_wcss_umac_ce1_src_reg;
403 	u32 hal_seq_wcss_umac_ce1_dst_reg;
404 
405 	u32 hal_wbm_idle_link_ring_base_lsb;
406 	u32 hal_wbm_idle_link_ring_misc;
407 
408 	u32 hal_wbm_release_ring_base_lsb;
409 
410 	u32 hal_wbm0_release_ring_base_lsb;
411 	u32 hal_wbm1_release_ring_base_lsb;
412 
413 	u32 pcie_qserdes_sysclk_en_sel;
414 	u32 pcie_pcs_osc_dtct_config_base;
415 
416 	u32 hal_shadow_base_addr;
417 	u32 hal_reo1_misc_ctl;
418 };
419 
420 extern const struct ath11k_hw_regs ipq8074_regs;
421 extern const struct ath11k_hw_regs qca6390_regs;
422 extern const struct ath11k_hw_regs qcn9074_regs;
423 extern const struct ath11k_hw_regs wcn6855_regs;
424 extern const struct ath11k_hw_regs wcn6750_regs;
425 extern const struct ath11k_hw_regs ipq5018_regs;
426 
427 static inline const char *ath11k_bd_ie_type_str(enum ath11k_bd_ie_type type)
428 {
429 	switch (type) {
430 	case ATH11K_BD_IE_BOARD:
431 		return "board data";
432 	case ATH11K_BD_IE_REGDB:
433 		return "regdb data";
434 	}
435 
436 	return "unknown";
437 }
438 
439 extern const struct cfg80211_sar_capa ath11k_hw_sar_capa_wcn6855;
440 
441 #endif
442