drivers/net/ethernet/xilinx/xilinx_axienet.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Definitions for Xilinx Axi Ethernet device driver.
   4  *
   5  * Copyright (c) 2009 Secret Lab Technologies, Ltd.
   6  * Copyright (c) 2010 - 2012 Xilinx, Inc. All rights reserved.
   7  */
   8
   9 #ifndef XILINX_AXIENET_H
  10 #define XILINX_AXIENET_H
  11
  12 #include <linux/netdevice.h>
  13 #include <linux/spinlock.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/if_vlan.h>
  16
  17 /* Packet size info */
  18 #define XAE_HDR_SIZE                    14 /* Size of Ethernet header */
  19 #define XAE_TRL_SIZE                     4 /* Size of Ethernet trailer (FCS) */
  20 #define XAE_MTU                       1500 /* Max MTU of an Ethernet frame */
  21 #define XAE_JUMBO_MTU                 9000 /* Max MTU of a jumbo Eth. frame */
  22
  23 #define XAE_MAX_FRAME_SIZE       (XAE_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
  24 #define XAE_MAX_VLAN_FRAME_SIZE  (XAE_MTU + VLAN_ETH_HLEN + XAE_TRL_SIZE)
  25 #define XAE_MAX_JUMBO_FRAME_SIZE (XAE_JUMBO_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE)
  26
  27 /* Configuration options */
  28
  29 /* Accept all incoming packets. Default: disabled (cleared) */
  30 #define XAE_OPTION_PROMISC                      (1 << 0)
  31
  32 /* Jumbo frame support for Tx & Rx. Default: disabled (cleared) */
  33 #define XAE_OPTION_JUMBO                        (1 << 1)
  34
  35 /* VLAN Rx & Tx frame support. Default: disabled (cleared) */
  36 #define XAE_OPTION_VLAN                         (1 << 2)
  37
  38 /* Enable recognition of flow control frames on Rx. Default: enabled (set) */
  39 #define XAE_OPTION_FLOW_CONTROL                 (1 << 4)
  40
  41 /* Strip FCS and PAD from incoming frames. Note: PAD from VLAN frames is not
  42  * stripped. Default: disabled (set)
  43  */
  44 #define XAE_OPTION_FCS_STRIP                    (1 << 5)
  45
  46 /* Generate FCS field and add PAD automatically for outgoing frames.
  47  * Default: enabled (set)
  48  */
  49 #define XAE_OPTION_FCS_INSERT                   (1 << 6)
  50
  51 /* Enable Length/Type error checking for incoming frames. When this option is
  52  * set, the MAC will filter frames that have a mismatched type/length field
  53  * and if XAE_OPTION_REPORT_RXERR is set, the user is notified when these
  54  * types of frames are encountered. When this option is cleared, the MAC will
  55  * allow these types of frames to be received. Default: enabled (set)
  56  */
  57 #define XAE_OPTION_LENTYPE_ERR                  (1 << 7)
  58
  59 /* Enable the transmitter. Default: enabled (set) */
  60 #define XAE_OPTION_TXEN                         (1 << 11)
  61
  62 /*  Enable the receiver. Default: enabled (set) */
  63 #define XAE_OPTION_RXEN                         (1 << 12)
  64
  65 /*  Default options set when device is initialized or reset */
  66 #define XAE_OPTION_DEFAULTS                                \
  67                                 (XAE_OPTION_TXEN |         \
  68                                  XAE_OPTION_FLOW_CONTROL | \
  69                                  XAE_OPTION_RXEN)
  70
  71 /* Axi DMA Register definitions */
  72
  73 #define XAXIDMA_TX_CR_OFFSET    0x00000000 /* Channel control */
  74 #define XAXIDMA_TX_SR_OFFSET    0x00000004 /* Status */
  75 #define XAXIDMA_TX_CDESC_OFFSET 0x00000008 /* Current descriptor pointer */
  76 #define XAXIDMA_TX_TDESC_OFFSET 0x00000010 /* Tail descriptor pointer */
  77
  78 #define XAXIDMA_RX_CR_OFFSET    0x00000030 /* Channel control */
  79 #define XAXIDMA_RX_SR_OFFSET    0x00000034 /* Status */
  80 #define XAXIDMA_RX_CDESC_OFFSET 0x00000038 /* Current descriptor pointer */
  81 #define XAXIDMA_RX_TDESC_OFFSET 0x00000040 /* Tail descriptor pointer */
  82
  83 #define XAXIDMA_CR_RUNSTOP_MASK 0x00000001 /* Start/stop DMA channel */
  84 #define XAXIDMA_CR_RESET_MASK   0x00000004 /* Reset DMA engine */
  85
  86 #define XAXIDMA_BD_NDESC_OFFSET         0x00 /* Next descriptor pointer */
  87 #define XAXIDMA_BD_BUFA_OFFSET          0x08 /* Buffer address */
  88 #define XAXIDMA_BD_CTRL_LEN_OFFSET      0x18 /* Control/buffer length */
  89 #define XAXIDMA_BD_STS_OFFSET           0x1C /* Status */
  90 #define XAXIDMA_BD_USR0_OFFSET          0x20 /* User IP specific word0 */
  91 #define XAXIDMA_BD_USR1_OFFSET          0x24 /* User IP specific word1 */
  92 #define XAXIDMA_BD_USR2_OFFSET          0x28 /* User IP specific word2 */
  93 #define XAXIDMA_BD_USR3_OFFSET          0x2C /* User IP specific word3 */
  94 #define XAXIDMA_BD_USR4_OFFSET          0x30 /* User IP specific word4 */
  95 #define XAXIDMA_BD_ID_OFFSET            0x34 /* Sw ID */
  96 #define XAXIDMA_BD_HAS_STSCNTRL_OFFSET  0x38 /* Whether has stscntrl strm */
  97 #define XAXIDMA_BD_HAS_DRE_OFFSET       0x3C /* Whether has DRE */
  98
  99 #define XAXIDMA_BD_HAS_DRE_SHIFT        8 /* Whether has DRE shift */
 100 #define XAXIDMA_BD_HAS_DRE_MASK         0xF00 /* Whether has DRE mask */
 101 #define XAXIDMA_BD_WORDLEN_MASK         0xFF /* Whether has DRE mask */
 102
 103 #define XAXIDMA_BD_CTRL_LENGTH_MASK     0x007FFFFF /* Requested len */
 104 #define XAXIDMA_BD_CTRL_TXSOF_MASK      0x08000000 /* First tx packet */
 105 #define XAXIDMA_BD_CTRL_TXEOF_MASK      0x04000000 /* Last tx packet */
 106 #define XAXIDMA_BD_CTRL_ALL_MASK        0x0C000000 /* All control bits */
 107
 108 #define XAXIDMA_DELAY_MASK              0xFF000000 /* Delay timeout counter */
 109 #define XAXIDMA_COALESCE_MASK           0x00FF0000 /* Coalesce counter */
 110
 111 #define XAXIDMA_DELAY_SHIFT             24
 112 #define XAXIDMA_COALESCE_SHIFT          16
 113
 114 #define XAXIDMA_IRQ_IOC_MASK            0x00001000 /* Completion intr */
 115 #define XAXIDMA_IRQ_DELAY_MASK          0x00002000 /* Delay interrupt */
 116 #define XAXIDMA_IRQ_ERROR_MASK          0x00004000 /* Error interrupt */
 117 #define XAXIDMA_IRQ_ALL_MASK            0x00007000 /* All interrupts */
 118
 119 /* Default TX/RX Threshold and waitbound values for SGDMA mode */
 120 #define XAXIDMA_DFT_TX_THRESHOLD        24
 121 #define XAXIDMA_DFT_TX_WAITBOUND        254
 122 #define XAXIDMA_DFT_RX_THRESHOLD        24
 123 #define XAXIDMA_DFT_RX_WAITBOUND        254
 124
 125 #define XAXIDMA_BD_CTRL_TXSOF_MASK      0x08000000 /* First tx packet */
 126 #define XAXIDMA_BD_CTRL_TXEOF_MASK      0x04000000 /* Last tx packet */
 127 #define XAXIDMA_BD_CTRL_ALL_MASK        0x0C000000 /* All control bits */
 128
 129 #define XAXIDMA_BD_STS_ACTUAL_LEN_MASK  0x007FFFFF /* Actual len */
 130 #define XAXIDMA_BD_STS_COMPLETE_MASK    0x80000000 /* Completed */
 131 #define XAXIDMA_BD_STS_DEC_ERR_MASK     0x40000000 /* Decode error */
 132 #define XAXIDMA_BD_STS_SLV_ERR_MASK     0x20000000 /* Slave error */
 133 #define XAXIDMA_BD_STS_INT_ERR_MASK     0x10000000 /* Internal err */
 134 #define XAXIDMA_BD_STS_ALL_ERR_MASK     0x70000000 /* All errors */
 135 #define XAXIDMA_BD_STS_RXSOF_MASK       0x08000000 /* First rx pkt */
 136 #define XAXIDMA_BD_STS_RXEOF_MASK       0x04000000 /* Last rx pkt */
 137 #define XAXIDMA_BD_STS_ALL_MASK         0xFC000000 /* All status bits */
 138
 139 #define XAXIDMA_BD_MINIMUM_ALIGNMENT    0x40
 140
 141 /* Axi Ethernet registers definition */
 142 #define XAE_RAF_OFFSET          0x00000000 /* Reset and Address filter */
 143 #define XAE_TPF_OFFSET          0x00000004 /* Tx Pause Frame */
 144 #define XAE_IFGP_OFFSET         0x00000008 /* Tx Inter-frame gap adjustment*/
 145 #define XAE_IS_OFFSET           0x0000000C /* Interrupt status */
 146 #define XAE_IP_OFFSET           0x00000010 /* Interrupt pending */
 147 #define XAE_IE_OFFSET           0x00000014 /* Interrupt enable */
 148 #define XAE_TTAG_OFFSET         0x00000018 /* Tx VLAN TAG */
 149 #define XAE_RTAG_OFFSET         0x0000001C /* Rx VLAN TAG */
 150 #define XAE_UAWL_OFFSET         0x00000020 /* Unicast address word lower */
 151 #define XAE_UAWU_OFFSET         0x00000024 /* Unicast address word upper */
 152 #define XAE_TPID0_OFFSET        0x00000028 /* VLAN TPID0 register */
 153 #define XAE_TPID1_OFFSET        0x0000002C /* VLAN TPID1 register */
 154 #define XAE_PPST_OFFSET         0x00000030 /* PCS PMA Soft Temac Status Reg */
 155 #define XAE_RCW0_OFFSET         0x00000400 /* Rx Configuration Word 0 */
 156 #define XAE_RCW1_OFFSET         0x00000404 /* Rx Configuration Word 1 */
 157 #define XAE_TC_OFFSET           0x00000408 /* Tx Configuration */
 158 #define XAE_FCC_OFFSET          0x0000040C /* Flow Control Configuration */
 159 #define XAE_EMMC_OFFSET         0x00000410 /* EMAC mode configuration */
 160 #define XAE_PHYC_OFFSET         0x00000414 /* RGMII/SGMII configuration */
 161 #define XAE_MDIO_MC_OFFSET      0x00000500 /* MII Management Config */
 162 #define XAE_MDIO_MCR_OFFSET     0x00000504 /* MII Management Control */
 163 #define XAE_MDIO_MWD_OFFSET     0x00000508 /* MII Management Write Data */
 164 #define XAE_MDIO_MRD_OFFSET     0x0000050C /* MII Management Read Data */
 165 #define XAE_MDIO_MIS_OFFSET     0x00000600 /* MII Management Interrupt Status */
 166 /* MII Mgmt Interrupt Pending register offset */
 167 #define XAE_MDIO_MIP_OFFSET     0x00000620
 168 /* MII Management Interrupt Enable register offset */
 169 #define XAE_MDIO_MIE_OFFSET     0x00000640
 170 /* MII Management Interrupt Clear register offset. */
 171 #define XAE_MDIO_MIC_OFFSET     0x00000660
 172 #define XAE_UAW0_OFFSET         0x00000700 /* Unicast address word 0 */
 173 #define XAE_UAW1_OFFSET         0x00000704 /* Unicast address word 1 */
 174 #define XAE_FMI_OFFSET          0x00000708 /* Filter Mask Index */
 175 #define XAE_AF0_OFFSET          0x00000710 /* Address Filter 0 */
 176 #define XAE_AF1_OFFSET          0x00000714 /* Address Filter 1 */
 177
 178 #define XAE_TX_VLAN_DATA_OFFSET 0x00004000 /* TX VLAN data table address */
 179 #define XAE_RX_VLAN_DATA_OFFSET 0x00008000 /* RX VLAN data table address */
 180 #define XAE_MCAST_TABLE_OFFSET  0x00020000 /* Multicast table address */
 181
 182 /* Bit Masks for Axi Ethernet RAF register */
 183 /* Reject receive multicast destination address */
 184 #define XAE_RAF_MCSTREJ_MASK            0x00000002
 185 /* Reject receive broadcast destination address */
 186 #define XAE_RAF_BCSTREJ_MASK            0x00000004
 187 #define XAE_RAF_TXVTAGMODE_MASK         0x00000018 /* Tx VLAN TAG mode */
 188 #define XAE_RAF_RXVTAGMODE_MASK         0x00000060 /* Rx VLAN TAG mode */
 189 #define XAE_RAF_TXVSTRPMODE_MASK        0x00000180 /* Tx VLAN STRIP mode */
 190 #define XAE_RAF_RXVSTRPMODE_MASK        0x00000600 /* Rx VLAN STRIP mode */
 191 #define XAE_RAF_NEWFNCENBL_MASK         0x00000800 /* New function mode */
 192 /* Exteneded Multicast Filtering mode */
 193 #define XAE_RAF_EMULTIFLTRENBL_MASK     0x00001000
 194 #define XAE_RAF_STATSRST_MASK           0x00002000 /* Stats. Counter Reset */
 195 #define XAE_RAF_RXBADFRMEN_MASK         0x00004000 /* Recv Bad Frame Enable */
 196 #define XAE_RAF_TXVTAGMODE_SHIFT        3 /* Tx Tag mode shift bits */
 197 #define XAE_RAF_RXVTAGMODE_SHIFT        5 /* Rx Tag mode shift bits */
 198 #define XAE_RAF_TXVSTRPMODE_SHIFT       7 /* Tx strip mode shift bits*/
 199 #define XAE_RAF_RXVSTRPMODE_SHIFT       9 /* Rx Strip mode shift bits*/
 200
 201 /* Bit Masks for Axi Ethernet TPF and IFGP registers */
 202 #define XAE_TPF_TPFV_MASK               0x0000FFFF /* Tx pause frame value */
 203 /* Transmit inter-frame gap adjustment value */
 204 #define XAE_IFGP0_IFGP_MASK             0x0000007F
 205
 206 /* Bit Masks for Axi Ethernet IS, IE and IP registers, Same masks apply
 207  * for all 3 registers.
 208  */
 209 /* Hard register access complete */
 210 #define XAE_INT_HARDACSCMPLT_MASK       0x00000001
 211 /* Auto negotiation complete */
 212 #define XAE_INT_AUTONEG_MASK            0x00000002
 213 #define XAE_INT_RXCMPIT_MASK            0x00000004 /* Rx complete */
 214 #define XAE_INT_RXRJECT_MASK            0x00000008 /* Rx frame rejected */
 215 #define XAE_INT_RXFIFOOVR_MASK          0x00000010 /* Rx fifo overrun */
 216 #define XAE_INT_TXCMPIT_MASK            0x00000020 /* Tx complete */
 217 #define XAE_INT_RXDCMLOCK_MASK          0x00000040 /* Rx Dcm Lock */
 218 #define XAE_INT_MGTRDY_MASK             0x00000080 /* MGT clock Lock */
 219 #define XAE_INT_PHYRSTCMPLT_MASK        0x00000100 /* Phy Reset complete */
 220 #define XAE_INT_ALL_MASK                0x0000003F /* All the ints */
 221
 222 /* INT bits that indicate receive errors */
 223 #define XAE_INT_RECV_ERROR_MASK                         \
 224         (XAE_INT_RXRJECT_MASK | XAE_INT_RXFIFOOVR_MASK)
 225
 226 /* Bit masks for Axi Ethernet VLAN TPID Word 0 register */
 227 #define XAE_TPID_0_MASK         0x0000FFFF /* TPID 0 */
 228 #define XAE_TPID_1_MASK         0xFFFF0000 /* TPID 1 */
 229
 230 /* Bit masks for Axi Ethernet VLAN TPID Word 1 register */
 231 #define XAE_TPID_2_MASK         0x0000FFFF /* TPID 0 */
 232 #define XAE_TPID_3_MASK         0xFFFF0000 /* TPID 1 */
 233
 234 /* Bit masks for Axi Ethernet RCW1 register */
 235 #define XAE_RCW1_RST_MASK       0x80000000 /* Reset */
 236 #define XAE_RCW1_JUM_MASK       0x40000000 /* Jumbo frame enable */
 237 /* In-Band FCS enable (FCS not stripped) */
 238 #define XAE_RCW1_FCS_MASK       0x20000000
 239 #define XAE_RCW1_RX_MASK        0x10000000 /* Receiver enable */
 240 #define XAE_RCW1_VLAN_MASK      0x08000000 /* VLAN frame enable */
 241 /* Length/type field valid check disable */
 242 #define XAE_RCW1_LT_DIS_MASK    0x02000000
 243 /* Control frame Length check disable */
 244 #define XAE_RCW1_CL_DIS_MASK    0x01000000
 245 /* Pause frame source address bits [47:32]. Bits [31:0] are
 246  * stored in register RCW0
 247  */
 248 #define XAE_RCW1_PAUSEADDR_MASK 0x0000FFFF
 249
 250 /* Bit masks for Axi Ethernet TC register */
 251 #define XAE_TC_RST_MASK         0x80000000 /* Reset */
 252 #define XAE_TC_JUM_MASK         0x40000000 /* Jumbo frame enable */
 253 /* In-Band FCS enable (FCS not generated) */
 254 #define XAE_TC_FCS_MASK         0x20000000
 255 #define XAE_TC_TX_MASK          0x10000000 /* Transmitter enable */
 256 #define XAE_TC_VLAN_MASK        0x08000000 /* VLAN frame enable */
 257 /* Inter-frame gap adjustment enable */
 258 #define XAE_TC_IFG_MASK         0x02000000
 259
 260 /* Bit masks for Axi Ethernet FCC register */
 261 #define XAE_FCC_FCRX_MASK       0x20000000 /* Rx flow control enable */
 262 #define XAE_FCC_FCTX_MASK       0x40000000 /* Tx flow control enable */
 263
 264 /* Bit masks for Axi Ethernet EMMC register */
 265 #define XAE_EMMC_LINKSPEED_MASK 0xC0000000 /* Link speed */
 266 #define XAE_EMMC_RGMII_MASK     0x20000000 /* RGMII mode enable */
 267 #define XAE_EMMC_SGMII_MASK     0x10000000 /* SGMII mode enable */
 268 #define XAE_EMMC_GPCS_MASK      0x08000000 /* 1000BaseX mode enable */
 269 #define XAE_EMMC_HOST_MASK      0x04000000 /* Host interface enable */
 270 #define XAE_EMMC_TX16BIT        0x02000000 /* 16 bit Tx client enable */
 271 #define XAE_EMMC_RX16BIT        0x01000000 /* 16 bit Rx client enable */
 272 #define XAE_EMMC_LINKSPD_10     0x00000000 /* Link Speed mask for 10 Mbit */
 273 #define XAE_EMMC_LINKSPD_100    0x40000000 /* Link Speed mask for 100 Mbit */
 274 #define XAE_EMMC_LINKSPD_1000   0x80000000 /* Link Speed mask for 1000 Mbit */
 275
 276 /* Bit masks for Axi Ethernet PHYC register */
 277 #define XAE_PHYC_SGMIILINKSPEED_MASK    0xC0000000 /* SGMII link speed mask*/
 278 #define XAE_PHYC_RGMIILINKSPEED_MASK    0x0000000C /* RGMII link speed */
 279 #define XAE_PHYC_RGMIIHD_MASK           0x00000002 /* RGMII Half-duplex */
 280 #define XAE_PHYC_RGMIILINK_MASK         0x00000001 /* RGMII link status */
 281 #define XAE_PHYC_RGLINKSPD_10           0x00000000 /* RGMII link 10 Mbit */
 282 #define XAE_PHYC_RGLINKSPD_100          0x00000004 /* RGMII link 100 Mbit */
 283 #define XAE_PHYC_RGLINKSPD_1000         0x00000008 /* RGMII link 1000 Mbit */
 284 #define XAE_PHYC_SGLINKSPD_10           0x00000000 /* SGMII link 10 Mbit */
 285 #define XAE_PHYC_SGLINKSPD_100          0x40000000 /* SGMII link 100 Mbit */
 286 #define XAE_PHYC_SGLINKSPD_1000         0x80000000 /* SGMII link 1000 Mbit */
 287
 288 /* Bit masks for Axi Ethernet MDIO interface MC register */
 289 #define XAE_MDIO_MC_MDIOEN_MASK         0x00000040 /* MII management enable */
 290 #define XAE_MDIO_MC_CLOCK_DIVIDE_MAX    0x3F       /* Maximum MDIO divisor */
 291
 292 /* Bit masks for Axi Ethernet MDIO interface MCR register */
 293 #define XAE_MDIO_MCR_PHYAD_MASK         0x1F000000 /* Phy Address Mask */
 294 #define XAE_MDIO_MCR_PHYAD_SHIFT        24         /* Phy Address Shift */
 295 #define XAE_MDIO_MCR_REGAD_MASK         0x001F0000 /* Reg Address Mask */
 296 #define XAE_MDIO_MCR_REGAD_SHIFT        16         /* Reg Address Shift */
 297 #define XAE_MDIO_MCR_OP_MASK            0x0000C000 /* Operation Code Mask */
 298 #define XAE_MDIO_MCR_OP_SHIFT           13         /* Operation Code Shift */
 299 #define XAE_MDIO_MCR_OP_READ_MASK       0x00008000 /* Op Code Read Mask */
 300 #define XAE_MDIO_MCR_OP_WRITE_MASK      0x00004000 /* Op Code Write Mask */
 301 #define XAE_MDIO_MCR_INITIATE_MASK      0x00000800 /* Ready Mask */
 302 #define XAE_MDIO_MCR_READY_MASK         0x00000080 /* Ready Mask */
 303
 304 /* Bit masks for Axi Ethernet MDIO interface MIS, MIP, MIE, MIC registers */
 305 #define XAE_MDIO_INT_MIIM_RDY_MASK      0x00000001 /* MIIM Interrupt */
 306
 307 /* Bit masks for Axi Ethernet UAW1 register */
 308 /* Station address bits [47:32]; Station address
 309  * bits [31:0] are stored in register UAW0
 310  */
 311 #define XAE_UAW1_UNICASTADDR_MASK       0x0000FFFF
 312
 313 /* Bit masks for Axi Ethernet FMI register */
 314 #define XAE_FMI_PM_MASK                 0x80000000 /* Promis. mode enable */
 315 #define XAE_FMI_IND_MASK                0x00000003 /* Index Mask */
 316
 317 #define XAE_MDIO_DIV_DFT                29 /* Default MDIO clock divisor */
 318
 319 /* Defines for different options for C_PHY_TYPE parameter in Axi Ethernet IP */
 320 #define XAE_PHY_TYPE_MII                0
 321 #define XAE_PHY_TYPE_GMII               1
 322 #define XAE_PHY_TYPE_RGMII_1_3          2
 323 #define XAE_PHY_TYPE_RGMII_2_0          3
 324 #define XAE_PHY_TYPE_SGMII              4
 325 #define XAE_PHY_TYPE_1000BASE_X         5
 326
 327  /* Total number of entries in the hardware multicast table. */
 328 #define XAE_MULTICAST_CAM_TABLE_NUM     4
 329
 330 /* Axi Ethernet Synthesis features */
 331 #define XAE_FEATURE_PARTIAL_RX_CSUM     (1 << 0)
 332 #define XAE_FEATURE_PARTIAL_TX_CSUM     (1 << 1)
 333 #define XAE_FEATURE_FULL_RX_CSUM        (1 << 2)
 334 #define XAE_FEATURE_FULL_TX_CSUM        (1 << 3)
 335
 336 #define XAE_NO_CSUM_OFFLOAD             0
 337
 338 #define XAE_FULL_CSUM_STATUS_MASK       0x00000038
 339 #define XAE_IP_UDP_CSUM_VALIDATED       0x00000003
 340 #define XAE_IP_TCP_CSUM_VALIDATED       0x00000002
 341
 342 #define DELAY_OF_ONE_MILLISEC           1000
 343
 344 /**
 345  * struct axidma_bd - Axi Dma buffer descriptor layout
 346  * @next:         MM2S/S2MM Next Descriptor Pointer
 347  * @reserved1:    Reserved and not used
 348  * @phys:         MM2S/S2MM Buffer Address
 349  * @reserved2:    Reserved and not used
 350  * @reserved3:    Reserved and not used
 351  * @reserved4:    Reserved and not used
 352  * @cntrl:        MM2S/S2MM Control value
 353  * @status:       MM2S/S2MM Status value
 354  * @app0:         MM2S/S2MM User Application Field 0.
 355  * @app1:         MM2S/S2MM User Application Field 1.
 356  * @app2:         MM2S/S2MM User Application Field 2.
 357  * @app3:         MM2S/S2MM User Application Field 3.
 358  * @app4:         MM2S/S2MM User Application Field 4.
 359  * @sw_id_offset: MM2S/S2MM Sw ID
 360  * @reserved5:    Reserved and not used
 361  * @reserved6:    Reserved and not used
 362  */
 363 struct axidma_bd {
 364         u32 next;       /* Physical address of next buffer descriptor */
 365         u32 reserved1;
 366         u32 phys;
 367         u32 reserved2;
 368         u32 reserved3;
 369         u32 reserved4;
 370         u32 cntrl;
 371         u32 status;
 372         u32 app0;
 373         u32 app1;       /* TX start << 16 | insert */
 374         u32 app2;       /* TX csum seed */
 375         u32 app3;
 376         u32 app4;
 377         u32 sw_id_offset;
 378         u32 reserved5;
 379         u32 reserved6;
 380 };
 381
 382 /**
 383  * struct axienet_local - axienet private per device data
 384  * @ndev:       Pointer for net_device to which it will be attached.
 385  * @dev:        Pointer to device structure
 386  * @phy_node:   Pointer to device node structure
 387  * @mii_bus:    Pointer to MII bus structure
 388  * @regs:       Base address for the axienet_local device address space
 389  * @dma_regs:   Base address for the axidma device address space
 390  * @dma_err_tasklet: Tasklet structure to process Axi DMA errors
 391  * @tx_irq:     Axidma TX IRQ number
 392  * @rx_irq:     Axidma RX IRQ number
 393  * @phy_mode:   Phy type to identify between MII/GMII/RGMII/SGMII/1000 Base-X
 394  * @options:    AxiEthernet option word
 395  * @last_link:  Phy link state in which the PHY was negotiated earlier
 396  * @features:   Stores the extended features supported by the axienet hw
 397  * @tx_bd_v:    Virtual address of the TX buffer descriptor ring
 398  * @tx_bd_p:    Physical address(start address) of the TX buffer descr. ring
 399  * @rx_bd_v:    Virtual address of the RX buffer descriptor ring
 400  * @rx_bd_p:    Physical address(start address) of the RX buffer descr. ring
 401  * @tx_bd_ci:   Stores the index of the Tx buffer descriptor in the ring being
 402  *              accessed currently. Used while alloc. BDs before a TX starts
 403  * @tx_bd_tail: Stores the index of the Tx buffer descriptor in the ring being
 404  *              accessed currently. Used while processing BDs after the TX
 405  *              completed.
 406  * @rx_bd_ci:   Stores the index of the Rx buffer descriptor in the ring being
 407  *              accessed currently.
 408  * @max_frm_size: Stores the maximum size of the frame that can be that
 409  *                Txed/Rxed in the existing hardware. If jumbo option is
 410  *                supported, the maximum frame size would be 9k. Else it is
 411  *                1522 bytes (assuming support for basic VLAN)
 412  * @rxmem:      Stores rx memory size for jumbo frame handling.
 413  * @csum_offload_on_tx_path:    Stores the checksum selection on TX side.
 414  * @csum_offload_on_rx_path:    Stores the checksum selection on RX side.
 415  * @coalesce_count_rx:  Store the irq coalesce on RX side.
 416  * @coalesce_count_tx:  Store the irq coalesce on TX side.
 417  */
 418 struct axienet_local {
 419         struct net_device *ndev;
 420         struct device *dev;
 421
 422         /* Connection to PHY device */
 423         struct device_node *phy_node;
 424
 425         /* MDIO bus data */
 426         struct mii_bus *mii_bus;        /* MII bus reference */
 427
 428         /* IO registers, dma functions and IRQs */
 429         void __iomem *regs;
 430         void __iomem *dma_regs;
 431
 432         struct tasklet_struct dma_err_tasklet;
 433
 434         int tx_irq;
 435         int rx_irq;
 436         phy_interface_t phy_mode;
 437
 438         u32 options;                    /* Current options word */
 439         u32 last_link;
 440         u32 features;
 441
 442         /* Buffer descriptors */
 443         struct axidma_bd *tx_bd_v;
 444         dma_addr_t tx_bd_p;
 445         struct axidma_bd *rx_bd_v;
 446         dma_addr_t rx_bd_p;
 447         u32 tx_bd_ci;
 448         u32 tx_bd_tail;
 449         u32 rx_bd_ci;
 450
 451         u32 max_frm_size;
 452         u32 rxmem;
 453
 454         int csum_offload_on_tx_path;
 455         int csum_offload_on_rx_path;
 456
 457         u32 coalesce_count_rx;
 458         u32 coalesce_count_tx;
 459 };
 460
 461 /**
 462  * struct axiethernet_option - Used to set axi ethernet hardware options
 463  * @opt:        Option to be set.
 464  * @reg:        Register offset to be written for setting the option
 465  * @m_or:       Mask to be ORed for setting the option in the register
 466  */
 467 struct axienet_option {
 468         u32 opt;
 469         u32 reg;
 470         u32 m_or;
 471 };
 472
 473 /**
 474  * axienet_ior - Memory mapped Axi Ethernet register read
 475  * @lp:         Pointer to axienet local structure
 476  * @offset:     Address offset from the base address of Axi Ethernet core
 477  *
 478  * Return: The contents of the Axi Ethernet register
 479  *
 480  * This function returns the contents of the corresponding register.
 481  */
 482 static inline u32 axienet_ior(struct axienet_local *lp, off_t offset)
 483 {
 484         return in_be32(lp->regs + offset);
 485 }
 486
 487 /**
 488  * axienet_iow - Memory mapped Axi Ethernet register write
 489  * @lp:         Pointer to axienet local structure
 490  * @offset:     Address offset from the base address of Axi Ethernet core
 491  * @value:      Value to be written into the Axi Ethernet register
 492  *
 493  * This function writes the desired value into the corresponding Axi Ethernet
 494  * register.
 495  */
 496 static inline void axienet_iow(struct axienet_local *lp, off_t offset,
 497                                u32 value)
 498 {
 499         out_be32((lp->regs + offset), value);
 500 }
 501
 502 /* Function prototypes visible in xilinx_axienet_mdio.c for other files */
 503 int axienet_mdio_setup(struct axienet_local *lp, struct device_node *np);
 504 int axienet_mdio_wait_until_ready(struct axienet_local *lp);
 505 void axienet_mdio_teardown(struct axienet_local *lp);
 506
 507 #endif /* XILINX_AXI_ENET_H */