/*      $NetBSD: cemacreg.h,v 1.8 2024/11/29 17:37:58 skrll Exp $       */

/*-
 * Copyright (c) 2015  Genetec Corporation.  All rights reserved.
 * Written by Hashimoto Kenichi for Genetec Corporation.
 *
 * Copyright (c) 2007 Embedtronics Oy
 * All rights reserved
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 */

#ifndef _IF_CEMACREG_H_
#define _IF_CEMACREG_H_

/* Ethernet MAC (EMAC),
 * at91rm9200.pdf, page 573 */

#define ETH_CTL         0x00U   /* Control Register                     */
#define ETH_CFG         0x04U   /* Configuration Register               */
#define ETH_SR          0x08U   /* Status Register                      */
#define ETH_TAR         0x0CU   /* Transmit Address Register (at91rm9200 only)  */
#define ETH_TCR         0x10U   /* Transmit Control Register (at91rm9200 only)  */
#define ETH_TSR         0x14U   /* Transmit Status Register             */
#define ETH_RBQP        0x18U   /* Receive Buffer Queue Pointer         */
#define ETH_TBQP        0x1CU   /* Transmit Buffer Queue Pointer        */
#define ETH_RSR         0x20U   /* Receive Status Register              */
#define ETH_ISR         0x24U   /* Interrupt Status Register            */
#define ETH_IER         0x28U   /* Interrupt Enable Register            */
#define ETH_IDR         0x2CU   /* Interrupt Disable Register           */
#define ETH_IMR         0x30U   /* Interrupt Mask Register              */
#define ETH_MAN         0x34U   /* PHY Maintenance Register             */

#define ETH_FRA         0x40U   /* Frames Transmitted OK                */
#define ETH_SCOL        0x44U   /* Single Collision Frames              */
#define ETH_MCOL        0x48U   /* Multiple Collision Frames            */
#define ETH_OK          0x4CU   /* Frames Received OK                   */
#define ETH_SEQE        0x50U   /* Frame Check Sequence Errors          */
#define ETH_ALE         0x54U   /* Alignment Errors                     */
#define ETH_DTE         0x58U   /* Deferred Transmission Frame          */
#define ETH_LCOL        0x5CU   /* Late Collisions                      */
#define ETH_ECOL        0x60U   /* Excessive Collisions                 */
#define ETH_CSE         0x64U   /* Carrier Sense Errors                 */
#define ETH_TUE         0x68U   /* Transmit Underrun Errors             */
#define ETH_CDE         0x6CU   /* Code Errors                          */
#define ETH_ELR         0x70U   /* Excessive Length Errors              */
#define ETH_RJB         0x74U   /* Receive Jabbers                      */
#define ETH_USF         0x78U   /* Undersize Frames                     */
#define ETH_SQEE        0x7CU   /* SQE Test Errors                      */
#define ETH_DRFC        0x80U   /* Discarded RX Frames                  */

#define ETH_HSH         0x90U   /* Hash Address High                    */
#define ETH_HSL         0x94U   /* Hash Address Low                     */

#define ETH_SA1L        0x98U   /* Specific Address 1 Low               */
#define ETH_SA1H        0x9CU   /* Specific Address 1 High              */

#define ETH_SA2L        0xA0U   /* Specific Address 2 Low               */
#define ETH_SA2H        0xA4U   /* Specific Address 2 High              */

#define ETH_SA3L        0xA8U   /* Specific Address 3 Low               */
#define ETH_SA3H        0xACU   /* Specific Address 3 High              */

#define ETH_SA4L        0xB0U   /* Specific Address 4 Low               */
#define ETH_SA4H        0xB4U   /* Specific Address 4 High              */

/*
 * Gigabit Ethernet Controller (GEM)
 * ug585-Zynq-7000-TRM.pdf
 */

