drivers/net/ethernet/apm/xgene/xgene_enet_main.h

   1 /* Applied Micro X-Gene SoC Ethernet Driver
   2  *
   3  * Copyright (c) 2014, Applied Micro Circuits Corporation
   4  * Authors: Iyappan Subramanian <isubramanian@apm.com>
   5  *          Ravi Patel <rapatel@apm.com>
   6  *          Keyur Chudgar <kchudgar@apm.com>
   7  *
   8  * This program is free software; you can redistribute  it and/or modify it
   9  * under  the terms of  the GNU General  Public License as published by the
  10  * Free Software Foundation;  either version 2 of the  License, or (at your
  11  * option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __XGENE_ENET_MAIN_H__
  23 #define __XGENE_ENET_MAIN_H__
  24
  25 #include <linux/acpi.h>
  26 #include <linux/clk.h>
  27 #include <linux/efi.h>
  28 #include <linux/irq.h>
  29 #include <linux/io.h>
  30 #include <linux/of_platform.h>
  31 #include <linux/of_net.h>
  32 #include <linux/of_mdio.h>
  33 #include <linux/module.h>
  34 #include <net/ip.h>
  35 #include <linux/prefetch.h>
  36 #include <linux/if_vlan.h>
  37 #include <linux/phy.h>
  38 #include "xgene_enet_hw.h"
  39 #include "xgene_enet_cle.h"
  40 #include "xgene_enet_ring2.h"
  41 #include "../../../phy/mdio-xgene.h"
  42
  43 #define XGENE_DRV_VERSION       "v1.0"
  44 #define XGENE_ENET_MAX_MTU      1536
  45 #define SKB_BUFFER_SIZE         (XGENE_ENET_MAX_MTU - NET_IP_ALIGN)
  46 #define BUFLEN_16K      (16 * 1024)
  47 #define NUM_PKT_BUF     64
  48 #define NUM_BUFPOOL     32
  49 #define MAX_EXP_BUFFS   256
  50 #define NUM_MSS_REG     4
  51 #define XGENE_MIN_ENET_FRAME_SIZE       60
  52
  53 #define XGENE_MAX_ENET_IRQ      16
  54 #define XGENE_NUM_RX_RING       8
  55 #define XGENE_NUM_TX_RING       8
  56 #define XGENE_NUM_TXC_RING      8
  57
  58 #define START_CPU_BUFNUM_0      0
  59 #define START_ETH_BUFNUM_0      2
  60 #define START_BP_BUFNUM_0       0x22
  61 #define START_RING_NUM_0        8
  62 #define START_CPU_BUFNUM_1      12
  63 #define START_ETH_BUFNUM_1      10
  64 #define START_BP_BUFNUM_1       0x2A
  65 #define START_RING_NUM_1        264
  66
  67 #define XG_START_CPU_BUFNUM_1   12
  68 #define XG_START_ETH_BUFNUM_1   2
  69 #define XG_START_BP_BUFNUM_1    0x22
  70 #define XG_START_RING_NUM_1     264
  71
  72 #define X2_START_CPU_BUFNUM_0   0
  73 #define X2_START_ETH_BUFNUM_0   0
  74 #define X2_START_BP_BUFNUM_0    0x20
  75 #define X2_START_RING_NUM_0     0
  76 #define X2_START_CPU_BUFNUM_1   0xc
  77 #define X2_START_ETH_BUFNUM_1   0
  78 #define X2_START_BP_BUFNUM_1    0x20
  79 #define X2_START_RING_NUM_1     256
  80
  81 #define IRQ_ID_SIZE             16
  82
  83 #define PHY_POLL_LINK_ON        (10 * HZ)
  84 #define PHY_POLL_LINK_OFF       (PHY_POLL_LINK_ON / 5)
  85
  86 enum xgene_enet_id {
  87         XGENE_ENET1 = 1,
  88         XGENE_ENET2
  89 };
  90
  91 /* software context of a descriptor ring */
  92 struct xgene_enet_desc_ring {
  93         struct net_device *ndev;
  94         u16 id;
  95         u16 num;
  96         u16 head;
  97         u16 tail;
  98         u16 exp_buf_tail;
  99         u16 slots;
 100         u16 irq;
 101         char irq_name[IRQ_ID_SIZE];
 102         u32 size;
 103         u32 state[X2_NUM_RING_CONFIG];
 104         void __iomem *cmd_base;
 105         void __iomem *cmd;
 106         dma_addr_t dma;
 107         dma_addr_t irq_mbox_dma;
 108         void *irq_mbox_addr;
 109         u16 dst_ring_num;
 110         u8 nbufpool;
 111         u8 index;
 112         struct sk_buff *(*rx_skb);
 113         struct sk_buff *(*cp_skb);
 114         dma_addr_t *frag_dma_addr;
 115         enum xgene_enet_ring_cfgsize cfgsize;
 116         struct xgene_enet_desc_ring *cp_ring;
 117         struct xgene_enet_desc_ring *buf_pool;
 118         struct napi_struct napi;
 119         union {
 120                 void *desc_addr;
 121                 struct xgene_enet_raw_desc *raw_desc;
 122                 struct xgene_enet_raw_desc16 *raw_desc16;
 123         };
 124         __le64 *exp_bufs;
 125         u64 tx_packets;
 126         u64 tx_bytes;
 127         u64 rx_packets;
 128         u64 rx_bytes;
 129         u64 rx_dropped;
 130         u64 rx_errors;
 131         u64 rx_length_errors;
 132         u64 rx_crc_errors;
 133         u64 rx_frame_errors;
 134         u64 rx_fifo_errors;
 135 };
 136
 137 struct xgene_mac_ops {
 138         void (*init)(struct xgene_enet_pdata *pdata);
 139         void (*reset)(struct xgene_enet_pdata *pdata);
 140         void (*tx_enable)(struct xgene_enet_pdata *pdata);
 141         void (*rx_enable)(struct xgene_enet_pdata *pdata);
 142         void (*tx_disable)(struct xgene_enet_pdata *pdata);
 143         void (*rx_disable)(struct xgene_enet_pdata *pdata);
 144         void (*set_speed)(struct xgene_enet_pdata *pdata);
 145         void (*set_mac_addr)(struct xgene_enet_pdata *pdata);
 146         void (*set_mss)(struct xgene_enet_pdata *pdata, u16 mss, u8 index);
 147         void (*link_state)(struct work_struct *work);
 148 };
 149
 150 struct xgene_port_ops {
 151         int (*reset)(struct xgene_enet_pdata *pdata);
 152         void (*clear)(struct xgene_enet_pdata *pdata,
 153                       struct xgene_enet_desc_ring *ring);
 154         void (*cle_bypass)(struct xgene_enet_pdata *pdata,
 155                            u32 dst_ring_num, u16 bufpool_id);
 156         void (*shutdown)(struct xgene_enet_pdata *pdata);
 157 };
 158
 159 struct xgene_ring_ops {
 160         u8 num_ring_config;
 161         u8 num_ring_id_shift;
 162         struct xgene_enet_desc_ring * (*setup)(struct xgene_enet_desc_ring *);
 163         void (*clear)(struct xgene_enet_desc_ring *);
 164         void (*wr_cmd)(struct xgene_enet_desc_ring *, int);
 165         u32 (*len)(struct xgene_enet_desc_ring *);
 166         void (*coalesce)(struct xgene_enet_desc_ring *);
 167 };
 168
 169 struct xgene_cle_ops {
 170         int (*cle_init)(struct xgene_enet_pdata *pdata);
 171 };
 172
 173 /* ethernet private data */
 174 struct xgene_enet_pdata {
 175         struct net_device *ndev;
 176         struct mii_bus *mdio_bus;
 177         int phy_speed;
 178         struct clk *clk;
 179         struct platform_device *pdev;
 180         enum xgene_enet_id enet_id;
 181         struct xgene_enet_desc_ring *tx_ring[XGENE_NUM_TX_RING];
 182         struct xgene_enet_desc_ring *rx_ring[XGENE_NUM_RX_RING];
 183         u16 tx_level[XGENE_NUM_TX_RING];
 184         u16 txc_level[XGENE_NUM_TX_RING];
 185         char *dev_name;
 186         u32 rx_buff_cnt;
 187         u32 tx_qcnt_hi;
 188         u32 irqs[XGENE_MAX_ENET_IRQ];
 189         u8 rxq_cnt;
 190         u8 txq_cnt;
 191         u8 cq_cnt;
 192         void __iomem *eth_csr_addr;
 193         void __iomem *eth_ring_if_addr;
 194         void __iomem *eth_diag_csr_addr;
 195         void __iomem *mcx_mac_addr;
 196         void __iomem *mcx_mac_csr_addr;
 197         void __iomem *base_addr;
 198         void __iomem *pcs_addr;
 199         void __iomem *ring_csr_addr;
 200         void __iomem *ring_cmd_addr;
 201         int phy_mode;
 202         enum xgene_enet_rm rm;
 203         struct xgene_enet_cle cle;
 204         struct rtnl_link_stats64 stats;
 205         const struct xgene_mac_ops *mac_ops;
 206         const struct xgene_port_ops *port_ops;
 207         struct xgene_ring_ops *ring_ops;
 208         const struct xgene_cle_ops *cle_ops;
 209         struct delayed_work link_work;
 210         u32 port_id;
 211         u8 cpu_bufnum;
 212         u8 eth_bufnum;
 213         u8 bp_bufnum;
 214         u16 ring_num;
 215         u32 mss[NUM_MSS_REG];
 216         u32 mss_refcnt[NUM_MSS_REG];
 217         spinlock_t mss_lock;  /* mss lock */
 218         u8 tx_delay;
 219         u8 rx_delay;
 220         bool mdio_driver;
 221         struct gpio_desc *sfp_rdy;
 222 };
 223
 224 struct xgene_indirect_ctl {
 225         void __iomem *addr;
 226         void __iomem *ctl;
 227         void __iomem *cmd;
 228         void __iomem *cmd_done;
 229 };
 230
 231 static inline struct device *ndev_to_dev(struct net_device *ndev)
 232 {
 233         return ndev->dev.parent;
 234 }
 235
 236 static inline u16 xgene_enet_dst_ring_num(struct xgene_enet_desc_ring *ring)
 237 {
 238         struct xgene_enet_pdata *pdata = netdev_priv(ring->ndev);
 239
 240         return ((u16)pdata->rm << 10) | ring->num;
 241 }
 242
 243 void xgene_enet_set_ethtool_ops(struct net_device *netdev);
 244
 245 #endif /* __XGENE_ENET_MAIN_H__ */