Path: blob/main/sys/contrib/dev/athk/ath12k/qmi.h
108653 views
/* SPDX-License-Identifier: BSD-3-Clause-Clear */1/*2* Copyright (c) 2018-2021 The Linux Foundation. All rights reserved.3* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.4*/56#ifndef ATH12K_QMI_H7#define ATH12K_QMI_H89#include <linux/mutex.h>10#include <linux/soc/qcom/qmi.h>1112#define ATH12K_HOST_VERSION_STRING "WIN"13#define ATH12K_QMI_WLANFW_TIMEOUT_MS 1000014#define ATH12K_QMI_MAX_BDF_FILE_NAME_SIZE 6415#define ATH12K_QMI_CALDB_ADDRESS 0x4BA0000016#define ATH12K_QMI_WLANFW_MAX_BUILD_ID_LEN_V01 12817#define ATH12K_QMI_WLFW_NODE_ID_BASE 0x0718#define ATH12K_QMI_WLFW_SERVICE_ID_V01 0x4519#define ATH12K_QMI_WLFW_SERVICE_VERS_V01 0x0120#define ATH12K_QMI_WLFW_SERVICE_INS_ID_V01 0x0221#define ATH12K_QMI_WLFW_SERVICE_INS_ID_V01_WCN7850 0x12223#define ATH12K_QMI_WLFW_SERVICE_INS_ID_V01_QCN9274 0x0724#define ATH12K_QMI_WLANFW_MAX_TIMESTAMP_LEN_V01 3225#define ATH12K_QMI_RESP_LEN_MAX 819226#define ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01 5227#define ATH12K_QMI_CALDB_SIZE 0x48000028#define ATH12K_QMI_BDF_EXT_STR_LENGTH 0x2029#define ATH12K_QMI_FW_MEM_REQ_SEGMENT_CNT 330#define ATH12K_QMI_WLFW_MAX_DEV_MEM_NUM_V01 431#define ATH12K_QMI_DEVMEM_CMEM_INDEX 03233#define QMI_WLFW_REQUEST_MEM_IND_V01 0x003534#define QMI_WLFW_FW_MEM_READY_IND_V01 0x003735#define QMI_WLFW_FW_READY_IND_V01 0x00383637#define QMI_WLANFW_MAX_DATA_SIZE_V01 614438#define ATH12K_FIRMWARE_MODE_OFF 439#define ATH12K_QMI_TARGET_MEM_MODE_DEFAULT 04041#define ATH12K_BOARD_ID_DEFAULT 0xFF4243struct ath12k_base;4445enum ath12k_qmi_file_type {46ATH12K_QMI_FILE_TYPE_BDF_GOLDEN = 0,47ATH12K_QMI_FILE_TYPE_CALDATA = 2,48ATH12K_QMI_FILE_TYPE_EEPROM = 3,49ATH12K_QMI_MAX_FILE_TYPE = 4,50};5152enum ath12k_qmi_bdf_type {53ATH12K_QMI_BDF_TYPE_BIN = 0,54ATH12K_QMI_BDF_TYPE_ELF = 1,55ATH12K_QMI_BDF_TYPE_REGDB = 4,56ATH12K_QMI_BDF_TYPE_CALIBRATION = 5,57};5859enum ath12k_qmi_event_type {60ATH12K_QMI_EVENT_SERVER_ARRIVE,61ATH12K_QMI_EVENT_SERVER_EXIT,62ATH12K_QMI_EVENT_REQUEST_MEM,63ATH12K_QMI_EVENT_FW_MEM_READY,64ATH12K_QMI_EVENT_FW_READY,65ATH12K_QMI_EVENT_REGISTER_DRIVER,66ATH12K_QMI_EVENT_UNREGISTER_DRIVER,67ATH12K_QMI_EVENT_RECOVERY,68ATH12K_QMI_EVENT_FORCE_FW_ASSERT,69ATH12K_QMI_EVENT_POWER_UP,70ATH12K_QMI_EVENT_POWER_DOWN,71ATH12K_QMI_EVENT_MAX,72};7374struct ath12k_qmi_driver_event {75struct list_head list;76enum ath12k_qmi_event_type type;77void *data;78};7980struct ath12k_qmi_ce_cfg {81const struct ce_pipe_config *tgt_ce;82int tgt_ce_len;83const struct service_to_pipe *svc_to_ce_map;84int svc_to_ce_map_len;85const u8 *shadow_reg;86int shadow_reg_len;87u32 *shadow_reg_v3;88int shadow_reg_v3_len;89};9091struct ath12k_qmi_event_msg {92struct list_head list;93enum ath12k_qmi_event_type type;94};9596struct target_mem_chunk {97u32 size;98u32 type;99dma_addr_t paddr;100union {101void __iomem *ioaddr;102void *addr;103} v;104};105106struct target_info {107u32 chip_id;108u32 chip_family;109u32 board_id;110u32 soc_id;111u32 fw_version;112u32 eeprom_caldata;113char fw_build_timestamp[ATH12K_QMI_WLANFW_MAX_TIMESTAMP_LEN_V01 + 1];114char fw_build_id[ATH12K_QMI_WLANFW_MAX_BUILD_ID_LEN_V01 + 1];115char bdf_ext[ATH12K_QMI_BDF_EXT_STR_LENGTH];116};117118struct m3_mem_region {119u32 size;120dma_addr_t paddr;121void *vaddr;122};123124struct dev_mem_info {125u64 start;126u64 size;127};128129struct ath12k_qmi {130struct ath12k_base *ab;131struct qmi_handle handle;132struct sockaddr_qrtr sq;133struct work_struct event_work;134struct workqueue_struct *event_wq;135struct list_head event_list;136spinlock_t event_lock; /* spinlock for qmi event list */137struct ath12k_qmi_ce_cfg ce_cfg;138struct target_mem_chunk target_mem[ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01];139u32 mem_seg_count;140u32 target_mem_mode;141bool target_mem_delayed;142u8 cal_done;143struct target_info target;144struct m3_mem_region m3_mem;145unsigned int service_ins_id;146struct dev_mem_info dev_mem[ATH12K_QMI_WLFW_MAX_DEV_MEM_NUM_V01];147};148149#define QMI_WLANFW_HOST_CAP_REQ_MSG_V01_MAX_LEN 261150#define QMI_WLANFW_HOST_CAP_REQ_V01 0x0034151#define QMI_WLANFW_HOST_CAP_RESP_MSG_V01_MAX_LEN 7152#define QMI_WLFW_HOST_CAP_RESP_V01 0x0034153#define QMI_WLFW_MAX_NUM_GPIO_V01 32154#define QMI_WLANFW_MAX_PLATFORM_NAME_LEN_V01 64155#define QMI_WLANFW_MAX_HOST_DDR_RANGE_SIZE_V01 3156157struct qmi_wlanfw_host_ddr_range {158u64 start;159u64 size;160};161162enum ath12k_qmi_target_mem {163HOST_DDR_REGION_TYPE = 0x1,164BDF_MEM_REGION_TYPE = 0x2,165M3_DUMP_REGION_TYPE = 0x3,166CALDB_MEM_REGION_TYPE = 0x4,167PAGEABLE_MEM_REGION_TYPE = 0x9,168};169170enum qmi_wlanfw_host_build_type {171WLANFW_HOST_BUILD_TYPE_ENUM_MIN_VAL_V01 = INT_MIN,172QMI_WLANFW_HOST_BUILD_TYPE_UNSPECIFIED_V01 = 0,173QMI_WLANFW_HOST_BUILD_TYPE_PRIMARY_V01 = 1,174QMI_WLANFW_HOST_BUILD_TYPE_SECONDARY_V01 = 2,175WLANFW_HOST_BUILD_TYPE_ENUM_MAX_VAL_V01 = INT_MAX,176};177178#define QMI_WLFW_MAX_NUM_MLO_CHIPS_V01 3179#define QMI_WLFW_MAX_NUM_MLO_LINKS_PER_CHIP_V01 2180181struct wlfw_host_mlo_chip_info_s_v01 {182u8 chip_id;183u8 num_local_links;184u8 hw_link_id[QMI_WLFW_MAX_NUM_MLO_LINKS_PER_CHIP_V01];185u8 valid_mlo_link_id[QMI_WLFW_MAX_NUM_MLO_LINKS_PER_CHIP_V01];186};187188enum ath12k_qmi_cnss_feature {189CNSS_FEATURE_MIN_ENUM_VAL_V01 = INT_MIN,190CNSS_QDSS_CFG_MISS_V01 = 3,191CNSS_PCIE_PERST_NO_PULL_V01 = 4,192CNSS_MAX_FEATURE_V01 = 64,193CNSS_FEATURE_MAX_ENUM_VAL_V01 = INT_MAX,194};195196struct qmi_wlanfw_host_cap_req_msg_v01 {197u8 num_clients_valid;198u32 num_clients;199u8 wake_msi_valid;200u32 wake_msi;201u8 gpios_valid;202u32 gpios_len;203u32 gpios[QMI_WLFW_MAX_NUM_GPIO_V01];204u8 nm_modem_valid;205u8 nm_modem;206u8 bdf_support_valid;207u8 bdf_support;208u8 bdf_cache_support_valid;209u8 bdf_cache_support;210u8 m3_support_valid;211u8 m3_support;212u8 m3_cache_support_valid;213u8 m3_cache_support;214u8 cal_filesys_support_valid;215u8 cal_filesys_support;216u8 cal_cache_support_valid;217u8 cal_cache_support;218u8 cal_done_valid;219u8 cal_done;220u8 mem_bucket_valid;221u32 mem_bucket;222u8 mem_cfg_mode_valid;223u8 mem_cfg_mode;224u8 cal_duration_valid;225u16 cal_duraiton;226u8 platform_name_valid;227char platform_name[QMI_WLANFW_MAX_PLATFORM_NAME_LEN_V01 + 1];228u8 ddr_range_valid;229struct qmi_wlanfw_host_ddr_range ddr_range[QMI_WLANFW_MAX_HOST_DDR_RANGE_SIZE_V01];230u8 host_build_type_valid;231enum qmi_wlanfw_host_build_type host_build_type;232u8 mlo_capable_valid;233u8 mlo_capable;234u8 mlo_chip_id_valid;235u16 mlo_chip_id;236u8 mlo_group_id_valid;237u8 mlo_group_id;238u8 max_mlo_peer_valid;239u16 max_mlo_peer;240u8 mlo_num_chips_valid;241u8 mlo_num_chips;242u8 mlo_chip_info_valid;243struct wlfw_host_mlo_chip_info_s_v01 mlo_chip_info[QMI_WLFW_MAX_NUM_MLO_CHIPS_V01];244u8 feature_list_valid;245u64 feature_list;246247};248249struct qmi_wlanfw_host_cap_resp_msg_v01 {250struct qmi_response_type_v01 resp;251};252253#define QMI_WLANFW_IND_REGISTER_REQ_MSG_V01_MAX_LEN 54254#define QMI_WLANFW_IND_REGISTER_REQ_V01 0x0020255#define QMI_WLANFW_IND_REGISTER_RESP_MSG_V01_MAX_LEN 18256#define QMI_WLANFW_IND_REGISTER_RESP_V01 0x0020257#define QMI_WLANFW_CLIENT_ID 0x4b4e454c258259struct qmi_wlanfw_ind_register_req_msg_v01 {260u8 fw_ready_enable_valid;261u8 fw_ready_enable;262u8 initiate_cal_download_enable_valid;263u8 initiate_cal_download_enable;264u8 initiate_cal_update_enable_valid;265u8 initiate_cal_update_enable;266u8 msa_ready_enable_valid;267u8 msa_ready_enable;268u8 pin_connect_result_enable_valid;269u8 pin_connect_result_enable;270u8 client_id_valid;271u32 client_id;272u8 request_mem_enable_valid;273u8 request_mem_enable;274u8 fw_mem_ready_enable_valid;275u8 fw_mem_ready_enable;276u8 fw_init_done_enable_valid;277u8 fw_init_done_enable;278u8 rejuvenate_enable_valid;279u32 rejuvenate_enable;280u8 xo_cal_enable_valid;281u8 xo_cal_enable;282u8 cal_done_enable_valid;283u8 cal_done_enable;284};285286struct qmi_wlanfw_ind_register_resp_msg_v01 {287struct qmi_response_type_v01 resp;288u8 fw_status_valid;289u64 fw_status;290};291292#define QMI_WLANFW_REQUEST_MEM_IND_MSG_V01_MAX_LEN 1824293#define QMI_WLANFW_RESPOND_MEM_REQ_MSG_V01_MAX_LEN 888294#define QMI_WLANFW_RESPOND_MEM_RESP_MSG_V01_MAX_LEN 7295#define QMI_WLANFW_REQUEST_MEM_IND_V01 0x0035296#define QMI_WLANFW_RESPOND_MEM_REQ_V01 0x0036297#define QMI_WLANFW_RESPOND_MEM_RESP_V01 0x0036298#define QMI_WLANFW_MAX_NUM_MEM_CFG_V01 2299#define QMI_WLANFW_MAX_STR_LEN_V01 16300301struct qmi_wlanfw_mem_cfg_s_v01 {302u64 offset;303u32 size;304u8 secure_flag;305};306307enum qmi_wlanfw_mem_type_enum_v01 {308WLANFW_MEM_TYPE_ENUM_MIN_VAL_V01 = INT_MIN,309QMI_WLANFW_MEM_TYPE_MSA_V01 = 0,310QMI_WLANFW_MEM_TYPE_DDR_V01 = 1,311QMI_WLANFW_MEM_BDF_V01 = 2,312QMI_WLANFW_MEM_M3_V01 = 3,313QMI_WLANFW_MEM_CAL_V01 = 4,314QMI_WLANFW_MEM_DPD_V01 = 5,315WLANFW_MEM_TYPE_ENUM_MAX_VAL_V01 = INT_MAX,316};317318struct qmi_wlanfw_mem_seg_s_v01 {319u32 size;320enum qmi_wlanfw_mem_type_enum_v01 type;321u32 mem_cfg_len;322struct qmi_wlanfw_mem_cfg_s_v01 mem_cfg[QMI_WLANFW_MAX_NUM_MEM_CFG_V01];323};324325struct qmi_wlanfw_request_mem_ind_msg_v01 {326u32 mem_seg_len;327struct qmi_wlanfw_mem_seg_s_v01 mem_seg[ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01];328};329330struct qmi_wlanfw_mem_seg_resp_s_v01 {331u64 addr;332u32 size;333enum qmi_wlanfw_mem_type_enum_v01 type;334u8 restore;335};336337struct qmi_wlanfw_respond_mem_req_msg_v01 {338u32 mem_seg_len;339struct qmi_wlanfw_mem_seg_resp_s_v01 mem_seg[ATH12K_QMI_WLANFW_MAX_NUM_MEM_SEG_V01];340};341342struct qmi_wlanfw_respond_mem_resp_msg_v01 {343struct qmi_response_type_v01 resp;344};345346struct qmi_wlanfw_fw_mem_ready_ind_msg_v01 {347char placeholder;348};349350struct qmi_wlanfw_fw_ready_ind_msg_v01 {351char placeholder;352};353354#define QMI_WLANFW_CAP_REQ_MSG_V01_MAX_LEN 0355#define QMI_WLANFW_CAP_RESP_MSG_V01_MAX_LEN 207356#define QMI_WLANFW_CAP_REQ_V01 0x0024357#define QMI_WLANFW_CAP_RESP_V01 0x0024358359enum qmi_wlanfw_pipedir_enum_v01 {360QMI_WLFW_PIPEDIR_NONE_V01 = 0,361QMI_WLFW_PIPEDIR_IN_V01 = 1,362QMI_WLFW_PIPEDIR_OUT_V01 = 2,363QMI_WLFW_PIPEDIR_INOUT_V01 = 3,364};365366struct qmi_wlanfw_ce_tgt_pipe_cfg_s_v01 {367__le32 pipe_num;368__le32 pipe_dir;369__le32 nentries;370__le32 nbytes_max;371__le32 flags;372};373374struct qmi_wlanfw_ce_svc_pipe_cfg_s_v01 {375__le32 service_id;376__le32 pipe_dir;377__le32 pipe_num;378};379380struct qmi_wlanfw_shadow_reg_cfg_s_v01 {381u16 id;382u16 offset;383};384385struct qmi_wlanfw_shadow_reg_v3_cfg_s_v01 {386u32 addr;387};388389struct qmi_wlanfw_memory_region_info_s_v01 {390u64 region_addr;391u32 size;392u8 secure_flag;393};394395struct qmi_wlanfw_rf_chip_info_s_v01 {396u32 chip_id;397u32 chip_family;398};399400struct qmi_wlanfw_rf_board_info_s_v01 {401u32 board_id;402};403404struct qmi_wlanfw_soc_info_s_v01 {405u32 soc_id;406};407408struct qmi_wlanfw_fw_version_info_s_v01 {409u32 fw_version;410char fw_build_timestamp[ATH12K_QMI_WLANFW_MAX_TIMESTAMP_LEN_V01 + 1];411};412413struct qmi_wlanfw_dev_mem_info_s_v01 {414u64 start;415u64 size;416};417418enum qmi_wlanfw_cal_temp_id_enum_v01 {419QMI_WLANFW_CAL_TEMP_IDX_0_V01 = 0,420QMI_WLANFW_CAL_TEMP_IDX_1_V01 = 1,421QMI_WLANFW_CAL_TEMP_IDX_2_V01 = 2,422QMI_WLANFW_CAL_TEMP_IDX_3_V01 = 3,423QMI_WLANFW_CAL_TEMP_IDX_4_V01 = 4,424QMI_WLANFW_CAL_TEMP_ID_MAX_V01 = 0xFF,425};426427enum qmi_wlanfw_rd_card_chain_cap_v01 {428WLFW_RD_CARD_CHAIN_CAP_MIN_VAL_V01 = INT_MIN,429WLFW_RD_CARD_CHAIN_CAP_UNSPECIFIED_V01 = 0,430WLFW_RD_CARD_CHAIN_CAP_1x1_V01 = 1,431WLFW_RD_CARD_CHAIN_CAP_2x2_V01 = 2,432WLFW_RD_CARD_CHAIN_CAP_MAX_VAL_V01 = INT_MAX,433};434435struct qmi_wlanfw_cap_resp_msg_v01 {436struct qmi_response_type_v01 resp;437u8 chip_info_valid;438struct qmi_wlanfw_rf_chip_info_s_v01 chip_info;439u8 board_info_valid;440struct qmi_wlanfw_rf_board_info_s_v01 board_info;441u8 soc_info_valid;442struct qmi_wlanfw_soc_info_s_v01 soc_info;443u8 fw_version_info_valid;444struct qmi_wlanfw_fw_version_info_s_v01 fw_version_info;445u8 fw_build_id_valid;446char fw_build_id[ATH12K_QMI_WLANFW_MAX_BUILD_ID_LEN_V01 + 1];447u8 num_macs_valid;448u8 num_macs;449u8 voltage_mv_valid;450u32 voltage_mv;451u8 time_freq_hz_valid;452u32 time_freq_hz;453u8 otp_version_valid;454u32 otp_version;455u8 eeprom_caldata_read_timeout_valid;456u32 eeprom_caldata_read_timeout;457u8 fw_caps_valid;458u64 fw_caps;459u8 rd_card_chain_cap_valid;460enum qmi_wlanfw_rd_card_chain_cap_v01 rd_card_chain_cap;461u8 dev_mem_info_valid;462struct qmi_wlanfw_dev_mem_info_s_v01 dev_mem[ATH12K_QMI_WLFW_MAX_DEV_MEM_NUM_V01];463};464465struct qmi_wlanfw_cap_req_msg_v01 {466char placeholder;467};468469#define QMI_WLANFW_BDF_DOWNLOAD_REQ_MSG_V01_MAX_LEN 6182470#define QMI_WLANFW_BDF_DOWNLOAD_RESP_MSG_V01_MAX_LEN 7471#define QMI_WLANFW_BDF_DOWNLOAD_RESP_V01 0x0025472#define QMI_WLANFW_BDF_DOWNLOAD_REQ_V01 0x0025473/* TODO: Need to check with MCL and FW team that data can be pointer and474* can be last element in structure475*/476struct qmi_wlanfw_bdf_download_req_msg_v01 {477u8 valid;478u8 file_id_valid;479enum qmi_wlanfw_cal_temp_id_enum_v01 file_id;480u8 total_size_valid;481u32 total_size;482u8 seg_id_valid;483u32 seg_id;484u8 data_valid;485u32 data_len;486u8 data[QMI_WLANFW_MAX_DATA_SIZE_V01];487u8 end_valid;488u8 end;489u8 bdf_type_valid;490u8 bdf_type;491492};493494struct qmi_wlanfw_bdf_download_resp_msg_v01 {495struct qmi_response_type_v01 resp;496};497498#define QMI_WLANFW_M3_INFO_REQ_MSG_V01_MAX_MSG_LEN 18499#define QMI_WLANFW_M3_INFO_RESP_MSG_V01_MAX_MSG_LEN 7500#define QMI_WLANFW_M3_INFO_RESP_V01 0x003C501#define QMI_WLANFW_M3_INFO_REQ_V01 0x003C502503struct qmi_wlanfw_m3_info_req_msg_v01 {504u64 addr;505u32 size;506};507508struct qmi_wlanfw_m3_info_resp_msg_v01 {509struct qmi_response_type_v01 resp;510};511512#define QMI_WLANFW_WLAN_MODE_REQ_MSG_V01_MAX_LEN 11513#define QMI_WLANFW_WLAN_MODE_RESP_MSG_V01_MAX_LEN 7514#define QMI_WLANFW_WLAN_CFG_REQ_MSG_V01_MAX_LEN 803515#define QMI_WLANFW_WLAN_CFG_RESP_MSG_V01_MAX_LEN 7516#define QMI_WLANFW_WLAN_MODE_REQ_V01 0x0022517#define QMI_WLANFW_WLAN_MODE_RESP_V01 0x0022518#define QMI_WLANFW_WLAN_CFG_REQ_V01 0x0023519#define QMI_WLANFW_WLAN_CFG_RESP_V01 0x0023520#define QMI_WLANFW_MAX_STR_LEN_V01 16521#define QMI_WLANFW_MAX_NUM_CE_V01 12522#define QMI_WLANFW_MAX_NUM_SVC_V01 24523#define QMI_WLANFW_MAX_NUM_SHADOW_REG_V01 24524#define QMI_WLANFW_MAX_NUM_SHADOW_REG_V3_V01 60525526struct qmi_wlanfw_wlan_mode_req_msg_v01 {527u32 mode;528u8 hw_debug_valid;529u8 hw_debug;530};531532struct qmi_wlanfw_wlan_mode_resp_msg_v01 {533struct qmi_response_type_v01 resp;534};535536struct qmi_wlanfw_wlan_cfg_req_msg_v01 {537u8 host_version_valid;538char host_version[QMI_WLANFW_MAX_STR_LEN_V01 + 1];539u8 tgt_cfg_valid;540u32 tgt_cfg_len;541struct qmi_wlanfw_ce_tgt_pipe_cfg_s_v01542tgt_cfg[QMI_WLANFW_MAX_NUM_CE_V01];543u8 svc_cfg_valid;544u32 svc_cfg_len;545struct qmi_wlanfw_ce_svc_pipe_cfg_s_v01546svc_cfg[QMI_WLANFW_MAX_NUM_SVC_V01];547u8 shadow_reg_valid;548u32 shadow_reg_len;549struct qmi_wlanfw_shadow_reg_cfg_s_v01550shadow_reg[QMI_WLANFW_MAX_NUM_SHADOW_REG_V01];551u8 shadow_reg_v3_valid;552u32 shadow_reg_v3_len;553struct qmi_wlanfw_shadow_reg_v3_cfg_s_v01554shadow_reg_v3[QMI_WLANFW_MAX_NUM_SHADOW_REG_V3_V01];555};556557struct qmi_wlanfw_wlan_cfg_resp_msg_v01 {558struct qmi_response_type_v01 resp;559};560561int ath12k_qmi_firmware_start(struct ath12k_base *ab,562u32 mode);563void ath12k_qmi_firmware_stop(struct ath12k_base *ab);564void ath12k_qmi_event_work(struct work_struct *work);565void ath12k_qmi_msg_recv_work(struct work_struct *work);566void ath12k_qmi_deinit_service(struct ath12k_base *ab);567int ath12k_qmi_init_service(struct ath12k_base *ab);568569#endif570571572