#define GEM_USER_IO     0x000C
#define GEM_DMA_CFG     0x0010  /* DMA Configuration */
#define  GEM_DMA_CFG_DISC_WHEN_NO_AHB           __BIT(24)
#define  GEM_DMA_CFG_RX_BUF_SIZE                __BITS(23, 16)
#define  GEM_DMA_CFG_CHKSUM_GEN_OFFLOAD_EN      __BIT(11)
#define  GEM_DMA_CFG_TX_PKTBUF_MEMSZ_SEL        __BIT(10)
#define  GEM_DMA_CFG_RX_PKTBUF_MEMSZ_SEL        __BITS(9, 8)
#define  GEM_DMA_CFG_AHB_ENDIAN_SWAP_PKT_EN     __BIT(7)
#define  GEM_DMA_CFG_AHB_ENDIAN_SWAP_MGMT_EN    __BIT(6)
#define  GEM_DMA_CFG_AHB_FIXED_BURST_LEN        __BITS(4, 0)
#define GEM_HSH         0x0080
#define GEM_HSL         0x0084
#define GEM_SA1L        0x0088
#define GEM_SA1H        0x008C
#define GEM_SA2L        0x0090
#define GEM_SA2H        0x0094
#define GEM_SA3L        0x0098
#define GEM_SA3H        0x009C
#define GEM_SA4L        0x0090
#define GEM_SA4H        0x0094
#define GEM_SCOL        0x0138
#define GEM_MCOL        0x013C
#define GEM_DCFG2       0x0284
#define GEM_DCFG3       0x0288
#define GEM_DCFG4       0x028C
#define GEM_DCFG5       0x0290

#define ETH_SIZE        0x1000

/* Control Register bits: */
#define GEM_CTL_ZEROPAUSETX     __BIT(12)
#define GEM_CTL_PAUSETX         __BIT(11)
#define GEM_CTL_HALTTX          __BIT(10)
#define GEM_CTL_STARTTX         __BIT(9)

#define ETH_CTL_BP      __BIT(8)  /* 1 = back pressure enabled                */
#define ETH_CTL_WES     __BIT(7)  /* 1 = statistics registers writeable       */
#define ETH_CTL_ISR     __BIT(6)  /* 1 = increment statistics registers       */
#define ETH_CTL_CSR     __BIT(5)  /* 1 = clear statistics registers           */
#define ETH_CTL_MPE     __BIT(4)  /* 1 = management port enabled              */
#define ETH_CTL_TE      __BIT(3)  /* 1 = transmit enable                      */
#define ETH_CTL_RE      __BIT(2)  /* 1 = receive enable                       */
#define ETH_CTL_LBL     __BIT(1)  /* 1 = local loopback enabled               */
#define ETH_CTL_LB      __BIT(0)  /* 1 = loopback signal is at high level     */


/* Configuration Register bits: */
#define ETH_CFG_RMII    __BIT(13)  /* 1 = enable RMII (Reduce MII) (AT91RM9200 only) */
#define ETH_CFG_RTY     __BIT(12)  /* 1 = retry test enabled            */
#define ETH_CFG_CLK     __BITS(11, 10)  /* clock                                */
#define  ETH_CFG_CLK_8  __SHIFTIN(0, ETH_CFG_CLK)
#define  ETH_CFG_CLK_16 __SHIFTIN(1, ETH_CFG_CLK)
#define  ETH_CFG_CLK_32 __SHIFTIN(2, ETH_CFG_CLK)
#define  ETH_CFG_CLK_64 __SHIFTIN(3, ETH_CFG_CLK)
#define ETH_CFG_EAE     __BIT(9)  /* 1 = external address match enable  */
#define ETH_CFG_BIG     __BIT(8)  /* 1 = receive up to 1522 bytes       (VLAN)  */
#define ETH_CFG_UNI     __BIT(7)  /* 1 = enable unicast hash            */
#define ETH_CFG_MTI     __BIT(6)  /* 1 = enable multicast hash          */
#define ETH_CFG_NBC     __BIT(5)  /* 1 = ignore received broadcasts     */
#define ETH_CFG_CAF     __BIT(4)  /* 1 = receive all valid frames               */
#define ETH_CFG_BR      __BIT(2)
#define ETH_CFG_FD      __BIT(1)  /* 1 = force full duplex              */
#define ETH_CFG_SPD     __BIT(0)  /* 1 = 100 Mbps                               */

