/* SPDX-License-Identifier: GPL-2.0 */ /* * Definitions for Xilinx Axi Ethernet device driver. * * Copyright (c) 2009 Secret Lab Technologies, Ltd. * Copyright (c) 2010 - 2012 Xilinx, Inc. All rights reserved. */ #ifndef XILINX_AXIENET_H #define XILINX_AXIENET_H #include #include #include #include #include #include /* Packet size info */ #define XAE_HDR_SIZE 14 /* Size of Ethernet header */ #define XAE_TRL_SIZE 4 /* Size of Ethernet trailer (FCS) */ #define XAE_MTU 1500 /* Max MTU of an Ethernet frame */ #define XAE_JUMBO_MTU 9000 /* Max MTU of a jumbo Eth. frame */ #define XAE_MAX_FRAME_SIZE (XAE_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE) #define XAE_MAX_VLAN_FRAME_SIZE (XAE_MTU + VLAN_ETH_HLEN + XAE_TRL_SIZE) #define XAE_MAX_JUMBO_FRAME_SIZE (XAE_JUMBO_MTU + XAE_HDR_SIZE + XAE_TRL_SIZE) /* Configuration options */ /* Accept all incoming packets. Default: disabled (cleared) */ #define XAE_OPTION_PROMISC BIT(0) /* Jumbo frame support for Tx & Rx. Default: disabled (cleared) */ #define XAE_OPTION_JUMBO BIT(1) /* VLAN Rx & Tx frame support. Default: disabled (cleared) */ #define XAE_OPTION_VLAN BIT(2) /* Enable recognition of flow control frames on Rx. Default: enabled (set) */ #define XAE_OPTION_FLOW_CONTROL BIT(4) /* Strip FCS and PAD from incoming frames. Note: PAD from VLAN frames is not * stripped. Default: disabled (set) */ #define XAE_OPTION_FCS_STRIP BIT(5) /* Generate FCS field and add PAD automatically for outgoing frames. * Default: enabled (set) */ #define XAE_OPTION_FCS_INSERT BIT(6) /* Enable Length/Type error checking for incoming frames. When this option is * set, the MAC will filter frames that have a mismatched type/length field * and if XAE_OPTION_REPORT_RXERR is set, the user is notified when these * types of frames are encountered. When this option is cleared, the MAC will * allow these types of frames to be received. Default: enabled (set) */ #define XAE_OPTION_LENTYPE_ERR BIT(7) /* Enable the transmitter. Default: enabled (set) */ #define XAE_OPTION_TXEN BIT(11) /* Enable the receiver. Default: enabled (set) */ #define XAE_OPTION_RXEN BIT(12) /* Default options set when device is initialized or reset */ #define XAE_OPTION_DEFAULTS \ (XAE_OPTION_TXEN | \ XAE_OPTION_FLOW_CONTROL | \ XAE_OPTION_RXEN) /* Axi DMA Register definitions */ #define XAXIDMA_TX_CR_OFFSET 0x00000000 /* Channel control */ #define XAXIDMA_TX_SR_OFFSET 0x00000004 /* Status */ #define XAXIDMA_TX_CDESC_OFFSET 0x00000008 /* Current descriptor pointer */ #define XAXIDMA_TX_TDESC_OFFSET 0x00000010 /* Tail descriptor pointer */ #define XAXIDMA_RX_CR_OFFSET 0x00000030 /* Channel control */ #define XAXIDMA_RX_SR_OFFSET 0x00000034 /* Status */ #define XAXIDMA_RX_CDESC_OFFSET 0x00000038 /* Current descriptor pointer */ #define XAXIDMA_RX_TDESC_OFFSET 0x00000040 /* Tail descriptor pointer */ #define XAXIDMA_CR_RUNSTOP_MASK 0x00000001 /* Start/stop DMA channel */ #define XAXIDMA_CR_RESET_MASK 0x00000004 /* Reset DMA engine */ #define XAXIDMA_SR_HALT_MASK 0x00000001 /* Indicates DMA channel halted */ #define XAXIDMA_BD_NDESC_OFFSET 0x00 /* Next descriptor pointer */ #define XAXIDMA_BD_BUFA_OFFSET 0x08 /* Buffer address */ #define XAXIDMA_BD_CTRL_LEN_OFFSET 0x18 /* Control/buffer length */ #define XAXIDMA_BD_STS_OFFSET 0x1C /* Status */ #define XAXIDMA_BD_USR0_OFFSET 0x20 /* User IP specific word0 */ #define XAXIDMA_BD_USR1_OFFSET 0x24 /* User IP specific word1 */ #define XAXIDMA_BD_USR2_OFFSET 0x28 /* User IP specific word2 */ #define XAXIDMA_BD_USR3_OFFSET 0x2C /* User IP specific word3 */ #define XAXIDMA_BD_USR4_OFFSET 0x30 /* User IP specific word4 */ #define XAXIDMA_BD_ID_OFFSET 0x34 /* Sw ID */ #define XAXIDMA_BD_HAS_STSCNTRL_OFFSET 0x38 /* Whether has stscntrl strm */ #define XAXIDMA_BD_HAS_DRE_OFFSET 0x3C /* Whether has DRE */ #define XAXIDMA_BD_HAS_DRE_SHIFT 8 /* Whether has DRE shift */ #define XAXIDMA_BD_HAS_DRE_MASK 0xF00 /* Whether has DRE mask */ #define XAXIDMA_BD_WORDLEN_MASK 0xFF /* Whether has DRE mask */ #define XAXIDMA_BD_CTRL_LENGTH_MASK 0x007FFFFF /* Requested len */ #define XAXIDMA_BD_CTRL_TXSOF_MASK 0x08000000 /* First tx packet */ #define XAXIDMA_BD_CTRL_TXEOF_MASK 0x04000000 /* Last tx packet */ #define XAXIDMA_BD_CTRL_ALL_MASK 0x0C000000 /* All control bits */ #define XAXIDMA_DELAY_MASK 0xFF000000 /* Delay timeout counter */ #define XAXIDMA_COALESCE_MASK 0x00FF0000 /* Coalesce counter */ #define XAXIDMA_DELAY_SHIFT 24 #define XAXIDMA_COALESCE_SHIFT 16 #define XAXIDMA_IRQ_IOC_MASK 0x00001000 /* Completion intr */ #define XAXIDMA_IRQ_DELAY_MASK 0x00002000 /* Delay interrupt */ #define XAXIDMA_IRQ_ERROR_MASK 0x00004000 /* Error interrupt */ #define XAXIDMA_IRQ_ALL_MASK 0x00007000 /* All interrupts */ /* Default TX/RX Threshold and delay timer values for SGDMA mode */ #define XAXIDMA_DFT_TX_THRESHOLD 24 #define XAXIDMA_DFT_TX_USEC 50 #define XAXIDMA_DFT_RX_THRESHOLD 1 #define XAXIDMA_DFT_RX_USEC 50 #define XAXIDMA_BD_CTRL_TXSOF_MASK 0x08000000 /* First tx packet */ #define XAXIDMA_BD_CTRL_TXEOF_MASK 0x04000000 /* Last tx packet */ #define XAXIDMA_BD_CTRL_ALL_MASK 0x0C000000 /* All control bits */ #define XAXIDMA_BD_STS_ACTUAL_LEN_MASK 0x007FFFFF /* Actual len */ #define XAXIDMA_BD_STS_COMPLETE_MASK 0x80000000 /* Completed */ #define XAXIDMA_BD_STS_DEC_ERR_MASK 0x40000000 /* Decode error */ #define XAXIDMA_BD_STS_SLV_ERR_MASK 0x20000000 /* Slave error */ #define XAXIDMA_BD_STS_INT_ERR_MASK 0x10000000 /* Internal err */ #define XAXIDMA_BD_STS_ALL_ERR_MASK 0x70000000 /* All errors */ #define XAXIDMA_BD_STS_RXSOF_MASK 0x08000000 /* First rx pkt */ #define XAXIDMA_BD_STS_RXEOF_MASK 0x04000000 /* Last rx pkt */ #define XAXIDMA_BD_STS_ALL_MASK 0xFC000000 /* All status bits */ #define XAXIDMA_BD_MINIMUM_ALIGNMENT 0x40 /* Axi Ethernet registers definition */ #define XAE_RAF_OFFSET 0x00000000 /* Reset and Address filter */ #define XAE_TPF_OFFSET 0x00000004 /* Tx Pause Frame */ #define XAE_IFGP_OFFSET 0x00000008 /* Tx Inter-frame gap adjustment*/ #define XAE_IS_OFFSET 0x0000000C /* Interrupt status */ #define XAE_IP_OFFSET 0x00000010 /* Interrupt pending */ #define XAE_IE_OFFSET 0x00000014 /* Interrupt enable */ #define XAE_TTAG_OFFSET 0x00000018 /* Tx VLAN TAG */ #define XAE_RTAG_OFFSET 0x0000001C /* Rx VLAN TAG */ #define XAE_UAWL_OFFSET 0x00000020 /* Unicast address word lower */ #define XAE_UAWU_OFFSET 0x00000024 /* Unicast address word upper */ #define XAE_TPID0_OFFSET 0x00000028 /* VLAN TPID0 register */ #define XAE_TPID1_OFFSET 0x0000002C /* VLAN TPID1 register */ #define XAE_PPST_OFFSET 0x00000030 /* PCS PMA Soft Temac Status Reg */ #define XAE_STATS_OFFSET 0x00000200 /* Statistics counters */ #define XAE_RCW0_OFFSET 0x00000400 /* Rx Configuration Word 0 */ #define XAE_RCW1_OFFSET 0x00000404 /* Rx Configuration Word 1 */ #define XAE_TC_OFFSET 0x00000408 /* Tx Configuration */ #define XAE_FCC_OFFSET 0x0000040C /* Flow Control Configuration */ #define XAE_EMMC_OFFSET 0x00000410 /* MAC speed configuration */ #define XAE_PHYC_OFFSET 0x00000414 /* RX Max Frame Configuration */ #define XAE_ID_OFFSET 0x000004F8 /* Identification register */ #define XAE_ABILITY_OFFSET 0x000004FC /* Ability Register offset */ #define XAE_MDIO_MC_OFFSET 0x00000500 /* MDIO Setup */ #define XAE_MDIO_MCR_OFFSET 0x00000504 /* MDIO Control */ #define XAE_MDIO_MWD_OFFSET 0x00000508 /* MDIO Write Data */ #define XAE_MDIO_MRD_OFFSET 0x0000050C /* MDIO Read Data */ #define XAE_UAW0_OFFSET 0x00000700 /* Unicast address word 0 */ #define XAE_UAW1_OFFSET 0x00000704 /* Unicast address word 1 */ #define XAE_FMI_OFFSET 0x00000708 /* Frame Filter Control */ #define XAE_FFE_OFFSET 0x0000070C /* Frame Filter Enable */ #define XAE_AF0_OFFSET 0x00000710 /* Address Filter 0 */ #define XAE_AF1_OFFSET 0x00000714 /* Address Filter 1 */ #define XAE_AM0_OFFSET 0x00000750 /* Frame Filter Mask Value Bytes 3-0 */ #define XAE_AM1_OFFSET 0x00000754 /* Frame Filter Mask Value Bytes 7-4 */ #define XAE_TX_VLAN_DATA_OFFSET 0x00004000 /* TX VLAN data table address */ #define XAE_RX_VLAN_DATA_OFFSET 0x00008000 /* RX VLAN data table address */ #define XAE_MCAST_TABLE_OFFSET 0x00020000 /* Multicast table address */ /* Bit Masks for Axi Ethernet RAF register */ /* Reject receive multicast destination address */ #define XAE_RAF_MCSTREJ_MASK 0x00000002 /* Reject receive broadcast destination address */ #define XAE_RAF_BCSTREJ_MASK 0x00000004 #define XAE_RAF_TXVTAGMODE_MASK 0x00000018 /* Tx VLAN TAG mode */ #define XAE_RAF_RXVTAGMODE_MASK 0x00000060 /* Rx VLAN TAG mode */ #define XAE_RAF_TXVSTRPMODE_MASK 0x00000180 /* Tx VLAN STRIP mode */ #define XAE_RAF_RXVSTRPMODE_MASK 0x00000600 /* Rx VLAN STRIP mode */ #define XAE_RAF_NEWFNCENBL_MASK 0x00000800 /* New function mode */ /* Extended Multicast Filtering mode */ #define XAE_RAF_EMULTIFLTRENBL_MASK 0x00001000 #define XAE_RAF_STATSRST_MASK 0x00002000 /* Stats. Counter Reset */ #define XAE_RAF_RXBADFRMEN_MASK 0x00004000 /* Recv Bad Frame Enable */ #define XAE_RAF_TXVTAGMODE_SHIFT 3 /* Tx Tag mode shift bits */ #define XAE_RAF_RXVTAGMODE_SHIFT 5 /* Rx Tag mode shift bits */ #define XAE_RAF_TXVSTRPMODE_SHIFT 7 /* Tx strip mode shift bits*/ #define XAE_RAF_RXVSTRPMODE_SHIFT 9 /* Rx Strip mode shift bits*/ /* Bit Masks for Axi Ethernet TPF and IFGP registers */ #define XAE_TPF_TPFV_MASK 0x0000FFFF /* Tx pause frame value */ /* Transmit inter-frame gap adjustment value */ #define XAE_IFGP0_IFGP_MASK 0x0000007F /* Bit Masks for Axi Ethernet IS, IE and IP registers, Same masks apply * for all 3 registers. */ /* Hard register access complete */ #define XAE_INT_HARDACSCMPLT_MASK 0x00000001 /* Auto negotiation complete */ #define XAE_INT_AUTONEG_MASK 0x00000002 #define XAE_INT_RXCMPIT_MASK 0x00000004 /* Rx complete */ #define XAE_INT_RXRJECT_MASK 0x00000008 /* Rx frame rejected */ #define XAE_INT_RXFIFOOVR_MASK 0x00000010 /* Rx fifo overrun */ #define XAE_INT_TXCMPIT_MASK 0x00000020 /* Tx complete */ #define XAE_INT_RXDCMLOCK_MASK 0x00000040 /* Rx Dcm Lock */ #define XAE_INT_MGTRDY_MASK 0x00000080 /* MGT clock Lock */ #define XAE_INT_PHYRSTCMPLT_MASK 0x00000100 /* Phy Reset complete */ #define XAE_INT_ALL_MASK 0x0000003F /* All the ints */ /* INT bits that indicate receive errors */ #define XAE_INT_RECV_ERROR_MASK \ (XAE_INT_RXRJECT_MASK | XAE_INT_RXFIFOOVR_MASK) /* Bit masks for Axi Ethernet VLAN TPID Word 0 register */ #define XAE_TPID_0_MASK 0x0000FFFF /* TPID 0 */ #define XAE_TPID_1_MASK 0xFFFF0000 /* TPID 1 */ /* Bit masks for Axi Ethernet VLAN TPID Word 1 register */ #define XAE_TPID_2_MASK 0x0000FFFF /* TPID 0 */ #define XAE_TPID_3_MASK 0xFFFF0000 /* TPID 1 */ /* Bit masks for Axi Ethernet RCW1 register */ #define XAE_RCW1_RST_MASK 0x80000000 /* Reset */ #define XAE_RCW1_JUM_MASK 0x40000000 /* Jumbo frame enable */ /* In-Band FCS enable (FCS not stripped) */ #define XAE_RCW1_FCS_MASK 0x20000000 #define XAE_RCW1_RX_MASK 0x10000000 /* Receiver enable */ #define XAE_RCW1_VLAN_MASK 0x08000000 /* VLAN frame enable */ /* Length/type field valid check disable */ #define XAE_RCW1_LT_DIS_MASK 0x02000000 /* Control frame Length check disable */ #define XAE_RCW1_CL_DIS_MASK 0x01000000 /* Pause frame source address bits [47:32]. Bits [31:0] are * stored in register RCW0 */ #define XAE_RCW1_PAUSEADDR_MASK 0x0000FFFF /* Bit masks for Axi Ethernet TC register */ #define XAE_TC_RST_MASK 0x80000000 /* Reset */ #define XAE_TC_JUM_MASK 0x40000000 /* Jumbo frame enable */ /* In-Band FCS enable (FCS not generated) */ #define XAE_TC_FCS_MASK 0x20000000 #define XAE_TC_TX_MASK 0x10000000 /* Transmitter enable */ #define XAE_TC_VLAN_MASK 0x08000000 /* VLAN frame enable */ /* Inter-frame gap adjustment enable */ #define XAE_TC_IFG_MASK 0x02000000 /* Bit masks for Axi Ethernet FCC register */ #define XAE_FCC_FCRX_MASK 0x20000000 /* Rx flow control enable */ #define XAE_FCC_FCTX_MASK 0x40000000 /* Tx flow control enable */ /* Bit masks for Axi Ethernet EMMC register */ #define XAE_EMMC_LINKSPEED_MASK 0xC0000000 /* Link speed */ #define XAE_EMMC_RGMII_MASK 0x20000000 /* RGMII mode enable */ #define XAE_EMMC_SGMII_MASK 0x10000000 /* SGMII mode enable */ #define XAE_EMMC_GPCS_MASK 0x08000000 /* 1000BaseX mode enable */ #define XAE_EMMC_HOST_MASK 0x04000000 /* Host interface enable */ #define XAE_EMMC_TX16BIT 0x02000000 /* 16 bit Tx client enable */ #define XAE_EMMC_RX16BIT 0x01000000 /* 16 bit Rx client enable */ #define XAE_EMMC_LINKSPD_10 0x00000000 /* Link Speed mask for 10 Mbit */ #define XAE_EMMC_LINKSPD_100 0x40000000 /* Link Speed mask for 100 Mbit */ #define XAE_EMMC_LINKSPD_1000 0x80000000 /* Link Speed mask for 1000 Mbit */ /* Bit masks for Axi Ethernet PHYC register */ #define XAE_PHYC_SGMIILINKSPEED_MASK 0xC0000000 /* SGMII link speed mask*/ #define XAE_PHYC_RGMIILINKSPEED_MASK 0x0000000C /* RGMII link speed */ #define XAE_PHYC_RGMIIHD_MASK 0x00000002 /* RGMII Half-duplex */ #define XAE_PHYC_RGMIILINK_MASK 0x00000001 /* RGMII link status */ #define XAE_PHYC_RGLINKSPD_10 0x00000000 /* RGMII link 10 Mbit */ #define XAE_PHYC_RGLINKSPD_100 0x00000004 /* RGMII link 100 Mbit */ #define XAE_PHYC_RGLINKSPD_1000 0x00000008 /* RGMII link 1000 Mbit */ #define XAE_PHYC_SGLINKSPD_10 0x00000000 /* SGMII link 10 Mbit */ #define XAE_PHYC_SGLINKSPD_100 0x40000000 /* SGMII link 100 Mbit */ #define XAE_PHYC_SGLINKSPD_1000 0x80000000 /* SGMII link 1000 Mbit */ /* Bit masks for Axi Ethernet ability register */ #define XAE_ABILITY_PFC BIT(16) #define XAE_ABILITY_FRAME_FILTER BIT(10) #define XAE_ABILITY_HALF_DUPLEX BIT(9) #define XAE_ABILITY_STATS BIT(8) #define XAE_ABILITY_2_5G BIT(3) #define XAE_ABILITY_1G BIT(2) #define XAE_ABILITY_100M BIT(1) #define XAE_ABILITY_10M BIT(0) /* Bit masks for Axi Ethernet MDIO interface MC register */ #define XAE_MDIO_MC_MDIOEN_MASK 0x00000040 /* MII management enable */ #define XAE_MDIO_MC_CLOCK_DIVIDE_MAX 0x3F /* Maximum MDIO divisor */ /* Bit masks for Axi Ethernet MDIO interface MCR register */ #define XAE_MDIO_MCR_PHYAD_MASK 0x1F000000 /* Phy Address Mask */ #define XAE_MDIO_MCR_PHYAD_SHIFT 24 /* Phy Address Shift */ #define XAE_MDIO_MCR_REGAD_MASK 0x001F0000 /* Reg Address Mask */ #define XAE_MDIO_MCR_REGAD_SHIFT 16 /* Reg Address Shift */ #define XAE_MDIO_MCR_OP_MASK 0x0000C000 /* Operation Code Mask */ #define XAE_MDIO_MCR_OP_SHIFT 13 /* Operation Code Shift */ #define XAE_MDIO_MCR_OP_READ_MASK 0x00008000 /* Op Code Read Mask */ #define XAE_MDIO_MCR_OP_WRITE_MASK 0x00004000 /* Op Code Write Mask */ #define XAE_MDIO_MCR_INITIATE_MASK 0x00000800 /* Ready Mask */ #define XAE_MDIO_MCR_READY_MASK 0x00000080 /* Ready Mask */ /* Bit masks for Axi Ethernet MDIO interface MIS, MIP, MIE, MIC registers */ #define XAE_MDIO_INT_MIIM_RDY_MASK 0x00000001 /* MIIM Interrupt */ /* Bit masks for Axi Ethernet UAW1 register */ /* Station address bits [47:32]; Station address * bits [31:0] are stored in register UAW0 */ #define XAE_UAW1_UNICASTADDR_MASK 0x0000FFFF /* Bit masks for Axi Ethernet FMC register */ #define XAE_FMI_PM_MASK 0x80000000 /* Promis. mode enable */ #define XAE_FMI_IND_MASK 0x00000003 /* Index Mask */ #define XAE_MDIO_DIV_DFT 29 /* Default MDIO clock divisor */ /* Defines for different options for C_PHY_TYPE parameter in Axi Ethernet IP */ #define XAE_PHY_TYPE_MII 0 #define XAE_PHY_TYPE_GMII 1 #define XAE_PHY_TYPE_RGMII_1_3 2 #define XAE_PHY_TYPE_RGMII_2_0 3 #define XAE_PHY_TYPE_SGMII 4 #define XAE_PHY_TYPE_1000BASE_X 5 /* Total number of entries in the hardware multicast table. */ #define XAE_MULTICAST_CAM_TABLE_NUM 4 /* Axi Ethernet Synthesis features */ #define XAE_FEATURE_PARTIAL_RX_CSUM BIT(0) #define XAE_FEATURE_PARTIAL_TX_CSUM BIT(1) #define XAE_FEATURE_FULL_RX_CSUM BIT(2) #define XAE_FEATURE_FULL_TX_CSUM BIT(3) #define XAE_FEATURE_DMA_64BIT BIT(4) #define XAE_FEATURE_STATS BIT(5) #define XAE_NO_CSUM_OFFLOAD 0 #define XAE_FULL_CSUM_STATUS_MASK 0x00000038 #define XAE_IP_UDP_CSUM_VALIDATED 0x00000003 #define XAE_IP_TCP_CSUM_VALIDATED 0x00000002 #define DELAY_OF_ONE_MILLISEC 1000 /* Xilinx PCS/PMA PHY register for switching 1000BaseX or SGMII */ #define XLNX_MII_STD_SELECT_REG 0x11 #define XLNX_MII_STD_SELECT_SGMII BIT(0) /* enum temac_stat - TEMAC statistics counters * * Index of statistics counters within the TEMAC. This must match the * order/offset of hardware registers exactly. */ enum temac_stat { STAT_RX_BYTES = 0, STAT_TX_BYTES, STAT_UNDERSIZE_FRAMES, STAT_FRAGMENT_FRAMES, STAT_RX_64_BYTE_FRAMES, STAT_RX_65_127_BYTE_FRAMES, STAT_RX_128_255_BYTE_FRAMES, STAT_RX_256_511_BYTE_FRAMES, STAT_RX_512_1023_BYTE_FRAMES, STAT_RX_1024_MAX_BYTE_FRAMES, STAT_RX_OVERSIZE_FRAMES, STAT_TX_64_BYTE_FRAMES, STAT_TX_65_127_BYTE_FRAMES, STAT_TX_128_255_BYTE_FRAMES, STAT_TX_256_511_BYTE_FRAMES, STAT_TX_512_1023_BYTE_FRAMES, STAT_TX_1024_MAX_BYTE_FRAMES, STAT_TX_OVERSIZE_FRAMES, STAT_RX_GOOD_FRAMES, STAT_RX_FCS_ERRORS, STAT_RX_BROADCAST_FRAMES, STAT_RX_MULTICAST_FRAMES, STAT_RX_CONTROL_FRAMES, STAT_RX_LENGTH_ERRORS, STAT_RX_VLAN_FRAMES, STAT_RX_PAUSE_FRAMES, STAT_RX_CONTROL_OPCODE_ERRORS, STAT_TX_GOOD_FRAMES, STAT_TX_BROADCAST_FRAMES, STAT_TX_MULTICAST_FRAMES, STAT_TX_UNDERRUN_ERRORS, STAT_TX_CONTROL_FRAMES, STAT_TX_VLAN_FRAMES, STAT_TX_PAUSE_FRAMES, STAT_TX_SINGLE_COLLISION_FRAMES, STAT_TX_MULTIPLE_COLLISION_FRAMES, STAT_TX_DEFERRED_FRAMES, STAT_TX_LATE_COLLISIONS, STAT_TX_EXCESS_COLLISIONS, STAT_TX_EXCESS_DEFERRAL, STAT_RX_ALIGNMENT_ERRORS, STAT_TX_PFC_FRAMES, STAT_RX_PFC_FRAMES, STAT_USER_DEFINED0, STAT_USER_DEFINED1, STAT_USER_DEFINED2, STAT_COUNT, }; /** * struct axidma_bd - Axi Dma buffer descriptor layout * @next: MM2S/S2MM Next Descriptor Pointer * @next_msb: MM2S/S2MM Next Descriptor Pointer (high 32 bits) * @phys: MM2S/S2MM Buffer Address * @phys_msb: MM2S/S2MM Buffer Address (high 32 bits) * @reserved3: Reserved and not used * @reserved4: Reserved and not used * @cntrl: MM2S/S2MM Control value * @status: MM2S/S2MM Status value * @app0: MM2S/S2MM User Application Field 0. * @app1: MM2S/S2MM User Application Field 1. * @app2: MM2S/S2MM User Application Field 2. * @app3: MM2S/S2MM User Application Field 3. * @app4: MM2S/S2MM User Application Field 4. * @skb: Pointer to SKB transferred using DMA */ struct axidma_bd { u32 next; /* Physical address of next buffer descriptor */ u32 next_msb; /* high 32 bits for IP >= v7.1, reserved on older IP */ u32 phys; u32 phys_msb; /* for IP >= v7.1, reserved for older IP */ u32 reserved3; u32 reserved4; u32 cntrl; u32 status; u32 app0; u32 app1; /* TX start << 16 | insert */ u32 app2; /* TX csum seed */ u32 app3; u32 app4; /* Last field used by HW */ struct sk_buff *skb; } __aligned(XAXIDMA_BD_MINIMUM_ALIGNMENT); #define XAE_NUM_MISC_CLOCKS 3 /** * struct skbuf_dma_descriptor - skb for each dma descriptor * @sgl: Pointer for sglist. * @desc: Pointer to dma descriptor. * @dma_address: dma address of sglist. * @skb: Pointer to SKB transferred using DMA * @sg_len: number of entries in the sglist. */ struct skbuf_dma_descriptor { struct scatterlist sgl[MAX_SKB_FRAGS + 1]; struct dma_async_tx_descriptor *desc; dma_addr_t dma_address; struct sk_buff *skb; int sg_len; }; /** * struct axienet_local - axienet private per device data * @ndev: Pointer for net_device to which it will be attached. * @dev: Pointer to device structure * @phylink: Pointer to phylink instance * @phylink_config: phylink configuration settings * @pcs_phy: Reference to PCS/PMA PHY if used * @pcs: phylink pcs structure for PCS PHY * @switch_x_sgmii: Whether switchable 1000BaseX/SGMII mode is enabled in the core * @axi_clk: AXI4-Lite bus clock * @misc_clks: Misc ethernet clocks (AXI4-Stream, Ref, MGT clocks) * @mii_bus: Pointer to MII bus structure * @mii_clk_div: MII bus clock divider value * @regs_start: Resource start for axienet device addresses * @regs: Base address for the axienet_local device address space * @dma_regs: Base address for the axidma device address space * @napi_rx: NAPI RX control structure * @rx_dma_cr: Nominal content of RX DMA control register * @rx_bd_v: Virtual address of the RX buffer descriptor ring * @rx_bd_p: Physical address(start address) of the RX buffer descr. ring * @rx_bd_num: Size of RX buffer descriptor ring * @rx_bd_ci: Stores the index of the Rx buffer descriptor in the ring being * accessed currently. * @rx_packets: RX packet count for statistics * @rx_bytes: RX byte count for statistics * @rx_stat_sync: Synchronization object for RX stats * @napi_tx: NAPI TX control structure * @tx_dma_cr: Nominal content of TX DMA control register * @tx_bd_v: Virtual address of the TX buffer descriptor ring * @tx_bd_p: Physical address(start address) of the TX buffer descr. ring * @tx_bd_num: Size of TX buffer descriptor ring * @tx_bd_ci: Stores the next Tx buffer descriptor in the ring that may be * complete. Only updated at runtime by TX NAPI poll. * @tx_bd_tail: Stores the index of the next Tx buffer descriptor in the ring * to be populated. * @tx_packets: TX packet count for statistics * @tx_bytes: TX byte count for statistics * @tx_stat_sync: Synchronization object for TX stats * @hw_stat_base: Base offset for statistics counters. This may be nonzero if * the statistics counteres were reset or wrapped around. * @hw_last_counter: Last-seen value of each statistic counter * @reset_in_progress: Set while we are performing a reset and statistics * counters may be invalid * @hw_stats_seqcount: Sequence counter for @hw_stat_base, @hw_last_counter, * and @reset_in_progress. * @stats_lock: Lock for @hw_stats_seqcount * @stats_work: Work for reading the hardware statistics counters often enough * to catch overflows. * @dma_err_task: Work structure to process Axi DMA errors * @stopping: Set when @dma_err_task shouldn't do anything because we are * about to stop the device. * @tx_irq: Axidma TX IRQ number * @rx_irq: Axidma RX IRQ number * @eth_irq: Ethernet core IRQ number * @phy_mode: Phy type to identify between MII/GMII/RGMII/SGMII/1000 Base-X * @options: AxiEthernet option word * @features: Stores the extended features supported by the axienet hw * @max_frm_size: Stores the maximum size of the frame that can be that * Txed/Rxed in the existing hardware. If jumbo option is * supported, the maximum frame size would be 9k. Else it is * 1522 bytes (assuming support for basic VLAN) * @rxmem: Stores rx memory size for jumbo frame handling. * @coalesce_count_rx: Store the irq coalesce on RX side. * @coalesce_usec_rx: IRQ coalesce delay for RX * @coalesce_count_tx: Store the irq coalesce on TX side. * @coalesce_usec_tx: IRQ coalesce delay for TX * @use_dmaengine: flag to check dmaengine framework usage. * @tx_chan: TX DMA channel. * @rx_chan: RX DMA channel. * @tx_skb_ring: Pointer to TX skb ring buffer array. * @rx_skb_ring: Pointer to RX skb ring buffer array. * @tx_ring_head: TX skb ring buffer head index. * @tx_ring_tail: TX skb ring buffer tail index. * @rx_ring_head: RX skb ring buffer head index. * @rx_ring_tail: RX skb ring buffer tail index. */ struct axienet_local { struct net_device *ndev; struct device *dev; struct phylink *phylink; struct phylink_config phylink_config; struct mdio_device *pcs_phy; struct phylink_pcs pcs; bool switch_x_sgmii; struct clk *axi_clk; struct clk_bulk_data misc_clks[XAE_NUM_MISC_CLOCKS]; struct mii_bus *mii_bus; u8 mii_clk_div; resource_size_t regs_start; void __iomem *regs; void __iomem *dma_regs; struct napi_struct napi_rx; u32 rx_dma_cr; struct axidma_bd *rx_bd_v; dma_addr_t rx_bd_p; u32 rx_bd_num; u32 rx_bd_ci; u64_stats_t rx_packets; u64_stats_t rx_bytes; struct u64_stats_sync rx_stat_sync; struct napi_struct napi_tx; u32 tx_dma_cr; struct axidma_bd *tx_bd_v; dma_addr_t tx_bd_p; u32 tx_bd_num; u32 tx_bd_ci; u32 tx_bd_tail; u64_stats_t tx_packets; u64_stats_t tx_bytes; struct u64_stats_sync tx_stat_sync; u64 hw_stat_base[STAT_COUNT]; u32 hw_last_counter[STAT_COUNT]; seqcount_mutex_t hw_stats_seqcount; struct mutex stats_lock; struct delayed_work stats_work; bool reset_in_progress; struct work_struct dma_err_task; bool stopping; int tx_irq; int rx_irq; int eth_irq; phy_interface_t phy_mode; u32 options; u32 features; u32 max_frm_size; u32 rxmem; u32 coalesce_count_rx; u32 coalesce_usec_rx; u32 coalesce_count_tx; u32 coalesce_usec_tx; u8 use_dmaengine; struct dma_chan *tx_chan; struct dma_chan *rx_chan; struct skbuf_dma_descriptor **tx_skb_ring; struct skbuf_dma_descriptor **rx_skb_ring; int tx_ring_head; int tx_ring_tail; int rx_ring_head; int rx_ring_tail; }; /** * struct axienet_option - Used to set axi ethernet hardware options * @opt: Option to be set. * @reg: Register offset to be written for setting the option * @m_or: Mask to be ORed for setting the option in the register */ struct axienet_option { u32 opt; u32 reg; u32 m_or; }; /** * axienet_ior - Memory mapped Axi Ethernet register read * @lp: Pointer to axienet local structure * @offset: Address offset from the base address of Axi Ethernet core * * Return: The contents of the Axi Ethernet register * * This function returns the contents of the corresponding register. */ static inline u32 axienet_ior(struct axienet_local *lp, off_t offset) { return ioread32(lp->regs + offset); } static inline u32 axinet_ior_read_mcr(struct axienet_local *lp) { return axienet_ior(lp, XAE_MDIO_MCR_OFFSET); } static inline void axienet_lock_mii(struct axienet_local *lp) { if (lp->mii_bus) mutex_lock(&lp->mii_bus->mdio_lock); } static inline void axienet_unlock_mii(struct axienet_local *lp) { if (lp->mii_bus) mutex_unlock(&lp->mii_bus->mdio_lock); } /** * axienet_iow - Memory mapped Axi Ethernet register write * @lp: Pointer to axienet local structure * @offset: Address offset from the base address of Axi Ethernet core * @value: Value to be written into the Axi Ethernet register * * This function writes the desired value into the corresponding Axi Ethernet * register. */ static inline void axienet_iow(struct axienet_local *lp, off_t offset, u32 value) { iowrite32(value, lp->regs + offset); } /** * axienet_dma_out32 - Memory mapped Axi DMA register write. * @lp: Pointer to axienet local structure * @reg: Address offset from the base address of the Axi DMA core * @value: Value to be written into the Axi DMA register * * This function writes the desired value into the corresponding Axi DMA * register. */ static inline void axienet_dma_out32(struct axienet_local *lp, off_t reg, u32 value) { iowrite32(value, lp->dma_regs + reg); } #if defined(CONFIG_64BIT) && defined(iowrite64) /** * axienet_dma_out64 - Memory mapped Axi DMA register write. * @lp: Pointer to axienet local structure * @reg: Address offset from the base address of the Axi DMA core * @value: Value to be written into the Axi DMA register * * This function writes the desired value into the corresponding Axi DMA * register. */ static inline void axienet_dma_out64(struct axienet_local *lp, off_t reg, u64 value) { iowrite64(value, lp->dma_regs + reg); } static inline void axienet_dma_out_addr(struct axienet_local *lp, off_t reg, dma_addr_t addr) { if (lp->features & XAE_FEATURE_DMA_64BIT) axienet_dma_out64(lp, reg, addr); else axienet_dma_out32(lp, reg, lower_32_bits(addr)); } #else /* CONFIG_64BIT */ static inline void axienet_dma_out_addr(struct axienet_local *lp, off_t reg, dma_addr_t addr) { axienet_dma_out32(lp, reg, lower_32_bits(addr)); } #endif /* CONFIG_64BIT */ /* Function prototypes visible in xilinx_axienet_mdio.c for other files */ int axienet_mdio_setup(struct axienet_local *lp); void axienet_mdio_teardown(struct axienet_local *lp); #endif /* XILINX_AXI_ENET_H */