1 /* 2 * Copyright (c) 2016-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 #ifndef _HAL_HW_INTERNAL_H_ 20 #define _HAL_HW_INTERNAL_H_ 21 #include "qdf_types.h" 22 #include "qdf_lock.h" 23 #include "qdf_mem.h" 24 #include "rx_msdu_link.h" 25 #include "rx_reo_queue.h" 26 #include "rx_reo_queue_ext.h" 27 #include "wcss_seq_hwiobase.h" 28 #include "tlv_hdr.h" 29 #include "tlv_tag_def.h" 30 #include "reo_destination_ring.h" 31 #include "reo_reg_seq_hwioreg.h" 32 #include "reo_entrance_ring.h" 33 #include "reo_get_queue_stats.h" 34 #include "reo_get_queue_stats_status.h" 35 #include "tcl_data_cmd.h" 36 #include "tcl_gse_cmd.h" 37 #include "tcl_status_ring.h" 38 #include "mac_tcl_reg_seq_hwioreg.h" 39 #include "ce_src_desc.h" 40 #include "ce_stat_desc.h" 41 #include "wfss_ce_reg_seq_hwioreg.h" 42 #include "wbm_link_descriptor_ring.h" 43 #include "wbm_reg_seq_hwioreg.h" 44 #include "wbm_buffer_ring.h" 45 #include "wbm_release_ring.h" 46 #include "rx_msdu_desc_info.h" 47 #include "rx_mpdu_start.h" 48 #include "rx_mpdu_end.h" 49 #include "rx_msdu_start.h" 50 #include "rx_msdu_end.h" 51 #include "rx_attention.h" 52 #include "rx_ppdu_start.h" 53 #include "rx_ppdu_start_user_info.h" 54 #include "rx_ppdu_end_user_stats.h" 55 #include "rx_ppdu_end_user_stats_ext.h" 56 #include "rx_mpdu_desc_info.h" 57 #include "rxpcu_ppdu_end_info.h" 58 #include "phyrx_he_sig_a_su.h" 59 #include "phyrx_he_sig_a_mu_dl.h" 60 #if defined(CONFIG_MCL) && defined(QCA_WIFI_QCA6290_11AX) 61 #include "phyrx_he_sig_a_mu_ul.h" 62 #endif 63 #include "phyrx_he_sig_b1_mu.h" 64 #include "phyrx_he_sig_b2_mu.h" 65 #include "phyrx_he_sig_b2_ofdma.h" 66 #include "phyrx_l_sig_a.h" 67 #include "phyrx_l_sig_b.h" 68 #include "phyrx_vht_sig_a.h" 69 #include "phyrx_ht_sig.h" 70 #include "tx_msdu_extension.h" 71 #include "receive_rssi_info.h" 72 #include "phyrx_pkt_end.h" 73 #include "phyrx_rssi_legacy.h" 74 #include "wcss_version.h" 75 #include "rx_msdu_link.h" 76 77 #define HAL_SRNG_REO_EXCEPTION HAL_SRNG_REO2SW1 78 #define HAL_SRNG_REO_ALTERNATE_SELECT 0x7 79 #define HAL_NON_QOS_TID 16 80 81 /* calculate the register address offset from bar0 of shadow register x */ 82 #ifdef QCA_WIFI_QCA6390 83 #define SHADOW_REGISTER(x) (0x000008FC + (4 * (x))) 84 #else 85 #define SHADOW_REGISTER(x) (0x00003024 + (4 * (x))) 86 #endif 87 88 /* TODO: Check if the following can be provided directly by HW headers */ 89 #define SRNG_LOOP_CNT_MASK REO_DESTINATION_RING_15_LOOPING_COUNT_MASK 90 #define SRNG_LOOP_CNT_LSB REO_DESTINATION_RING_15_LOOPING_COUNT_LSB 91 92 #define HAL_DEFAULT_REO_TIMEOUT_MS 40 /* milliseconds */ 93 94 #define HAL_DESC_SET_FIELD(_desc, _word, _fld, _value) do { \ 95 ((uint32_t *)(_desc))[(_word ## _ ## _fld ## _OFFSET) >> 2] &= \ 96 ~(_word ## _ ## _fld ## _MASK); \ 97 ((uint32_t *)(_desc))[(_word ## _ ## _fld ## _OFFSET) >> 2] |= \ 98 ((_value) << _word ## _ ## _fld ## _LSB); \ 99 } while (0) 100 101 #define HAL_SM(_reg, _fld, _val) \ 102 (((_val) << (_reg ## _ ## _fld ## _SHFT)) & \ 103 (_reg ## _ ## _fld ## _BMSK)) 104 105 #define HAL_MS(_reg, _fld, _val) \ 106 (((_val) & (_reg ## _ ## _fld ## _BMSK)) >> \ 107 (_reg ## _ ## _fld ## _SHFT)) 108 109 #define HAL_REG_WRITE(_soc, _reg, _value) \ 110 hal_write32_mb(_soc, (_reg), (_value)) 111 112 #define HAL_REG_READ(_soc, _offset) \ 113 hal_read32_mb(_soc, (_offset)) 114 115 #define WBM_IDLE_DESC_LIST 1 116 117 /** 118 * Common SRNG register access macros: 119 * The SRNG registers are distributed across various UMAC and LMAC HW blocks, 120 * but the register group and format is exactly same for all rings, with some 121 * difference between producer rings (these are 'producer rings' with respect 122 * to HW and referred as 'destination rings' in SW) and consumer rings (these 123 * are 'consumer rings' with respect to HW and 124 * referred as 'source rings' in SW). 125 * The following macros provide uniform access to all SRNG rings. 126 */ 127 128 /* SRNG registers are split among two groups R0 and R2 and following 129 * definitions identify the group to which each register belongs to 130 */ 131 #define R0_INDEX 0 132 #define R2_INDEX 1 133 134 #define HWREG_INDEX(_reg_group) _reg_group ## _ ## INDEX 135 136 /* Registers in R0 group */ 137 #define BASE_LSB_GROUP R0 138 #define BASE_MSB_GROUP R0 139 #define ID_GROUP R0 140 #define STATUS_GROUP R0 141 #define MISC_GROUP R0 142 #define HP_ADDR_LSB_GROUP R0 143 #define HP_ADDR_MSB_GROUP R0 144 #define PRODUCER_INT_SETUP_GROUP R0 145 #define PRODUCER_INT_STATUS_GROUP R0 146 #define PRODUCER_FULL_COUNTER_GROUP R0 147 #define MSI1_BASE_LSB_GROUP R0 148 #define MSI1_BASE_MSB_GROUP R0 149 #define MSI1_DATA_GROUP R0 150 #define HP_TP_SW_OFFSET_GROUP R0 151 #define TP_ADDR_LSB_GROUP R0 152 #define TP_ADDR_MSB_GROUP R0 153 #define CONSUMER_INT_SETUP_IX0_GROUP R0 154 #define CONSUMER_INT_SETUP_IX1_GROUP R0 155 #define CONSUMER_INT_STATUS_GROUP R0 156 #define CONSUMER_EMPTY_COUNTER_GROUP R0 157 #define CONSUMER_PREFETCH_TIMER_GROUP R0 158 #define CONSUMER_PREFETCH_STATUS_GROUP R0 159 160 /* Registers in R2 group */ 161 #define HP_GROUP R2 162 #define TP_GROUP R2 163 164 /** 165 * Register definitions for all SRNG based rings are same, except few 166 * differences between source (HW consumer) and destination (HW producer) 167 * registers. Following macros definitions provide generic access to all 168 * SRNG based rings. 169 * For source rings, we will use the register/field definitions of SW2TCL1 170 * ring defined in the HW header file mac_tcl_reg_seq_hwioreg.h. To setup 171 * individual fields, SRNG_SM macros should be used with fields specified 172 * using SRNG_SRC_FLD(<register>, <field>), Register writes should be done 173 * using SRNG_SRC_REG_WRITE(<hal_srng>, <register>, <value>). 174 * Similarly for destination rings we will use definitions of REO2SW1 ring 175 * defined in the register reo_destination_ring.h. To setup individual 176 * fields SRNG_SM macros should be used with fields specified using 177 * SRNG_DST_FLD(<register>, <field>). Register writes should be done using 178 * SRNG_DST_REG_WRITE(<hal_srng>, <register>, <value>). 179 */ 180 181 #define SRNG_DST_REG_OFFSET(_reg, _reg_group) \ 182 HWIO_REO_ ## _reg_group ## _REO2SW1_RING_ ## _reg##_ADDR(0) 183 184 #define SRNG_SRC_REG_OFFSET(_reg, _reg_group) \ 185 HWIO_TCL_ ## _reg_group ## _SW2TCL1_RING_ ## _reg ## _ADDR(0) 186 187 #define _SRNG_DST_FLD(_reg_group, _reg_fld) \ 188 HWIO_REO_ ## _reg_group ## _REO2SW1_RING_ ## _reg_fld 189 #define _SRNG_SRC_FLD(_reg_group, _reg_fld) \ 190 HWIO_TCL_ ## _reg_group ## _SW2TCL1_RING_ ## _reg_fld 191 192 #define _SRNG_FLD(_reg_group, _reg_fld, _dir) \ 193 _SRNG_ ## _dir ## _FLD(_reg_group, _reg_fld) 194 195 #define SRNG_DST_FLD(_reg, _f) _SRNG_FLD(_reg ## _GROUP, _reg ## _ ## _f, DST) 196 #define SRNG_SRC_FLD(_reg, _f) _SRNG_FLD(_reg ## _GROUP, _reg ## _ ## _f, SRC) 197 198 #define SRNG_SRC_R0_START_OFFSET SRNG_SRC_REG_OFFSET(BASE_LSB, R0) 199 #define SRNG_DST_R0_START_OFFSET SRNG_DST_REG_OFFSET(BASE_LSB, R0) 200 201 #define SRNG_SRC_R2_START_OFFSET SRNG_SRC_REG_OFFSET(HP, R2) 202 #define SRNG_DST_R2_START_OFFSET SRNG_DST_REG_OFFSET(HP, R2) 203 204 #define SRNG_SRC_START_OFFSET(_reg_group) \ 205 SRNG_SRC_ ## _reg_group ## _START_OFFSET 206 #define SRNG_DST_START_OFFSET(_reg_group) \ 207 SRNG_DST_ ## _reg_group ## _START_OFFSET 208 #define SRNG_REG_ADDR(_srng, _reg, _reg_group, _dir) \ 209 ((_srng)->hwreg_base[HWREG_INDEX(_reg_group)] + \ 210 ((_srng)->hal_soc->hal_hw_reg_offset[_dir ## _ ##_reg])) 211 212 #define CALCULATE_REG_OFFSET(_dir, _reg, _reg_group) \ 213 (SRNG_ ## _dir ## _REG_OFFSET(_reg, _reg_group) - \ 214 SRNG_ ## _dir ## _START_OFFSET(_reg_group)) 215 216 #define REG_OFFSET(_dir, _reg) \ 217 CALCULATE_REG_OFFSET(_dir, _reg, _reg ## _GROUP) 218 219 #define SRNG_DST_ADDR(_srng, _reg) \ 220 SRNG_REG_ADDR(_srng, _reg, _reg ## _GROUP, DST) 221 222 #define SRNG_SRC_ADDR(_srng, _reg) \ 223 SRNG_REG_ADDR(_srng, _reg, _reg ## _GROUP, SRC) 224 225 #define SRNG_REG_WRITE(_srng, _reg, _value, _dir) \ 226 hal_write_address_32_mb(_srng->hal_soc, \ 227 SRNG_ ## _dir ## _ADDR(_srng, _reg), (_value)) 228 229 #define SRNG_REG_READ(_srng, _reg, _dir) \ 230 hal_read_address_32_mb(_srng->hal_soc, \ 231 SRNG_ ## _dir ## _ADDR(_srng, _reg)) 232 233 #define SRNG_SRC_REG_WRITE(_srng, _reg, _value) \ 234 SRNG_REG_WRITE(_srng, _reg, _value, SRC) 235 236 #define SRNG_DST_REG_WRITE(_srng, _reg, _value) \ 237 SRNG_REG_WRITE(_srng, _reg, _value, DST) 238 239 #define SRNG_SRC_REG_READ(_srng, _reg) \ 240 SRNG_REG_READ(_srng, _reg, SRC) 241 242 #define SRNG_DST_REG_READ(_srng, _reg) \ 243 SRNG_REG_READ(_srng, _reg, DST) 244 245 #define _SRNG_FM(_reg_fld) _reg_fld ## _BMSK 246 #define _SRNG_FS(_reg_fld) _reg_fld ## _SHFT 247 248 #define SRNG_SM(_reg_fld, _val) \ 249 (((_val) << _SRNG_FS(_reg_fld)) & _SRNG_FM(_reg_fld)) 250 251 #define SRNG_MS(_reg_fld, _val) \ 252 (((_val) & _SRNG_FM(_reg_fld)) >> _SRNG_FS(_reg_fld)) 253 254 #define SRNG_MAX_SIZE_DWORDS \ 255 (SRNG_MS(SRNG_SRC_FLD(BASE_MSB, RING_SIZE), 0xffffffff)) 256 257 /** 258 * HW ring configuration table to identify hardware ring attributes like 259 * register addresses, number of rings, ring entry size etc., for each type 260 * of SRNG ring. 261 * 262 * Currently there is just one HW ring table, but there could be multiple 263 * configurations in future based on HW variants from the same wifi3.0 family 264 * and hence need to be attached with hal_soc based on HW type 265 */ 266 #define HAL_SRNG_CONFIG(_hal_soc, _ring_type) \ 267 (&_hal_soc->hw_srng_table[_ring_type]) 268 269 enum SRNG_REGISTERS { 270 DST_HP = 0, 271 DST_TP, 272 DST_ID, 273 DST_MISC, 274 DST_HP_ADDR_LSB, 275 DST_HP_ADDR_MSB, 276 DST_MSI1_BASE_LSB, 277 DST_MSI1_BASE_MSB, 278 DST_MSI1_DATA, 279 DST_BASE_LSB, 280 DST_BASE_MSB, 281 DST_PRODUCER_INT_SETUP, 282 283 SRC_HP, 284 SRC_TP, 285 SRC_ID, 286 SRC_MISC, 287 SRC_TP_ADDR_LSB, 288 SRC_TP_ADDR_MSB, 289 SRC_MSI1_BASE_LSB, 290 SRC_MSI1_BASE_MSB, 291 SRC_MSI1_DATA, 292 SRC_BASE_LSB, 293 SRC_BASE_MSB, 294 SRC_CONSUMER_INT_SETUP_IX0, 295 SRC_CONSUMER_INT_SETUP_IX1, 296 }; 297 298 /** 299 * hal_set_link_desc_addr - Setup link descriptor in a buffer_addr_info 300 * HW structure 301 * 302 * @desc: Descriptor entry (from WBM_IDLE_LINK ring) 303 * @cookie: SW cookie for the buffer/descriptor 304 * @link_desc_paddr: Physical address of link descriptor entry 305 * 306 */ 307 static inline void hal_set_link_desc_addr(void *desc, uint32_t cookie, 308 qdf_dma_addr_t link_desc_paddr) 309 { 310 uint32_t *buf_addr = (uint32_t *)desc; 311 312 HAL_DESC_SET_FIELD(buf_addr, BUFFER_ADDR_INFO_0, BUFFER_ADDR_31_0, 313 link_desc_paddr & 0xffffffff); 314 HAL_DESC_SET_FIELD(buf_addr, BUFFER_ADDR_INFO_1, BUFFER_ADDR_39_32, 315 (uint64_t)link_desc_paddr >> 32); 316 HAL_DESC_SET_FIELD(buf_addr, BUFFER_ADDR_INFO_1, RETURN_BUFFER_MANAGER, 317 WBM_IDLE_DESC_LIST); 318 HAL_DESC_SET_FIELD(buf_addr, BUFFER_ADDR_INFO_1, SW_BUFFER_COOKIE, 319 cookie); 320 } 321 322 /** 323 * hal_get_reo_qdesc_size - Get size of reo queue descriptor 324 * 325 * @hal_soc: Opaque HAL SOC handle 326 * @ba_window_size: BlockAck window size 327 * @tid: TID number 328 * 329 */ 330 static inline uint32_t hal_get_reo_qdesc_size(void *hal_soc, 331 uint32_t ba_window_size, int tid) 332 { 333 /* Return descriptor size corresponding to window size of 2 since 334 * we set ba_window_size to 2 while setting up REO descriptors as 335 * a WAR to get 2k jump exception aggregates are received without 336 * a BA session. 337 */ 338 if (ba_window_size <= 1) { 339 if (tid != HAL_NON_QOS_TID) 340 return sizeof(struct rx_reo_queue) + 341 sizeof(struct rx_reo_queue_ext); 342 else 343 return sizeof(struct rx_reo_queue); 344 } 345 346 if (ba_window_size <= 105) 347 return sizeof(struct rx_reo_queue) + 348 sizeof(struct rx_reo_queue_ext); 349 350 if (ba_window_size <= 210) 351 return sizeof(struct rx_reo_queue) + 352 (2 * sizeof(struct rx_reo_queue_ext)); 353 354 return sizeof(struct rx_reo_queue) + 355 (3 * sizeof(struct rx_reo_queue_ext)); 356 } 357 358 #endif /* _HAL_HW_INTERNAL_H_ */ 359