drivers/net/wireless/quantenna/qtnfmac/pearl/pcie_ipc.h

   1 /*
   2  * Copyright (c) 2015-2016 Quantenna Communications, Inc.
   3  * All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  */
  16
  17 #ifndef _QTN_FMAC_PCIE_IPC_H_
  18 #define _QTN_FMAC_PCIE_IPC_H_
  19
  20 #include <linux/types.h>
  21
  22 #include "shm_ipc_defs.h"
  23
  24 /* bitmap for EP status and flags: updated by EP, read by RC */
  25 #define QTN_EP_HAS_UBOOT        BIT(0)
  26 #define QTN_EP_HAS_FIRMWARE     BIT(1)
  27 #define QTN_EP_REQ_UBOOT        BIT(2)
  28 #define QTN_EP_REQ_FIRMWARE     BIT(3)
  29 #define QTN_EP_ERROR_UBOOT      BIT(4)
  30 #define QTN_EP_ERROR_FIRMWARE   BIT(5)
  31
  32 #define QTN_EP_FW_LOADRDY       BIT(8)
  33 #define QTN_EP_FW_SYNC          BIT(9)
  34 #define QTN_EP_FW_RETRY         BIT(10)
  35 #define QTN_EP_FW_QLINK_DONE    BIT(15)
  36 #define QTN_EP_FW_DONE          BIT(16)
  37
  38 /* bitmap for RC status and flags: updated by RC, read by EP */
  39 #define QTN_RC_PCIE_LINK        BIT(0)
  40 #define QTN_RC_NET_LINK         BIT(1)
  41 #define QTN_RC_FW_FLASHBOOT     BIT(5)
  42 #define QTN_RC_FW_QLINK         BIT(7)
  43 #define QTN_RC_FW_LOADRDY       BIT(8)
  44 #define QTN_RC_FW_SYNC          BIT(9)
  45
  46 /* state transition timeouts */
  47 #define QTN_FW_DL_TIMEOUT_MS    3000
  48 #define QTN_FW_QLINK_TIMEOUT_MS 30000
  49
  50 #define PCIE_HDP_INT_RX_BITS (0         \
  51         | PCIE_HDP_INT_EP_TXDMA         \
  52         | PCIE_HDP_INT_EP_TXEMPTY       \
  53         | PCIE_HDP_INT_HHBM_UF          \
  54         )
  55
  56 #define PCIE_HDP_INT_TX_BITS (0         \
  57         | PCIE_HDP_INT_EP_RXDMA         \
  58         )
  59
  60 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
  61 #define QTN_HOST_HI32(a)        ((u32)(((u64)a) >> 32))
  62 #define QTN_HOST_LO32(a)        ((u32)(((u64)a) & 0xffffffffUL))
  63 #define QTN_HOST_ADDR(h, l)     ((((u64)h) << 32) | ((u64)l))
  64 #else
  65 #define QTN_HOST_HI32(a)        0
  66 #define QTN_HOST_LO32(a)        ((u32)(((u32)a) & 0xffffffffUL))
  67 #define QTN_HOST_ADDR(h, l)     ((u32)l)
  68 #endif
  69
  70 #define QTN_SYSCTL_BAR  0
  71 #define QTN_SHMEM_BAR   2
  72 #define QTN_DMA_BAR     3
  73
  74 #define QTN_PCIE_BDA_VERSION            0x1002
  75
  76 #define PCIE_BDA_NAMELEN                32
  77 #define PCIE_HHBM_MAX_SIZE              2048
  78
  79 #define SKB_BUF_SIZE            2048
  80
  81 #define QTN_PCIE_BOARDFLG       "PCIEQTN"
  82 #define QTN_PCIE_FW_DLMASK      0xF
  83 #define QTN_PCIE_FW_BUFSZ       2048
  84
  85 #define QTN_ENET_ADDR_LENGTH    6
  86
  87 #define QTN_TXDONE_MASK         ((u32)0x80000000)
  88 #define QTN_GET_LEN(x)          ((x) & 0xFFFF)
  89
  90 #define QTN_PCIE_TX_DESC_LEN_MASK       0xFFFF
  91 #define QTN_PCIE_TX_DESC_LEN_SHIFT      0
  92 #define QTN_PCIE_TX_DESC_PORT_MASK      0xF
  93 #define QTN_PCIE_TX_DESC_PORT_SHIFT     16
  94 #define QTN_PCIE_TX_DESC_TQE_BIT        BIT(24)
  95
  96 #define QTN_EP_LHOST_TQE_PORT   4
  97
  98 enum qtnf_pcie_bda_ipc_flags {
  99         QTN_PCIE_IPC_FLAG_HBM_MAGIC     = BIT(0),
 100         QTN_PCIE_IPC_FLAG_SHM_PIO       = BIT(1),
 101 };
 102
 103 struct qtnf_pcie_bda {
 104         __le16 bda_len;
 105         __le16 bda_version;
 106         __le32 bda_pci_endian;
 107         __le32 bda_ep_state;
 108         __le32 bda_rc_state;
 109         __le32 bda_dma_mask;
 110         __le32 bda_msi_addr;
 111         __le32 bda_flashsz;
 112         u8 bda_boardname[PCIE_BDA_NAMELEN];
 113         __le32 bda_rc_msi_enabled;
 114         u8 bda_hhbm_list[PCIE_HHBM_MAX_SIZE];
 115         __le32 bda_dsbw_start_index;
 116         __le32 bda_dsbw_end_index;
 117         __le32 bda_dsbw_total_bytes;
 118         __le32 bda_rc_tx_bd_base;
 119         __le32 bda_rc_tx_bd_num;
 120         u8 bda_pcie_mac[QTN_ENET_ADDR_LENGTH];
 121         struct qtnf_shm_ipc_region bda_shm_reg1 __aligned(4096); /* host TX */
 122         struct qtnf_shm_ipc_region bda_shm_reg2 __aligned(4096); /* host RX */
 123 } __packed;
 124
 125 struct qtnf_tx_bd {
 126         __le32 addr;
 127         __le32 addr_h;
 128         __le32 info;
 129         __le32 info_h;
 130 } __packed;
 131
 132 struct qtnf_rx_bd {
 133         __le32 addr;
 134         __le32 addr_h;
 135         __le32 info;
 136         __le32 info_h;
 137         __le32 next_ptr;
 138         __le32 next_ptr_h;
 139 } __packed;
 140
 141 enum qtnf_fw_loadtype {
 142         QTN_FW_DBEGIN,
 143         QTN_FW_DSUB,
 144         QTN_FW_DEND,
 145         QTN_FW_CTRL
 146 };
 147
 148 struct qtnf_pcie_fw_hdr {
 149         u8 boardflg[8];
 150         __le32 fwsize;
 151         __le32 seqnum;
 152         __le32 type;
 153         __le32 pktlen;
 154         __le32 crc;
 155 } __packed;
 156
 157 #endif /* _QTN_FMAC_PCIE_IPC_H_ */