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 #define START_ETH_BUFNUM 2 42 #define START_BP_BUFNUM 0x22 43 #define START_RING_NUM 8 44 45 #define PHY_POLL_LINK_ON (10 * HZ) 46 #define PHY_POLL_LINK_OFF (PHY_POLL_LINK_ON / 5) 47 48 /* software context of a descriptor ring */ 49 struct xgene_enet_desc_ring { 50 struct net_device *ndev; 51 u16 id; 52 u16 num; 53 u16 head; 54 u16 tail; 55 u16 slots; 56 u16 irq; 57 u32 size; 58 u32 state[NUM_RING_CONFIG]; 59 void __iomem *cmd_base; 60 void __iomem *cmd; 61 dma_addr_t dma; 62 u16 dst_ring_num; 63 u8 nbufpool; 64 struct sk_buff *(*rx_skb); 65 struct sk_buff *(*cp_skb); 66 enum xgene_enet_ring_cfgsize cfgsize; 67 struct xgene_enet_desc_ring *cp_ring; 68 struct xgene_enet_desc_ring *buf_pool; 69 struct napi_struct napi; 70 union { 71 void *desc_addr; 72 struct xgene_enet_raw_desc *raw_desc; 73 struct xgene_enet_raw_desc16 *raw_desc16; 74 }; 75 }; 76 77 struct xgene_mac_ops { 78 void (*init)(struct xgene_enet_pdata *pdata); 79 void (*reset)(struct xgene_enet_pdata *pdata); 80 void (*tx_enable)(struct xgene_enet_pdata *pdata); 81 void (*rx_enable)(struct xgene_enet_pdata *pdata); 82 void (*tx_disable)(struct xgene_enet_pdata *pdata); 83 void (*rx_disable)(struct xgene_enet_pdata *pdata); 84 void (*set_mac_addr)(struct xgene_enet_pdata *pdata); 85 void (*link_state)(struct work_struct *work); 86 }; 87 88 struct xgene_port_ops { 89 int (*reset)(struct xgene_enet_pdata *pdata); 90 void (*cle_bypass)(struct xgene_enet_pdata *pdata, 91 u32 dst_ring_num, u16 bufpool_id); 92 void (*shutdown)(struct xgene_enet_pdata *pdata); 93 }; 94 95 /* ethernet private data */ 96 struct xgene_enet_pdata { 97 struct net_device *ndev; 98 struct mii_bus *mdio_bus; 99 struct phy_device *phy_dev; 100 int phy_speed; 101 struct clk *clk; 102 struct platform_device *pdev; 103 struct xgene_enet_desc_ring *tx_ring; 104 struct xgene_enet_desc_ring *rx_ring; 105 char *dev_name; 106 u32 rx_buff_cnt; 107 u32 tx_qcnt_hi; 108 u32 cp_qcnt_hi; 109 u32 cp_qcnt_low; 110 u32 rx_irq; 111 void __iomem *eth_csr_addr; 112 void __iomem *eth_ring_if_addr; 113 void __iomem *eth_diag_csr_addr; 114 void __iomem *mcx_mac_addr; 115 void __iomem *mcx_mac_csr_addr; 116 void __iomem *base_addr; 117 void __iomem *ring_csr_addr; 118 void __iomem *ring_cmd_addr; 119 int phy_mode; 120 enum xgene_enet_rm rm; 121 struct rtnl_link_stats64 stats; 122 struct xgene_mac_ops *mac_ops; 123 struct xgene_port_ops *port_ops; 124 struct delayed_work link_work; 125 }; 126 127 struct xgene_indirect_ctl { 128 void __iomem *addr; 129 void __iomem *ctl; 130 void __iomem *cmd; 131 void __iomem *cmd_done; 132 }; 133 134 /* Set the specified value into a bit-field defined by its starting position 135 * and length within a single u64. 136 */ 137 static inline u64 xgene_enet_set_field_value(int pos, int len, u64 val) 138 { 139 return (val & ((1ULL << len) - 1)) << pos; 140 } 141 142 #define SET_VAL(field, val) \ 143 xgene_enet_set_field_value(field ## _POS, field ## _LEN, val) 144 145 #define SET_BIT(field) \ 146 xgene_enet_set_field_value(field ## _POS, 1, 1) 147 148 /* Get the value from a bit-field defined by its starting position 149 * and length within the specified u64. 150 */ 151 static inline u64 xgene_enet_get_field_value(int pos, int len, u64 src) 152 { 153 return (src >> pos) & ((1ULL << len) - 1); 154 } 155 156 #define GET_VAL(field, src) \ 157 xgene_enet_get_field_value(field ## _POS, field ## _LEN, src) 158 159 static inline struct device *ndev_to_dev(struct net_device *ndev) 160 { 161 return ndev->dev.parent; 162 } 163 164 void xgene_enet_set_ethtool_ops(struct net_device *netdev); 165 166 #endif /* __XGENE_ENET_MAIN_H__ */ 167