1 /* SPDX-License-Identifier: BSD-3-Clause-Clear */
3 * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved.
4 * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
10 #include <linux/mutex.h>
11 #include <linux/soc/qcom/qmi.h>
13 #define ATH12K_HOST_VERSION_STRING "WIN"
14 #define ATH12K_QMI_WLANFW_TIMEOUT_MS 10000
15 #define ATH12K_QMI_MAX_BDF_FILE_NAME_SIZE 64
16 #define ATH12K_QMI_CALDB_ADDRESS 0x4BA00000
17 #define ATH12K_QMI_WLANFW_MAX_BUILD_ID_LEN_V01 128
18 #define ATH12K_QMI_WLFW_NODE_ID_BASE 0x07
19 #define ATH12K_QMI_WLFW_SERVICE_ID_V01 0x45
20 #define ATH12K_QMI_WLFW_SERVICE_VERS_V01 0x01
21 #define ATH12K_QMI_WLFW_SERVICE_INS_ID_V01 0x02
22 #define ATH12K_QMI_WLFW_SERVICE_INS_ID_V01_WCN7850 0x1
24 #define ATH12K_QMI_WLFW_SERVICE_INS_ID_V01_QCN9274 0x07
25 #define ATH12K_QMI_WLANFW_MAX_TIMESTAMP_LEN_V01 32
26 #define ATH12K_QMI_RESP_LEN_MAX 8192
27 #define ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01 52
28 #define ATH12K_QMI_CALDB_SIZE 0x480000
29 #define ATH12K_QMI_BDF_EXT_STR_LENGTH 0x20
30 #define ATH12K_QMI_FW_MEM_REQ_SEGMENT_CNT 3
31 #define ATH12K_QMI_WLFW_MAX_DEV_MEM_NUM_V01 4
32 #define ATH12K_QMI_DEVMEM_CMEM_INDEX 0
34 #define QMI_WLFW_REQUEST_MEM_IND_V01 0x0035
35 #define QMI_WLFW_FW_MEM_READY_IND_V01 0x0037
36 #define QMI_WLFW_FW_READY_IND_V01 0x0038
38 #define QMI_WLANFW_MAX_DATA_SIZE_V01 6144
39 #define ATH12K_FIRMWARE_MODE_OFF 4
40 #define ATH12K_QMI_TARGET_MEM_MODE_DEFAULT 0
42 #define ATH12K_BOARD_ID_DEFAULT 0xFF
46 enum ath12k_qmi_file_type {
47 ATH12K_QMI_FILE_TYPE_BDF_GOLDEN = 0,
48 ATH12K_QMI_FILE_TYPE_CALDATA = 2,
49 ATH12K_QMI_FILE_TYPE_EEPROM = 3,
50 ATH12K_QMI_MAX_FILE_TYPE = 4,
53 enum ath12k_qmi_bdf_type {
54 ATH12K_QMI_BDF_TYPE_BIN = 0,
55 ATH12K_QMI_BDF_TYPE_ELF = 1,
56 ATH12K_QMI_BDF_TYPE_REGDB = 4,
57 ATH12K_QMI_BDF_TYPE_CALIBRATION = 5,
60 enum ath12k_qmi_event_type {
61 ATH12K_QMI_EVENT_SERVER_ARRIVE,
62 ATH12K_QMI_EVENT_SERVER_EXIT,
63 ATH12K_QMI_EVENT_REQUEST_MEM,
64 ATH12K_QMI_EVENT_FW_MEM_READY,
65 ATH12K_QMI_EVENT_FW_READY,
66 ATH12K_QMI_EVENT_REGISTER_DRIVER,
67 ATH12K_QMI_EVENT_UNREGISTER_DRIVER,
68 ATH12K_QMI_EVENT_RECOVERY,
69 ATH12K_QMI_EVENT_FORCE_FW_ASSERT,
70 ATH12K_QMI_EVENT_POWER_UP,
71 ATH12K_QMI_EVENT_POWER_DOWN,
75 struct ath12k_qmi_driver_event {
76 struct list_head list;
77 enum ath12k_qmi_event_type type;
81 struct ath12k_qmi_ce_cfg {
82 const struct ce_pipe_config *tgt_ce;
84 const struct service_to_pipe *svc_to_ce_map;
85 int svc_to_ce_map_len;
89 int shadow_reg_v3_len;
92 struct ath12k_qmi_event_msg {
93 struct list_head list;
94 enum ath12k_qmi_event_type type;
97 struct target_mem_chunk {
102 void __iomem *ioaddr;
114 char fw_build_timestamp[ATH12K_QMI_WLANFW_MAX_TIMESTAMP_LEN_V01 + 1];
115 char fw_build_id[ATH12K_QMI_WLANFW_MAX_BUILD_ID_LEN_V01 + 1];
116 char bdf_ext[ATH12K_QMI_BDF_EXT_STR_LENGTH];
119 struct m3_mem_region {
125 struct dev_mem_info {
131 struct ath12k_base *ab;
132 struct qmi_handle handle;
133 struct sockaddr_qrtr sq;
134 struct work_struct event_work;
135 struct workqueue_struct *event_wq;
136 struct list_head event_list;
137 spinlock_t event_lock; /* spinlock for qmi event list */
138 struct ath12k_qmi_ce_cfg ce_cfg;
139 struct target_mem_chunk target_mem[ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01];
142 bool target_mem_delayed;
144 struct target_info target;
145 struct m3_mem_region m3_mem;
146 unsigned int service_ins_id;
147 struct dev_mem_info dev_mem[ATH12K_QMI_WLFW_MAX_DEV_MEM_NUM_V01];
150 #define QMI_WLANFW_HOST_CAP_REQ_MSG_V01_MAX_LEN 261
151 #define QMI_WLANFW_HOST_CAP_REQ_V01 0x0034
152 #define QMI_WLANFW_HOST_CAP_RESP_MSG_V01_MAX_LEN 7
153 #define QMI_WLFW_HOST_CAP_RESP_V01 0x0034
154 #define QMI_WLFW_MAX_NUM_GPIO_V01 32
155 #define QMI_WLANFW_MAX_PLATFORM_NAME_LEN_V01 64
156 #define QMI_WLANFW_MAX_HOST_DDR_RANGE_SIZE_V01 3
158 struct qmi_wlanfw_host_ddr_range {
163 enum ath12k_qmi_target_mem {
164 HOST_DDR_REGION_TYPE = 0x1,
165 BDF_MEM_REGION_TYPE = 0x2,
166 M3_DUMP_REGION_TYPE = 0x3,
167 CALDB_MEM_REGION_TYPE = 0x4,
168 PAGEABLE_MEM_REGION_TYPE = 0x9,
171 enum qmi_wlanfw_host_build_type {
172 WLANFW_HOST_BUILD_TYPE_ENUM_MIN_VAL_V01 = INT_MIN,
173 QMI_WLANFW_HOST_BUILD_TYPE_UNSPECIFIED_V01 = 0,
174 QMI_WLANFW_HOST_BUILD_TYPE_PRIMARY_V01 = 1,
175 QMI_WLANFW_HOST_BUILD_TYPE_SECONDARY_V01 = 2,
176 WLANFW_HOST_BUILD_TYPE_ENUM_MAX_VAL_V01 = INT_MAX,
179 #define QMI_WLFW_MAX_NUM_MLO_CHIPS_V01 3
180 #define QMI_WLFW_MAX_NUM_MLO_LINKS_PER_CHIP_V01 2
182 struct wlfw_host_mlo_chip_info_s_v01 {
185 u8 hw_link_id[QMI_WLFW_MAX_NUM_MLO_LINKS_PER_CHIP_V01];
186 u8 valid_mlo_link_id[QMI_WLFW_MAX_NUM_MLO_LINKS_PER_CHIP_V01];
189 enum ath12k_qmi_cnss_feature {
190 CNSS_FEATURE_MIN_ENUM_VAL_V01 = INT_MIN,
191 CNSS_QDSS_CFG_MISS_V01 = 3,
192 CNSS_MAX_FEATURE_V01 = 64,
193 CNSS_FEATURE_MAX_ENUM_VAL_V01 = INT_MAX,
196 struct qmi_wlanfw_host_cap_req_msg_v01 {
197 u8 num_clients_valid;
203 u32 gpios[QMI_WLFW_MAX_NUM_GPIO_V01];
206 u8 bdf_support_valid;
208 u8 bdf_cache_support_valid;
209 u8 bdf_cache_support;
212 u8 m3_cache_support_valid;
214 u8 cal_filesys_support_valid;
215 u8 cal_filesys_support;
216 u8 cal_cache_support_valid;
217 u8 cal_cache_support;
222 u8 mem_cfg_mode_valid;
224 u8 cal_duration_valid;
226 u8 platform_name_valid;
227 char platform_name[QMI_WLANFW_MAX_PLATFORM_NAME_LEN_V01 + 1];
229 struct qmi_wlanfw_host_ddr_range ddr_range[QMI_WLANFW_MAX_HOST_DDR_RANGE_SIZE_V01];
230 u8 host_build_type_valid;
231 enum qmi_wlanfw_host_build_type host_build_type;
232 u8 mlo_capable_valid;
234 u8 mlo_chip_id_valid;
236 u8 mlo_group_id_valid;
238 u8 max_mlo_peer_valid;
240 u8 mlo_num_chips_valid;
242 u8 mlo_chip_info_valid;
243 struct wlfw_host_mlo_chip_info_s_v01 mlo_chip_info[QMI_WLFW_MAX_NUM_MLO_CHIPS_V01];
244 u8 feature_list_valid;
249 struct qmi_wlanfw_host_cap_resp_msg_v01 {
250 struct qmi_response_type_v01 resp;
253 #define QMI_WLANFW_IND_REGISTER_REQ_MSG_V01_MAX_LEN 54
254 #define QMI_WLANFW_IND_REGISTER_REQ_V01 0x0020
255 #define QMI_WLANFW_IND_REGISTER_RESP_MSG_V01_MAX_LEN 18
256 #define QMI_WLANFW_IND_REGISTER_RESP_V01 0x0020
257 #define QMI_WLANFW_CLIENT_ID 0x4b4e454c
259 struct qmi_wlanfw_ind_register_req_msg_v01 {
260 u8 fw_ready_enable_valid;
262 u8 initiate_cal_download_enable_valid;
263 u8 initiate_cal_download_enable;
264 u8 initiate_cal_update_enable_valid;
265 u8 initiate_cal_update_enable;
266 u8 msa_ready_enable_valid;
268 u8 pin_connect_result_enable_valid;
269 u8 pin_connect_result_enable;
272 u8 request_mem_enable_valid;
273 u8 request_mem_enable;
274 u8 fw_mem_ready_enable_valid;
275 u8 fw_mem_ready_enable;
276 u8 fw_init_done_enable_valid;
277 u8 fw_init_done_enable;
278 u8 rejuvenate_enable_valid;
279 u32 rejuvenate_enable;
280 u8 xo_cal_enable_valid;
282 u8 cal_done_enable_valid;
286 struct qmi_wlanfw_ind_register_resp_msg_v01 {
287 struct qmi_response_type_v01 resp;
292 #define QMI_WLANFW_REQUEST_MEM_IND_MSG_V01_MAX_LEN 1824
293 #define QMI_WLANFW_RESPOND_MEM_REQ_MSG_V01_MAX_LEN 888
294 #define QMI_WLANFW_RESPOND_MEM_RESP_MSG_V01_MAX_LEN 7
295 #define QMI_WLANFW_REQUEST_MEM_IND_V01 0x0035
296 #define QMI_WLANFW_RESPOND_MEM_REQ_V01 0x0036
297 #define QMI_WLANFW_RESPOND_MEM_RESP_V01 0x0036
298 #define QMI_WLANFW_MAX_NUM_MEM_CFG_V01 2
299 #define QMI_WLANFW_MAX_STR_LEN_V01 16
301 struct qmi_wlanfw_mem_cfg_s_v01 {
307 enum qmi_wlanfw_mem_type_enum_v01 {
308 WLANFW_MEM_TYPE_ENUM_MIN_VAL_V01 = INT_MIN,
309 QMI_WLANFW_MEM_TYPE_MSA_V01 = 0,
310 QMI_WLANFW_MEM_TYPE_DDR_V01 = 1,
311 QMI_WLANFW_MEM_BDF_V01 = 2,
312 QMI_WLANFW_MEM_M3_V01 = 3,
313 QMI_WLANFW_MEM_CAL_V01 = 4,
314 QMI_WLANFW_MEM_DPD_V01 = 5,
315 WLANFW_MEM_TYPE_ENUM_MAX_VAL_V01 = INT_MAX,
318 struct qmi_wlanfw_mem_seg_s_v01 {
320 enum qmi_wlanfw_mem_type_enum_v01 type;
322 struct qmi_wlanfw_mem_cfg_s_v01 mem_cfg[QMI_WLANFW_MAX_NUM_MEM_CFG_V01];
325 struct qmi_wlanfw_request_mem_ind_msg_v01 {
327 struct qmi_wlanfw_mem_seg_s_v01 mem_seg[ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01];
330 struct qmi_wlanfw_mem_seg_resp_s_v01 {
333 enum qmi_wlanfw_mem_type_enum_v01 type;
337 struct qmi_wlanfw_respond_mem_req_msg_v01 {
339 struct qmi_wlanfw_mem_seg_resp_s_v01 mem_seg[ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01];
342 struct qmi_wlanfw_respond_mem_resp_msg_v01 {
343 struct qmi_response_type_v01 resp;
346 struct qmi_wlanfw_fw_mem_ready_ind_msg_v01 {
350 struct qmi_wlanfw_fw_ready_ind_msg_v01 {
354 #define QMI_WLANFW_CAP_REQ_MSG_V01_MAX_LEN 0
355 #define QMI_WLANFW_CAP_RESP_MSG_V01_MAX_LEN 207
356 #define QMI_WLANFW_CAP_REQ_V01 0x0024
357 #define QMI_WLANFW_CAP_RESP_V01 0x0024
359 enum qmi_wlanfw_pipedir_enum_v01 {
360 QMI_WLFW_PIPEDIR_NONE_V01 = 0,
361 QMI_WLFW_PIPEDIR_IN_V01 = 1,
362 QMI_WLFW_PIPEDIR_OUT_V01 = 2,
363 QMI_WLFW_PIPEDIR_INOUT_V01 = 3,
366 struct qmi_wlanfw_ce_tgt_pipe_cfg_s_v01 {
374 struct qmi_wlanfw_ce_svc_pipe_cfg_s_v01 {
380 struct qmi_wlanfw_shadow_reg_cfg_s_v01 {
385 struct qmi_wlanfw_shadow_reg_v3_cfg_s_v01 {
389 struct qmi_wlanfw_memory_region_info_s_v01 {
395 struct qmi_wlanfw_rf_chip_info_s_v01 {
400 struct qmi_wlanfw_rf_board_info_s_v01 {
404 struct qmi_wlanfw_soc_info_s_v01 {
408 struct qmi_wlanfw_fw_version_info_s_v01 {
410 char fw_build_timestamp[ATH12K_QMI_WLANFW_MAX_TIMESTAMP_LEN_V01 + 1];
413 struct qmi_wlanfw_dev_mem_info_s_v01 {
418 enum qmi_wlanfw_cal_temp_id_enum_v01 {
419 QMI_WLANFW_CAL_TEMP_IDX_0_V01 = 0,
420 QMI_WLANFW_CAL_TEMP_IDX_1_V01 = 1,
421 QMI_WLANFW_CAL_TEMP_IDX_2_V01 = 2,
422 QMI_WLANFW_CAL_TEMP_IDX_3_V01 = 3,
423 QMI_WLANFW_CAL_TEMP_IDX_4_V01 = 4,
424 QMI_WLANFW_CAL_TEMP_ID_MAX_V01 = 0xFF,
427 enum qmi_wlanfw_rd_card_chain_cap_v01 {
428 WLFW_RD_CARD_CHAIN_CAP_MIN_VAL_V01 = INT_MIN,
429 WLFW_RD_CARD_CHAIN_CAP_UNSPECIFIED_V01 = 0,
430 WLFW_RD_CARD_CHAIN_CAP_1x1_V01 = 1,
431 WLFW_RD_CARD_CHAIN_CAP_2x2_V01 = 2,
432 WLFW_RD_CARD_CHAIN_CAP_MAX_VAL_V01 = INT_MAX,
435 struct qmi_wlanfw_cap_resp_msg_v01 {
436 struct qmi_response_type_v01 resp;
438 struct qmi_wlanfw_rf_chip_info_s_v01 chip_info;
440 struct qmi_wlanfw_rf_board_info_s_v01 board_info;
442 struct qmi_wlanfw_soc_info_s_v01 soc_info;
443 u8 fw_version_info_valid;
444 struct qmi_wlanfw_fw_version_info_s_v01 fw_version_info;
445 u8 fw_build_id_valid;
446 char fw_build_id[ATH12K_QMI_WLANFW_MAX_BUILD_ID_LEN_V01 + 1];
451 u8 time_freq_hz_valid;
453 u8 otp_version_valid;
455 u8 eeprom_caldata_read_timeout_valid;
456 u32 eeprom_caldata_read_timeout;
459 u8 rd_card_chain_cap_valid;
460 enum qmi_wlanfw_rd_card_chain_cap_v01 rd_card_chain_cap;
461 u8 dev_mem_info_valid;
462 struct qmi_wlanfw_dev_mem_info_s_v01 dev_mem[ATH12K_QMI_WLFW_MAX_DEV_MEM_NUM_V01];
465 struct qmi_wlanfw_cap_req_msg_v01 {
469 #define QMI_WLANFW_BDF_DOWNLOAD_REQ_MSG_V01_MAX_LEN 6182
470 #define QMI_WLANFW_BDF_DOWNLOAD_RESP_MSG_V01_MAX_LEN 7
471 #define QMI_WLANFW_BDF_DOWNLOAD_RESP_V01 0x0025
472 #define QMI_WLANFW_BDF_DOWNLOAD_REQ_V01 0x0025
473 /* TODO: Need to check with MCL and FW team that data can be pointer and
474 * can be last element in structure
476 struct qmi_wlanfw_bdf_download_req_msg_v01 {
479 enum qmi_wlanfw_cal_temp_id_enum_v01 file_id;
486 u8 data[QMI_WLANFW_MAX_DATA_SIZE_V01];
494 struct qmi_wlanfw_bdf_download_resp_msg_v01 {
495 struct qmi_response_type_v01 resp;
498 #define QMI_WLANFW_M3_INFO_REQ_MSG_V01_MAX_MSG_LEN 18
499 #define QMI_WLANFW_M3_INFO_RESP_MSG_V01_MAX_MSG_LEN 7
500 #define QMI_WLANFW_M3_INFO_RESP_V01 0x003C
501 #define QMI_WLANFW_M3_INFO_REQ_V01 0x003C
503 struct qmi_wlanfw_m3_info_req_msg_v01 {
508 struct qmi_wlanfw_m3_info_resp_msg_v01 {
509 struct qmi_response_type_v01 resp;
512 #define QMI_WLANFW_WLAN_MODE_REQ_MSG_V01_MAX_LEN 11
513 #define QMI_WLANFW_WLAN_MODE_RESP_MSG_V01_MAX_LEN 7
514 #define QMI_WLANFW_WLAN_CFG_REQ_MSG_V01_MAX_LEN 803
515 #define QMI_WLANFW_WLAN_CFG_RESP_MSG_V01_MAX_LEN 7
516 #define QMI_WLANFW_WLAN_MODE_REQ_V01 0x0022
517 #define QMI_WLANFW_WLAN_MODE_RESP_V01 0x0022
518 #define QMI_WLANFW_WLAN_CFG_REQ_V01 0x0023
519 #define QMI_WLANFW_WLAN_CFG_RESP_V01 0x0023
520 #define QMI_WLANFW_MAX_STR_LEN_V01 16
521 #define QMI_WLANFW_MAX_NUM_CE_V01 12
522 #define QMI_WLANFW_MAX_NUM_SVC_V01 24
523 #define QMI_WLANFW_MAX_NUM_SHADOW_REG_V01 24
524 #define QMI_WLANFW_MAX_NUM_SHADOW_REG_V3_V01 60
526 struct qmi_wlanfw_wlan_mode_req_msg_v01 {
532 struct qmi_wlanfw_wlan_mode_resp_msg_v01 {
533 struct qmi_response_type_v01 resp;
536 struct qmi_wlanfw_wlan_cfg_req_msg_v01 {
537 u8 host_version_valid;
538 char host_version[QMI_WLANFW_MAX_STR_LEN_V01 + 1];
541 struct qmi_wlanfw_ce_tgt_pipe_cfg_s_v01
542 tgt_cfg[QMI_WLANFW_MAX_NUM_CE_V01];
545 struct qmi_wlanfw_ce_svc_pipe_cfg_s_v01
546 svc_cfg[QMI_WLANFW_MAX_NUM_SVC_V01];
549 struct qmi_wlanfw_shadow_reg_cfg_s_v01
550 shadow_reg[QMI_WLANFW_MAX_NUM_SHADOW_REG_V01];
551 u8 shadow_reg_v3_valid;
552 u32 shadow_reg_v3_len;
553 struct qmi_wlanfw_shadow_reg_v3_cfg_s_v01
554 shadow_reg_v3[QMI_WLANFW_MAX_NUM_SHADOW_REG_V3_V01];
557 struct qmi_wlanfw_wlan_cfg_resp_msg_v01 {
558 struct qmi_response_type_v01 resp;
561 int ath12k_qmi_firmware_start(struct ath12k_base *ab,
563 void ath12k_qmi_firmware_stop(struct ath12k_base *ab);
564 void ath12k_qmi_event_work(struct work_struct *work);
565 void ath12k_qmi_msg_recv_work(struct work_struct *work);
566 void ath12k_qmi_deinit_service(struct ath12k_base *ab);
567 int ath12k_qmi_init_service(struct ath12k_base *ab);