drivers/net/wireless/mwifiex/pcie.h

   1 /* @file mwifiex_pcie.h
   2  *
   3  * @brief This file contains definitions for PCI-E interface.
   4  * driver.
   5  *
   6  * Copyright (C) 2011-2014, Marvell International Ltd.
   7  *
   8  * This software file (the "File") is distributed by Marvell International
   9  * Ltd. under the terms of the GNU General Public License Version 2, June 1991
  10  * (the "License").  You may use, redistribute and/or modify this File in
  11  * accordance with the terms and conditions of the License, a copy of which
  12  * is available by writing to the Free Software Foundation, Inc.,
  13  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
  14  * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
  15  *
  16  * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
  19  * this warranty disclaimer.
  20  */
  21
  22 #ifndef _MWIFIEX_PCIE_H
  23 #define _MWIFIEX_PCIE_H
  24
  25 #include    <linux/pci.h>
  26 #include    <linux/pcieport_if.h>
  27 #include    <linux/interrupt.h>
  28
  29 #include    "main.h"
  30
  31 #define PCIE8766_DEFAULT_FW_NAME "mrvl/pcie8766_uapsta.bin"
  32 #define PCIE8897_DEFAULT_FW_NAME "mrvl/pcie8897_uapsta.bin"
  33
  34 #define PCIE_VENDOR_ID_MARVELL              (0x11ab)
  35 #define PCIE_DEVICE_ID_MARVELL_88W8766P         (0x2b30)
  36 #define PCIE_DEVICE_ID_MARVELL_88W8897          (0x2b38)
  37
  38 /* Constants for Buffer Descriptor (BD) rings */
  39 #define MWIFIEX_MAX_TXRX_BD                     0x20
  40 #define MWIFIEX_TXBD_MASK                       0x3F
  41 #define MWIFIEX_RXBD_MASK                       0x3F
  42
  43 #define MWIFIEX_MAX_EVT_BD                      0x04
  44 #define MWIFIEX_EVTBD_MASK                      0x07
  45
  46 /* PCIE INTERNAL REGISTERS */
  47 #define PCIE_SCRATCH_0_REG                              0xC10
  48 #define PCIE_SCRATCH_1_REG                              0xC14
  49 #define PCIE_CPU_INT_EVENT                              0xC18
  50 #define PCIE_CPU_INT_STATUS                             0xC1C
  51 #define PCIE_HOST_INT_STATUS                            0xC30
  52 #define PCIE_HOST_INT_MASK                              0xC34
  53 #define PCIE_HOST_INT_STATUS_MASK                       0xC3C
  54 #define PCIE_SCRATCH_2_REG                              0xC40
  55 #define PCIE_SCRATCH_3_REG                              0xC44
  56 #define PCIE_SCRATCH_4_REG                              0xCD0
  57 #define PCIE_SCRATCH_5_REG                              0xCD4
  58 #define PCIE_SCRATCH_6_REG                              0xCD8
  59 #define PCIE_SCRATCH_7_REG                              0xCDC
  60 #define PCIE_SCRATCH_8_REG                              0xCE0
  61 #define PCIE_SCRATCH_9_REG                              0xCE4
  62 #define PCIE_SCRATCH_10_REG                             0xCE8
  63 #define PCIE_SCRATCH_11_REG                             0xCEC
  64 #define PCIE_SCRATCH_12_REG                             0xCF0
  65 #define PCIE_RD_DATA_PTR_Q0_Q1                          0xC08C
  66 #define PCIE_WR_DATA_PTR_Q0_Q1                          0xC05C
  67
  68 #define CPU_INTR_DNLD_RDY                               BIT(0)
  69 #define CPU_INTR_DOOR_BELL                              BIT(1)
  70 #define CPU_INTR_SLEEP_CFM_DONE                 BIT(2)
  71 #define CPU_INTR_RESET                                  BIT(3)
  72
  73 #define HOST_INTR_DNLD_DONE                             BIT(0)
  74 #define HOST_INTR_UPLD_RDY                              BIT(1)
  75 #define HOST_INTR_CMD_DONE                              BIT(2)
  76 #define HOST_INTR_EVENT_RDY                             BIT(3)
  77 #define HOST_INTR_MASK                                  (HOST_INTR_DNLD_DONE | \
  78                                                          HOST_INTR_UPLD_RDY  | \
  79                                                          HOST_INTR_CMD_DONE  | \
  80                                                          HOST_INTR_EVENT_RDY)
  81
  82 #define MWIFIEX_BD_FLAG_ROLLOVER_IND                    BIT(7)
  83 #define MWIFIEX_BD_FLAG_FIRST_DESC                      BIT(0)
  84 #define MWIFIEX_BD_FLAG_LAST_DESC                       BIT(1)
  85 #define MWIFIEX_BD_FLAG_SOP                             BIT(0)
  86 #define MWIFIEX_BD_FLAG_EOP                             BIT(1)
  87 #define MWIFIEX_BD_FLAG_XS_SOP                          BIT(2)
  88 #define MWIFIEX_BD_FLAG_XS_EOP                          BIT(3)
  89 #define MWIFIEX_BD_FLAG_EVT_ROLLOVER_IND                BIT(7)
  90 #define MWIFIEX_BD_FLAG_RX_ROLLOVER_IND                 BIT(10)
  91 #define MWIFIEX_BD_FLAG_TX_START_PTR                    BIT(16)
  92 #define MWIFIEX_BD_FLAG_TX_ROLLOVER_IND                 BIT(26)
  93
  94 /* Max retry number of command write */
  95 #define MAX_WRITE_IOMEM_RETRY                           2
  96 /* Define PCIE block size for firmware download */
  97 #define MWIFIEX_PCIE_BLOCK_SIZE_FW_DNLD         256
  98 /* FW awake cookie after FW ready */
  99 #define FW_AWAKE_COOKIE                                         (0xAA55AA55)
 100 #define MWIFIEX_DEF_SLEEP_COOKIE                        0xBEEFBEEF
 101 #define MWIFIEX_MAX_DELAY_COUNT                         5
 102
 103 struct mwifiex_pcie_card_reg {
 104         u16 cmd_addr_lo;
 105         u16 cmd_addr_hi;
 106         u16 fw_status;
 107         u16 cmd_size;
 108         u16 cmdrsp_addr_lo;
 109         u16 cmdrsp_addr_hi;
 110         u16 tx_rdptr;
 111         u16 tx_wrptr;
 112         u16 rx_rdptr;
 113         u16 rx_wrptr;
 114         u16 evt_rdptr;
 115         u16 evt_wrptr;
 116         u16 drv_rdy;
 117         u16 tx_start_ptr;
 118         u32 tx_mask;
 119         u32 tx_wrap_mask;
 120         u32 rx_mask;
 121         u32 rx_wrap_mask;
 122         u32 tx_rollover_ind;
 123         u32 rx_rollover_ind;
 124         u32 evt_rollover_ind;
 125         u8 ring_flag_sop;
 126         u8 ring_flag_eop;
 127         u8 ring_flag_xs_sop;
 128         u8 ring_flag_xs_eop;
 129         u32 ring_tx_start_ptr;
 130         u8 pfu_enabled;
 131         u8 sleep_cookie;
 132         u16 fw_dump_ctrl;
 133         u16 fw_dump_start;
 134         u16 fw_dump_end;
 135 };
 136
 137 static const struct mwifiex_pcie_card_reg mwifiex_reg_8766 = {
 138         .cmd_addr_lo = PCIE_SCRATCH_0_REG,
 139         .cmd_addr_hi = PCIE_SCRATCH_1_REG,
 140         .cmd_size = PCIE_SCRATCH_2_REG,
 141         .fw_status = PCIE_SCRATCH_3_REG,
 142         .cmdrsp_addr_lo = PCIE_SCRATCH_4_REG,
 143         .cmdrsp_addr_hi = PCIE_SCRATCH_5_REG,
 144         .tx_rdptr = PCIE_SCRATCH_6_REG,
 145         .tx_wrptr = PCIE_SCRATCH_7_REG,
 146         .rx_rdptr = PCIE_SCRATCH_8_REG,
 147         .rx_wrptr = PCIE_SCRATCH_9_REG,
 148         .evt_rdptr = PCIE_SCRATCH_10_REG,
 149         .evt_wrptr = PCIE_SCRATCH_11_REG,
 150         .drv_rdy = PCIE_SCRATCH_12_REG,
 151         .tx_start_ptr = 0,
 152         .tx_mask = MWIFIEX_TXBD_MASK,
 153         .tx_wrap_mask = 0,
 154         .rx_mask = MWIFIEX_RXBD_MASK,
 155         .rx_wrap_mask = 0,
 156         .tx_rollover_ind = MWIFIEX_BD_FLAG_ROLLOVER_IND,
 157         .rx_rollover_ind = MWIFIEX_BD_FLAG_ROLLOVER_IND,
 158         .evt_rollover_ind = MWIFIEX_BD_FLAG_ROLLOVER_IND,
 159         .ring_flag_sop = 0,
 160         .ring_flag_eop = 0,
 161         .ring_flag_xs_sop = 0,
 162         .ring_flag_xs_eop = 0,
 163         .ring_tx_start_ptr = 0,
 164         .pfu_enabled = 0,
 165         .sleep_cookie = 1,
 166 };
 167
 168 static const struct mwifiex_pcie_card_reg mwifiex_reg_8897 = {
 169         .cmd_addr_lo = PCIE_SCRATCH_0_REG,
 170         .cmd_addr_hi = PCIE_SCRATCH_1_REG,
 171         .cmd_size = PCIE_SCRATCH_2_REG,
 172         .fw_status = PCIE_SCRATCH_3_REG,
 173         .cmdrsp_addr_lo = PCIE_SCRATCH_4_REG,
 174         .cmdrsp_addr_hi = PCIE_SCRATCH_5_REG,
 175         .tx_rdptr = PCIE_RD_DATA_PTR_Q0_Q1,
 176         .tx_wrptr = PCIE_WR_DATA_PTR_Q0_Q1,
 177         .rx_rdptr = PCIE_WR_DATA_PTR_Q0_Q1,
 178         .rx_wrptr = PCIE_RD_DATA_PTR_Q0_Q1,
 179         .evt_rdptr = PCIE_SCRATCH_10_REG,
 180         .evt_wrptr = PCIE_SCRATCH_11_REG,
 181         .drv_rdy = PCIE_SCRATCH_12_REG,
 182         .tx_start_ptr = 16,
 183         .tx_mask = 0x03FF0000,
 184         .tx_wrap_mask = 0x07FF0000,
 185         .rx_mask = 0x000003FF,
 186         .rx_wrap_mask = 0x000007FF,
 187         .tx_rollover_ind = MWIFIEX_BD_FLAG_TX_ROLLOVER_IND,
 188         .rx_rollover_ind = MWIFIEX_BD_FLAG_RX_ROLLOVER_IND,
 189         .evt_rollover_ind = MWIFIEX_BD_FLAG_EVT_ROLLOVER_IND,
 190         .ring_flag_sop = MWIFIEX_BD_FLAG_SOP,
 191         .ring_flag_eop = MWIFIEX_BD_FLAG_EOP,
 192         .ring_flag_xs_sop = MWIFIEX_BD_FLAG_XS_SOP,
 193         .ring_flag_xs_eop = MWIFIEX_BD_FLAG_XS_EOP,
 194         .ring_tx_start_ptr = MWIFIEX_BD_FLAG_TX_START_PTR,
 195         .pfu_enabled = 1,
 196         .sleep_cookie = 0,
 197         .fw_dump_ctrl = 0xcf4,
 198         .fw_dump_start = 0xcf8,
 199         .fw_dump_end = 0xcff
 200 };
 201
 202 struct mwifiex_pcie_device {
 203         const char *firmware;
 204         const struct mwifiex_pcie_card_reg *reg;
 205         u16 blksz_fw_dl;
 206         u16 tx_buf_size;
 207         bool supports_fw_dump;
 208 };
 209
 210 static const struct mwifiex_pcie_device mwifiex_pcie8766 = {
 211         .firmware       = PCIE8766_DEFAULT_FW_NAME,
 212         .reg            = &mwifiex_reg_8766,
 213         .blksz_fw_dl = MWIFIEX_PCIE_BLOCK_SIZE_FW_DNLD,
 214         .tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_2K,
 215         .supports_fw_dump = false,
 216 };
 217
 218 static const struct mwifiex_pcie_device mwifiex_pcie8897 = {
 219         .firmware       = PCIE8897_DEFAULT_FW_NAME,
 220         .reg            = &mwifiex_reg_8897,
 221         .blksz_fw_dl = MWIFIEX_PCIE_BLOCK_SIZE_FW_DNLD,
 222         .tx_buf_size = MWIFIEX_TX_DATA_BUF_SIZE_4K,
 223         .supports_fw_dump = true,
 224 };
 225
 226 struct mwifiex_evt_buf_desc {
 227         u64 paddr;
 228         u16 len;
 229         u16 flags;
 230 } __packed;
 231
 232 struct mwifiex_pcie_buf_desc {
 233         u64 paddr;
 234         u16 len;
 235         u16 flags;
 236 } __packed;
 237
 238 struct mwifiex_pfu_buf_desc {
 239         u16 flags;
 240         u16 offset;
 241         u16 frag_len;
 242         u16 len;
 243         u64 paddr;
 244         u32 reserved;
 245 } __packed;
 246
 247 struct pcie_service_card {
 248         struct pci_dev *dev;
 249         struct mwifiex_adapter *adapter;
 250         struct mwifiex_pcie_device pcie;
 251
 252         u8 txbd_flush;
 253         u32 txbd_wrptr;
 254         u32 txbd_rdptr;
 255         u32 txbd_ring_size;
 256         u8 *txbd_ring_vbase;
 257         dma_addr_t txbd_ring_pbase;
 258         void *txbd_ring[MWIFIEX_MAX_TXRX_BD];
 259         struct sk_buff *tx_buf_list[MWIFIEX_MAX_TXRX_BD];
 260
 261         u32 rxbd_wrptr;
 262         u32 rxbd_rdptr;
 263         u32 rxbd_ring_size;
 264         u8 *rxbd_ring_vbase;
 265         dma_addr_t rxbd_ring_pbase;
 266         void *rxbd_ring[MWIFIEX_MAX_TXRX_BD];
 267         struct sk_buff *rx_buf_list[MWIFIEX_MAX_TXRX_BD];
 268
 269         u32 evtbd_wrptr;
 270         u32 evtbd_rdptr;
 271         u32 evtbd_ring_size;
 272         u8 *evtbd_ring_vbase;
 273         dma_addr_t evtbd_ring_pbase;
 274         void *evtbd_ring[MWIFIEX_MAX_EVT_BD];
 275         struct sk_buff *evt_buf_list[MWIFIEX_MAX_EVT_BD];
 276
 277         struct sk_buff *cmd_buf;
 278         struct sk_buff *cmdrsp_buf;
 279         u8 *sleep_cookie_vbase;
 280         dma_addr_t sleep_cookie_pbase;
 281         void __iomem *pci_mmap;
 282         void __iomem *pci_mmap1;
 283 };
 284
 285 static inline int
 286 mwifiex_pcie_txbd_empty(struct pcie_service_card *card, u32 rdptr)
 287 {
 288         const struct mwifiex_pcie_card_reg *reg = card->pcie.reg;
 289
 290         switch (card->dev->device) {
 291         case PCIE_DEVICE_ID_MARVELL_88W8766P:
 292                 if (((card->txbd_wrptr & reg->tx_mask) ==
 293                      (rdptr & reg->tx_mask)) &&
 294                     ((card->txbd_wrptr & reg->tx_rollover_ind) !=
 295                      (rdptr & reg->tx_rollover_ind)))
 296                         return 1;
 297                 break;
 298         case PCIE_DEVICE_ID_MARVELL_88W8897:
 299                 if (((card->txbd_wrptr & reg->tx_mask) ==
 300                      (rdptr & reg->tx_mask)) &&
 301                     ((card->txbd_wrptr & reg->tx_rollover_ind) ==
 302                         (rdptr & reg->tx_rollover_ind)))
 303                         return 1;
 304                 break;
 305         }
 306
 307         return 0;
 308 }
 309
 310 static inline int
 311 mwifiex_pcie_txbd_not_full(struct pcie_service_card *card)
 312 {
 313         const struct mwifiex_pcie_card_reg *reg = card->pcie.reg;
 314
 315         switch (card->dev->device) {
 316         case PCIE_DEVICE_ID_MARVELL_88W8766P:
 317                 if (((card->txbd_wrptr & reg->tx_mask) !=
 318                      (card->txbd_rdptr & reg->tx_mask)) ||
 319                     ((card->txbd_wrptr & reg->tx_rollover_ind) !=
 320                      (card->txbd_rdptr & reg->tx_rollover_ind)))
 321                         return 1;
 322                 break;
 323         case PCIE_DEVICE_ID_MARVELL_88W8897:
 324                 if (((card->txbd_wrptr & reg->tx_mask) !=
 325                      (card->txbd_rdptr & reg->tx_mask)) ||
 326                     ((card->txbd_wrptr & reg->tx_rollover_ind) ==
 327                      (card->txbd_rdptr & reg->tx_rollover_ind)))
 328                         return 1;
 329                 break;
 330         }
 331
 332         return 0;
 333 }
 334
 335 #endif /* _MWIFIEX_PCIE_H */