#define GEM_CFG_GEN     __BIT(10)
#define GEM_CFG_CLK     __BITS(20, 18)
#define  GEM_CFG_CLK_8          __SHIFTIN(0, GEM_CFG_CLK)
#define  GEM_CFG_CLK_16         __SHIFTIN(1, GEM_CFG_CLK)
#define  GEM_CFG_CLK_32         __SHIFTIN(2, GEM_CFG_CLK)
#define  GEM_CFG_CLK_48         __SHIFTIN(3, GEM_CFG_CLK)
#define  GEM_CFG_CLK_64         __SHIFTIN(4, GEM_CFG_CLK)
#define  GEM_CFG_CLK_96         __SHIFTIN(5, GEM_CFG_CLK)
#define  GEM_CFG_CLK_128        __SHIFTIN(6, GEM_CFG_CLK)
#define  GEM_CFG_CLK_224        __SHIFTIN(7, GEM_CFG_CLK)
#define GEM_CFG_DBW     __BITS(22, 21)
#define  GEM_CFG_DBW_32         __SHIFTIN(0, GEM_CFG_DBW)
#define  GEM_CFG_DBW_64         __SHIFTIN(1, GEM_CFG_DBW)
#define  GEM_CFG_DBW_128        __SHIFTIN(2, GEM_CFG_DBW)
#define GEM_CFG_RXCOEN  __BIT(24)

/* Status Register bits: */
#define ETH_SR_IDLE     __BIT(2)        /* 1 = PHY logic is running             */
#define ETH_SR_MDIO     __BIT(1)        /* 1 = MDIO pin set                     */
#define ETH_SR_LINK     __BIT(0)


/* Transmit Control Register bits: */
#define ETH_TCR_NCRC    0x8000U /* 1 = don't append CRC                 */
#define ETH_TCR_LEN     0x07FFU /* transmit frame length                */


/* Transmit Status Register bits: */
#define ETH_TSR_UND     __BIT(6)  /* 1 = transmit underrun detected     */
#define ETH_TSR_COMP    __BIT(5)  /* 1 = transmit complete              */
#define ETH_TSR_BNQ     __BIT(4)  /* 1 = transmit buffer not queued (at91rm9200 only)   */
#define ETH_TSR_IDLE    __BIT(3)  /* 1 = transmitter idle                       */
#define ETH_TSR_RLE     __BIT(2)  /* 1 = retry limit exceeded           */
#define ETH_TSR_COL     __BIT(1)  /* 1 = collision occurred             */
#define ETH_TSR_OVR     __BIT(0)  /* 1 = transmit buffer overrun                */

#define GEM_TSR_TXGO    __BIT(3)

/* Receive Status Register bits: */
#define ETH_RSR_OVR     __BIT(2)  /* 1 = RX overrun                     */
#define ETH_RSR_REC     __BIT(1)  /* 1 = frame received                 */
#define ETH_RSR_BNA     __BIT(0)  /* 1 = buffer not available           */


/* Interrupt bits: */
#define ETH_ISR_ABT     __BIT(11) /* 1 = abort during DMA transfer      */
#define ETH_ISR_ROVR    __BIT(10) /* 1 = RX overrun                     */
#define ETH_ISR_LINK    __BIT(9)  /* 1 = link pin changed                       */
#define ETH_ISR_TIDLE   __BIT(8)  /* 1 = transmitter idle                       */
#define ETH_ISR_TCOM    __BIT(7)  /* 1 = transmit complete              */
#define ETH_ISR_TBRE    __BIT(6)  /* 1 = transmit buffer register empty */
#define ETH_ISR_RTRY    __BIT(5)  /* 1 = retry limit exceeded           */
#define ETH_ISR_TUND    __BIT(4)  /* 1 = transmit buffer underrun               */
#define ETH_ISR_TOVR    __BIT(3)  /* 1 = transmit buffer overrun                */
#define ETH_ISR_RBNA    __BIT(2)  /* 1 = receive buffer not available   */
#define ETH_ISR_RCOM    __BIT(1)  /* 1 = receive complete                       */
#define ETH_ISR_DONE    __BIT(0)  /* 1 = management done                        */


/* PHY Maintenance Register bits: */
#define ETH_MAN_LOW     __BIT(31) /* must not be set                    */
#define ETH_MAN_HIGH    __BIT(30) /* must be set for clause 22          */

#define ETH_MAN_RW      __BITS(29, 28)
#define ETH_MAN_RW_RD   __SHIFTIN(2, ETH_MAN_RW)
#define ETH_MAN_RW_WR   __SHIFTIN(1, ETH_MAN_RW)

