1 /* 2 * Copyright (c) 2013-2018 The Linux Foundation. All rights reserved. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for 5 * any purpose with or without fee is hereby granted, provided that the 6 * above copyright notice and this permission notice appear in all 7 * copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 10 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 11 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 12 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 13 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 14 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 15 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 16 * PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 /* 20 * NB: Inappropriate references to "HTC" are used in this (and other) 21 * HIF implementations. HTC is typically the calling layer, but it 22 * theoretically could be some alternative. 23 */ 24 25 /* 26 * This holds all state needed to process a pending send/recv interrupt. 27 * The information is saved here as soon as the interrupt occurs (thus 28 * allowing the underlying CE to re-use the ring descriptor). The 29 * information here is eventually processed by a completion processing 30 * thread. 31 */ 32 33 #ifndef __HIF_MAIN_H__ 34 #define __HIF_MAIN_H__ 35 36 #include <qdf_atomic.h> /* qdf_atomic_read */ 37 #include "qdf_lock.h" 38 #include "cepci.h" 39 #include "hif.h" 40 #include "multibus.h" 41 #include "hif_unit_test_suspend_i.h" 42 43 #define HIF_MIN_SLEEP_INACTIVITY_TIME_MS 50 44 #define HIF_SLEEP_INACTIVITY_TIMER_PERIOD_MS 60 45 46 #define HIF_MAX_BUDGET 0xFFFF 47 48 /* 49 * This macro implementation is exposed for efficiency only. 50 * The implementation may change and callers should 51 * consider the targid to be a completely opaque handle. 52 */ 53 #define TARGID_TO_PCI_ADDR(targid) (*((A_target_id_t *)(targid))) 54 55 #ifdef QCA_WIFI_3_0 56 #define DISABLE_L1SS_STATES 1 57 #endif 58 59 #define MAX_NUM_OF_RECEIVES HIF_NAPI_MAX_RECEIVES 60 61 #ifdef QCA_WIFI_3_0_ADRASTEA 62 #define ADRASTEA_BU 1 63 #else 64 #define ADRASTEA_BU 0 65 #endif 66 67 #ifdef QCA_WIFI_3_0 68 #define HAS_FW_INDICATOR 0 69 #else 70 #define HAS_FW_INDICATOR 1 71 #endif 72 73 74 #define AR9888_DEVICE_ID (0x003c) 75 #define AR6320_DEVICE_ID (0x003e) 76 #define AR6320_FW_1_1 (0x11) 77 #define AR6320_FW_1_3 (0x13) 78 #define AR6320_FW_2_0 (0x20) 79 #define AR6320_FW_3_0 (0x30) 80 #define AR6320_FW_3_2 (0x32) 81 #define QCA6290_EMULATION_DEVICE_ID (0xabcd) 82 #define QCA6290_DEVICE_ID (0x1100) 83 #define ADRASTEA_DEVICE_ID_P2_E12 (0x7021) 84 #define AR9887_DEVICE_ID (0x0050) 85 #define AR900B_DEVICE_ID (0x0040) 86 #define QCA9984_DEVICE_ID (0x0046) 87 #define QCA9888_DEVICE_ID (0x0056) 88 #ifndef IPQ4019_DEVICE_ID 89 #define IPQ4019_DEVICE_ID (0x12ef) 90 #endif 91 #define QCA8074_DEVICE_ID (0xffff) /* Todo: replace this with 92 actual number once available. 93 currently defining this to 0xffff for 94 emulation purpose */ 95 #define RUMIM2M_DEVICE_ID_NODE0 0xabc0 96 #define RUMIM2M_DEVICE_ID_NODE1 0xabc1 97 #define RUMIM2M_DEVICE_ID_NODE2 0xabc2 98 #define RUMIM2M_DEVICE_ID_NODE3 0xabc3 99 100 #define HIF_GET_PCI_SOFTC(scn) ((struct hif_pci_softc *)scn) 101 #define HIF_GET_CE_STATE(scn) ((struct HIF_CE_state *)scn) 102 #define HIF_GET_SDIO_SOFTC(scn) ((struct hif_sdio_softc *)scn) 103 #define HIF_GET_USB_SOFTC(scn) ((struct hif_usb_softc *)scn) 104 #define HIF_GET_USB_DEVICE(scn) ((struct HIF_DEVICE_USB *)scn) 105 #define HIF_GET_SOFTC(scn) ((struct hif_softc *)scn) 106 #define GET_HIF_OPAQUE_HDL(scn) ((struct hif_opaque_softc *)scn) 107 108 struct hif_ce_stats { 109 int hif_pipe_no_resrc_count; 110 int ce_ring_delta_fail_count; 111 }; 112 113 /* 114 * Note: For MCL, #if defined (HIF_CONFIG_SLUB_DEBUG_ON) needs to be checked 115 * for defined here 116 */ 117 #if HIF_CE_DEBUG_DATA_BUF 118 struct ce_desc_hist { 119 qdf_atomic_t history_index[CE_COUNT_MAX]; 120 uint32_t enable[CE_COUNT_MAX]; 121 uint32_t data_enable[CE_COUNT_MAX]; 122 uint32_t hist_index; 123 uint32_t hist_id; 124 void *hist_ev[CE_COUNT_MAX]; 125 }; 126 #endif /* #if defined(HIF_CONFIG_SLUB_DEBUG_ON) || HIF_CE_DEBUG_DATA_BUF */ 127 128 struct hif_softc { 129 struct hif_opaque_softc osc; 130 struct hif_config_info hif_config; 131 struct hif_target_info target_info; 132 void __iomem *mem; 133 enum qdf_bus_type bus_type; 134 struct hif_bus_ops bus_ops; 135 void *ce_id_to_state[CE_COUNT_MAX]; 136 qdf_device_t qdf_dev; 137 bool hif_init_done; 138 bool request_irq_done; 139 bool ext_grp_irq_configured; 140 /* Packet statistics */ 141 struct hif_ce_stats pkt_stats; 142 enum hif_target_status target_status; 143 144 struct targetdef_s *targetdef; 145 struct ce_reg_def *target_ce_def; 146 struct hostdef_s *hostdef; 147 struct host_shadow_regs_s *host_shadow_regs; 148 149 bool recovery; 150 bool notice_send; 151 bool per_ce_irq; 152 uint32_t ce_irq_summary; 153 /* No of copy engines supported */ 154 unsigned int ce_count; 155 atomic_t active_tasklet_cnt; 156 atomic_t active_grp_tasklet_cnt; 157 atomic_t link_suspended; 158 uint32_t *vaddr_rri_on_ddr; 159 qdf_dma_addr_t paddr_rri_on_ddr; 160 int linkstate_vote; 161 bool fastpath_mode_on; 162 bool polled_mode_on; 163 atomic_t tasklet_from_intr; 164 int htc_htt_tx_endpoint; 165 qdf_dma_addr_t mem_pa; 166 bool athdiag_procfs_inited; 167 #ifdef FEATURE_NAPI 168 struct qca_napi_data napi_data; 169 #endif /* FEATURE_NAPI */ 170 /* stores ce_service_max_yield_time in ns */ 171 unsigned long long ce_service_max_yield_time; 172 uint8_t ce_service_max_rx_ind_flush; 173 struct hif_driver_state_callbacks callbacks; 174 uint32_t hif_con_param; 175 #ifdef QCA_NSS_WIFI_OFFLOAD_SUPPORT 176 uint32_t nss_wifi_ol_mode; 177 #endif 178 void *hal_soc; 179 struct hif_ut_suspend_context ut_suspend_ctx; 180 uint32_t hif_attribute; 181 int wake_irq; 182 void (*initial_wakeup_cb)(void *); 183 void *initial_wakeup_priv; 184 #ifdef REMOVE_PKT_LOG 185 /* Handle to pktlog device */ 186 void *pktlog_dev; 187 #endif 188 189 /* 190 * Note: For MCL, #if defined (HIF_CONFIG_SLUB_DEBUG_ON) needs to be checked 191 * for defined here 192 */ 193 #if HIF_CE_DEBUG_DATA_BUF 194 struct ce_desc_hist hif_ce_desc_hist; 195 #endif /* #if defined(HIF_CONFIG_SLUB_DEBUG_ON) || HIF_CE_DEBUG_DATA_BUF */ 196 #ifdef IPA_OFFLOAD 197 qdf_shared_mem_t *ipa_ce_ring; 198 #endif 199 }; 200 201 static inline void *hif_get_hal_handle(void *hif_hdl) 202 { 203 struct hif_softc *sc = (struct hif_softc *)hif_hdl; 204 205 if (!sc) 206 return NULL; 207 208 return sc->hal_soc; 209 } 210 211 #ifdef QCA_NSS_WIFI_OFFLOAD_SUPPORT 212 static inline bool hif_is_nss_wifi_enabled(struct hif_softc *sc) 213 { 214 return !!(sc->nss_wifi_ol_mode); 215 } 216 #else 217 static inline bool hif_is_nss_wifi_enabled(struct hif_softc *sc) 218 { 219 return false; 220 } 221 #endif 222 223 static inline uint8_t hif_is_attribute_set(struct hif_softc *sc, 224 uint32_t hif_attrib) 225 { 226 return sc->hif_attribute == hif_attrib; 227 } 228 229 A_target_id_t hif_get_target_id(struct hif_softc *scn); 230 void hif_dump_pipe_debug_count(struct hif_softc *scn); 231 void hif_display_bus_stats(struct hif_opaque_softc *scn); 232 void hif_clear_bus_stats(struct hif_opaque_softc *scn); 233 bool hif_max_num_receives_reached(struct hif_softc *scn, unsigned int count); 234 void hif_shutdown_device(struct hif_opaque_softc *hif_ctx); 235 int hif_bus_configure(struct hif_softc *scn); 236 void hif_cancel_deferred_target_sleep(struct hif_softc *scn); 237 int hif_config_ce(struct hif_softc *scn); 238 void hif_unconfig_ce(struct hif_softc *scn); 239 void hif_ce_prepare_config(struct hif_softc *scn); 240 QDF_STATUS hif_ce_open(struct hif_softc *scn); 241 void hif_ce_close(struct hif_softc *scn); 242 int athdiag_procfs_init(void *scn); 243 void athdiag_procfs_remove(void); 244 /* routine to modify the initial buffer count to be allocated on an os 245 * platform basis. Platform owner will need to modify this as needed 246 */ 247 qdf_size_t init_buffer_count(qdf_size_t maxSize); 248 249 irqreturn_t hif_fw_interrupt_handler(int irq, void *arg); 250 int hif_get_device_type(uint32_t device_id, 251 uint32_t revision_id, 252 uint32_t *hif_type, uint32_t *target_type); 253 /*These functions are exposed to HDD*/ 254 void hif_nointrs(struct hif_softc *scn); 255 void hif_bus_close(struct hif_softc *ol_sc); 256 QDF_STATUS hif_bus_open(struct hif_softc *ol_sc, 257 enum qdf_bus_type bus_type); 258 QDF_STATUS hif_enable_bus(struct hif_softc *ol_sc, struct device *dev, 259 void *bdev, const struct hif_bus_id *bid, enum hif_enable_type type); 260 void hif_disable_bus(struct hif_softc *scn); 261 void hif_bus_prevent_linkdown(struct hif_softc *scn, bool flag); 262 int hif_bus_get_context_size(enum qdf_bus_type bus_type); 263 void hif_read_phy_mem_base(struct hif_softc *scn, qdf_dma_addr_t *bar_value); 264 uint32_t hif_get_conparam(struct hif_softc *scn); 265 struct hif_driver_state_callbacks *hif_get_callbacks_handle( 266 struct hif_softc *scn); 267 bool hif_is_driver_unloading(struct hif_softc *scn); 268 bool hif_is_load_or_unload_in_progress(struct hif_softc *scn); 269 bool hif_is_recovery_in_progress(struct hif_softc *scn); 270 bool hif_is_target_ready(struct hif_softc *scn); 271 void hif_wlan_disable(struct hif_softc *scn); 272 int hif_target_sleep_state_adjust(struct hif_softc *scn, 273 bool sleep_ok, 274 bool wait_for_it); 275 /** 276 * hif_get_rx_ctx_id() - Returns NAPI instance ID based on CE ID 277 * @ctx_id: Rx CE context ID 278 * @hif_hdl: HIF Context 279 * 280 * Return: Rx instance ID 281 */ 282 int hif_get_rx_ctx_id(int ctx_id, struct hif_opaque_softc *hif_hdl); 283 void hif_ramdump_handler(struct hif_opaque_softc *scn); 284 #ifdef HIF_USB 285 void hif_usb_get_hw_info(struct hif_softc *scn); 286 void hif_usb_ramdump_handler(struct hif_opaque_softc *scn); 287 #else 288 static inline void hif_usb_get_hw_info(struct hif_softc *scn) {} 289 static inline void hif_usb_ramdump_handler(struct hif_opaque_softc *scn) {} 290 #endif 291 292 /** 293 * hif_wake_interrupt_handler() - interrupt handler for standalone wake irq 294 * @irq: the irq number that fired 295 * @context: the opaque pointer passed to request_irq() 296 * 297 * Return: an irq return type 298 */ 299 irqreturn_t hif_wake_interrupt_handler(int irq, void *context); 300 301 #ifdef HIF_SNOC 302 bool hif_is_target_register_access_allowed(struct hif_softc *hif_sc); 303 #else 304 static inline 305 bool hif_is_target_register_access_allowed(struct hif_softc *hif_sc) 306 { 307 return true; 308 } 309 #endif 310 311 #ifdef ADRASTEA_RRI_ON_DDR 312 void hif_uninit_rri_on_ddr(struct hif_softc *scn); 313 #else 314 static inline 315 void hif_uninit_rri_on_ddr(struct hif_softc *scn) {} 316 #endif 317 #endif /* __HIF_MAIN_H__ */ 318