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/clk.h>
  26 #include <linux/of_platform.h>
  27 #include <linux/of_net.h>
  28 #include <linux/of_mdio.h>
  29 #include <linux/module.h>
  30 #include <net/ip.h>
  31 #include <linux/prefetch.h>
  32 #include <linux/if_vlan.h>
  33 #include <linux/phy.h>
  34 #include "xgene_enet_hw.h"
  35
  36 #define XGENE_DRV_VERSION       "v1.0"
  37 #define XGENE_ENET_MAX_MTU      1536
  38 #define SKB_BUFFER_SIZE         (XGENE_ENET_MAX_MTU - NET_IP_ALIGN)
  39 #define NUM_PKT_BUF     64
  40 #define NUM_BUFPOOL     32
  41
  42 /* software context of a descriptor ring */
  43 struct xgene_enet_desc_ring {
  44         struct net_device *ndev;
  45         u16 id;
  46         u16 num;
  47         u16 head;
  48         u16 tail;
  49         u16 slots;
  50         u16 irq;
  51         u32 size;
  52         u32 state[NUM_RING_CONFIG];
  53         void __iomem *cmd_base;
  54         void __iomem *cmd;
  55         dma_addr_t dma;
  56         u16 dst_ring_num;
  57         u8 nbufpool;
  58         struct sk_buff *(*rx_skb);
  59         struct sk_buff *(*cp_skb);
  60         enum xgene_enet_ring_cfgsize cfgsize;
  61         struct xgene_enet_desc_ring *cp_ring;
  62         struct xgene_enet_desc_ring *buf_pool;
  63         struct napi_struct napi;
  64         union {
  65                 void *desc_addr;
  66                 struct xgene_enet_raw_desc *raw_desc;
  67                 struct xgene_enet_raw_desc16 *raw_desc16;
  68         };
  69 };
  70
  71 struct xgene_mac_ops {
  72         void (*init)(struct xgene_enet_pdata *pdata);
  73         void (*reset)(struct xgene_enet_pdata *pdata);
  74         void (*tx_enable)(struct xgene_enet_pdata *pdata);
  75         void (*rx_enable)(struct xgene_enet_pdata *pdata);
  76         void (*tx_disable)(struct xgene_enet_pdata *pdata);
  77         void (*rx_disable)(struct xgene_enet_pdata *pdata);
  78         void (*set_mac_addr)(struct xgene_enet_pdata *pdata);
  79 };
  80
  81 struct xgene_port_ops {
  82         void (*reset)(struct xgene_enet_pdata *pdata);
  83         void (*cle_bypass)(struct xgene_enet_pdata *pdata,
  84                            u32 dst_ring_num, u16 bufpool_id);
  85         void (*shutdown)(struct xgene_enet_pdata *pdata);
  86 };
  87
  88 /* ethernet private data */
  89 struct xgene_enet_pdata {
  90         struct net_device *ndev;
  91         struct mii_bus *mdio_bus;
  92         struct phy_device *phy_dev;
  93         int phy_speed;
  94         struct clk *clk;
  95         struct platform_device *pdev;
  96         struct xgene_enet_desc_ring *tx_ring;
  97         struct xgene_enet_desc_ring *rx_ring;
  98         char *dev_name;
  99         u32 rx_buff_cnt;
 100         u32 tx_qcnt_hi;
 101         u32 cp_qcnt_hi;
 102         u32 cp_qcnt_low;
 103         u32 rx_irq;
 104         void __iomem *eth_csr_addr;
 105         void __iomem *eth_ring_if_addr;
 106         void __iomem *eth_diag_csr_addr;
 107         void __iomem *mcx_mac_addr;
 108         void __iomem *mcx_stats_addr;
 109         void __iomem *mcx_mac_csr_addr;
 110         void __iomem *base_addr;
 111         void __iomem *ring_csr_addr;
 112         void __iomem *ring_cmd_addr;
 113         u32 phy_addr;
 114         int phy_mode;
 115         u32 speed;
 116         u16 rm;
 117         struct rtnl_link_stats64 stats;
 118         struct xgene_mac_ops *mac_ops;
 119         struct xgene_port_ops *port_ops;
 120 };
 121
 122 /* Set the specified value into a bit-field defined by its starting position
 123  * and length within a single u64.
 124  */
 125 static inline u64 xgene_enet_set_field_value(int pos, int len, u64 val)
 126 {
 127         return (val & ((1ULL << len) - 1)) << pos;
 128 }
 129
 130 #define SET_VAL(field, val) \
 131                 xgene_enet_set_field_value(field ## _POS, field ## _LEN, val)
 132
 133 #define SET_BIT(field) \
 134                 xgene_enet_set_field_value(field ## _POS, 1, 1)
 135
 136 /* Get the value from a bit-field defined by its starting position
 137  * and length within the specified u64.
 138  */
 139 static inline u64 xgene_enet_get_field_value(int pos, int len, u64 src)
 140 {
 141         return (src >> pos) & ((1ULL << len) - 1);
 142 }
 143
 144 #define GET_VAL(field, src) \
 145                 xgene_enet_get_field_value(field ## _POS, field ## _LEN, src)
 146
 147 static inline struct device *ndev_to_dev(struct net_device *ndev)
 148 {
 149         return ndev->dev.parent;
 150 }
 151
 152 void xgene_enet_set_ethtool_ops(struct net_device *netdev);
 153
 154 #endif /* __XGENE_ENET_MAIN_H__ */