/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Atmel MACB Ethernet Controller driver
 *
 * Copyright (C) 2004-2006 Atmel Corporation
 */
#ifndef _MACB_H
#define _MACB_H

#include <linux/clk.h>
#include <linux/phylink.h>
#include <linux/ptp_clock_kernel.h>
#include <linux/net_tstamp.h>
#include <linux/interrupt.h>
#include <linux/phy/phy.h>
#include <linux/workqueue.h>

#define MACB_GREGS_NBR 16
#define MACB_GREGS_VERSION 2
#define MACB_MAX_QUEUES 8

/* MACB register offsets */
#define MACB_NCR                0x0000 /* Network Control */
#define MACB_NCFGR              0x0004 /* Network Config */
#define MACB_NSR                0x0008 /* Network Status */
#define MACB_TAR                0x000c /* AT91RM9200 only */
#define MACB_TCR                0x0010 /* AT91RM9200 only */
#define MACB_TSR                0x0014 /* Transmit Status */
#define MACB_RBQP               0x0018 /* RX Q Base Address */
#define MACB_TBQP               0x001c /* TX Q Base Address */
#define MACB_RSR                0x0020 /* Receive Status */
#define MACB_ISR                0x0024 /* Interrupt Status */
#define MACB_IER                0x0028 /* Interrupt Enable */
#define MACB_IDR                0x002c /* Interrupt Disable */
#define MACB_IMR                0x0030 /* Interrupt Mask */
#define MACB_MAN                0x0034 /* PHY Maintenance */
#define MACB_PTR                0x0038
#define MACB_PFR                0x003c
#define MACB_FTO                0x0040
#define MACB_SCF                0x0044
#define MACB_MCF                0x0048
#define MACB_FRO                0x004c
#define MACB_FCSE               0x0050
#define MACB_ALE                0x0054
#define MACB_DTF                0x0058
#define MACB_LCOL               0x005c
#define MACB_EXCOL              0x0060
#define MACB_TUND               0x0064
#define MACB_CSE                0x0068
#define MACB_RRE                0x006c
#define MACB_ROVR               0x0070
#define MACB_RSE                0x0074
#define MACB_ELE                0x0078
#define MACB_RJA                0x007c
#define MACB_USF                0x0080
#define MACB_STE                0x0084
#define MACB_RLE                0x0088
#define MACB_TPF                0x008c
#define MACB_HRB                0x0090
#define MACB_HRT                0x0094
#define MACB_SA1B               0x0098
#define MACB_SA1T               0x009c
#define MACB_SA2B               0x00a0
#define MACB_SA2T               0x00a4
#define MACB_SA3B               0x00a8
#define MACB_SA3T               0x00ac
#define MACB_SA4B               0x00b0
#define MACB_SA4T               0x00b4
#define MACB_TID                0x00b8
#define MACB_TPQ                0x00bc
#define MACB_USRIO              0x00c0
#define MACB_WOL                0x00c4
#define MACB_MID                0x00fc
#define MACB_TBQPH              0x04C8
#define MACB_RBQPH              0x04D4

/* GEM register offsets. */
#define GEM_NCR                 0x0000 /* Network Control */
#define GEM_NCFGR               0x0004 /* Network Config */
#define GEM_USRIO               0x000c /* User IO */
#define GEM_DMACFG              0x0010 /* DMA Configuration */
#define GEM_PBUFRXCUT           0x0044 /* RX Partial Store and Forward */
#define GEM_JML                 0x0048 /* Jumbo Max Length */
#define GEM_HS_MAC_CONFIG       0x0050 /* GEM high speed config */
#define GEM_HRB                 0x0080 /* Hash Bottom */
#define GEM_HRT                 0x0084 /* Hash Top */
#define GEM_SA1B                0x0088 /* Specific1 Bottom */
#define GEM_SA1T                0x008C /* Specific1 Top */
#define GEM_SA2B                0x0090 /* Specific2 Bottom */
#define GEM_SA2T                0x0094 /* Specific2 Top */
#define GEM_SA3B                0x0098 /* Specific3 Bottom */
#define GEM_SA3T                0x009C /* Specific3 Top */
#define GEM_SA4B                0x00A0 /* Specific4 Bottom */
#define GEM_SA4T                0x00A4 /* Specific4 Top */
#define GEM_WOL                 0x00b8 /* Wake on LAN */
#define GEM_RXPTPUNI            0x00D4 /* PTP RX Unicast address */
#define GEM_TXPTPUNI            0x00D8 /* PTP TX Unicast address */
#define GEM_EFTSH               0x00e8 /* PTP Event Frame Transmitted Seconds Register 47:32 */
#define GEM_EFRSH               0x00ec /* PTP Event Frame Received Seconds Register 47:32 */
#define GEM_PEFTSH              0x00f0 /* PTP Peer Event Frame Transmitted Seconds Register 47:32 */
#define GEM_PEFRSH              0x00f4 /* PTP Peer Event Frame Received Seconds Register 47:32 */
#define GEM_OTX                 0x0100 /* Octets transmitted */
#define GEM_OCTTXL              0x0100 /* Octets transmitted [31:0] */
#define GEM_OCTTXH              0x0104 /* Octets transmitted [47:32] */
#define GEM_TXCNT               0x0108 /* Frames Transmitted counter */
#define GEM_TXBCCNT             0x010c /* Broadcast Frames counter */
#define GEM_TXMCCNT             0x0110 /* Multicast Frames counter */
#define GEM_TXPAUSECNT          0x0114 /* Pause Frames Transmitted Counter */
#define GEM_TX64CNT             0x0118 /* 64 byte Frames TX counter */
#define GEM_TX65CNT             0x011c /* 65-127 byte Frames TX counter */
#define GEM_TX128CNT            0x0120 /* 128-255 byte Frames TX counter */
#define GEM_TX256CNT            0x0124 /* 256-511 byte Frames TX counter */
#define GEM_TX512CNT            0x0128 /* 512-1023 byte Frames TX counter */
#define GEM_TX1024CNT           0x012c /* 1024-1518 byte Frames TX counter */
#define GEM_TX1519CNT           0x0130 /* 1519+ byte Frames TX counter */
#define GEM_TXURUNCNT           0x0134 /* TX under run error counter */
#define GEM_SNGLCOLLCNT         0x0138 /* Single Collision Frame Counter */
#define GEM_MULTICOLLCNT        0x013c /* Multiple Collision Frame Counter */
#define GEM_EXCESSCOLLCNT       0x0140 /* Excessive Collision Frame Counter */
#define GEM_LATECOLLCNT         0x0144 /* Late Collision Frame Counter */
#define GEM_TXDEFERCNT          0x0148 /* Deferred Transmission Frame Counter */
#define GEM_TXCSENSECNT         0x014c /* Carrier Sense Error Counter */
#define GEM_ORX                 0x0150 /* Octets received */
#define GEM_OCTRXL              0x0150 /* Octets received [31:0] */
#define GEM_OCTRXH              0x0154 /* Octets received [47:32] */
#define GEM_RXCNT               0x0158 /* Frames Received Counter */
#define GEM_RXBROADCNT          0x015c /* Broadcast Frames Received Counter */
#define GEM_RXMULTICNT          0x0160 /* Multicast Frames Received Counter */
#define GEM_RXPAUSECNT          0x0164 /* Pause Frames Received Counter */
#define GEM_RX64CNT             0x0168 /* 64 byte Frames RX Counter */
#define GEM_RX65CNT             0x016c /* 65-127 byte Frames RX Counter */
#define GEM_RX128CNT            0x0170 /* 128-255 byte Frames RX Counter */
#define GEM_RX256CNT            0x0174 /* 256-511 byte Frames RX Counter */
#define GEM_RX512CNT            0x0178 /* 512-1023 byte Frames RX Counter */
#define GEM_RX1024CNT           0x017c /* 1024-1518 byte Frames RX Counter */
#define GEM_RX1519CNT           0x0180 /* 1519+ byte Frames RX Counter */
#define GEM_RXUNDRCNT           0x0184 /* Undersize Frames Received Counter */
#define GEM_RXOVRCNT            0x0188 /* Oversize Frames Received Counter */
#define GEM_RXJABCNT            0x018c /* Jabbers Received Counter */
#define GEM_RXFCSCNT            0x0190 /* Frame Check Sequence Error Counter */
#define GEM_RXLENGTHCNT         0x0194 /* Length Field Error Counter */
#define GEM_RXSYMBCNT           0x0198 /* Symbol Error Counter */
#define GEM_RXALIGNCNT          0x019c /* Alignment Error Counter */
#define GEM_RXRESERRCNT         0x01a0 /* Receive Resource Error Counter */
#define GEM_RXORCNT             0x01a4 /* Receive Overrun Counter */
#define GEM_RXIPCCNT            0x01a8 /* IP header Checksum Error Counter */
#define GEM_RXTCPCCNT           0x01ac /* TCP Checksum Error Counter */
#define GEM_RXUDPCCNT           0x01b0 /* UDP Checksum Error Counter */
#define GEM_TISUBN              0x01bc /* 1588 Timer Increment Sub-ns */
#define GEM_TSH                 0x01c0 /* 1588 Timer Seconds High */
#define GEM_TSL                 0x01d0 /* 1588 Timer Seconds Low */
#define GEM_TN                  0x01d4 /* 1588 Timer Nanoseconds */
#define GEM_TA                  0x01d8 /* 1588 Timer Adjust */
#define GEM_TI                  0x01dc /* 1588 Timer Increment */
#define GEM_EFTSL               0x01e0 /* PTP Event Frame Tx Seconds Low */
#define GEM_EFTN                0x01e4 /* PTP Event Frame Tx Nanoseconds */
#define GEM_EFRSL               0x01e8 /* PTP Event Frame Rx Seconds Low */
#define GEM_EFRN                0x01ec /* PTP Event Frame Rx Nanoseconds */
#define GEM_PEFTSL              0x01f0 /* PTP Peer Event Frame Tx Secs Low */
#define GEM_PEFTN               0x01f4 /* PTP Peer Event Frame Tx Ns */
#define GEM_PEFRSL              0x01f8 /* PTP Peer Event Frame Rx Sec Low */
#define GEM_PEFRN               0x01fc /* PTP Peer Event Frame Rx Ns */
#define GEM_PCSCNTRL            0x0200 /* PCS Control */
#define GEM_PCSSTS              0x0204 /* PCS Status */
#define GEM_PCSPHYTOPID         0x0208 /* PCS PHY Top ID */
#define GEM_PCSPHYBOTID         0x020c /* PCS PHY Bottom ID */
#define GEM_PCSANADV            0x0210 /* PCS AN Advertisement */
#define GEM_PCSANLPBASE         0x0214 /* PCS AN Link Partner Base */
#define GEM_PCSANEXP            0x0218 /* PCS AN Expansion */
#define GEM_PCSANNPTX           0x021c /* PCS AN Next Page TX */
#define GEM_PCSANNPLP           0x0220 /* PCS AN Next Page LP */
#define GEM_PCSANEXTSTS         0x023c /* PCS AN Extended Status */
#define GEM_DCFG1               0x0280 /* Design Config 1 */
#define GEM_DCFG2               0x0284 /* Design Config 2 */
#define GEM_DCFG3               0x0288 /* Design Config 3 */
#define GEM_DCFG4               0x028c /* Design Config 4 */
#define GEM_DCFG5               0x0290 /* Design Config 5 */
#define GEM_DCFG6               0x0294 /* Design Config 6 */
#define GEM_DCFG7               0x0298 /* Design Config 7 */
#define GEM_DCFG8               0x029C /* Design Config 8 */
#define GEM_DCFG10              0x02A4 /* Design Config 10 */
#define GEM_DCFG12              0x02AC /* Design Config 12 */
#define GEM_ENST_START_TIME_Q0  0x0800 /* ENST Q0 start time */
#define GEM_ENST_START_TIME_Q1  0x0804 /* ENST Q1 start time */
#define GEM_ENST_ON_TIME_Q0     0x0820 /* ENST Q0 on time */
#define GEM_ENST_ON_TIME_Q1     0x0824 /* ENST Q1 on time */
#define GEM_ENST_OFF_TIME_Q0    0x0840 /* ENST Q0 off time */
#define GEM_ENST_OFF_TIME_Q1    0x0844 /* ENST Q1 off time */
#define GEM_ENST_CONTROL        0x0880 /* ENST control register */
#define GEM_USX_CONTROL         0x0A80 /* High speed PCS control register */
#define GEM_USX_STATUS          0x0A88 /* High speed PCS status register */

