1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* Copyright (c) 2016-2021, The Linux Foundation. All rights reserved. */ 3 4 #ifndef _NET_CNSS2_H 5 #define _NET_CNSS2_H 6 7 #include <linux/pci.h> 8 9 #define CNSS_MAX_FILE_NAME 20 10 #define CNSS_MAX_TIMESTAMP_LEN 32 11 #define CNSS_MAX_DEV_MEM_NUM 4 12 13 /* 14 * Temporary change for compilation, will be removed 15 * after WLAN host driver switched to use new APIs 16 */ 17 #define CNSS_API_WITH_DEV 18 19 enum cnss_bus_width_type { 20 CNSS_BUS_WIDTH_NONE, 21 CNSS_BUS_WIDTH_IDLE, 22 CNSS_BUS_WIDTH_LOW, 23 CNSS_BUS_WIDTH_MEDIUM, 24 CNSS_BUS_WIDTH_HIGH, 25 CNSS_BUS_WIDTH_VERY_HIGH, 26 CNSS_BUS_WIDTH_LOW_LATENCY 27 }; 28 29 enum cnss_platform_cap_flag { 30 CNSS_HAS_EXTERNAL_SWREG = 0x01, 31 CNSS_HAS_UART_ACCESS = 0x02, 32 CNSS_HAS_DRV_SUPPORT = 0x04, 33 }; 34 35 struct cnss_platform_cap { 36 u32 cap_flag; 37 }; 38 39 struct cnss_fw_files { 40 char image_file[CNSS_MAX_FILE_NAME]; 41 char board_data[CNSS_MAX_FILE_NAME]; 42 char otp_data[CNSS_MAX_FILE_NAME]; 43 char utf_file[CNSS_MAX_FILE_NAME]; 44 char utf_board_data[CNSS_MAX_FILE_NAME]; 45 char epping_file[CNSS_MAX_FILE_NAME]; 46 char evicted_data[CNSS_MAX_FILE_NAME]; 47 }; 48 49 struct cnss_device_version { 50 u32 family_number; 51 u32 device_number; 52 u32 major_version; 53 u32 minor_version; 54 }; 55 56 struct cnss_dev_mem_info { 57 u64 start; 58 u64 size; 59 }; 60 61 struct cnss_soc_info { 62 void __iomem *va; 63 phys_addr_t pa; 64 uint32_t chip_id; 65 uint32_t chip_family; 66 uint32_t board_id; 67 uint32_t soc_id; 68 uint32_t fw_version; 69 char fw_build_timestamp[CNSS_MAX_TIMESTAMP_LEN + 1]; 70 struct cnss_device_version device_version; 71 struct cnss_dev_mem_info dev_mem_info[CNSS_MAX_DEV_MEM_NUM]; 72 }; 73 74 struct cnss_wlan_runtime_ops { 75 int (*runtime_suspend)(struct pci_dev *pdev); 76 int (*runtime_resume)(struct pci_dev *pdev); 77 }; 78 79 enum cnss_driver_status { 80 CNSS_UNINITIALIZED, 81 CNSS_INITIALIZED, 82 CNSS_LOAD_UNLOAD, 83 CNSS_RECOVERY, 84 CNSS_FW_DOWN, 85 CNSS_HANG_EVENT, 86 CNSS_BUS_EVENT, 87 }; 88 89 enum cnss_bus_event_type { 90 BUS_EVENT_PCI_LINK_DOWN = 0, 91 92 BUS_EVENT_INVALID = 0xFFFF, 93 }; 94 95 struct cnss_hang_event { 96 void *hang_event_data; 97 u16 hang_event_data_len; 98 }; 99 100 struct cnss_bus_event { 101 enum cnss_bus_event_type etype; 102 void *event_data; 103 }; 104 105 struct cnss_uevent_data { 106 enum cnss_driver_status status; 107 void *data; 108 }; 109 110 struct cnss_wlan_driver { 111 char *name; 112 int (*probe)(struct pci_dev *pdev, const struct pci_device_id *id); 113 void (*remove)(struct pci_dev *pdev); 114 int (*idle_restart)(struct pci_dev *pdev, 115 const struct pci_device_id *id); 116 int (*idle_shutdown)(struct pci_dev *pdev); 117 int (*reinit)(struct pci_dev *pdev, const struct pci_device_id *id); 118 void (*shutdown)(struct pci_dev *pdev); 119 void (*crash_shutdown)(struct pci_dev *pdev); 120 int (*suspend)(struct pci_dev *pdev, pm_message_t state); 121 int (*resume)(struct pci_dev *pdev); 122 int (*suspend_noirq)(struct pci_dev *pdev); 123 int (*resume_noirq)(struct pci_dev *pdev); 124 void (*modem_status)(struct pci_dev *pdev, int state); 125 void (*update_status)(struct pci_dev *pdev, uint32_t status); 126 int (*update_event)(struct pci_dev *pdev, 127 struct cnss_uevent_data *uevent); 128 struct cnss_wlan_runtime_ops *runtime_ops; 129 const struct pci_device_id *id_table; 130 }; 131 132 struct cnss_ce_tgt_pipe_cfg { 133 u32 pipe_num; 134 u32 pipe_dir; 135 u32 nentries; 136 u32 nbytes_max; 137 u32 flags; 138 u32 reserved; 139 }; 140 141 struct cnss_ce_svc_pipe_cfg { 142 u32 service_id; 143 u32 pipe_dir; 144 u32 pipe_num; 145 }; 146 147 struct cnss_shadow_reg_cfg { 148 u16 ce_id; 149 u16 reg_offset; 150 }; 151 152 struct cnss_shadow_reg_v2_cfg { 153 u32 addr; 154 }; 155 156 struct cnss_rri_over_ddr_cfg { 157 u32 base_addr_low; 158 u32 base_addr_high; 159 }; 160 161 struct cnss_wlan_enable_cfg { 162 u32 num_ce_tgt_cfg; 163 struct cnss_ce_tgt_pipe_cfg *ce_tgt_cfg; 164 u32 num_ce_svc_pipe_cfg; 165 struct cnss_ce_svc_pipe_cfg *ce_svc_cfg; 166 u32 num_shadow_reg_cfg; 167 struct cnss_shadow_reg_cfg *shadow_reg_cfg; 168 u32 num_shadow_reg_v2_cfg; 169 struct cnss_shadow_reg_v2_cfg *shadow_reg_v2_cfg; 170 bool rri_over_ddr_cfg_valid; 171 struct cnss_rri_over_ddr_cfg rri_over_ddr_cfg; 172 }; 173 174 enum cnss_driver_mode { 175 CNSS_MISSION, 176 CNSS_FTM, 177 CNSS_EPPING, 178 CNSS_WALTEST, 179 CNSS_OFF, 180 CNSS_CCPM, 181 CNSS_QVIT, 182 CNSS_CALIBRATION, 183 }; 184 185 enum cnss_recovery_reason { 186 CNSS_REASON_DEFAULT, 187 CNSS_REASON_LINK_DOWN, 188 CNSS_REASON_RDDM, 189 CNSS_REASON_TIMEOUT, 190 }; 191 192 enum cnss_remote_mem_type { 193 CNSS_REMOTE_MEM_TYPE_FW, 194 CNSS_REMOTE_MEM_TYPE_QDSS, 195 CNSS_REMOTE_MEM_TYPE_MAX, 196 }; 197 198 struct cnss_mem_segment { 199 size_t size; 200 void *va; 201 phys_addr_t pa; 202 }; 203 204 extern int cnss_wlan_register_driver(struct cnss_wlan_driver *driver); 205 extern void cnss_wlan_unregister_driver(struct cnss_wlan_driver *driver); 206 extern void cnss_device_crashed(struct device *dev); 207 extern int cnss_pci_prevent_l1(struct device *dev); 208 extern void cnss_pci_allow_l1(struct device *dev); 209 extern int cnss_pci_link_down(struct device *dev); 210 extern int cnss_pci_is_device_down(struct device *dev); 211 extern void cnss_schedule_recovery(struct device *dev, 212 enum cnss_recovery_reason reason); 213 extern int cnss_self_recovery(struct device *dev, 214 enum cnss_recovery_reason reason); 215 extern int cnss_force_fw_assert(struct device *dev); 216 extern int cnss_force_collect_rddm(struct device *dev); 217 extern int cnss_qmi_send_get(struct device *dev); 218 extern int cnss_qmi_send_put(struct device *dev); 219 extern int cnss_qmi_send(struct device *dev, int type, void *cmd, 220 int cmd_len, void *cb_ctx, 221 int (*cb)(void *ctx, void *event, int event_len)); 222 extern void *cnss_get_virt_ramdump_mem(struct device *dev, unsigned long *size); 223 extern int cnss_get_fw_files_for_target(struct device *dev, 224 struct cnss_fw_files *pfw_files, 225 u32 target_type, u32 target_version); 226 extern int cnss_get_platform_cap(struct device *dev, 227 struct cnss_platform_cap *cap); 228 extern struct iommu_domain *cnss_smmu_get_domain(struct device *dev); 229 extern int cnss_smmu_map(struct device *dev, 230 phys_addr_t paddr, uint32_t *iova_addr, size_t size); 231 extern int cnss_smmu_unmap(struct device *dev, uint32_t iova_addr, size_t size); 232 extern int cnss_get_soc_info(struct device *dev, struct cnss_soc_info *info); 233 extern int cnss_request_bus_bandwidth(struct device *dev, int bandwidth); 234 extern int cnss_power_up(struct device *dev); 235 extern int cnss_power_down(struct device *dev); 236 extern int cnss_idle_restart(struct device *dev); 237 extern int cnss_idle_shutdown(struct device *dev); 238 extern void cnss_request_pm_qos(struct device *dev, u32 qos_val); 239 extern void cnss_remove_pm_qos(struct device *dev); 240 extern void cnss_lock_pm_sem(struct device *dev); 241 extern void cnss_release_pm_sem(struct device *dev); 242 extern void cnss_pci_lock_reg_window(struct device *dev, unsigned long *flags); 243 extern void cnss_pci_unlock_reg_window(struct device *dev, 244 unsigned long *flags); 245 extern int cnss_wlan_pm_control(struct device *dev, bool vote); 246 extern int cnss_auto_suspend(struct device *dev); 247 extern int cnss_auto_resume(struct device *dev); 248 extern int cnss_pci_is_drv_connected(struct device *dev); 249 extern int cnss_pci_force_wake_request_sync(struct device *dev, int timeout); 250 extern int cnss_pci_force_wake_request(struct device *dev); 251 extern int cnss_pci_is_device_awake(struct device *dev); 252 extern int cnss_pci_force_wake_release(struct device *dev); 253 extern int cnss_get_user_msi_assignment(struct device *dev, char *user_name, 254 int *num_vectors, 255 uint32_t *user_base_data, 256 uint32_t *base_vector); 257 extern int cnss_get_msi_irq(struct device *dev, unsigned int vector); 258 extern void cnss_get_msi_address(struct device *dev, uint32_t *msi_addr_low, 259 uint32_t *msi_addr_high); 260 extern int cnss_wlan_enable(struct device *dev, 261 struct cnss_wlan_enable_cfg *config, 262 enum cnss_driver_mode mode, 263 const char *host_version); 264 extern int cnss_wlan_disable(struct device *dev, enum cnss_driver_mode mode); 265 extern unsigned int cnss_get_boot_timeout(struct device *dev); 266 extern int cnss_athdiag_read(struct device *dev, uint32_t offset, 267 uint32_t mem_type, uint32_t data_len, 268 uint8_t *output); 269 extern int cnss_athdiag_write(struct device *dev, uint32_t offset, 270 uint32_t mem_type, uint32_t data_len, 271 uint8_t *input); 272 extern int cnss_set_fw_log_mode(struct device *dev, uint8_t fw_log_mode); 273 extern int cnss_set_pcie_gen_speed(struct device *dev, u8 pcie_gen_speed); 274 extern int cnss_get_mem_seg_count(enum cnss_remote_mem_type type, u32 *seg); 275 extern int cnss_get_mem_segment_info(enum cnss_remote_mem_type type, 276 struct cnss_mem_segment segment[], 277 u32 segment_count); 278 #endif /* _NET_CNSS2_H */ 279