drivers/net/wireless/ath/wil6210/wil6210.h

   1 /*
   2  * Copyright (c) 2012-2017 Qualcomm Atheros, Inc.
   3  * Copyright (c) 2018, The Linux Foundation. All rights reserved.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #ifndef __WIL6210_H__
  19 #define __WIL6210_H__
  20
  21 #include <linux/etherdevice.h>
  22 #include <linux/netdevice.h>
  23 #include <linux/wireless.h>
  24 #include <net/cfg80211.h>
  25 #include <linux/timex.h>
  26 #include <linux/types.h>
  27 #include <linux/irqreturn.h>
  28 #include "wmi.h"
  29 #include "wil_platform.h"
  30 #include "fw.h"
  31
  32 extern bool no_fw_recovery;
  33 extern unsigned int mtu_max;
  34 extern unsigned short rx_ring_overflow_thrsh;
  35 extern int agg_wsize;
  36 extern bool rx_align_2;
  37 extern bool rx_large_buf;
  38 extern bool debug_fw;
  39 extern bool disable_ap_sme;
  40 extern bool ftm_mode;
  41
  42 struct wil6210_priv;
  43 struct wil6210_vif;
  44 union wil_tx_desc;
  45
  46 #define WIL_NAME "wil6210"
  47
  48 #define WIL_FW_NAME_DEFAULT "/*(DEBLOBBED)*/"
  49 #define WIL_FW_NAME_FTM_DEFAULT "/*(DEBLOBBED)*/"
  50
  51 #define WIL_FW_NAME_SPARROW_PLUS "/*(DEBLOBBED)*/"
  52 #define WIL_FW_NAME_FTM_SPARROW_PLUS "/*(DEBLOBBED)*/"
  53
  54 #define WIL_FW_NAME_TALYN "/*(DEBLOBBED)*/"
  55 #define WIL_FW_NAME_FTM_TALYN "/*(DEBLOBBED)*/"
  56 #define WIL_BRD_NAME_TALYN "wil6436.brd"
  57
  58 #define WIL_BOARD_FILE_NAME "wil6210.brd" /* board & radio parameters */
  59
  60 #define WIL_DEFAULT_BUS_REQUEST_KBPS 128000 /* ~1Gbps */
  61 #define WIL_MAX_BUS_REQUEST_KBPS 800000 /* ~6.1Gbps */
  62
  63 #define WIL_NUM_LATENCY_BINS 200
  64
  65 /* maximum number of virtual interfaces the driver supports
  66  * (including the main interface)
  67  */
  68 #define WIL_MAX_VIFS 4
  69
  70 /**
  71  * extract bits [@b0:@b1] (inclusive) from the value @x
  72  * it should be @b0 <= @b1, or result is incorrect
  73  */
  74 static inline u32 WIL_GET_BITS(u32 x, int b0, int b1)
  75 {
  76         return (x >> b0) & ((1 << (b1 - b0 + 1)) - 1);
  77 }
  78
  79 #define WIL6210_MIN_MEM_SIZE (2 * 1024 * 1024UL)
  80 #define WIL6210_MAX_MEM_SIZE (4 * 1024 * 1024UL)
  81
  82 #define WIL_TX_Q_LEN_DEFAULT            (4000)
  83 #define WIL_RX_RING_SIZE_ORDER_DEFAULT  (10)
  84 #define WIL_TX_RING_SIZE_ORDER_DEFAULT  (12)
  85 #define WIL_BCAST_RING_SIZE_ORDER_DEFAULT       (7)
  86 #define WIL_BCAST_MCS0_LIMIT            (1024) /* limit for MCS0 frame size */
  87 /* limit ring size in range [32..32k] */
  88 #define WIL_RING_SIZE_ORDER_MIN (5)
  89 #define WIL_RING_SIZE_ORDER_MAX (15)
  90 #define WIL6210_MAX_TX_RINGS    (24) /* HW limit */
  91 #define WIL6210_MAX_CID         (8) /* HW limit */
  92 #define WIL6210_NAPI_BUDGET     (16) /* arbitrary */
  93 #define WIL_MAX_AMPDU_SIZE      (64 * 1024) /* FW/HW limit */
  94 #define WIL_MAX_AGG_WSIZE       (32) /* FW/HW limit */
  95 #define WIL_MAX_AMPDU_SIZE_128  (128 * 1024) /* FW/HW limit */
  96 #define WIL_MAX_AGG_WSIZE_64    (64) /* FW/HW limit */
  97 #define WIL6210_MAX_STATUS_RINGS        (8)
  98
  99 /* Hardware offload block adds the following:
 100  * 26 bytes - 3-address QoS data header
 101  *  8 bytes - IV + EIV (for GCMP)
 102  *  8 bytes - SNAP
 103  * 16 bytes - MIC (for GCMP)
 104  *  4 bytes - CRC
 105  */
 106 #define WIL_MAX_MPDU_OVERHEAD   (62)
 107
 108 struct wil_suspend_count_stats {
 109         unsigned long successful_suspends;
 110         unsigned long successful_resumes;
 111         unsigned long failed_suspends;
 112         unsigned long failed_resumes;
 113 };
 114
 115 struct wil_suspend_stats {
 116         struct wil_suspend_count_stats r_off;
 117         struct wil_suspend_count_stats r_on;
 118         unsigned long rejected_by_device; /* only radio on */
 119         unsigned long rejected_by_host;
 120 };
 121
 122 /* Calculate MAC buffer size for the firmware. It includes all overhead,
 123  * as it will go over the air, and need to be 8 byte aligned
 124  */
 125 static inline u32 wil_mtu2macbuf(u32 mtu)
 126 {
 127         return ALIGN(mtu + WIL_MAX_MPDU_OVERHEAD, 8);
 128 }
 129
 130 /* MTU for Ethernet need to take into account 8-byte SNAP header
 131  * to be added when encapsulating Ethernet frame into 802.11
 132  */
 133 #define WIL_MAX_ETH_MTU         (IEEE80211_MAX_DATA_LEN_DMG - 8)
 134 /* Max supported by wil6210 value for interrupt threshold is 5sec. */
 135 #define WIL6210_ITR_TRSH_MAX (5000000)
 136 #define WIL6210_ITR_TX_INTERFRAME_TIMEOUT_DEFAULT (13) /* usec */
 137 #define WIL6210_ITR_RX_INTERFRAME_TIMEOUT_DEFAULT (13) /* usec */
 138 #define WIL6210_ITR_TX_MAX_BURST_DURATION_DEFAULT (500) /* usec */
 139 #define WIL6210_ITR_RX_MAX_BURST_DURATION_DEFAULT (500) /* usec */
 140 #define WIL6210_FW_RECOVERY_RETRIES     (5) /* try to recover this many times */
 141 #define WIL6210_FW_RECOVERY_TO  msecs_to_jiffies(5000)
 142 #define WIL6210_SCAN_TO         msecs_to_jiffies(10000)
 143 #define WIL6210_DISCONNECT_TO_MS (2000)
 144 #define WIL6210_RX_HIGH_TRSH_INIT               (0)
 145 #define WIL6210_RX_HIGH_TRSH_DEFAULT \
 146                                 (1 << (WIL_RX_RING_SIZE_ORDER_DEFAULT - 3))
 147 #define WIL_MAX_DMG_AID 254 /* for DMG only 1-254 allowed (see
 148                              * 802.11REVmc/D5.0, section 9.4.1.8)
 149                              */
 150 /* Hardware definitions begin */
 151
 152 /*
 153  * Mapping
 154  * RGF File      | Host addr    |  FW addr
 155  *               |              |
 156  * user_rgf      | 0x000000     | 0x880000
 157  *  dma_rgf      | 0x001000     | 0x881000
 158  * pcie_rgf      | 0x002000     | 0x882000
 159  *               |              |
 160  */
 161
 162 /* Where various structures placed in host address space */
 163 #define WIL6210_FW_HOST_OFF      (0x880000UL)
 164
 165 #define HOSTADDR(fwaddr)        (fwaddr - WIL6210_FW_HOST_OFF)
 166
 167 /*
 168  * Interrupt control registers block
 169  *
 170  * each interrupt controlled by the same bit in all registers
 171  */
 172 struct RGF_ICR {
 173         u32 ICC; /* Cause Control, RW: 0 - W1C, 1 - COR */
 174         u32 ICR; /* Cause, W1C/COR depending on ICC */
 175         u32 ICM; /* Cause masked (ICR & ~IMV), W1C/COR depending on ICC */
 176         u32 ICS; /* Cause Set, WO */
 177         u32 IMV; /* Mask, RW+S/C */
 178         u32 IMS; /* Mask Set, write 1 to set */
 179         u32 IMC; /* Mask Clear, write 1 to clear */
 180 } __packed;
 181
 182 /* registers - FW addresses */
 183 #define RGF_USER_USAGE_1                (0x880004)
 184 #define RGF_USER_USAGE_6                (0x880018)
 185         #define BIT_USER_OOB_MODE               BIT(31)
 186         #define BIT_USER_OOB_R2_MODE            BIT(30)
 187 #define RGF_USER_USAGE_8                (0x880020)
 188         #define BIT_USER_PREVENT_DEEP_SLEEP     BIT(0)
 189         #define BIT_USER_SUPPORT_T_POWER_ON_0   BIT(1)
 190         #define BIT_USER_EXT_CLK                BIT(2)
 191 #define RGF_USER_HW_MACHINE_STATE       (0x8801dc)
 192         #define HW_MACHINE_BOOT_DONE    (0x3fffffd)
 193 #define RGF_USER_USER_CPU_0             (0x8801e0)
 194         #define BIT_USER_USER_CPU_MAN_RST       BIT(1) /* user_cpu_man_rst */
 195 #define RGF_USER_CPU_PC                 (0x8801e8)
 196 #define RGF_USER_MAC_CPU_0              (0x8801fc)
 197         #define BIT_USER_MAC_CPU_MAN_RST        BIT(1) /* mac_cpu_man_rst */
 198 #define RGF_USER_USER_SCRATCH_PAD       (0x8802bc)
 199 #define RGF_USER_BL                     (0x880A3C) /* Boot Loader */
 200 #define RGF_USER_FW_REV_ID              (0x880a8c) /* chip revision */
 201 #define RGF_USER_FW_CALIB_RESULT        (0x880a90) /* b0-7:result
 202                                                     * b8-15:signature
 203                                                     */
 204         #define CALIB_RESULT_SIGNATURE  (0x11)
 205 #define RGF_USER_CLKS_CTL_0             (0x880abc)
 206         #define BIT_USER_CLKS_CAR_AHB_SW_SEL    BIT(1) /* ref clk/PLL */
 207         #define BIT_USER_CLKS_RST_PWGD  BIT(11) /* reset on "power good" */
 208 #define RGF_USER_CLKS_CTL_SW_RST_VEC_0  (0x880b04)
 209 #define RGF_USER_CLKS_CTL_SW_RST_VEC_1  (0x880b08)
 210 #define RGF_USER_CLKS_CTL_SW_RST_VEC_2  (0x880b0c)
 211 #define RGF_USER_CLKS_CTL_SW_RST_VEC_3  (0x880b10)
 212 #define RGF_USER_CLKS_CTL_SW_RST_MASK_0 (0x880b14)
 213         #define BIT_HPAL_PERST_FROM_PAD BIT(6)
 214         #define BIT_CAR_PERST_RST       BIT(7)
 215 #define RGF_USER_USER_ICR               (0x880b4c) /* struct RGF_ICR */
 216         #define BIT_USER_USER_ICR_SW_INT_2      BIT(18)
 217 #define RGF_USER_CLKS_CTL_EXT_SW_RST_VEC_0      (0x880c18)
 218 #define RGF_USER_CLKS_CTL_EXT_SW_RST_VEC_1      (0x880c2c)
 219 #define RGF_USER_SPARROW_M_4                    (0x880c50) /* Sparrow */
 220         #define BIT_SPARROW_M_4_SEL_SLEEP_OR_REF        BIT(2)
 221 #define RGF_USER_OTP_HW_RD_MACHINE_1    (0x880ce0)
 222         #define BIT_OTP_SIGNATURE_ERR_TALYN_MB          BIT(0)
 223         #define BIT_OTP_HW_SECTION_DONE_TALYN_MB        BIT(2)
 224         #define BIT_NO_FLASH_INDICATION                 BIT(8)
 225 #define RGF_USER_XPM_IFC_RD_TIME1       (0x880cec)
 226 #define RGF_USER_XPM_IFC_RD_TIME2       (0x880cf0)
 227 #define RGF_USER_XPM_IFC_RD_TIME3       (0x880cf4)
 228 #define RGF_USER_XPM_IFC_RD_TIME4       (0x880cf8)
 229 #define RGF_USER_XPM_IFC_RD_TIME5       (0x880cfc)
 230 #define RGF_USER_XPM_IFC_RD_TIME6       (0x880d00)
 231 #define RGF_USER_XPM_IFC_RD_TIME7       (0x880d04)
 232 #define RGF_USER_XPM_IFC_RD_TIME8       (0x880d08)
 233 #define RGF_USER_XPM_IFC_RD_TIME9       (0x880d0c)
 234 #define RGF_USER_XPM_IFC_RD_TIME10      (0x880d10)
 235 #define RGF_USER_XPM_RD_DOUT_SAMPLE_TIME (0x880d64)
 236
 237 #define RGF_DMA_EP_TX_ICR               (0x881bb4) /* struct RGF_ICR */
 238         #define BIT_DMA_EP_TX_ICR_TX_DONE       BIT(0)
 239         #define BIT_DMA_EP_TX_ICR_TX_DONE_N(n)  BIT(n+1) /* n = [0..23] */
 240 #define RGF_DMA_EP_RX_ICR               (0x881bd0) /* struct RGF_ICR */
 241         #define BIT_DMA_EP_RX_ICR_RX_DONE       BIT(0)
 242         #define BIT_DMA_EP_RX_ICR_RX_HTRSH      BIT(1)
 243 #define RGF_DMA_EP_MISC_ICR             (0x881bec) /* struct RGF_ICR */
 244         #define BIT_DMA_EP_MISC_ICR_RX_HTRSH    BIT(0)
 245         #define BIT_DMA_EP_MISC_ICR_TX_NO_ACT   BIT(1)
 246         #define BIT_DMA_EP_MISC_ICR_HALP        BIT(27)
 247         #define BIT_DMA_EP_MISC_ICR_FW_INT(n)   BIT(28+n) /* n = [0..3] */
 248
 249 /* Legacy interrupt moderation control (before Sparrow v2)*/
 250 #define RGF_DMA_ITR_CNT_TRSH            (0x881c5c)
 251 #define RGF_DMA_ITR_CNT_DATA            (0x881c60)
 252 #define RGF_DMA_ITR_CNT_CRL             (0x881c64)
 253         #define BIT_DMA_ITR_CNT_CRL_EN          BIT(0)
 254         #define BIT_DMA_ITR_CNT_CRL_EXT_TICK    BIT(1)
 255         #define BIT_DMA_ITR_CNT_CRL_FOREVER     BIT(2)
 256         #define BIT_DMA_ITR_CNT_CRL_CLR         BIT(3)
 257         #define BIT_DMA_ITR_CNT_CRL_REACH_TRSH  BIT(4)
 258
 259 /* Offload control (Sparrow B0+) */
 260 #define RGF_DMA_OFUL_NID_0              (0x881cd4)
 261         #define BIT_DMA_OFUL_NID_0_RX_EXT_TR_EN         BIT(0)
 262         #define BIT_DMA_OFUL_NID_0_TX_EXT_TR_EN         BIT(1)
 263         #define BIT_DMA_OFUL_NID_0_RX_EXT_A3_SRC        BIT(2)
 264         #define BIT_DMA_OFUL_NID_0_TX_EXT_A3_SRC        BIT(3)
 265
 266 /* New (sparrow v2+) interrupt moderation control */
 267 #define RGF_DMA_ITR_TX_DESQ_NO_MOD              (0x881d40)
 268 #define RGF_DMA_ITR_TX_CNT_TRSH                 (0x881d34)
 269 #define RGF_DMA_ITR_TX_CNT_DATA                 (0x881d38)
 270 #define RGF_DMA_ITR_TX_CNT_CTL                  (0x881d3c)
 271         #define BIT_DMA_ITR_TX_CNT_CTL_EN               BIT(0)
 272         #define BIT_DMA_ITR_TX_CNT_CTL_EXT_TIC_SEL      BIT(1)
 273         #define BIT_DMA_ITR_TX_CNT_CTL_FOREVER          BIT(2)
 274         #define BIT_DMA_ITR_TX_CNT_CTL_CLR              BIT(3)
 275         #define BIT_DMA_ITR_TX_CNT_CTL_REACHED_TRESH    BIT(4)
 276         #define BIT_DMA_ITR_TX_CNT_CTL_CROSS_EN         BIT(5)
 277         #define BIT_DMA_ITR_TX_CNT_CTL_FREE_RUNNIG      BIT(6)
 278 #define RGF_DMA_ITR_TX_IDL_CNT_TRSH                     (0x881d60)
 279 #define RGF_DMA_ITR_TX_IDL_CNT_DATA                     (0x881d64)
 280 #define RGF_DMA_ITR_TX_IDL_CNT_CTL                      (0x881d68)
 281         #define BIT_DMA_ITR_TX_IDL_CNT_CTL_EN                   BIT(0)
 282         #define BIT_DMA_ITR_TX_IDL_CNT_CTL_EXT_TIC_SEL          BIT(1)
 283         #define BIT_DMA_ITR_TX_IDL_CNT_CTL_FOREVER              BIT(2)
 284         #define BIT_DMA_ITR_TX_IDL_CNT_CTL_CLR                  BIT(3)
 285         #define BIT_DMA_ITR_TX_IDL_CNT_CTL_REACHED_TRESH        BIT(4)
 286 #define RGF_DMA_ITR_RX_DESQ_NO_MOD              (0x881d50)
 287 #define RGF_DMA_ITR_RX_CNT_TRSH                 (0x881d44)
 288 #define RGF_DMA_ITR_RX_CNT_DATA                 (0x881d48)
 289 #define RGF_DMA_ITR_RX_CNT_CTL                  (0x881d4c)
 290         #define BIT_DMA_ITR_RX_CNT_CTL_EN               BIT(0)
 291         #define BIT_DMA_ITR_RX_CNT_CTL_EXT_TIC_SEL      BIT(1)
 292         #define BIT_DMA_ITR_RX_CNT_CTL_FOREVER          BIT(2)
 293         #define BIT_DMA_ITR_RX_CNT_CTL_CLR              BIT(3)
 294         #define BIT_DMA_ITR_RX_CNT_CTL_REACHED_TRESH    BIT(4)
 295         #define BIT_DMA_ITR_RX_CNT_CTL_CROSS_EN         BIT(5)
 296         #define BIT_DMA_ITR_RX_CNT_CTL_FREE_RUNNIG      BIT(6)
 297 #define RGF_DMA_ITR_RX_IDL_CNT_TRSH                     (0x881d54)
 298 #define RGF_DMA_ITR_RX_IDL_CNT_DATA                     (0x881d58)
 299 #define RGF_DMA_ITR_RX_IDL_CNT_CTL                      (0x881d5c)
 300         #define BIT_DMA_ITR_RX_IDL_CNT_CTL_EN                   BIT(0)
 301         #define BIT_DMA_ITR_RX_IDL_CNT_CTL_EXT_TIC_SEL          BIT(1)
 302         #define BIT_DMA_ITR_RX_IDL_CNT_CTL_FOREVER              BIT(2)
 303         #define BIT_DMA_ITR_RX_IDL_CNT_CTL_CLR                  BIT(3)
 304         #define BIT_DMA_ITR_RX_IDL_CNT_CTL_REACHED_TRESH        BIT(4)
 305 #define RGF_DMA_MISC_CTL                                (0x881d6c)
 306         #define BIT_OFUL34_RDY_VALID_BUG_FIX_EN                 BIT(7)
 307
 308 #define RGF_DMA_PSEUDO_CAUSE            (0x881c68)
 309 #define RGF_DMA_PSEUDO_CAUSE_MASK_SW    (0x881c6c)
 310 #define RGF_DMA_PSEUDO_CAUSE_MASK_FW    (0x881c70)
 311         #define BIT_DMA_PSEUDO_CAUSE_RX         BIT(0)
 312         #define BIT_DMA_PSEUDO_CAUSE_TX         BIT(1)
 313         #define BIT_DMA_PSEUDO_CAUSE_MISC       BIT(2)
 314
 315 #define RGF_HP_CTRL                     (0x88265c)
 316 #define RGF_PAL_UNIT_ICR                (0x88266c) /* struct RGF_ICR */
 317 #define RGF_PCIE_LOS_COUNTER_CTL        (0x882dc4)
 318
 319 /* MAC timer, usec, for packet lifetime */
 320 #define RGF_MAC_MTRL_COUNTER_0          (0x886aa8)
 321
 322 #define RGF_CAF_ICR_TALYN_MB            (0x8893d4) /* struct RGF_ICR */
 323 #define RGF_CAF_ICR                     (0x88946c) /* struct RGF_ICR */
 324 #define RGF_CAF_OSC_CONTROL             (0x88afa4)
 325         #define BIT_CAF_OSC_XTAL_EN             BIT(0)
 326 #define RGF_CAF_PLL_LOCK_STATUS         (0x88afec)
 327         #define BIT_CAF_OSC_DIG_XTAL_STABLE     BIT(0)
 328
 329 #define RGF_OTP_QC_SECURED              (0x8a0038)
 330         #define BIT_BOOT_FROM_ROM               BIT(31)
 331
 332 /* eDMA */
 333 #define RGF_INT_COUNT_ON_SPECIAL_EVT    (0x8b62d8)
 334
 335 #define RGF_INT_CTRL_INT_GEN_CFG_0      (0x8bc000)
 336 #define RGF_INT_CTRL_INT_GEN_CFG_1      (0x8bc004)
 337 #define RGF_INT_GEN_TIME_UNIT_LIMIT     (0x8bc0c8)
 338
 339 #define RGF_INT_GEN_CTRL                (0x8bc0ec)
 340         #define BIT_CONTROL_0                   BIT(0)
 341
 342 /* eDMA status interrupts */
 343 #define RGF_INT_GEN_RX_ICR              (0x8bc0f4)
 344         #define BIT_RX_STATUS_IRQ BIT(WIL_RX_STATUS_IRQ_IDX)
 345 #define RGF_INT_GEN_TX_ICR              (0x8bc110)
 346         #define BIT_TX_STATUS_IRQ BIT(WIL_TX_STATUS_IRQ_IDX)
 347 #define RGF_INT_CTRL_RX_INT_MASK        (0x8bc12c)
 348 #define RGF_INT_CTRL_TX_INT_MASK        (0x8bc130)
 349
 350 #define RGF_INT_GEN_IDLE_TIME_LIMIT     (0x8bc134)
 351
 352 #define USER_EXT_USER_PMU_3             (0x88d00c)
 353         #define BIT_PMU_DEVICE_RDY              BIT(0)
 354
 355 #define RGF_USER_JTAG_DEV_ID    (0x880b34) /* device ID */
 356         #define JTAG_DEV_ID_SPARROW     (0x2632072f)
 357         #define JTAG_DEV_ID_TALYN       (0x7e0e1)
 358         #define JTAG_DEV_ID_TALYN_MB    (0x1007e0e1)
 359
 360 #define RGF_USER_REVISION_ID            (0x88afe4)
 361 #define RGF_USER_REVISION_ID_MASK       (3)
 362         #define REVISION_ID_SPARROW_B0  (0x0)
 363         #define REVISION_ID_SPARROW_D0  (0x3)
 364
 365 #define RGF_OTP_MAC_TALYN_MB            (0x8a0304)
 366 #define RGF_OTP_MAC                     (0x8a0620)
 367
 368 /* Talyn-MB */
 369 #define RGF_USER_USER_CPU_0_TALYN_MB    (0x8c0138)
 370 #define RGF_USER_MAC_CPU_0_TALYN_MB     (0x8c0154)
 371
 372 /* crash codes for FW/Ucode stored here */
 373
 374 /* ASSERT RGFs */
 375 #define SPARROW_RGF_FW_ASSERT_CODE      (0x91f020)
 376 #define SPARROW_RGF_UCODE_ASSERT_CODE   (0x91f028)
 377 #define TALYN_RGF_FW_ASSERT_CODE        (0xa37020)
 378 #define TALYN_RGF_UCODE_ASSERT_CODE     (0xa37028)
 379
 380 enum {
 381         HW_VER_UNKNOWN,
 382         HW_VER_SPARROW_B0, /* REVISION_ID_SPARROW_B0 */
 383         HW_VER_SPARROW_D0, /* REVISION_ID_SPARROW_D0 */
 384         HW_VER_TALYN,   /* JTAG_DEV_ID_TALYN */
 385         HW_VER_TALYN_MB /* JTAG_DEV_ID_TALYN_MB */
 386 };
 387
 388 /* popular locations */
 389 #define RGF_MBOX   RGF_USER_USER_SCRATCH_PAD
 390 #define HOST_MBOX   HOSTADDR(RGF_MBOX)
 391 #define SW_INT_MBOX BIT_USER_USER_ICR_SW_INT_2
 392
 393 /* ISR register bits */
 394 #define ISR_MISC_FW_READY       BIT_DMA_EP_MISC_ICR_FW_INT(0)
 395 #define ISR_MISC_MBOX_EVT       BIT_DMA_EP_MISC_ICR_FW_INT(1)
 396 #define ISR_MISC_FW_ERROR       BIT_DMA_EP_MISC_ICR_FW_INT(3)
 397
 398 #define WIL_DATA_COMPLETION_TO_MS 200
 399
 400 /* Hardware definitions end */
 401 #define SPARROW_FW_MAPPING_TABLE_SIZE 10
 402 #define TALYN_FW_MAPPING_TABLE_SIZE 13
 403 #define TALYN_MB_FW_MAPPING_TABLE_SIZE 19
 404 #define MAX_FW_MAPPING_TABLE_SIZE 19
 405
 406 /* Common representation of physical address in wil ring */
 407 struct wil_ring_dma_addr {
 408         __le32 addr_low;
 409         __le16 addr_high;
 410 } __packed;
 411
 412 struct fw_map {
 413         u32 from; /* linker address - from, inclusive */
 414         u32 to;   /* linker address - to, exclusive */
 415         u32 host; /* PCI/Host address - BAR0 + 0x880000 */
 416         const char *name; /* for debugfs */
 417         bool fw; /* true if FW mapping, false if UCODE mapping */
 418         bool crash_dump; /* true if should be dumped during crash dump */
 419 };
 420
 421 /* array size should be in sync with actual definition in the wmi.c */
 422 extern const struct fw_map sparrow_fw_mapping[SPARROW_FW_MAPPING_TABLE_SIZE];
 423 extern const struct fw_map sparrow_d0_mac_rgf_ext;
 424 extern const struct fw_map talyn_fw_mapping[TALYN_FW_MAPPING_TABLE_SIZE];
 425 extern const struct fw_map talyn_mb_fw_mapping[TALYN_MB_FW_MAPPING_TABLE_SIZE];
 426 extern struct fw_map fw_mapping[MAX_FW_MAPPING_TABLE_SIZE];
 427
 428 /**
 429  * mk_cidxtid - construct @cidxtid field
 430  * @cid: CID value
 431  * @tid: TID value
 432  *
 433  * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
 434  */
 435 static inline u8 mk_cidxtid(u8 cid, u8 tid)
 436 {
 437         return ((tid & 0xf) << 4) | (cid & 0xf);
 438 }
 439
 440 /**
 441  * parse_cidxtid - parse @cidxtid field
 442  * @cid: store CID value here
 443  * @tid: store TID value here
 444  *
 445  * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
 446  */
 447 static inline void parse_cidxtid(u8 cidxtid, u8 *cid, u8 *tid)
 448 {
 449         *cid = cidxtid & 0xf;
 450         *tid = (cidxtid >> 4) & 0xf;
 451 }
 452
 453 struct wil6210_mbox_ring {
 454         u32 base;
 455         u16 entry_size; /* max. size of mbox entry, incl. all headers */
 456         u16 size;
 457         u32 tail;
 458         u32 head;
 459 } __packed;
 460
 461 struct wil6210_mbox_ring_desc {
 462         __le32 sync;
 463         __le32 addr;
 464 } __packed;
 465
 466 /* at HOST_OFF_WIL6210_MBOX_CTL */
 467 struct wil6210_mbox_ctl {
 468         struct wil6210_mbox_ring tx;
 469         struct wil6210_mbox_ring rx;
 470 } __packed;
 471
 472 struct wil6210_mbox_hdr {
 473         __le16 seq;
 474         __le16 len; /* payload, bytes after this header */
 475         __le16 type;
 476         u8 flags;
 477         u8 reserved;
 478 } __packed;
 479
 480 #define WIL_MBOX_HDR_TYPE_WMI (0)
 481
 482 /* max. value for wil6210_mbox_hdr.len */
 483 #define MAX_MBOXITEM_SIZE   (240)
 484
 485 struct pending_wmi_event {
 486         struct list_head list;
 487         struct {
 488                 struct wil6210_mbox_hdr hdr;
 489                 struct wmi_cmd_hdr wmi;
 490                 u8 data[0];
 491         } __packed event;
 492 };
 493
 494 enum { /* for wil_ctx.mapped_as */
 495         wil_mapped_as_none = 0,
 496         wil_mapped_as_single = 1,
 497         wil_mapped_as_page = 2,
 498 };
 499
 500 /**
 501  * struct wil_ctx - software context for ring descriptor
 502  */
 503 struct wil_ctx {
 504         struct sk_buff *skb;
 505         u8 nr_frags;
 506         u8 mapped_as;
 507 };
 508
 509 struct wil_desc_ring_rx_swtail { /* relevant for enhanced DMA only */
 510         u32 *va;
 511         dma_addr_t pa;
 512 };
 513
 514 /**
 515  * A general ring structure, used for RX and TX.
 516  * In legacy DMA it represents the vring,
 517  * In enahnced DMA it represents the descriptor ring (vrings are handled by FW)
 518  */
 519 struct wil_ring {
 520         dma_addr_t pa;
 521         volatile union wil_ring_desc *va;
 522         u16 size; /* number of wil_ring_desc elements */
 523         u32 swtail;
 524         u32 swhead;
 525         u32 hwtail; /* write here to inform hw */
 526         struct wil_ctx *ctx; /* ctx[size] - software context */
 527         struct wil_desc_ring_rx_swtail edma_rx_swtail;
 528         bool is_rx;
 529 };
 530
 531 /**
 532  * Additional data for Rx ring.
 533  * Used for enhanced DMA RX chaining.
 534  */
 535 struct wil_ring_rx_data {
 536         /* the skb being assembled */
 537         struct sk_buff *skb;
 538         /* true if we are skipping a bad fragmented packet */
 539         bool skipping;
 540         u16 buff_size;
 541 };
 542
 543 /**
 544  * Status ring structure, used for enhanced DMA completions for RX and TX.
 545  */
 546 struct wil_status_ring {
 547         dma_addr_t pa;
 548         void *va; /* pointer to ring_[tr]x_status elements */
 549         u16 size; /* number of status elements */
 550         size_t elem_size; /* status element size in bytes */
 551         u32 swhead;
 552         u32 hwtail; /* write here to inform hw */
 553         bool is_rx;
 554         u8 desc_rdy_pol; /* Expected descriptor ready bit polarity */
 555         struct wil_ring_rx_data rx_data;
 556 };
 557
 558 #define WIL_STA_TID_NUM (16)
 559 #define WIL_MCS_MAX (12) /* Maximum MCS supported */
 560
 561 struct wil_net_stats {
 562         unsigned long   rx_packets;
 563         unsigned long   tx_packets;
 564         unsigned long   rx_bytes;
 565         unsigned long   tx_bytes;
 566         unsigned long   tx_errors;
 567         u32 tx_latency_min_us;
 568         u32 tx_latency_max_us;
 569         u64 tx_latency_total_us;
 570         unsigned long   rx_dropped;
 571         unsigned long   rx_non_data_frame;
 572         unsigned long   rx_short_frame;
 573         unsigned long   rx_large_frame;
 574         unsigned long   rx_replay;
 575         unsigned long   rx_mic_error;
 576         unsigned long   rx_key_error; /* eDMA specific */
 577         unsigned long   rx_amsdu_error; /* eDMA specific */
 578         unsigned long   rx_csum_err;
 579         u16 last_mcs_rx;
 580         u64 rx_per_mcs[WIL_MCS_MAX + 1];
 581 };
 582
 583 /**
 584  * struct tx_rx_ops - different TX/RX ops for legacy and enhanced
 585  * DMA flow
 586  */
 587 struct wil_txrx_ops {
 588         void (*configure_interrupt_moderation)(struct wil6210_priv *wil);
 589         /* TX ops */
 590         int (*ring_init_tx)(struct wil6210_vif *vif, int ring_id,
 591                             int size, int cid, int tid);
 592         void (*ring_fini_tx)(struct wil6210_priv *wil, struct wil_ring *ring);
 593         int (*ring_init_bcast)(struct wil6210_vif *vif, int id, int size);
 594         int (*tx_init)(struct wil6210_priv *wil);
 595         void (*tx_fini)(struct wil6210_priv *wil);
 596         int (*tx_desc_map)(union wil_tx_desc *desc, dma_addr_t pa,
 597                            u32 len, int ring_index);
 598         void (*tx_desc_unmap)(struct device *dev,
 599                               union wil_tx_desc *desc,
 600                               struct wil_ctx *ctx);
 601         int (*tx_ring_tso)(struct wil6210_priv *wil, struct wil6210_vif *vif,
 602                            struct wil_ring *ring, struct sk_buff *skb);
 603         irqreturn_t (*irq_tx)(int irq, void *cookie);
 604         /* RX ops */
 605         int (*rx_init)(struct wil6210_priv *wil, uint ring_order);
 606         void (*rx_fini)(struct wil6210_priv *wil);
 607         int (*wmi_addba_rx_resp)(struct wil6210_priv *wil, u8 mid, u8 cid,
 608                                  u8 tid, u8 token, u16 status, bool amsdu,
 609                                  u16 agg_wsize, u16 timeout);
 610         void (*get_reorder_params)(struct wil6210_priv *wil,
 611                                    struct sk_buff *skb, int *tid, int *cid,
 612                                    int *mid, u16 *seq, int *mcast, int *retry);
 613         void (*get_netif_rx_params)(struct sk_buff *skb,
 614                                     int *cid, int *security);
 615         int (*rx_crypto_check)(struct wil6210_priv *wil, struct sk_buff *skb);
 616         int (*rx_error_check)(struct wil6210_priv *wil, struct sk_buff *skb,
 617                               struct wil_net_stats *stats);
 618         bool (*is_rx_idle)(struct wil6210_priv *wil);
 619         irqreturn_t (*irq_rx)(int irq, void *cookie);
 620 };
 621
 622 /**
 623  * Additional data for Tx ring
 624  */
 625 struct wil_ring_tx_data {
 626         bool dot1x_open;
 627         int enabled;
 628         cycles_t idle, last_idle, begin;
 629         u8 agg_wsize; /* agreed aggregation window, 0 - no agg */
 630         u16 agg_timeout;
 631         u8 agg_amsdu;
 632         bool addba_in_progress; /* if set, agg_xxx is for request in progress */
 633         u8 mid;
 634         spinlock_t lock;
 635 };
 636
 637 enum { /* for wil6210_priv.status */
 638         wil_status_fwready = 0, /* FW operational */
 639         wil_status_dontscan,
 640         wil_status_mbox_ready, /* MBOX structures ready */
 641         wil_status_irqen, /* interrupts enabled - for debug */
 642         wil_status_napi_en, /* NAPI enabled protected by wil->mutex */
 643         wil_status_resetting, /* reset in progress */
 644         wil_status_suspending, /* suspend in progress */
 645         wil_status_suspended, /* suspend completed, device is suspended */
 646         wil_status_resuming, /* resume in progress */
 647         wil_status_collecting_dumps, /* crashdump collection in progress */
 648         wil_status_last /* keep last */
 649 };
 650
 651 struct pci_dev;
 652
 653 /**
 654  * struct tid_ampdu_rx - TID aggregation information (Rx).
 655  *
 656  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 657  * @last_rx: jiffies of last rx activity
 658  * @head_seq_num: head sequence number in reordering buffer.
 659  * @stored_mpdu_num: number of MPDUs in reordering buffer
 660  * @ssn: Starting Sequence Number expected to be aggregated.
 661  * @buf_size: buffer size for incoming A-MPDUs
 662  * @ssn_last_drop: SSN of the last dropped frame
 663  * @total: total number of processed incoming frames
 664  * @drop_dup: duplicate frames dropped for this reorder buffer
 665  * @drop_old: old frames dropped for this reorder buffer
 666  * @first_time: true when this buffer used 1-st time
 667  * @mcast_last_seq: sequence number (SN) of last received multicast packet
 668  * @drop_dup_mcast: duplicate multicast frames dropped for this reorder buffer
 669  */
 670 struct wil_tid_ampdu_rx {
 671         struct sk_buff **reorder_buf;
 672         unsigned long last_rx;
 673         u16 head_seq_num;
 674         u16 stored_mpdu_num;
 675         u16 ssn;
 676         u16 buf_size;
 677         u16 ssn_last_drop;
 678         unsigned long long total; /* frames processed */
 679         unsigned long long drop_dup;
 680         unsigned long long drop_old;
 681         bool first_time; /* is it 1-st time this buffer used? */
 682         u16 mcast_last_seq; /* multicast dup detection */
 683         unsigned long long drop_dup_mcast;
 684 };
 685
 686 /**
 687  * struct wil_tid_crypto_rx_single - TID crypto information (Rx).
 688  *
 689  * @pn: GCMP PN for the session
 690  * @key_set: valid key present
 691  */
 692 struct wil_tid_crypto_rx_single {
 693         u8 pn[IEEE80211_GCMP_PN_LEN];
 694         bool key_set;
 695 };
 696
 697 struct wil_tid_crypto_rx {
 698         struct wil_tid_crypto_rx_single key_id[4];
 699 };
 700
 701 struct wil_p2p_info {
 702         struct ieee80211_channel listen_chan;
 703         u8 discovery_started;
 704         u64 cookie;
 705         struct wireless_dev *pending_listen_wdev;
 706         unsigned int listen_duration;
 707         struct timer_list discovery_timer; /* listen/search duration */
 708         struct work_struct discovery_expired_work; /* listen/search expire */
 709         struct work_struct delayed_listen_work; /* listen after scan done */
 710 };
 711
 712 enum wil_sta_status {
 713         wil_sta_unused = 0,
 714         wil_sta_conn_pending = 1,
 715         wil_sta_connected = 2,
 716 };
 717
 718 /**
 719  * struct wil_sta_info - data for peer
 720  *
 721  * Peer identified by its CID (connection ID)
 722  * NIC performs beam forming for each peer;
 723  * if no beam forming done, frame exchange is not
 724  * possible.
 725  */
 726 struct wil_sta_info {
 727         u8 addr[ETH_ALEN];
 728         u8 mid;
 729         enum wil_sta_status status;
 730         struct wil_net_stats stats;
 731         /**
 732          * 20 latency bins. 1st bin counts packets with latency
 733          * of 0..tx_latency_res, last bin counts packets with latency
 734          * of 19*tx_latency_res and above.
 735          * tx_latency_res is configured from "tx_latency" debug-fs.
 736          */
 737         u64 *tx_latency_bins;
 738         struct wmi_link_stats_basic fw_stats_basic;
 739         /* Rx BACK */
 740         struct wil_tid_ampdu_rx *tid_rx[WIL_STA_TID_NUM];
 741         spinlock_t tid_rx_lock; /* guarding tid_rx array */
 742         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(WIL_STA_TID_NUM)];
 743         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(WIL_STA_TID_NUM)];
 744         struct wil_tid_crypto_rx tid_crypto_rx[WIL_STA_TID_NUM];
 745         struct wil_tid_crypto_rx group_crypto_rx;
 746         u8 aid; /* 1-254; 0 if unknown/not reported */
 747 };
 748
 749 enum {
 750         fw_recovery_idle = 0,
 751         fw_recovery_pending = 1,
 752         fw_recovery_running = 2,
 753 };
 754
 755 enum {
 756         hw_capa_no_flash,
 757         hw_capa_last
 758 };
 759
 760 struct wil_probe_client_req {
 761         struct list_head list;
 762         u64 cookie;
 763         u8 cid;
 764 };
 765
 766 struct pmc_ctx {
 767         /* alloc, free, and read operations must own the lock */
 768         struct mutex            lock;
 769         struct vring_tx_desc    *pring_va;
 770         dma_addr_t              pring_pa;
 771         struct desc_alloc_info  *descriptors;
 772         int                     last_cmd_status;
 773         int                     num_descriptors;
 774         int                     descriptor_size;
 775 };
 776
 777 struct wil_halp {
 778         struct mutex            lock; /* protect halp ref_cnt */
 779         unsigned int            ref_cnt;
 780         struct completion       comp;
 781         u8                      handle_icr;
 782 };
 783
 784 struct wil_blob_wrapper {
 785         struct wil6210_priv *wil;
 786         struct debugfs_blob_wrapper blob;
 787 };
 788
 789 #define WIL_LED_MAX_ID                  (2)
 790 #define WIL_LED_INVALID_ID              (0xF)
 791 #define WIL_LED_BLINK_ON_SLOW_MS        (300)
 792 #define WIL_LED_BLINK_OFF_SLOW_MS       (300)
 793 #define WIL_LED_BLINK_ON_MED_MS         (200)
 794 #define WIL_LED_BLINK_OFF_MED_MS        (200)
 795 #define WIL_LED_BLINK_ON_FAST_MS        (100)
 796 #define WIL_LED_BLINK_OFF_FAST_MS       (100)
 797 enum {
 798         WIL_LED_TIME_SLOW = 0,
 799         WIL_LED_TIME_MED,
 800         WIL_LED_TIME_FAST,
 801         WIL_LED_TIME_LAST,
 802 };
 803
 804 struct blink_on_off_time {
 805         u32 on_ms;
 806         u32 off_ms;
 807 };
 808
 809 struct wil_debugfs_iomem_data {
 810         void *offset;
 811         struct wil6210_priv *wil;
 812 };
 813
 814 struct wil_debugfs_data {
 815         struct wil_debugfs_iomem_data *data_arr;
 816         int iomem_data_count;
 817 };
 818
 819 extern struct blink_on_off_time led_blink_time[WIL_LED_TIME_LAST];
 820 extern u8 led_id;
 821 extern u8 led_polarity;
 822
 823 enum wil6210_vif_status {
 824         wil_vif_fwconnecting,
 825         wil_vif_fwconnected,
 826         wil_vif_status_last /* keep last */
 827 };
 828
 829 struct wil6210_vif {
 830         struct wireless_dev wdev;
 831         struct net_device *ndev;
 832         struct wil6210_priv *wil;
 833         u8 mid;
 834         DECLARE_BITMAP(status, wil_vif_status_last);
 835         u32 privacy; /* secure connection? */
 836         u16 channel; /* relevant in AP mode */
 837         u8 hidden_ssid; /* relevant in AP mode */
 838         u32 ap_isolate; /* no intra-BSS communication */
 839         bool pbss;
 840         int bcast_ring;
 841         struct cfg80211_bss *bss; /* connected bss, relevant in STA mode */
 842         int locally_generated_disc; /* relevant in STA mode */
 843         struct timer_list connect_timer;
 844         struct work_struct disconnect_worker;
 845         /* scan */
 846         struct cfg80211_scan_request *scan_request;
 847         struct timer_list scan_timer; /* detect scan timeout */
 848         struct wil_p2p_info p2p;
 849         /* keep alive */
 850         struct list_head probe_client_pending;
 851         struct mutex probe_client_mutex; /* protect @probe_client_pending */
 852         struct work_struct probe_client_worker;
 853         int net_queue_stopped; /* netif_tx_stop_all_queues invoked */
 854         bool fw_stats_ready; /* per-cid statistics are ready inside sta_info */
 855         u64 fw_stats_tsf; /* measurement timestamp */
 856 };
 857
 858 /**
 859  * RX buffer allocated for enhanced DMA RX descriptors
 860  */
 861 struct wil_rx_buff {
 862         struct sk_buff *skb;
 863         struct list_head list;
 864         int id;
 865 };
 866
 867 /**
 868  * During Rx completion processing, the driver extracts a buffer ID which
 869  * is used as an index to the rx_buff_mgmt.buff_arr array and then the SKB
 870  * is given to the network stack and the buffer is moved from the 'active'
 871  * list to the 'free' list.
 872  * During Rx refill, SKBs are attached to free buffers and moved to the
 873  * 'active' list.
 874  */
 875 struct wil_rx_buff_mgmt {
 876         struct wil_rx_buff *buff_arr;
 877         size_t size; /* number of items in buff_arr */
 878         struct list_head active;
 879         struct list_head free;
 880         unsigned long free_list_empty_cnt; /* statistics */
 881 };
 882
 883 struct wil_fw_stats_global {
 884         bool ready;
 885         u64 tsf; /* measurement timestamp */
 886         struct wmi_link_stats_global stats;
 887 };
 888
 889 struct wil6210_priv {
 890         struct pci_dev *pdev;
 891         u32 bar_size;
 892         struct wiphy *wiphy;
 893         struct net_device *main_ndev;
 894         int n_msi;
 895         void __iomem *csr;
 896         DECLARE_BITMAP(status, wil_status_last);
 897         u8 fw_version[ETHTOOL_FWVERS_LEN];
 898         u32 hw_version;
 899         u8 chip_revision;
 900         const char *hw_name;
 901         const char *wil_fw_name;
 902         char *board_file;
 903         u32 brd_file_addr;
 904         u32 brd_file_max_size;
 905         DECLARE_BITMAP(hw_capa, hw_capa_last);
 906         DECLARE_BITMAP(fw_capabilities, WMI_FW_CAPABILITY_MAX);
 907         DECLARE_BITMAP(platform_capa, WIL_PLATFORM_CAPA_MAX);
 908         u32 recovery_count; /* num of FW recovery attempts in a short time */
 909         u32 recovery_state; /* FW recovery state machine */
 910         unsigned long last_fw_recovery; /* jiffies of last fw recovery */
 911         wait_queue_head_t wq; /* for all wait_event() use */
 912         u8 max_vifs; /* maximum number of interfaces, including main */
 913         struct wil6210_vif *vifs[WIL_MAX_VIFS];
 914         struct mutex vif_mutex; /* protects access to VIF entries */
 915         atomic_t connected_vifs;
 916         /* profile */
 917         struct cfg80211_chan_def monitor_chandef;
 918         u32 monitor_flags;
 919         int sinfo_gen;
 920         /* interrupt moderation */
 921         u32 tx_max_burst_duration;
 922         u32 tx_interframe_timeout;
 923         u32 rx_max_burst_duration;
 924         u32 rx_interframe_timeout;
 925         /* cached ISR registers */
 926         u32 isr_misc;
 927         /* mailbox related */
 928         struct mutex wmi_mutex;
 929         struct wil6210_mbox_ctl mbox_ctl;
 930         struct completion wmi_ready;
 931         struct completion wmi_call;
 932         u16 wmi_seq;
 933         u16 reply_id; /**< wait for this WMI event */
 934         u8 reply_mid;
 935         void *reply_buf;
 936         u16 reply_size;
 937         struct workqueue_struct *wmi_wq; /* for deferred calls */
 938         struct work_struct wmi_event_worker;
 939         struct workqueue_struct *wq_service;
 940         struct work_struct fw_error_worker;     /* for FW error recovery */
 941         struct list_head pending_wmi_ev;
 942         /*
 943          * protect pending_wmi_ev
 944          * - fill in IRQ from wil6210_irq_misc,
 945          * - consumed in thread by wmi_event_worker
 946          */
 947         spinlock_t wmi_ev_lock;
 948         spinlock_t net_queue_lock; /* guarding stop/wake netif queue */
 949         struct napi_struct napi_rx;
 950         struct napi_struct napi_tx;
 951         struct net_device napi_ndev; /* dummy net_device serving all VIFs */
 952
 953         /* DMA related */
 954         struct wil_ring ring_rx;
 955         unsigned int rx_buf_len;
 956         struct wil_ring ring_tx[WIL6210_MAX_TX_RINGS];
 957         struct wil_ring_tx_data ring_tx_data[WIL6210_MAX_TX_RINGS];
 958         struct wil_status_ring srings[WIL6210_MAX_STATUS_RINGS];
 959         u8 num_rx_status_rings;
 960         int tx_sring_idx;
 961         u8 ring2cid_tid[WIL6210_MAX_TX_RINGS][2]; /* [0] - CID, [1] - TID */
 962         struct wil_sta_info sta[WIL6210_MAX_CID];
 963         u32 ring_idle_trsh; /* HW fetches up to 16 descriptors at once  */
 964         u32 dma_addr_size; /* indicates dma addr size */
 965         struct wil_rx_buff_mgmt rx_buff_mgmt;
 966         bool use_enhanced_dma_hw;
 967         struct wil_txrx_ops txrx_ops;
 968
 969         struct mutex mutex; /* for wil6210_priv access in wil_{up|down} */
 970         /* statistics */
 971         atomic_t isr_count_rx, isr_count_tx;
 972         /* debugfs */
 973         struct dentry *debug;
 974         struct wil_blob_wrapper blobs[MAX_FW_MAPPING_TABLE_SIZE];
 975         u8 discovery_mode;
 976         u8 abft_len;
 977         u8 wakeup_trigger;
 978         struct wil_suspend_stats suspend_stats;
 979         struct wil_debugfs_data dbg_data;
 980         bool tx_latency; /* collect TX latency measurements */
 981         size_t tx_latency_res; /* bin resolution in usec */
 982
 983         void *platform_handle;
 984         struct wil_platform_ops platform_ops;
 985         bool keep_radio_on_during_sleep;
 986
 987         struct pmc_ctx pmc;
 988
 989         u8 p2p_dev_started;
 990
 991         /* P2P_DEVICE vif */
 992         struct wireless_dev *p2p_wdev;
 993         struct wireless_dev *radio_wdev;
 994
 995         /* High Access Latency Policy voting */
 996         struct wil_halp halp;
 997
 998         enum wmi_ps_profile_type ps_profile;
 999
1000         int fw_calib_result;
1001
1002         struct notifier_block pm_notify;
1003
1004         bool suspend_resp_rcvd;
1005         bool suspend_resp_comp;
1006         u32 bus_request_kbps;
1007         u32 bus_request_kbps_pre_suspend;
1008
1009         u32 rgf_fw_assert_code_addr;
1010         u32 rgf_ucode_assert_code_addr;
1011         u32 iccm_base;
1012
1013         /* relevant only for eDMA */
1014         bool use_compressed_rx_status;
1015         u32 rx_status_ring_order;
1016         u32 tx_status_ring_order;
1017         u32 rx_buff_id_count;
1018         bool amsdu_en;
1019         bool use_rx_hw_reordering;
1020         bool secured_boot;
1021         u8 boot_config;
1022
1023         struct wil_fw_stats_global fw_stats_global;
1024
1025         u32 max_agg_wsize;
1026         u32 max_ampdu_size;
1027 };
1028
1029 #define wil_to_wiphy(i) (i->wiphy)
1030 #define wil_to_dev(i) (wiphy_dev(wil_to_wiphy(i)))
1031 #define wiphy_to_wil(w) (struct wil6210_priv *)(wiphy_priv(w))
1032 #define wdev_to_wil(w) (struct wil6210_priv *)(wdev_priv(w))
1033 #define ndev_to_wil(n) (wdev_to_wil(n->ieee80211_ptr))
1034 #define ndev_to_vif(n) (struct wil6210_vif *)(netdev_priv(n))
1035 #define vif_to_wil(v) (v->wil)
1036 #define vif_to_ndev(v) (v->ndev)
1037 #define vif_to_wdev(v) (&v->wdev)
1038
1039 static inline struct wil6210_vif *wdev_to_vif(struct wil6210_priv *wil,
1040                                               struct wireless_dev *wdev)
1041 {
1042         /* main interface is shared with P2P device */
1043         if (wdev == wil->p2p_wdev)
1044                 return ndev_to_vif(wil->main_ndev);
1045         else
1046                 return container_of(wdev, struct wil6210_vif, wdev);
1047 }
1048
1049 static inline struct wireless_dev *
1050 vif_to_radio_wdev(struct wil6210_priv *wil, struct wil6210_vif *vif)
1051 {
1052         /* main interface is shared with P2P device */
1053         if (vif->mid)
1054                 return vif_to_wdev(vif);
1055         else
1056                 return wil->radio_wdev;
1057 }
1058
1059 __printf(2, 3)
1060 void wil_dbg_trace(struct wil6210_priv *wil, const char *fmt, ...);
1061 __printf(2, 3)
1062 void __wil_err(struct wil6210_priv *wil, const char *fmt, ...);
1063 __printf(2, 3)
1064 void __wil_err_ratelimited(struct wil6210_priv *wil, const char *fmt, ...);
1065 __printf(2, 3)
1066 void __wil_info(struct wil6210_priv *wil, const char *fmt, ...);
1067 __printf(2, 3)
1068 void wil_dbg_ratelimited(const struct wil6210_priv *wil, const char *fmt, ...);
1069 #define wil_dbg(wil, fmt, arg...) do { \
1070         netdev_dbg(wil->main_ndev, fmt, ##arg); \
1071         wil_dbg_trace(wil, fmt, ##arg); \
1072 } while (0)
1073
1074 #define wil_dbg_irq(wil, fmt, arg...) wil_dbg(wil, "DBG[ IRQ]" fmt, ##arg)
1075 #define wil_dbg_txrx(wil, fmt, arg...) wil_dbg(wil, "DBG[TXRX]" fmt, ##arg)
1076 #define wil_dbg_wmi(wil, fmt, arg...) wil_dbg(wil, "DBG[ WMI]" fmt, ##arg)
1077 #define wil_dbg_misc(wil, fmt, arg...) wil_dbg(wil, "DBG[MISC]" fmt, ##arg)
1078 #define wil_dbg_pm(wil, fmt, arg...) wil_dbg(wil, "DBG[ PM ]" fmt, ##arg)
1079 #define wil_err(wil, fmt, arg...) __wil_err(wil, "%s: " fmt, __func__, ##arg)
1080 #define wil_info(wil, fmt, arg...) __wil_info(wil, "%s: " fmt, __func__, ##arg)
1081 #define wil_err_ratelimited(wil, fmt, arg...) \
1082         __wil_err_ratelimited(wil, "%s: " fmt, __func__, ##arg)
1083
1084 /* target operations */
1085 /* register read */
1086 static inline u32 wil_r(struct wil6210_priv *wil, u32 reg)
1087 {
1088         return readl(wil->csr + HOSTADDR(reg));
1089 }
1090
1091 /* register write. wmb() to make sure it is completed */
1092 static inline void wil_w(struct wil6210_priv *wil, u32 reg, u32 val)
1093 {
1094         writel(val, wil->csr + HOSTADDR(reg));
1095         wmb(); /* wait for write to propagate to the HW */
1096 }
1097
1098 /* register set = read, OR, write */
1099 static inline void wil_s(struct wil6210_priv *wil, u32 reg, u32 val)
1100 {
1101         wil_w(wil, reg, wil_r(wil, reg) | val);
1102 }
1103
1104 /* register clear = read, AND with inverted, write */
1105 static inline void wil_c(struct wil6210_priv *wil, u32 reg, u32 val)
1106 {
1107         wil_w(wil, reg, wil_r(wil, reg) & ~val);
1108 }
1109
1110 void wil_get_board_file(struct wil6210_priv *wil, char *buf, size_t len);
1111
1112 #if defined(CONFIG_DYNAMIC_DEBUG)
1113 #define wil_hex_dump_txrx(prefix_str, prefix_type, rowsize,     \
1114                           groupsize, buf, len, ascii)           \
1115                           print_hex_dump_debug("DBG[TXRX]" prefix_str,\
1116                                          prefix_type, rowsize,  \
1117                                          groupsize, buf, len, ascii)
1118
1119 #define wil_hex_dump_wmi(prefix_str, prefix_type, rowsize,      \
1120                          groupsize, buf, len, ascii)            \
1121                          print_hex_dump_debug("DBG[ WMI]" prefix_str,\
1122                                         prefix_type, rowsize,   \
1123                                         groupsize, buf, len, ascii)
1124
1125 #define wil_hex_dump_misc(prefix_str, prefix_type, rowsize,     \
1126                           groupsize, buf, len, ascii)           \
1127                           print_hex_dump_debug("DBG[MISC]" prefix_str,\
1128                                         prefix_type, rowsize,   \
1129                                         groupsize, buf, len, ascii)
1130 #else /* defined(CONFIG_DYNAMIC_DEBUG) */
1131 static inline
1132 void wil_hex_dump_txrx(const char *prefix_str, int prefix_type, int rowsize,
1133                        int groupsize, const void *buf, size_t len, bool ascii)
1134 {
1135 }
1136
1137 static inline
1138 void wil_hex_dump_wmi(const char *prefix_str, int prefix_type, int rowsize,
1139                       int groupsize, const void *buf, size_t len, bool ascii)
1140 {
1141 }
1142
1143 static inline
1144 void wil_hex_dump_misc(const char *prefix_str, int prefix_type, int rowsize,
1145                        int groupsize, const void *buf, size_t len, bool ascii)
1146 {
1147 }
1148 #endif /* defined(CONFIG_DYNAMIC_DEBUG) */
1149
1150 void wil_memcpy_fromio_32(void *dst, const volatile void __iomem *src,
1151                           size_t count);
1152 void wil_memcpy_toio_32(volatile void __iomem *dst, const void *src,
1153                         size_t count);
1154
1155 struct wil6210_vif *
1156 wil_vif_alloc(struct wil6210_priv *wil, const char *name,
1157               unsigned char name_assign_type, enum nl80211_iftype iftype);
1158 void wil_vif_free(struct wil6210_vif *vif);
1159 void *wil_if_alloc(struct device *dev);
1160 bool wil_has_other_active_ifaces(struct wil6210_priv *wil,
1161                                  struct net_device *ndev, bool up, bool ok);
1162 bool wil_has_active_ifaces(struct wil6210_priv *wil, bool up, bool ok);
1163 void wil_if_free(struct wil6210_priv *wil);
1164 int wil_vif_add(struct wil6210_priv *wil, struct wil6210_vif *vif);
1165 int wil_if_add(struct wil6210_priv *wil);
1166 void wil_vif_remove(struct wil6210_priv *wil, u8 mid);
1167 void wil_if_remove(struct wil6210_priv *wil);
1168 int wil_priv_init(struct wil6210_priv *wil);
1169 void wil_priv_deinit(struct wil6210_priv *wil);
1170 int wil_ps_update(struct wil6210_priv *wil,
1171                   enum wmi_ps_profile_type ps_profile);
1172 int wil_reset(struct wil6210_priv *wil, bool no_fw);
1173 void wil_fw_error_recovery(struct wil6210_priv *wil);
1174 void wil_set_recovery_state(struct wil6210_priv *wil, int state);
1175 bool wil_is_recovery_blocked(struct wil6210_priv *wil);
1176 int wil_up(struct wil6210_priv *wil);
1177 int __wil_up(struct wil6210_priv *wil);
1178 int wil_down(struct wil6210_priv *wil);
1179 int __wil_down(struct wil6210_priv *wil);
1180 void wil_refresh_fw_capabilities(struct wil6210_priv *wil);
1181 void wil_mbox_ring_le2cpus(struct wil6210_mbox_ring *r);
1182 int wil_find_cid(struct wil6210_priv *wil, u8 mid, const u8 *mac);
1183 void wil_set_ethtoolops(struct net_device *ndev);
1184
1185 struct fw_map *wil_find_fw_mapping(const char *section);
1186 void __iomem *wmi_buffer_block(struct wil6210_priv *wil, __le32 ptr, u32 size);
1187 void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr);
1188 void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr);
1189 int wmi_read_hdr(struct wil6210_priv *wil, __le32 ptr,
1190                  struct wil6210_mbox_hdr *hdr);
1191 int wmi_send(struct wil6210_priv *wil, u16 cmdid, u8 mid, void *buf, u16 len);
1192 void wmi_recv_cmd(struct wil6210_priv *wil);
1193 int wmi_call(struct wil6210_priv *wil, u16 cmdid, u8 mid, void *buf, u16 len,
1194              u16 reply_id, void *reply, u16 reply_size, int to_msec);
1195 void wmi_event_worker(struct work_struct *work);
1196 void wmi_event_flush(struct wil6210_priv *wil);
1197 int wmi_set_ssid(struct wil6210_vif *vif, u8 ssid_len, const void *ssid);
1198 int wmi_get_ssid(struct wil6210_vif *vif, u8 *ssid_len, void *ssid);
1199 int wmi_set_channel(struct wil6210_priv *wil, int channel);
1200 int wmi_get_channel(struct wil6210_priv *wil, int *channel);
1201 int wmi_del_cipher_key(struct wil6210_vif *vif, u8 key_index,
1202                        const void *mac_addr, int key_usage);
1203 int wmi_add_cipher_key(struct wil6210_vif *vif, u8 key_index,
1204                        const void *mac_addr, int key_len, const void *key,
1205                        int key_usage);
1206 int wmi_echo(struct wil6210_priv *wil);
1207 int wmi_set_ie(struct wil6210_vif *vif, u8 type, u16 ie_len, const void *ie);
1208 int wmi_rx_chain_add(struct wil6210_priv *wil, struct wil_ring *vring);
1209 int wmi_rxon(struct wil6210_priv *wil, bool on);
1210 int wmi_get_temperature(struct wil6210_priv *wil, u32 *t_m, u32 *t_r);
1211 int wmi_disconnect_sta(struct wil6210_vif *vif, const u8 *mac,
1212                        u16 reason, bool full_disconnect, bool del_sta);
1213 int wmi_addba(struct wil6210_priv *wil, u8 mid,
1214               u8 ringid, u8 size, u16 timeout);
1215 int wmi_delba_tx(struct wil6210_priv *wil, u8 mid, u8 ringid, u16 reason);
1216 int wmi_delba_rx(struct wil6210_priv *wil, u8 mid, u8 cidxtid, u16 reason);
1217 int wmi_addba_rx_resp(struct wil6210_priv *wil,
1218                       u8 mid, u8 cid, u8 tid, u8 token,
1219                       u16 status, bool amsdu, u16 agg_wsize, u16 timeout);
1220 int wmi_ps_dev_profile_cfg(struct wil6210_priv *wil,
1221                            enum wmi_ps_profile_type ps_profile);
1222 int wmi_set_mgmt_retry(struct wil6210_priv *wil, u8 retry_short);
1223 int wmi_get_mgmt_retry(struct wil6210_priv *wil, u8 *retry_short);
1224 int wmi_new_sta(struct wil6210_vif *vif, const u8 *mac, u8 aid);
1225 int wmi_port_allocate(struct wil6210_priv *wil, u8 mid,
1226                       const u8 *mac, enum nl80211_iftype iftype);
1227 int wmi_port_delete(struct wil6210_priv *wil, u8 mid);
1228 int wmi_link_stats_cfg(struct wil6210_vif *vif, u32 type, u8 cid, u32 interval);
1229 int wil_addba_rx_request(struct wil6210_priv *wil, u8 mid,
1230                          u8 cidxtid, u8 dialog_token, __le16 ba_param_set,
1231                          __le16 ba_timeout, __le16 ba_seq_ctrl);
1232 int wil_addba_tx_request(struct wil6210_priv *wil, u8 ringid, u16 wsize);
1233
1234 void wil6210_clear_irq(struct wil6210_priv *wil);
1235 int wil6210_init_irq(struct wil6210_priv *wil, int irq);
1236 void wil6210_fini_irq(struct wil6210_priv *wil, int irq);
1237 void wil_mask_irq(struct wil6210_priv *wil);
1238 void wil_unmask_irq(struct wil6210_priv *wil);
1239 void wil_configure_interrupt_moderation(struct wil6210_priv *wil);
1240 void wil_disable_irq(struct wil6210_priv *wil);
1241 void wil_enable_irq(struct wil6210_priv *wil);
1242 void wil6210_mask_halp(struct wil6210_priv *wil);
1243
1244 /* P2P */
1245 bool wil_p2p_is_social_scan(struct cfg80211_scan_request *request);
1246 int wil_p2p_search(struct wil6210_vif *vif,
1247                    struct cfg80211_scan_request *request);
1248 int wil_p2p_listen(struct wil6210_priv *wil, struct wireless_dev *wdev,
1249                    unsigned int duration, struct ieee80211_channel *chan,
1250                    u64 *cookie);
1251 u8 wil_p2p_stop_discovery(struct wil6210_vif *vif);
1252 int wil_p2p_cancel_listen(struct wil6210_vif *vif, u64 cookie);
1253 void wil_p2p_listen_expired(struct work_struct *work);
1254 void wil_p2p_search_expired(struct work_struct *work);
1255 void wil_p2p_stop_radio_operations(struct wil6210_priv *wil);
1256 void wil_p2p_delayed_listen_work(struct work_struct *work);
1257
1258 /* WMI for P2P */
1259 int wmi_p2p_cfg(struct wil6210_vif *vif, int channel, int bi);
1260 int wmi_start_listen(struct wil6210_vif *vif);
1261 int wmi_start_search(struct wil6210_vif *vif);
1262 int wmi_stop_discovery(struct wil6210_vif *vif);
1263
1264 int wil_cfg80211_mgmt_tx(struct wiphy *wiphy, struct wireless_dev *wdev,
1265                          struct cfg80211_mgmt_tx_params *params,
1266                          u64 *cookie);
1267 int wil_cfg80211_iface_combinations_from_fw(
1268         struct wil6210_priv *wil,
1269         const struct wil_fw_record_concurrency *conc);
1270 int wil_vif_prepare_stop(struct wil6210_vif *vif);
1271
1272 #if defined(CONFIG_WIL6210_DEBUGFS)
1273 int wil6210_debugfs_init(struct wil6210_priv *wil);
1274 void wil6210_debugfs_remove(struct wil6210_priv *wil);
1275 #else
1276 static inline int wil6210_debugfs_init(struct wil6210_priv *wil) { return 0; }
1277 static inline void wil6210_debugfs_remove(struct wil6210_priv *wil) {}
1278 #endif
1279
1280 int wil_cid_fill_sinfo(struct wil6210_vif *vif, int cid,
1281                        struct station_info *sinfo);
1282
1283 struct wil6210_priv *wil_cfg80211_init(struct device *dev);
1284 void wil_cfg80211_deinit(struct wil6210_priv *wil);
1285 void wil_p2p_wdev_free(struct wil6210_priv *wil);
1286
1287 int wmi_set_mac_address(struct wil6210_priv *wil, void *addr);
1288 int wmi_pcp_start(struct wil6210_vif *vif, int bi, u8 wmi_nettype, u8 chan,
1289                   u8 hidden_ssid, u8 is_go);
1290 int wmi_pcp_stop(struct wil6210_vif *vif);
1291 int wmi_led_cfg(struct wil6210_priv *wil, bool enable);
1292 int wmi_abort_scan(struct wil6210_vif *vif);
1293 void wil_abort_scan(struct wil6210_vif *vif, bool sync);
1294 void wil_abort_scan_all_vifs(struct wil6210_priv *wil, bool sync);
1295 void wil6210_bus_request(struct wil6210_priv *wil, u32 kbps);
1296 void wil6210_disconnect(struct wil6210_vif *vif, const u8 *bssid,
1297                         u16 reason_code, bool from_event);
1298 void wil_probe_client_flush(struct wil6210_vif *vif);
1299 void wil_probe_client_worker(struct work_struct *work);
1300 void wil_disconnect_worker(struct work_struct *work);
1301
1302 void wil_init_txrx_ops(struct wil6210_priv *wil);
1303
1304 /* TX API */
1305 int wil_ring_init_tx(struct wil6210_vif *vif, int cid);
1306 int wil_vring_init_bcast(struct wil6210_vif *vif, int id, int size);
1307 int wil_bcast_init(struct wil6210_vif *vif);
1308 void wil_bcast_fini(struct wil6210_vif *vif);
1309 void wil_bcast_fini_all(struct wil6210_priv *wil);
1310
1311 void wil_update_net_queues(struct wil6210_priv *wil, struct wil6210_vif *vif,
1312                            struct wil_ring *ring, bool should_stop);
1313 void wil_update_net_queues_bh(struct wil6210_priv *wil, struct wil6210_vif *vif,
1314                               struct wil_ring *ring, bool check_stop);
1315 netdev_tx_t wil_start_xmit(struct sk_buff *skb, struct net_device *ndev);
1316 int wil_tx_complete(struct wil6210_vif *vif, int ringid);
1317 void wil6210_unmask_irq_tx(struct wil6210_priv *wil);
1318 void wil6210_unmask_irq_tx_edma(struct wil6210_priv *wil);
1319
1320 /* RX API */
1321 void wil_rx_handle(struct wil6210_priv *wil, int *quota);
1322 void wil6210_unmask_irq_rx(struct wil6210_priv *wil);
1323 void wil6210_unmask_irq_rx_edma(struct wil6210_priv *wil);
1324
1325 int wil_iftype_nl2wmi(enum nl80211_iftype type);
1326
1327 int wil_request_firmware(struct wil6210_priv *wil, const char *name,
1328                          bool load);
1329 int wil_request_board(struct wil6210_priv *wil, const char *name);
1330 bool wil_fw_verify_file_exists(struct wil6210_priv *wil, const char *name);
1331
1332 void wil_pm_runtime_allow(struct wil6210_priv *wil);
1333 void wil_pm_runtime_forbid(struct wil6210_priv *wil);
1334 int wil_pm_runtime_get(struct wil6210_priv *wil);
1335 void wil_pm_runtime_put(struct wil6210_priv *wil);
1336
1337 int wil_can_suspend(struct wil6210_priv *wil, bool is_runtime);
1338 int wil_suspend(struct wil6210_priv *wil, bool is_runtime, bool keep_radio_on);
1339 int wil_resume(struct wil6210_priv *wil, bool is_runtime, bool keep_radio_on);
1340 bool wil_is_wmi_idle(struct wil6210_priv *wil);
1341 int wmi_resume(struct wil6210_priv *wil);
1342 int wmi_suspend(struct wil6210_priv *wil);
1343 bool wil_is_tx_idle(struct wil6210_priv *wil);
1344
1345 int wil_fw_copy_crash_dump(struct wil6210_priv *wil, void *dest, u32 size);
1346 void wil_fw_core_dump(struct wil6210_priv *wil);
1347
1348 void wil_halp_vote(struct wil6210_priv *wil);
1349 void wil_halp_unvote(struct wil6210_priv *wil);
1350 void wil6210_set_halp(struct wil6210_priv *wil);
1351 void wil6210_clear_halp(struct wil6210_priv *wil);
1352
1353 int wmi_start_sched_scan(struct wil6210_priv *wil,
1354                          struct cfg80211_sched_scan_request *request);
1355 int wmi_stop_sched_scan(struct wil6210_priv *wil);
1356 int wmi_mgmt_tx(struct wil6210_vif *vif, const u8 *buf, size_t len);
1357 int wmi_mgmt_tx_ext(struct wil6210_vif *vif, const u8 *buf, size_t len,
1358                     u8 channel, u16 duration_ms);
1359
1360 int reverse_memcmp(const void *cs, const void *ct, size_t count);
1361
1362 /* WMI for enhanced DMA */
1363 int wil_wmi_tx_sring_cfg(struct wil6210_priv *wil, int ring_id);
1364 int wil_wmi_cfg_def_rx_offload(struct wil6210_priv *wil,
1365                                u16 max_rx_pl_per_desc);
1366 int wil_wmi_rx_sring_add(struct wil6210_priv *wil, u16 ring_id);
1367 int wil_wmi_rx_desc_ring_add(struct wil6210_priv *wil, int status_ring_id);
1368 int wil_wmi_tx_desc_ring_add(struct wil6210_vif *vif, int ring_id, int cid,
1369                              int tid);
1370 int wil_wmi_bcast_desc_ring_add(struct wil6210_vif *vif, int ring_id);
1371 int wmi_addba_rx_resp_edma(struct wil6210_priv *wil, u8 mid, u8 cid,
1372                            u8 tid, u8 token, u16 status, bool amsdu,
1373                            u16 agg_wsize, u16 timeout);
1374
1375 #endif /* __WIL6210_H__ */