#define GEM_TXBDCTRL    0x04cc /* TX Buffer Descriptor control register */
#define GEM_RXBDCTRL    0x04d0 /* RX Buffer Descriptor control register */

/* Screener Type 2 match registers */
#define GEM_SCRT2               0x540

/* EtherType registers */
#define GEM_ETHT                0x06E0

/* Type 2 compare registers */
#define GEM_T2CMPW0             0x0700
#define GEM_T2CMPW1             0x0704
#define T2CMP_OFST(t2idx)       (t2idx * 2)

/* type 2 compare registers
 * each location requires 3 compare regs
 */
#define GEM_IP4SRC_CMP(idx)             (idx * 3)
#define GEM_IP4DST_CMP(idx)             (idx * 3 + 1)
#define GEM_PORT_CMP(idx)               (idx * 3 + 2)

/* Which screening type 2 EtherType register will be used (0 - 7) */
#define SCRT2_ETHT              0

#define GEM_ISR(hw_q)           (0x0400 + ((hw_q) << 2))
#define GEM_TBQP(hw_q)          (0x0440 + ((hw_q) << 2))
#define GEM_RBQP(hw_q)          (0x0480 + ((hw_q) << 2))
#define GEM_RBQS(hw_q)          (0x04A0 + ((hw_q) << 2))
#define GEM_IER(hw_q)           (0x0600 + ((hw_q) << 2))
#define GEM_IDR(hw_q)           (0x0620 + ((hw_q) << 2))
#define GEM_IMR(hw_q)           (0x0640 + ((hw_q) << 2))

#define GEM_ENST_START_TIME(hw_q)       (0x0800 + ((hw_q) << 2))
#define GEM_ENST_ON_TIME(hw_q)          (0x0820 + ((hw_q) << 2))
#define GEM_ENST_OFF_TIME(hw_q)         (0x0840 + ((hw_q) << 2))

/* Bitfields in ENST_CONTROL */
#define GEM_ENST_DISABLE_QUEUE_OFFSET   16

/* Bitfields in NCR */
#define MACB_LB_OFFSET          0 /* reserved */
#define MACB_LB_SIZE            1
#define MACB_LLB_OFFSET         1 /* Loop back local */
#define MACB_LLB_SIZE           1
#define MACB_RE_OFFSET          2 /* Receive enable */
#define MACB_RE_SIZE            1
#define MACB_TE_OFFSET          3 /* Transmit enable */
#define MACB_TE_SIZE            1
#define MACB_MPE_OFFSET         4 /* Management port enable */
#define MACB_MPE_SIZE           1
#define MACB_CLRSTAT_OFFSET     5 /* Clear stats regs */
#define MACB_CLRSTAT_SIZE       1
#define MACB_INCSTAT_OFFSET     6 /* Incremental stats regs */
#define MACB_INCSTAT_SIZE       1
#define MACB_WESTAT_OFFSET      7 /* Write enable stats regs */
#define MACB_WESTAT_SIZE        1
#define MACB_BP_OFFSET          8 /* Back pressure */
#define MACB_BP_SIZE            1
#define MACB_TSTART_OFFSET      9 /* Start transmission */
#define MACB_TSTART_SIZE        1
#define MACB_THALT_OFFSET       10 /* Transmit halt */
#define MACB_THALT_SIZE         1
#define MACB_NCR_TPF_OFFSET     11 /* Transmit pause frame */
#define MACB_NCR_TPF_SIZE       1
#define MACB_TZQ_OFFSET         12 /* Transmit zero quantum pause frame */
#define MACB_TZQ_SIZE           1
#define MACB_SRTSM_OFFSET       15 /* Store Receive Timestamp to Memory */
#define MACB_PTPUNI_OFFSET      20 /* PTP Unicast packet enable */
#define MACB_PTPUNI_SIZE        1
#define MACB_OSSMODE_OFFSET     24 /* Enable One Step Synchro Mode */
#define MACB_OSSMODE_SIZE       1
#define MACB_MIIONRGMII_OFFSET  28 /* MII Usage on RGMII Interface */
#define MACB_MIIONRGMII_SIZE    1

/* Bitfields in NCFGR */
#define MACB_SPD_OFFSET         0 /* Speed */
#define MACB_SPD_SIZE           1
#define MACB_FD_OFFSET          1 /* Full duplex */
#define MACB_FD_SIZE            1
#define MACB_BIT_RATE_OFFSET    2 /* Discard non-VLAN frames */
#define MACB_BIT_RATE_SIZE      1
#define MACB_JFRAME_OFFSET      3 /* reserved */
#define MACB_JFRAME_SIZE        1
#define MACB_CAF_OFFSET         4 /* Copy all frames */
#define MACB_CAF_SIZE           1
#define MACB_NBC_OFFSET         5 /* No broadcast */
#define MACB_NBC_SIZE           1
#define MACB_NCFGR_MTI_OFFSET   6 /* Multicast hash enable */
#define MACB_NCFGR_MTI_SIZE     1
#define MACB_UNI_OFFSET         7 /* Unicast hash enable */
#define MACB_UNI_SIZE           1
#define MACB_BIG_OFFSET         8 /* Receive 1536 byte frames */
#define MACB_BIG_SIZE           1
#define MACB_EAE_OFFSET         9 /* External address match enable */
#define MACB_EAE_SIZE           1
#define MACB_CLK_OFFSET         10
#define MACB_CLK_SIZE           2
#define MACB_RTY_OFFSET         12 /* Retry test */
#define MACB_RTY_SIZE           1
#define MACB_PAE_OFFSET         13 /* Pause enable */
#define MACB_PAE_SIZE           1
#define MACB_RM9200_RMII_OFFSET 13 /* AT91RM9200 only */
#define MACB_RM9200_RMII_SIZE   1  /* AT91RM9200 only */
#define MACB_RBOF_OFFSET        14 /* Receive buffer offset */
#define MACB_RBOF_SIZE          2
#define MACB_RLCE_OFFSET        16 /* Length field error frame discard */
#define MACB_RLCE_SIZE          1
#define MACB_DRFCS_OFFSET       17 /* FCS remove */
#define MACB_DRFCS_SIZE         1
#define MACB_EFRHD_OFFSET       18
#define MACB_EFRHD_SIZE         1
#define MACB_IRXFCS_OFFSET      19
#define MACB_IRXFCS_SIZE        1