#define ETH_MAN_PHYA    __BITS(27, 23) /* PHY address (normally 0)      */
#define ETH_MAN_PHYA_SHIFT 23U
#define ETH_MAN_REGA    __BITS(22, 18)
#define ETH_MAN_REGA_SHIFT 18U
#define ETH_MAN_CODE    __BITS(17, 16) /* must be 0b10                  */
#define ETH_MAN_CODE_IEEE802_3 \
                        __SHIFTIN(2, ETH_MAN_CODE)
#define ETH_MAN_DATA    __BITS(15, 0) /* data to be written to the PHY  */
#define ETH_MAN_VAL     (ETH_MAN_HIGH | ETH_MAN_CODE_IEEE802_3)


/* received buffer descriptor: */
#define ETH_DSC_ADDR            0x00U
#define ETH_DSC_FLAGS           0x00U
#define ETH_DSC_INFO            0x04U
#define ETH_DSC_SIZE            0x08U

typedef struct eth_dsc {
        volatile uint32_t       Addr;
        volatile uint32_t       Info;
} __attribute__ ((aligned(4))) eth_dsc_t;

/* flags: */
#define ETH_RDSC_F_WRAP         __BIT(1)
#define ETH_RDSC_F_USED         __BIT(0)

/* frame info bits: */
#define ETH_RDSC_I_BCAST        __BIT(31)
#define ETH_RDSC_I_MULTICAST    __BIT(30)
#define ETH_RDSC_I_UNICAST      __BIT(29)
#define ETH_RDSC_I_VLAN         __BIT(28)
#define ETH_RDSC_I_UNKNOWN_SRC  __BIT(27)
#define ETH_RDSC_I_MATCH1       __BIT(26)
#define ETH_RDSC_I_MATCH2       __BIT(25)
#define ETH_RDSC_I_MATCH3       __BIT(24)
#define ETH_RDSC_I_MATCH4       __BIT(23)
#define ETH_RDSC_I_CHKSUM       __BITS(23, 22)
#define  ETH_RDSC_I_CHKSUM_NONE __SHIFTIN(0, ETH_RDSC_I_CHKSUM)
#define  ETH_RDSC_I_CHKSUM_IP   __SHIFTIN(1, ETH_RDSC_I_CHKSUM)
#define  ETH_RDSC_I_CHKSUM_TCP  __SHIFTIN(2, ETH_RDSC_I_CHKSUM)
#define  ETH_RDSC_I_CHKSUM_UDP  __SHIFTIN(3, ETH_RDSC_I_CHKSUM)
#define ETH_RDSC_I_LEN          __BITS(13, 0)

#define ETH_TDSC_I_USED                         __BIT(31)       /* done transmitting */
#define ETH_TDSC_I_WRAP                         __BIT(30)       /* end of descr ring */
#define ETH_TDSC_I_RETRY_ERR                    __BIT(29)
#define ETH_TDSC_I_AHB_ERR                      __BIT(27)
#define ETH_TDSC_I_LATE_COLL                    __BIT(26)
#define ETH_TDSC_I_CHKSUM                       __BITS(22, 20)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_NO_ERR      __SHIFTIN(0, ETH_TDSC_I_CHKSUM)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_VLAN_HDR_ERR        __SHIFTIN(1, ETH_TDSC_I_CHKSUM)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_SNAP_HDR_ERR        __SHIFTIN(2, ETH_TDSC_I_CHKSUM)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_IP_HDR_ERR  __SHIFTIN(3, ETH_TDSC_I_CHKSUM)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_UNKNOWN_TYPE        __SHIFTIN(4, ETH_TDSC_I_CHKSUM)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_UNSUPP_FRAG __SHIFTIN(5, ETH_TDSC_I_CHKSUM)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_NOT_TCPUDP  __SHIFTIN(6, ETH_TDSC_I_CHKSUM)
#define  ETH_TDSC_I_CHKSUM_GEN_STAT_SHORT_PKT   __SHIFTIN(7, ETH_TDSC_I_CHKSUM)
#define ETH_TDSC_I_NO_CRC_APPENDED              __BIT(16)
#define ETH_TDSC_I_LAST_BUF                     __BIT(15)       /* last buf in frame */
#define ETH_TDSC_I_LEN                          __BITS(13, 0)

#endif /* !_IF_CEMACREG_H_ */