/* GEM specific NCR bitfields. */
#define GEM_ENABLE_HS_MAC_OFFSET        31
#define GEM_ENABLE_HS_MAC_SIZE          1

/* GEM specific NCFGR bitfields. */
#define GEM_FD_OFFSET           1 /* Full duplex */
#define GEM_FD_SIZE             1
#define GEM_GBE_OFFSET          10 /* Gigabit mode enable */
#define GEM_GBE_SIZE            1
#define GEM_PCSSEL_OFFSET       11
#define GEM_PCSSEL_SIZE         1
#define GEM_PAE_OFFSET          13 /* Pause enable */
#define GEM_PAE_SIZE            1
#define GEM_CLK_OFFSET          18 /* MDC clock division */
#define GEM_CLK_SIZE            3
#define GEM_DBW_OFFSET          21 /* Data bus width */
#define GEM_DBW_SIZE            2
#define GEM_RXCOEN_OFFSET       24
#define GEM_RXCOEN_SIZE         1
#define GEM_SGMIIEN_OFFSET      27
#define GEM_SGMIIEN_SIZE        1


/* Constants for data bus width. */
#define GEM_DBW32               0 /* 32 bit AMBA AHB data bus width */
#define GEM_DBW64               1 /* 64 bit AMBA AHB data bus width */
#define GEM_DBW128              2 /* 128 bit AMBA AHB data bus width */

/* Bitfields in DMACFG. */
#define GEM_FBLDO_OFFSET        0 /* fixed burst length for DMA */
#define GEM_FBLDO_SIZE          5
#define GEM_ENDIA_DESC_OFFSET   6 /* endian swap mode for management descriptor access */
#define GEM_ENDIA_DESC_SIZE     1
#define GEM_ENDIA_PKT_OFFSET    7 /* endian swap mode for packet data access */
#define GEM_ENDIA_PKT_SIZE      1
#define GEM_RXBMS_OFFSET        8 /* RX packet buffer memory size select */
#define GEM_RXBMS_SIZE          2
#define GEM_TXPBMS_OFFSET       10 /* TX packet buffer memory size select */
#define GEM_TXPBMS_SIZE         1
#define GEM_TXCOEN_OFFSET       11 /* TX IP/TCP/UDP checksum gen offload */
#define GEM_TXCOEN_SIZE         1
#define GEM_RXBS_OFFSET         16 /* DMA receive buffer size */
#define GEM_RXBS_SIZE           8
#define GEM_DDRP_OFFSET         24 /* disc_when_no_ahb */
#define GEM_DDRP_SIZE           1
#define GEM_RXEXT_OFFSET        28 /* RX extended Buffer Descriptor mode */
#define GEM_RXEXT_SIZE          1
#define GEM_TXEXT_OFFSET        29 /* TX extended Buffer Descriptor mode */
#define GEM_TXEXT_SIZE          1
#define GEM_ADDR64_OFFSET       30 /* Address bus width - 64b or 32b */
#define GEM_ADDR64_SIZE         1


/* Bitfields in PBUFRXCUT */
#define GEM_ENCUTTHRU_OFFSET    31 /* Enable RX partial store and forward */
#define GEM_ENCUTTHRU_SIZE      1

/* Bitfields in NSR */
#define MACB_NSR_LINK_OFFSET    0 /* pcs_link_state */
#define MACB_NSR_LINK_SIZE      1
#define MACB_MDIO_OFFSET        1 /* status of the mdio_in pin */
#define MACB_MDIO_SIZE          1
#define MACB_IDLE_OFFSET        2 /* The PHY management logic is idle */
#define MACB_IDLE_SIZE          1

/* Bitfields in TSR */
#define MACB_UBR_OFFSET         0 /* Used bit read */
#define MACB_UBR_SIZE           1
#define MACB_COL_OFFSET         1 /* Collision occurred */
#define MACB_COL_SIZE           1
#define MACB_TSR_RLE_OFFSET     2 /* Retry limit exceeded */
#define MACB_TSR_RLE_SIZE       1
#define MACB_TGO_OFFSET         3 /* Transmit go */
#define MACB_TGO_SIZE           1
#define MACB_BEX_OFFSET         4 /* TX frame corruption due to AHB error */
#define MACB_BEX_SIZE           1
#define MACB_RM9200_BNQ_OFFSET  4 /* AT91RM9200 only */
#define MACB_RM9200_BNQ_SIZE    1 /* AT91RM9200 only */
#define MACB_COMP_OFFSET        5 /* Trnasmit complete */
#define MACB_COMP_SIZE          1
#define MACB_UND_OFFSET         6 /* Trnasmit under run */
#define MACB_UND_SIZE           1

/* Bitfields in RSR */
#define MACB_BNA_OFFSET         0 /* Buffer not available */
#define MACB_BNA_SIZE           1
#define MACB_REC_OFFSET         1 /* Frame received */
#define MACB_REC_SIZE           1
#define MACB_OVR_OFFSET         2 /* Receive overrun */
#define MACB_OVR_SIZE           1

/* Bitfields in ISR/IER/IDR/IMR */
#define MACB_MFD_OFFSET         0 /* Management frame sent */
#define MACB_MFD_SIZE           1
#define MACB_RCOMP_OFFSET       1 /* Receive complete */
#define MACB_RCOMP_SIZE         1
#define MACB_RXUBR_OFFSET       2 /* RX used bit read */
#define MACB_RXUBR_SIZE         1
#define MACB_TXUBR_OFFSET       3 /* TX used bit read */
#define MACB_TXUBR_SIZE         1
#define MACB_ISR_TUND_OFFSET    4 /* Enable TX buffer under run interrupt */
#define MACB_ISR_TUND_SIZE      1
#define MACB_ISR_RLE_OFFSET     5 /* EN retry exceeded/late coll interrupt */
#define MACB_ISR_RLE_SIZE       1
#define MACB_TXERR_OFFSET       6 /* EN TX frame corrupt from error interrupt */
#define MACB_TXERR_SIZE         1
#define MACB_RM9200_TBRE_OFFSET 6 /* EN may send new frame interrupt (RM9200) */
#define MACB_RM9200_TBRE_SIZE   1
#define MACB_TCOMP_OFFSET       7 /* Enable transmit complete interrupt */
#define MACB_TCOMP_SIZE         1
#define MACB_ISR_LINK_OFFSET    9 /* Enable link change interrupt */
#define MACB_ISR_LINK_SIZE      1
#define MACB_ISR_ROVR_OFFSET    10 /* Enable receive overrun interrupt */
#define MACB_ISR_ROVR_SIZE      1
#define MACB_HRESP_OFFSET       11 /* Enable hrsep not OK interrupt */
#define MACB_HRESP_SIZE         1
#define MACB_PFR_OFFSET         12 /* Enable pause frame w/ quantum interrupt */
#define MACB_PFR_SIZE           1
#define MACB_PTZ_OFFSET         13 /* Enable pause time zero interrupt */
#define MACB_PTZ_SIZE           1
#define MACB_WOL_OFFSET         14 /* Enable wake-on-lan interrupt */
#define MACB_WOL_SIZE           1
#define MACB_DRQFR_OFFSET       18 /* PTP Delay Request Frame Received */
#define MACB_DRQFR_SIZE         1
#define MACB_SFR_OFFSET         19 /* PTP Sync Frame Received */
#define MACB_SFR_SIZE           1
#define MACB_DRQFT_OFFSET       20 /* PTP Delay Request Frame Transmitted */
#define MACB_DRQFT_SIZE         1
#define MACB_SFT_OFFSET         21 /* PTP Sync Frame Transmitted */
#define MACB_SFT_SIZE           1
#define MACB_PDRQFR_OFFSET      22 /* PDelay Request Frame Received */
#define MACB_PDRQFR_SIZE        1
#define MACB_PDRSFR_OFFSET      23 /* PDelay Response Frame Received */
#define MACB_PDRSFR_SIZE        1
#define MACB_PDRQFT_OFFSET      24 /* PDelay Request Frame Transmitted */
#define MACB_PDRQFT_SIZE        1
#define MACB_PDRSFT_OFFSET      25 /* PDelay Response Frame Transmitted */
#define MACB_PDRSFT_SIZE        1
#define MACB_SRI_OFFSET         26 /* TSU Seconds Register Increment */
#define MACB_SRI_SIZE           1
#define GEM_WOL_OFFSET          28 /* Enable wake-on-lan interrupt */
#define GEM_WOL_SIZE            1

/* Timer increment fields */
#define MACB_TI_CNS_OFFSET      0
#define MACB_TI_CNS_SIZE        8
#define MACB_TI_ACNS_OFFSET     8
#define MACB_TI_ACNS_SIZE       8
#define MACB_TI_NIT_OFFSET      16
#define MACB_TI_NIT_SIZE        8

/* Bitfields in MAN */
#define MACB_DATA_OFFSET        0 /* data */
#define MACB_DATA_SIZE          16
#define MACB_CODE_OFFSET        16 /* Must be written to 10 */
#define MACB_CODE_SIZE          2
#define MACB_REGA_OFFSET        18 /* Register address */
#define MACB_REGA_SIZE          5
#define MACB_PHYA_OFFSET        23 /* PHY address */
#define MACB_PHYA_SIZE          5
#define MACB_RW_OFFSET          28 /* Operation. 10 is read. 01 is write. */
#define MACB_RW_SIZE            2
#define MACB_SOF_OFFSET         30 /* Must be written to 1 for Clause 22 */
#define MACB_SOF_SIZE           2

/* Bitfields in USRIO (AVR32) */
#define MACB_MII_OFFSET                         0
#define MACB_MII_SIZE                           1
#define MACB_EAM_OFFSET                         1
#define MACB_EAM_SIZE                           1
#define MACB_TX_PAUSE_OFFSET                    2
#define MACB_TX_PAUSE_SIZE                      1
#define MACB_TX_PAUSE_ZERO_OFFSET               3
#define MACB_TX_PAUSE_ZERO_SIZE                 1

/* Bitfields in USRIO (AT91) */
#define MACB_RMII_OFFSET                        0
#define MACB_RMII_SIZE                          1
#define GEM_RGMII_OFFSET                        0 /* GEM gigabit mode */
#define GEM_RGMII_SIZE                          1
#define MACB_CLKEN_OFFSET                       1
#define MACB_CLKEN_SIZE                         1

/* Bitfields in WOL */
#define MACB_IP_OFFSET                          0
#define MACB_IP_SIZE                            16
#define MACB_MAG_OFFSET                         16
#define MACB_MAG_SIZE                           1
#define MACB_ARP_OFFSET                         17
#define MACB_ARP_SIZE                           1
#define MACB_SA1_OFFSET                         18
#define MACB_SA1_SIZE                           1
#define MACB_WOL_MTI_OFFSET                     19
#define MACB_WOL_MTI_SIZE                       1

/* Bitfields in MID */
#define MACB_IDNUM_OFFSET                       16
#define MACB_IDNUM_SIZE                         12
#define MACB_REV_OFFSET                         0
#define MACB_REV_SIZE                           16

/* Bitfield in HS_MAC_CONFIG */
#define GEM_HS_MAC_SPEED_OFFSET                 0
#define GEM_HS_MAC_SPEED_SIZE                   3

/* Bitfields in PCSCNTRL */
#define GEM_PCSAUTONEG_OFFSET                   12
#define GEM_PCSAUTONEG_SIZE                     1

/* Bitfields in DCFG1. */
#define GEM_IRQCOR_OFFSET                       23
#define GEM_IRQCOR_SIZE                         1
#define GEM_DBWDEF_OFFSET                       25
#define GEM_DBWDEF_SIZE                         3
#define GEM_NO_PCS_OFFSET                       0
#define GEM_NO_PCS_SIZE                         1

/* Bitfields in DCFG2. */
#define GEM_RX_PKT_BUFF_OFFSET                  20
#define GEM_RX_PKT_BUFF_SIZE                    1
#define GEM_TX_PKT_BUFF_OFFSET                  21
#define GEM_TX_PKT_BUFF_SIZE                    1

#define GEM_RX_PBUF_ADDR_OFFSET                 22
#define GEM_RX_PBUF_ADDR_SIZE                   4

/* Bitfields in DCFG5. */
#define GEM_TSU_OFFSET                          8
#define GEM_TSU_SIZE                            1

/* Bitfields in DCFG6. */
#define GEM_PBUF_LSO_OFFSET                     27
#define GEM_PBUF_LSO_SIZE                       1
#define GEM_PBUF_RSC_OFFSET                     26
#define GEM_PBUF_RSC_SIZE                       1
#define GEM_PBUF_CUTTHRU_OFFSET                 25
#define GEM_PBUF_CUTTHRU_SIZE                   1
#define GEM_DAW64_OFFSET                        23
#define GEM_DAW64_SIZE                          1

/* Bitfields in DCFG8. */
#define GEM_T1SCR_OFFSET                        24
#define GEM_T1SCR_SIZE                          8
#define GEM_T2SCR_OFFSET                        16
#define GEM_T2SCR_SIZE                          8
#define GEM_SCR2ETH_OFFSET                      8
#define GEM_SCR2ETH_SIZE                        8
#define GEM_SCR2CMP_OFFSET                      0
#define GEM_SCR2CMP_SIZE                        8

/* Bitfields in DCFG10 */
#define GEM_TXBD_RDBUFF_OFFSET                  12
#define GEM_TXBD_RDBUFF_SIZE                    4
#define GEM_RXBD_RDBUFF_OFFSET                  8
#define GEM_RXBD_RDBUFF_SIZE                    4

/* Bitfields in DCFG12. */
#define GEM_HIGH_SPEED_OFFSET                   26
#define GEM_HIGH_SPEED_SIZE                     1

/* Bitfields in ENST_START_TIME_Qx. */
#define GEM_START_TIME_SEC_OFFSET               30
#define GEM_START_TIME_SEC_SIZE                 2
#define GEM_START_TIME_NSEC_OFFSET              0
#define GEM_START_TIME_NSEC_SIZE                30

/* Bitfields in ENST_ON_TIME_Qx. */
#define GEM_ON_TIME_OFFSET                      0
#define GEM_ON_TIME_SIZE                        17

/* Bitfields in ENST_OFF_TIME_Qx. */
#define GEM_OFF_TIME_OFFSET                     0
#define GEM_OFF_TIME_SIZE                       17

/* Hardware ENST timing registers granularity */
#define ENST_TIME_GRANULARITY_NS                8

/* Bitfields in USX_CONTROL. */
#define GEM_USX_CTRL_SPEED_OFFSET               14
#define GEM_USX_CTRL_SPEED_SIZE                 3
#define GEM_SERDES_RATE_OFFSET                  12
#define GEM_SERDES_RATE_SIZE                    2
#define GEM_RX_SCR_BYPASS_OFFSET                9
#define GEM_RX_SCR_BYPASS_SIZE                  1
#define GEM_TX_SCR_BYPASS_OFFSET                8
#define GEM_TX_SCR_BYPASS_SIZE                  1
#define GEM_TX_EN_OFFSET                        1
#define GEM_TX_EN_SIZE                          1
#define GEM_SIGNAL_OK_OFFSET                    0
#define GEM_SIGNAL_OK_SIZE                      1

/* Bitfields in USX_STATUS. */
#define GEM_USX_BLOCK_LOCK_OFFSET               0
#define GEM_USX_BLOCK_LOCK_SIZE                 1

/* Bitfields in TISUBN */
#define GEM_SUBNSINCR_OFFSET                    0
#define GEM_SUBNSINCRL_OFFSET                   24
#define GEM_SUBNSINCRL_SIZE                     8
#define GEM_SUBNSINCRH_OFFSET                   0
#define GEM_SUBNSINCRH_SIZE                     16
#define GEM_SUBNSINCR_SIZE                      24

/* Bitfields in TI */
#define GEM_NSINCR_OFFSET                       0
#define GEM_NSINCR_SIZE                         8

/* Bitfields in TSH */
#define GEM_TSH_OFFSET                          0 /* TSU timer value (s). MSB [47:32] of seconds timer count */
#define GEM_TSH_SIZE                            16

/* Bitfields in TSL */
#define GEM_TSL_OFFSET                          0 /* TSU timer value (s). LSB [31:0] of seconds timer count */
#define GEM_TSL_SIZE                            32

/* Bitfields in TN */
#define GEM_TN_OFFSET                           0 /* TSU timer value (ns) */
#define GEM_TN_SIZE                                     30

/* Bitfields in TXBDCTRL */
#define GEM_TXTSMODE_OFFSET                     4 /* TX Descriptor Timestamp Insertion mode */
#define GEM_TXTSMODE_SIZE                       2

/* Bitfields in RXBDCTRL */
#define GEM_RXTSMODE_OFFSET                     4 /* RX Descriptor Timestamp Insertion mode */
#define GEM_RXTSMODE_SIZE                       2

/* Bitfields in SCRT2 */
#define GEM_QUEUE_OFFSET                        0 /* Queue Number */
#define GEM_QUEUE_SIZE                          4
#define GEM_VLANPR_OFFSET                       4 /* VLAN Priority */
#define GEM_VLANPR_SIZE                         3
#define GEM_VLANEN_OFFSET                       8 /* VLAN Enable */
#define GEM_VLANEN_SIZE                         1
#define GEM_ETHT2IDX_OFFSET                     9 /* Index to screener type 2 EtherType register */
#define GEM_ETHT2IDX_SIZE                       3
#define GEM_ETHTEN_OFFSET                       12 /* EtherType Enable */
#define GEM_ETHTEN_SIZE                         1
#define GEM_CMPA_OFFSET                         13 /* Compare A - Index to screener type 2 Compare register */
#define GEM_CMPA_SIZE                           5
#define GEM_CMPAEN_OFFSET                       18 /* Compare A Enable */
#define GEM_CMPAEN_SIZE                         1
#define GEM_CMPB_OFFSET                         19 /* Compare B - Index to screener type 2 Compare register */
#define GEM_CMPB_SIZE                           5
#define GEM_CMPBEN_OFFSET                       24 /* Compare B Enable */
#define GEM_CMPBEN_SIZE                         1
#define GEM_CMPC_OFFSET                         25 /* Compare C - Index to screener type 2 Compare register */
#define GEM_CMPC_SIZE                           5
#define GEM_CMPCEN_OFFSET                       30 /* Compare C Enable */
#define GEM_CMPCEN_SIZE                         1

/* Bitfields in ETHT */
#define GEM_ETHTCMP_OFFSET                      0 /* EtherType compare value */
#define GEM_ETHTCMP_SIZE                        16

/* Bitfields in T2CMPW0 */
#define GEM_T2CMP_OFFSET                        16 /* 0xFFFF0000 compare value */
#define GEM_T2CMP_SIZE                          16
#define GEM_T2MASK_OFFSET                       0 /* 0x0000FFFF compare value or mask */
#define GEM_T2MASK_SIZE                         16

/* Bitfields in T2CMPW1 */
#define GEM_T2DISMSK_OFFSET                     9 /* disable mask */
#define GEM_T2DISMSK_SIZE                       1
#define GEM_T2CMPOFST_OFFSET                    7 /* compare offset */
#define GEM_T2CMPOFST_SIZE                      2
#define GEM_T2OFST_OFFSET                       0 /* offset value */
#define GEM_T2OFST_SIZE                         7

/* Bitfields in queue pointer registers */
#define MACB_QUEUE_DISABLE_OFFSET               0 /* disable queue */
#define MACB_QUEUE_DISABLE_SIZE                 1

/* Offset for screener type 2 compare values (T2CMPOFST).
 * Note the offset is applied after the specified point,
 * e.g. GEM_T2COMPOFST_ETYPE denotes the EtherType field, so an offset
 * of 12 bytes from this would be the source IP address in an IP header
 */
#define GEM_T2COMPOFST_SOF              0
#define GEM_T2COMPOFST_ETYPE    1
#define GEM_T2COMPOFST_IPHDR    2
#define GEM_T2COMPOFST_TCPUDP   3

/* offset from EtherType to IP address */
#define ETYPE_SRCIP_OFFSET                      12
#define ETYPE_DSTIP_OFFSET                      16

/* offset from IP header to port */
#define IPHDR_SRCPORT_OFFSET            0
#define IPHDR_DSTPORT_OFFSET            2

/* Transmit DMA buffer descriptor Word 1 */
#define GEM_DMA_TXVALID_OFFSET          23 /* timestamp has been captured in the Buffer Descriptor */
#define GEM_DMA_TXVALID_SIZE            1

/* Receive DMA buffer descriptor Word 0 */
#define GEM_DMA_RXVALID_OFFSET          2 /* indicates a valid timestamp in the Buffer Descriptor */
#define GEM_DMA_RXVALID_SIZE            1

/* DMA buffer descriptor Word 2 (32 bit addressing) or Word 4 (64 bit addressing) */
#define GEM_DMA_SECL_OFFSET                     30 /* Timestamp seconds[1:0]  */
#define GEM_DMA_SECL_SIZE                       2
#define GEM_DMA_NSEC_OFFSET                     0 /* Timestamp nanosecs [29:0] */
#define GEM_DMA_NSEC_SIZE                       30

/* DMA buffer descriptor Word 3 (32 bit addressing) or Word 5 (64 bit addressing) */

/* New hardware supports 12 bit precision of timestamp in DMA buffer descriptor.
 * Old hardware supports only 6 bit precision but it is enough for PTP.
 * Less accuracy is used always instead of checking hardware version.
 */
#define GEM_DMA_SECH_OFFSET                     0 /* Timestamp seconds[5:2] */
#define GEM_DMA_SECH_SIZE                       4
#define GEM_DMA_SEC_WIDTH                       (GEM_DMA_SECH_SIZE + GEM_DMA_SECL_SIZE)
#define GEM_DMA_SEC_TOP                         (1 << GEM_DMA_SEC_WIDTH)
#define GEM_DMA_SEC_MASK                        (GEM_DMA_SEC_TOP - 1)

/* Bitfields in ADJ */
#define GEM_ADDSUB_OFFSET                       31
#define GEM_ADDSUB_SIZE                         1
/* Constants for CLK */
#define MACB_CLK_DIV8                           0
#define MACB_CLK_DIV16                          1
#define MACB_CLK_DIV32                          2
#define MACB_CLK_DIV64                          3

/* GEM specific constants for CLK. */
#define GEM_CLK_DIV8                            0
#define GEM_CLK_DIV16                           1
#define GEM_CLK_DIV32                           2
#define GEM_CLK_DIV48                           3
#define GEM_CLK_DIV64                           4
#define GEM_CLK_DIV96                           5
#define GEM_CLK_DIV128                          6
#define GEM_CLK_DIV224                          7

/* Constants for MAN register */
#define MACB_MAN_C22_SOF                        1
#define MACB_MAN_C22_WRITE                      1
#define MACB_MAN_C22_READ                       2
#define MACB_MAN_C22_CODE                       2

#define MACB_MAN_C45_SOF                        0
#define MACB_MAN_C45_ADDR                       0
#define MACB_MAN_C45_WRITE                      1
#define MACB_MAN_C45_POST_READ_INCR             2
#define MACB_MAN_C45_READ                       3
#define MACB_MAN_C45_CODE                       2

/* Capability mask bits */
#define MACB_CAPS_ISR_CLEAR_ON_WRITE            BIT(0)
#define MACB_CAPS_USRIO_HAS_CLKEN               BIT(1)
#define MACB_CAPS_USRIO_DEFAULT_IS_MII_GMII     BIT(2)
#define MACB_CAPS_NO_GIGABIT_HALF               BIT(3)
#define MACB_CAPS_USRIO_DISABLED                BIT(4)
#define MACB_CAPS_JUMBO                         BIT(5)
#define MACB_CAPS_GEM_HAS_PTP                   BIT(6)
#define MACB_CAPS_BD_RD_PREFETCH                BIT(7)
#define MACB_CAPS_NEEDS_RSTONUBR                BIT(8)
#define MACB_CAPS_MIIONRGMII                    BIT(9)
#define MACB_CAPS_NEED_TSUCLK                   BIT(10)
#define MACB_CAPS_QUEUE_DISABLE                 BIT(11)
#define MACB_CAPS_QBV                           BIT(12)
#define MACB_CAPS_PCS                           BIT(13)
#define MACB_CAPS_HIGH_SPEED                    BIT(14)
#define MACB_CAPS_CLK_HW_CHG                    BIT(15)
#define MACB_CAPS_MACB_IS_EMAC                  BIT(16)
#define MACB_CAPS_FIFO_MODE                     BIT(17)
#define MACB_CAPS_GIGABIT_MODE_AVAILABLE        BIT(18)
#define MACB_CAPS_SG_DISABLED                   BIT(19)
#define MACB_CAPS_MACB_IS_GEM                   BIT(20)
#define MACB_CAPS_DMA_64B                       BIT(21)
#define MACB_CAPS_DMA_PTP                       BIT(22)
#define MACB_CAPS_RSC                           BIT(23)
#define MACB_CAPS_NO_LSO                        BIT(24)

/* LSO settings */
#define MACB_LSO_UFO_ENABLE                     0x01
#define MACB_LSO_TSO_ENABLE                     0x02

/* Bit manipulation macros */
#define MACB_BIT(name)                                  \
        (1 << MACB_##name##_OFFSET)
#define MACB_BF(name,value)                             \
        (((value) & ((1 << MACB_##name##_SIZE) - 1))    \
         << MACB_##name##_OFFSET)
#define MACB_BFEXT(name,value)\
        (((value) >> MACB_##name##_OFFSET)              \
         & ((1 << MACB_##name##_SIZE) - 1))
#define MACB_BFINS(name,value,old)                      \
        (((old) & ~(((1 << MACB_##name##_SIZE) - 1)     \
                    << MACB_##name##_OFFSET))           \
         | MACB_BF(name,value))

#define GEM_BIT(name)                                   \
        (1 << GEM_##name##_OFFSET)
#define GEM_BF(name, value)                             \
        (((value) & ((1 << GEM_##name##_SIZE) - 1))     \
         << GEM_##name##_OFFSET)
#define GEM_BFEXT(name, value)\
        (((value) >> GEM_##name##_OFFSET)               \
         & ((1 << GEM_##name##_SIZE) - 1))
#define GEM_BFINS(name, value, old)                     \
        (((old) & ~(((1 << GEM_##name##_SIZE) - 1)      \
                    << GEM_##name##_OFFSET))            \
         | GEM_BF(name, value))

/* Register access macros */
#define macb_readl(port, reg)           (port)->macb_reg_readl((port), MACB_##reg)
#define macb_writel(port, reg, value)   (port)->macb_reg_writel((port), MACB_##reg, (value))
#define gem_readl(port, reg)            (port)->macb_reg_readl((port), GEM_##reg)
#define gem_writel(port, reg, value)    (port)->macb_reg_writel((port), GEM_##reg, (value))
#define queue_readl(queue, reg)         (queue)->bp->macb_reg_readl((queue)->bp, (queue)->reg)
#define queue_writel(queue, reg, value) (queue)->bp->macb_reg_writel((queue)->bp, (queue)->reg, (value))
#define gem_readl_n(port, reg, idx)             (port)->macb_reg_readl((port), GEM_##reg + idx * 4)
#define gem_writel_n(port, reg, idx, value)     (port)->macb_reg_writel((port), GEM_##reg + idx * 4, (value))

/* Conditional GEM/MACB macros.  These perform the operation to the correct
 * register dependent on whether the device is a GEM or a MACB.  For registers
 * and bitfields that are common across both devices, use macb_{read,write}l
 * to avoid the cost of the conditional.
 */
#define macb_or_gem_writel(__bp, __reg, __value) \
        ({ \
                if (macb_is_gem((__bp))) \
                        gem_writel((__bp), __reg, __value); \
                else \
                        macb_writel((__bp), __reg, __value); \
        })

#define macb_or_gem_readl(__bp, __reg) \
        ({ \
                u32 __v; \
                if (macb_is_gem((__bp))) \
                        __v = gem_readl((__bp), __reg); \
                else \
                        __v = macb_readl((__bp), __reg); \
                __v; \
        })

#define MACB_READ_NSR(bp)       macb_readl(bp, NSR)

/* struct macb_dma_desc - Hardware DMA descriptor
 * @addr: DMA address of data buffer
 * @ctrl: Control and status bits
 */
struct macb_dma_desc {
        u32     addr;
        u32     ctrl;
};

struct macb_dma_desc_64 {
        u32 addrh;
        u32 resvd;
};

struct macb_dma_desc_ptp {
        u32     ts_1;
        u32     ts_2;
};

/* DMA descriptor bitfields */
#define MACB_RX_USED_OFFSET                     0
#define MACB_RX_USED_SIZE                       1
#define MACB_RX_WRAP_OFFSET                     1
#define MACB_RX_WRAP_SIZE                       1
#define MACB_RX_WADDR_OFFSET                    2
#define MACB_RX_WADDR_SIZE                      30

#define MACB_RX_FRMLEN_OFFSET                   0
#define MACB_RX_FRMLEN_SIZE                     12
#define MACB_RX_OFFSET_OFFSET                   12
#define MACB_RX_OFFSET_SIZE                     2
#define MACB_RX_SOF_OFFSET                      14
#define MACB_RX_SOF_SIZE                        1
#define MACB_RX_EOF_OFFSET                      15
#define MACB_RX_EOF_SIZE                        1
#define MACB_RX_CFI_OFFSET                      16
#define MACB_RX_CFI_SIZE                        1
#define MACB_RX_VLAN_PRI_OFFSET                 17
#define MACB_RX_VLAN_PRI_SIZE                   3
#define MACB_RX_PRI_TAG_OFFSET                  20
#define MACB_RX_PRI_TAG_SIZE                    1
#define MACB_RX_VLAN_TAG_OFFSET                 21
#define MACB_RX_VLAN_TAG_SIZE                   1
#define MACB_RX_TYPEID_MATCH_OFFSET             22
#define MACB_RX_TYPEID_MATCH_SIZE               1
#define MACB_RX_SA4_MATCH_OFFSET                23
#define MACB_RX_SA4_MATCH_SIZE                  1
#define MACB_RX_SA3_MATCH_OFFSET                24
#define MACB_RX_SA3_MATCH_SIZE                  1
#define MACB_RX_SA2_MATCH_OFFSET                25
#define MACB_RX_SA2_MATCH_SIZE                  1
#define MACB_RX_SA1_MATCH_OFFSET                26
#define MACB_RX_SA1_MATCH_SIZE                  1
#define MACB_RX_EXT_MATCH_OFFSET                28
#define MACB_RX_EXT_MATCH_SIZE                  1
#define MACB_RX_UHASH_MATCH_OFFSET              29
#define MACB_RX_UHASH_MATCH_SIZE                1
#define MACB_RX_MHASH_MATCH_OFFSET              30
#define MACB_RX_MHASH_MATCH_SIZE                1
#define MACB_RX_BROADCAST_OFFSET                31
#define MACB_RX_BROADCAST_SIZE                  1

#define MACB_RX_FRMLEN_MASK                     0xFFF
#define MACB_RX_JFRMLEN_MASK                    0x3FFF

/* RX checksum offload disabled: bit 24 clear in NCFGR */
#define GEM_RX_TYPEID_MATCH_OFFSET              22
#define GEM_RX_TYPEID_MATCH_SIZE                2

/* RX checksum offload enabled: bit 24 set in NCFGR */
#define GEM_RX_CSUM_OFFSET                      22
#define GEM_RX_CSUM_SIZE                        2

#define MACB_TX_FRMLEN_OFFSET                   0
#define MACB_TX_FRMLEN_SIZE                     11
#define MACB_TX_LAST_OFFSET                     15
#define MACB_TX_LAST_SIZE                       1
#define MACB_TX_NOCRC_OFFSET                    16
#define MACB_TX_NOCRC_SIZE                      1
#define MACB_MSS_MFS_OFFSET                     16
#define MACB_MSS_MFS_SIZE                       14
#define MACB_TX_LSO_OFFSET                      17
#define MACB_TX_LSO_SIZE                        2
#define MACB_TX_TCP_SEQ_SRC_OFFSET              19
#define MACB_TX_TCP_SEQ_SRC_SIZE                1
#define MACB_TX_BUF_EXHAUSTED_OFFSET            27
#define MACB_TX_BUF_EXHAUSTED_SIZE              1
#define MACB_TX_UNDERRUN_OFFSET                 28
#define MACB_TX_UNDERRUN_SIZE                   1
#define MACB_TX_ERROR_OFFSET                    29
#define MACB_TX_ERROR_SIZE                      1
#define MACB_TX_WRAP_OFFSET                     30
#define MACB_TX_WRAP_SIZE                       1
#define MACB_TX_USED_OFFSET                     31
#define MACB_TX_USED_SIZE                       1

#define GEM_TX_FRMLEN_OFFSET                    0
#define GEM_TX_FRMLEN_SIZE                      14

/* Buffer descriptor constants */
#define GEM_RX_CSUM_NONE                        0
#define GEM_RX_CSUM_IP_ONLY                     1
#define GEM_RX_CSUM_IP_TCP                      2
#define GEM_RX_CSUM_IP_UDP                      3

/* limit RX checksum offload to TCP and UDP packets */
#define GEM_RX_CSUM_CHECKED_MASK                2

/* Scaled PPM fraction */
#define PPM_FRACTION    16

/* struct macb_tx_skb - data about an skb which is being transmitted
 * @skb: skb currently being transmitted, only set for the last buffer
 *       of the frame
 * @mapping: DMA address of the skb's fragment buffer
 * @size: size of the DMA mapped buffer
 * @mapped_as_page: true when buffer was mapped with skb_frag_dma_map(),
 *                  false when buffer was mapped with dma_map_single()
 */
struct macb_tx_skb {
        struct sk_buff          *skb;
        dma_addr_t              mapping;
        size_t                  size;
        bool                    mapped_as_page;
};

/* Hardware-collected statistics. Used when updating the network
 * device stats by a periodic timer.
 */
struct macb_stats {
        u64     rx_pause_frames;
        u64     tx_ok;
        u64     tx_single_cols;
        u64     tx_multiple_cols;
        u64     rx_ok;
        u64     rx_fcs_errors;
        u64     rx_align_errors;
        u64     tx_deferred;
        u64     tx_late_cols;
        u64     tx_excessive_cols;
        u64     tx_underruns;
        u64     tx_carrier_errors;
        u64     rx_resource_errors;
        u64     rx_overruns;
        u64     rx_symbol_errors;
        u64     rx_oversize_pkts;
        u64     rx_jabbers;
        u64     rx_undersize_pkts;
        u64     sqe_test_errors;
        u64     rx_length_mismatch;
        u64     tx_pause_frames;
};

struct gem_stats {
        u64     tx_octets;
        u64     tx_frames;
        u64     tx_broadcast_frames;
        u64     tx_multicast_frames;
        u64     tx_pause_frames;
        u64     tx_64_byte_frames;
        u64     tx_65_127_byte_frames;
        u64     tx_128_255_byte_frames;
        u64     tx_256_511_byte_frames;
        u64     tx_512_1023_byte_frames;
        u64     tx_1024_1518_byte_frames;
        u64     tx_greater_than_1518_byte_frames;
        u64     tx_underrun;
        u64     tx_single_collision_frames;
        u64     tx_multiple_collision_frames;
        u64     tx_excessive_collisions;
        u64     tx_late_collisions;
        u64     tx_deferred_frames;
        u64     tx_carrier_sense_errors;
        u64     rx_octets;
        u64     rx_frames;
        u64     rx_broadcast_frames;
        u64     rx_multicast_frames;
        u64     rx_pause_frames;
        u64     rx_64_byte_frames;
        u64     rx_65_127_byte_frames;
        u64     rx_128_255_byte_frames;
        u64     rx_256_511_byte_frames;
        u64     rx_512_1023_byte_frames;
        u64     rx_1024_1518_byte_frames;
        u64     rx_greater_than_1518_byte_frames;
        u64     rx_undersized_frames;
        u64     rx_oversize_frames;
        u64     rx_jabbers;
        u64     rx_frame_check_sequence_errors;
        u64     rx_length_field_frame_errors;
        u64     rx_symbol_errors;
        u64     rx_alignment_errors;
        u64     rx_resource_errors;
        u64     rx_overruns;
        u64     rx_ip_header_checksum_errors;
        u64     rx_tcp_checksum_errors;
        u64     rx_udp_checksum_errors;
};

/* Describes the name and offset of an individual statistic register, as
 * returned by `ethtool -S`. Also describes which net_device_stats statistics
 * this register should contribute to.
 */
struct gem_statistic {
        char stat_string[ETH_GSTRING_LEN] __nonstring;
        int offset;
        u32 stat_bits;
};

/* Bitfield defs for net_device_stat statistics */
#define GEM_NDS_RXERR_OFFSET            0
#define GEM_NDS_RXLENERR_OFFSET         1
#define GEM_NDS_RXOVERERR_OFFSET        2
#define GEM_NDS_RXCRCERR_OFFSET         3
#define GEM_NDS_RXFRAMEERR_OFFSET       4
#define GEM_NDS_RXFIFOERR_OFFSET        5
#define GEM_NDS_TXERR_OFFSET            6
#define GEM_NDS_TXABORTEDERR_OFFSET     7
#define GEM_NDS_TXCARRIERERR_OFFSET     8
#define GEM_NDS_TXFIFOERR_OFFSET        9
#define GEM_NDS_COLLISIONS_OFFSET       10

#define GEM_STAT_TITLE(name, title) GEM_STAT_TITLE_BITS(name, title, 0)
#define GEM_STAT_TITLE_BITS(name, title, bits) {        \
        .stat_string = title,                           \
        .offset = GEM_##name,                           \
        .stat_bits = bits                               \
}

/* list of gem statistic registers. The names MUST match the
 * corresponding GEM_* definitions.
 */
static const struct gem_statistic gem_statistics[] = {
        GEM_STAT_TITLE(OCTTXL, "tx_octets"), /* OCTTXH combined with OCTTXL */
        GEM_STAT_TITLE(TXCNT, "tx_frames"),
        GEM_STAT_TITLE(TXBCCNT, "tx_broadcast_frames"),
        GEM_STAT_TITLE(TXMCCNT, "tx_multicast_frames"),
        GEM_STAT_TITLE(TXPAUSECNT, "tx_pause_frames"),
        GEM_STAT_TITLE(TX64CNT, "tx_64_byte_frames"),
        GEM_STAT_TITLE(TX65CNT, "tx_65_127_byte_frames"),
        GEM_STAT_TITLE(TX128CNT, "tx_128_255_byte_frames"),
        GEM_STAT_TITLE(TX256CNT, "tx_256_511_byte_frames"),
        GEM_STAT_TITLE(TX512CNT, "tx_512_1023_byte_frames"),
        GEM_STAT_TITLE(TX1024CNT, "tx_1024_1518_byte_frames"),
        GEM_STAT_TITLE(TX1519CNT, "tx_greater_than_1518_byte_frames"),
        GEM_STAT_TITLE_BITS(TXURUNCNT, "tx_underrun",
                            GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_TXFIFOERR)),
        GEM_STAT_TITLE_BITS(SNGLCOLLCNT, "tx_single_collision_frames",
                            GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
        GEM_STAT_TITLE_BITS(MULTICOLLCNT, "tx_multiple_collision_frames",
                            GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
        GEM_STAT_TITLE_BITS(EXCESSCOLLCNT, "tx_excessive_collisions",
                            GEM_BIT(NDS_TXERR)|
                            GEM_BIT(NDS_TXABORTEDERR)|
                            GEM_BIT(NDS_COLLISIONS)),
        GEM_STAT_TITLE_BITS(LATECOLLCNT, "tx_late_collisions",
                            GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
        GEM_STAT_TITLE(TXDEFERCNT, "tx_deferred_frames"),
        GEM_STAT_TITLE_BITS(TXCSENSECNT, "tx_carrier_sense_errors",
                            GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
        GEM_STAT_TITLE(OCTRXL, "rx_octets"), /* OCTRXH combined with OCTRXL */
        GEM_STAT_TITLE(RXCNT, "rx_frames"),
        GEM_STAT_TITLE(RXBROADCNT, "rx_broadcast_frames"),
        GEM_STAT_TITLE(RXMULTICNT, "rx_multicast_frames"),
        GEM_STAT_TITLE(RXPAUSECNT, "rx_pause_frames"),
        GEM_STAT_TITLE(RX64CNT, "rx_64_byte_frames"),
        GEM_STAT_TITLE(RX65CNT, "rx_65_127_byte_frames"),
        GEM_STAT_TITLE(RX128CNT, "rx_128_255_byte_frames"),
        GEM_STAT_TITLE(RX256CNT, "rx_256_511_byte_frames"),
        GEM_STAT_TITLE(RX512CNT, "rx_512_1023_byte_frames"),
        GEM_STAT_TITLE(RX1024CNT, "rx_1024_1518_byte_frames"),
        GEM_STAT_TITLE(RX1519CNT, "rx_greater_than_1518_byte_frames"),
        GEM_STAT_TITLE_BITS(RXUNDRCNT, "rx_undersized_frames",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXLENERR)),
        GEM_STAT_TITLE_BITS(RXOVRCNT, "rx_oversize_frames",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXLENERR)),
        GEM_STAT_TITLE_BITS(RXJABCNT, "rx_jabbers",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXLENERR)),
        GEM_STAT_TITLE_BITS(RXFCSCNT, "rx_frame_check_sequence_errors",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXCRCERR)),
        GEM_STAT_TITLE_BITS(RXLENGTHCNT, "rx_length_field_frame_errors",
                            GEM_BIT(NDS_RXERR)),
        GEM_STAT_TITLE_BITS(RXSYMBCNT, "rx_symbol_errors",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXFRAMEERR)),
        GEM_STAT_TITLE_BITS(RXALIGNCNT, "rx_alignment_errors",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXOVERERR)),
        GEM_STAT_TITLE_BITS(RXRESERRCNT, "rx_resource_errors",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXOVERERR)),
        GEM_STAT_TITLE_BITS(RXORCNT, "rx_overruns",
                            GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXFIFOERR)),
        GEM_STAT_TITLE_BITS(RXIPCCNT, "rx_ip_header_checksum_errors",
                            GEM_BIT(NDS_RXERR)),
        GEM_STAT_TITLE_BITS(RXTCPCCNT, "rx_tcp_checksum_errors",
                            GEM_BIT(NDS_RXERR)),
        GEM_STAT_TITLE_BITS(RXUDPCCNT, "rx_udp_checksum_errors",
                            GEM_BIT(NDS_RXERR)),
};

#define GEM_STATS_LEN ARRAY_SIZE(gem_statistics)

#define QUEUE_STAT_TITLE(title) {       \
        .stat_string = title,                   \
}

/* per queue statistics, each should be unsigned long type */
struct queue_stats {
        union {
                unsigned long first;
                unsigned long rx_packets;
        };
        unsigned long rx_bytes;
        unsigned long rx_dropped;
        unsigned long tx_packets;
        unsigned long tx_bytes;
        unsigned long tx_dropped;
};

static const struct gem_statistic queue_statistics[] = {
                QUEUE_STAT_TITLE("rx_packets"),
                QUEUE_STAT_TITLE("rx_bytes"),
                QUEUE_STAT_TITLE("rx_dropped"),
                QUEUE_STAT_TITLE("tx_packets"),
                QUEUE_STAT_TITLE("tx_bytes"),
                QUEUE_STAT_TITLE("tx_dropped"),
};

#define QUEUE_STATS_LEN ARRAY_SIZE(queue_statistics)

struct macb;
struct macb_queue;

struct macb_or_gem_ops {
        int     (*mog_alloc_rx_buffers)(struct macb *bp);
        void    (*mog_free_rx_buffers)(struct macb *bp);
        void    (*mog_init_rings)(struct macb *bp);
        int     (*mog_rx)(struct macb_queue *queue, struct napi_struct *napi,
                          int budget);
};

/* MACB-PTP interface: adapt to platform needs. */
struct macb_ptp_info {
        void (*ptp_init)(struct net_device *ndev);
        void (*ptp_remove)(struct net_device *ndev);
        s32 (*get_ptp_max_adj)(void);
        unsigned int (*get_tsu_rate)(struct macb *bp);
        int (*get_ts_info)(struct net_device *dev,
                           struct kernel_ethtool_ts_info *info);
        int (*get_hwtst)(struct net_device *netdev,
                         struct kernel_hwtstamp_config *tstamp_config);
        int (*set_hwtst)(struct net_device *netdev,
                         struct kernel_hwtstamp_config *tstamp_config,
                         struct netlink_ext_ack *extack);
};

struct macb_pm_data {
        u32 scrt2;
        u32 usrio;
};

struct macb_usrio_config {
        u32 mii;
        u32 rmii;
        u32 rgmii;
        u32 refclk;
        u32 hdfctlen;
};

struct macb_config {
        u32                     caps;
        unsigned int            dma_burst_length;
        int     (*clk_init)(struct platform_device *pdev, struct clk **pclk,
                            struct clk **hclk, struct clk **tx_clk,
                            struct clk **rx_clk, struct clk **tsu_clk);
        int     (*init)(struct platform_device *pdev);
        unsigned int            max_tx_length;
        int     jumbo_max_len;
        const struct macb_usrio_config *usrio;
};

struct tsu_incr {
        u32 sub_ns;
        u32 ns;
};

struct macb_queue {
        struct macb             *bp;
        int                     irq;

        unsigned int            ISR;
        unsigned int            IER;
        unsigned int            IDR;
        unsigned int            IMR;
        unsigned int            TBQP;
        unsigned int            RBQS;
        unsigned int            RBQP;

        /* ENST register offsets for this queue */
        unsigned int            ENST_START_TIME;
        unsigned int            ENST_ON_TIME;
        unsigned int            ENST_OFF_TIME;

        /* Lock to protect tx_head and tx_tail */
        spinlock_t              tx_ptr_lock;
        unsigned int            tx_head, tx_tail;
        struct macb_dma_desc    *tx_ring;
        struct macb_tx_skb      *tx_skb;
        dma_addr_t              tx_ring_dma;
        struct work_struct      tx_error_task;
        bool                    txubr_pending;
        struct napi_struct      napi_tx;

        dma_addr_t              rx_ring_dma;
        dma_addr_t              rx_buffers_dma;
        unsigned int            rx_tail;
        unsigned int            rx_prepared_head;
        struct macb_dma_desc    *rx_ring;
        struct sk_buff          **rx_skbuff;
        void                    *rx_buffers;
        struct napi_struct      napi_rx;
        struct queue_stats stats;
};

struct ethtool_rx_fs_item {
        struct ethtool_rx_flow_spec fs;
        struct list_head list;
};

struct ethtool_rx_fs_list {
        struct list_head list;
        unsigned int count;
};

struct macb {
        void __iomem            *regs;
        bool                    native_io;

        /* hardware IO accessors */
        u32     (*macb_reg_readl)(struct macb *bp, int offset);
        void    (*macb_reg_writel)(struct macb *bp, int offset, u32 value);

        struct macb_dma_desc    *rx_ring_tieoff;
        dma_addr_t              rx_ring_tieoff_dma;
        size_t                  rx_buffer_size;

        unsigned int            rx_ring_size;
        unsigned int            tx_ring_size;

        unsigned int            num_queues;
        struct macb_queue       queues[MACB_MAX_QUEUES];

        spinlock_t              lock;
        struct platform_device  *pdev;
        struct clk              *pclk;
        struct clk              *hclk;
        struct clk              *tx_clk;
        struct clk              *rx_clk;
        struct clk              *tsu_clk;
        struct net_device       *dev;
        /* Protects hw_stats and ethtool_stats */
        spinlock_t              stats_lock;
        union {
                struct macb_stats       macb;
                struct gem_stats        gem;
        }                       hw_stats;

        struct macb_or_gem_ops  macbgem_ops;

        struct mii_bus          *mii_bus;
        struct phylink          *phylink;
        struct phylink_config   phylink_config;
        struct phylink_pcs      phylink_usx_pcs;
        struct phylink_pcs      phylink_sgmii_pcs;

        u32                     caps;
        unsigned int            dma_burst_length;

        phy_interface_t         phy_interface;

        /* AT91RM9200 transmit queue (1 on wire + 1 queued) */
        struct macb_tx_skb      rm9200_txq[2];
        unsigned int            max_tx_length;

        u64                     ethtool_stats[GEM_STATS_LEN + QUEUE_STATS_LEN * MACB_MAX_QUEUES];

        unsigned int            rx_frm_len_mask;
        unsigned int            jumbo_max_len;

        u32                     wol;
        u32                     wolopts;

        /* holds value of rx watermark value for pbuf_rxcutthru register */
        u32                     rx_watermark;

        struct macb_ptp_info    *ptp_info;      /* macb-ptp interface */

        struct phy              *phy;

        spinlock_t tsu_clk_lock; /* gem tsu clock locking */
        unsigned int tsu_rate;
        struct ptp_clock *ptp_clock;
        struct ptp_clock_info ptp_clock_info;
        struct tsu_incr tsu_incr;
        struct kernel_hwtstamp_config tstamp_config;

        /* RX queue filer rule set*/
        struct ethtool_rx_fs_list rx_fs_list;
        spinlock_t rx_fs_lock;
        unsigned int max_tuples;

        struct work_struct      hresp_err_bh_work;

        int     rx_bd_rd_prefetch;
        int     tx_bd_rd_prefetch;

        u32     rx_intr_mask;

        struct macb_pm_data pm_data;
        const struct macb_usrio_config *usrio;
};

#ifdef CONFIG_MACB_USE_HWSTAMP
#define GEM_TSEC_SIZE  (GEM_TSH_SIZE + GEM_TSL_SIZE)
#define TSU_SEC_MAX_VAL (((u64)1 << GEM_TSEC_SIZE) - 1)
#define TSU_NSEC_MAX_VAL ((1 << GEM_TN_SIZE) - 1)

enum macb_bd_control {
        TSTAMP_DISABLED,
        TSTAMP_FRAME_PTP_EVENT_ONLY,
        TSTAMP_ALL_PTP_FRAMES,
        TSTAMP_ALL_FRAMES,
};

void gem_ptp_init(struct net_device *ndev);
void gem_ptp_remove(struct net_device *ndev);
void gem_ptp_txstamp(struct macb *bp, struct sk_buff *skb, struct macb_dma_desc *desc);
void gem_ptp_rxstamp(struct macb *bp, struct sk_buff *skb, struct macb_dma_desc *desc);
static inline void gem_ptp_do_txstamp(struct macb *bp, struct sk_buff *skb, struct macb_dma_desc *desc)
{
        if (bp->tstamp_config.tx_type == TSTAMP_DISABLED)
                return;

        gem_ptp_txstamp(bp, skb, desc);
}

static inline void gem_ptp_do_rxstamp(struct macb *bp, struct sk_buff *skb, struct macb_dma_desc *desc)
{
        if (bp->tstamp_config.rx_filter == TSTAMP_DISABLED)
                return;

        gem_ptp_rxstamp(bp, skb, desc);
}

int gem_get_hwtst(struct net_device *dev,
                  struct kernel_hwtstamp_config *tstamp_config);
int gem_set_hwtst(struct net_device *dev,
                  struct kernel_hwtstamp_config *tstamp_config,
                  struct netlink_ext_ack *extack);
#else
static inline void gem_ptp_init(struct net_device *ndev) { }
static inline void gem_ptp_remove(struct net_device *ndev) { }

static inline void gem_ptp_do_txstamp(struct macb *bp, struct sk_buff *skb, struct macb_dma_desc *desc) { }
static inline void gem_ptp_do_rxstamp(struct macb *bp, struct sk_buff *skb, struct macb_dma_desc *desc) { }
#endif

static inline bool macb_is_gem(struct macb *bp)
{
        return !!(bp->caps & MACB_CAPS_MACB_IS_GEM);
}

static inline bool gem_has_ptp(struct macb *bp)
{
        return IS_ENABLED(CONFIG_MACB_USE_HWSTAMP) && (bp->caps & MACB_CAPS_GEM_HAS_PTP);
}

/* ENST Helper functions */
static inline u64 enst_ns_to_hw_units(size_t ns, u32 speed_mbps)
{
        return DIV_ROUND_UP((ns) * (speed_mbps),
                            (ENST_TIME_GRANULARITY_NS * 1000));
}

static inline u64 enst_max_hw_interval(u32 speed_mbps)
{
        return DIV_ROUND_UP(GENMASK(GEM_ON_TIME_SIZE - 1, 0) *
                            ENST_TIME_GRANULARITY_NS * 1000, (speed_mbps));
}

static inline bool macb_dma64(struct macb *bp)
{
        return IS_ENABLED(CONFIG_ARCH_DMA_ADDR_T_64BIT) &&
               bp->caps & MACB_CAPS_DMA_64B;
}

static inline bool macb_dma_ptp(struct macb *bp)
{
        return IS_ENABLED(CONFIG_MACB_USE_HWSTAMP) &&
               bp->caps & MACB_CAPS_DMA_PTP;
}

/**
 * struct macb_platform_data - platform data for MACB Ethernet used for PCI registration
 * @pclk:               platform clock
 * @hclk:               AHB clock
 */
struct macb_platform_data {
        struct clk      *pclk;
        struct clk      *hclk;
};

/**
 * struct macb_queue_enst_config - Configuration for Enhanced Scheduled Traffic
 * @start_time_mask:  Bitmask representing the start time for the queue
 * @on_time_bytes:    "on" time nsec expressed in bytes
 * @off_time_bytes:   "off" time nsec expressed in bytes
 * @queue_id:         Identifier for the queue
 *
 * This structure holds the configuration parameters for an ENST queue,
 * used to control time-based transmission scheduling in the MACB driver.
 */
struct macb_queue_enst_config {
        u32 start_time_mask;
        u32 on_time_bytes;
        u32 off_time_bytes;
        u8 queue_id;
};

#endif /* _MACB_H */