Linux Kernel: drivers/net/ethernet/ibm/emac/emac.h Source File

Go to the documentation of this file.
 /*
  * drivers/net/ethernet/ibm/emac/emac.h
  *
  * Register definitions for PowerPC 4xx on-chip ethernet contoller
  *
  * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
  *                <[email protected]>
  *
  * Based on the arch/ppc version of the driver:
  *
  * Copyright (c) 2004, 2005 Zultys Technologies.
  * Eugene Surovegin <[email protected]> or <[email protected]>
  *
  * Based on original work by
  *      Matt Porter <[email protected]>
  *      Armin Kuster <[email protected]>
  *  Copyright 2002-2004 MontaVista Software Inc.
  *
  * This program is free software; you can redistribute  it and/or modify it
  * under  the terms of  the GNU General  Public License as published by the
  * Free Software Foundation;  either version 2 of the  License, or (at your
  * option) any later version.
  *
  */
 #ifndef __IBM_NEWEMAC_H
 #define __IBM_NEWEMAC_H
 
 #include <linux/types.h>
 #include <linux/phy.h>
 
 /* EMAC registers           Write Access rules */
 struct emac_regs {
     /* Common registers across all EMAC implementations. */
     u32 mr0;            /* Special  */
     u32 mr1;            /* Reset    */
     u32 tmr0;           /* Special  */
     u32 tmr1;           /* Special  */
     u32 rmr;            /* Reset    */
     u32 isr;            /* Always   */
     u32 iser;           /* Reset    */
     u32 iahr;           /* Reset, R, T  */
     u32 ialr;           /* Reset, R, T  */
     u32 vtpid;          /* Reset, R, T  */
     u32 vtci;           /* Reset, R, T  */
     u32 ptr;            /* Reset,    T  */
     union {
         /* Registers unique to EMAC4 implementations */
         struct {
             u32 iaht1;  /* Reset, R */
             u32 iaht2;  /* Reset, R */
             u32 iaht3;  /* Reset, R */
             u32 iaht4;  /* Reset, R */
             u32 gaht1;  /* Reset, R */
             u32 gaht2;  /* Reset, R */
             u32 gaht3;  /* Reset, R */
             u32 gaht4;  /* Reset, R */
         } emac4;
         /* Registers unique to EMAC4SYNC implementations */
         struct {
             u32 mahr;   /* Reset, R, T  */
             u32 malr;   /* Reset, R, T  */
             u32 mmahr;  /* Reset, R, T  */
             u32 mmalr;  /* Reset, R, T  */
             u32 rsvd0[4];
         } emac4sync;
     } u0;
     /* Common registers across all EMAC implementations. */
     u32 lsah;
     u32 lsal;
     u32 ipgvr;          /* Reset,    T  */
     u32 stacr;          /* Special  */
     u32 trtr;           /* Special  */
     u32 rwmr;           /* Reset    */
     u32 octx;
     u32 ocrx;
     union {
         /* Registers unique to EMAC4 implementations */
         struct {
             u32 ipcr;
         } emac4;
         /* Registers unique to EMAC4SYNC implementations */
         struct {
             u32 rsvd1;
             u32 revid;
             u32 rsvd2[2];
             u32 iaht1;  /* Reset, R     */
             u32 iaht2;  /* Reset, R     */
             u32 iaht3;  /* Reset, R     */
             u32 iaht4;  /* Reset, R     */
             u32 iaht5;  /* Reset, R     */
             u32 iaht6;  /* Reset, R     */
             u32 iaht7;  /* Reset, R     */
             u32 iaht8;  /* Reset, R     */
             u32 gaht1;  /* Reset, R     */
             u32 gaht2;  /* Reset, R     */
             u32 gaht3;  /* Reset, R     */
             u32 gaht4;  /* Reset, R     */
             u32 gaht5;  /* Reset, R     */
             u32 gaht6;  /* Reset, R     */
             u32 gaht7;  /* Reset, R     */
             u32 gaht8;  /* Reset, R     */
             u32 tpc;    /* Reset, T     */
         } emac4sync;
     } u1;
 };
 
 /*
  * PHY mode settings (EMAC <-> ZMII/RGMII bridge <-> PHY)
  */
 #define PHY_MODE_NA PHY_INTERFACE_MODE_NA
 #define PHY_MODE_MII    PHY_INTERFACE_MODE_MII
 #define PHY_MODE_RMII   PHY_INTERFACE_MODE_RMII
 #define PHY_MODE_SMII   PHY_INTERFACE_MODE_SMII
 #define PHY_MODE_RGMII  PHY_INTERFACE_MODE_RGMII
 #define PHY_MODE_TBI    PHY_INTERFACE_MODE_TBI
 #define PHY_MODE_GMII   PHY_INTERFACE_MODE_GMII
 #define PHY_MODE_RTBI   PHY_INTERFACE_MODE_RTBI
 #define PHY_MODE_SGMII  PHY_INTERFACE_MODE_SGMII
 
 /* EMACx_MR0 */
 #define EMAC_MR0_RXI            0x80000000
 #define EMAC_MR0_TXI            0x40000000
 #define EMAC_MR0_SRST           0x20000000
 #define EMAC_MR0_TXE            0x10000000
 #define EMAC_MR0_RXE            0x08000000
 #define EMAC_MR0_WKE            0x04000000
 
 /* EMACx_MR1 */
 #define EMAC_MR1_FDE            0x80000000
 #define EMAC_MR1_ILE            0x40000000
 #define EMAC_MR1_VLE            0x20000000
 #define EMAC_MR1_EIFC           0x10000000
 #define EMAC_MR1_APP            0x08000000
 #define EMAC_MR1_IST            0x01000000
 
 #define EMAC_MR1_MF_MASK        0x00c00000
 #define EMAC_MR1_MF_10          0x00000000
 #define EMAC_MR1_MF_100         0x00400000
 #define EMAC_MR1_MF_1000        0x00800000
 #define EMAC_MR1_MF_1000GPCS        0x00c00000
 #define EMAC_MR1_MF_IPPA(id)        (((id) & 0x1f) << 6)
 
 #define EMAC_MR1_RFS_4K         0x00300000
 #define EMAC_MR1_RFS_16K        0x00000000
 #define EMAC_MR1_TFS_2K         0x00080000
 #define EMAC_MR1_TR0_MULT       0x00008000
 #define EMAC_MR1_JPSM           0x00000000
 #define EMAC_MR1_MWSW_001       0x00000000
 #define EMAC_MR1_BASE(opb)      (EMAC_MR1_TFS_2K | EMAC_MR1_TR0_MULT)
 
 
 #define EMAC4_MR1_RFS_2K        0x00100000
 #define EMAC4_MR1_RFS_4K        0x00180000
 #define EMAC4_MR1_RFS_16K       0x00280000
 #define EMAC4_MR1_TFS_2K            0x00020000
 #define EMAC4_MR1_TFS_4K        0x00030000
 #define EMAC4_MR1_TFS_16K       0x00050000
 #define EMAC4_MR1_TR            0x00008000
 #define EMAC4_MR1_MWSW_001      0x00001000
 #define EMAC4_MR1_JPSM          0x00000800
 #define EMAC4_MR1_OBCI_MASK     0x00000038
 #define EMAC4_MR1_OBCI_50       0x00000000
 #define EMAC4_MR1_OBCI_66       0x00000008
 #define EMAC4_MR1_OBCI_83       0x00000010
 #define EMAC4_MR1_OBCI_100      0x00000018
 #define EMAC4_MR1_OBCI_100P     0x00000020
 #define EMAC4_MR1_OBCI(freq)        ((freq) <= 50  ? EMAC4_MR1_OBCI_50 : \
                      (freq) <= 66  ? EMAC4_MR1_OBCI_66 : \
                      (freq) <= 83  ? EMAC4_MR1_OBCI_83 : \
                      (freq) <= 100 ? EMAC4_MR1_OBCI_100 : \
                         EMAC4_MR1_OBCI_100P)
 
 /* EMACx_TMR0 */
 #define EMAC_TMR0_GNP           0x80000000
 #define EMAC_TMR0_DEFAULT       0x00000000
 #define EMAC4_TMR0_TFAE_2_32        0x00000001
 #define EMAC4_TMR0_TFAE_4_64        0x00000002
 #define EMAC4_TMR0_TFAE_8_128       0x00000003
 #define EMAC4_TMR0_TFAE_16_256      0x00000004
 #define EMAC4_TMR0_TFAE_32_512      0x00000005
 #define EMAC4_TMR0_TFAE_64_1024     0x00000006
 #define EMAC4_TMR0_TFAE_128_2048    0x00000007
 #define EMAC4_TMR0_DEFAULT      EMAC4_TMR0_TFAE_2_32
 #define EMAC_TMR0_XMIT          (EMAC_TMR0_GNP | EMAC_TMR0_DEFAULT)
 #define EMAC4_TMR0_XMIT         (EMAC_TMR0_GNP | EMAC4_TMR0_DEFAULT)
 
 /* EMACx_TMR1 */
 
 #define EMAC_TMR1(l,h)          (((l) << 27) | (((h) & 0xff) << 16))
 #define EMAC4_TMR1(l,h)         (((l) << 27) | (((h) & 0x3ff) << 14))
 
 /* EMACx_RMR */
 #define EMAC_RMR_SP         0x80000000
 #define EMAC_RMR_SFCS           0x40000000
 #define EMAC_RMR_RRP            0x20000000
 #define EMAC_RMR_RFP            0x10000000
 #define EMAC_RMR_ROP            0x08000000
 #define EMAC_RMR_RPIR           0x04000000
 #define EMAC_RMR_PPP            0x02000000
 #define EMAC_RMR_PME            0x01000000
 #define EMAC_RMR_PMME           0x00800000
 #define EMAC_RMR_IAE            0x00400000
 #define EMAC_RMR_MIAE           0x00200000
 #define EMAC_RMR_BAE            0x00100000
 #define EMAC_RMR_MAE            0x00080000
 #define EMAC_RMR_BASE           0x00000000
 #define EMAC4_RMR_RFAF_2_32     0x00000001
 #define EMAC4_RMR_RFAF_4_64     0x00000002
 #define EMAC4_RMR_RFAF_8_128        0x00000003
 #define EMAC4_RMR_RFAF_16_256       0x00000004
 #define EMAC4_RMR_RFAF_32_512       0x00000005
 #define EMAC4_RMR_RFAF_64_1024      0x00000006
 #define EMAC4_RMR_RFAF_128_2048     0x00000007
 #define EMAC4_RMR_BASE          EMAC4_RMR_RFAF_128_2048
 #define EMAC4_RMR_MJS_MASK              0x0001fff8
 #define EMAC4_RMR_MJS(s)                (((s) << 3) & EMAC4_RMR_MJS_MASK)
 
 /* EMACx_ISR & EMACx_ISER */
 #define EMAC4_ISR_TXPE          0x20000000
 #define EMAC4_ISR_RXPE          0x10000000
 #define EMAC4_ISR_TXUE          0x08000000
 #define EMAC4_ISR_RXOE          0x04000000
 #define EMAC_ISR_OVR            0x02000000
 #define EMAC_ISR_PP         0x01000000
 #define EMAC_ISR_BP         0x00800000
 #define EMAC_ISR_RP         0x00400000
 #define EMAC_ISR_SE         0x00200000
 #define EMAC_ISR_ALE            0x00100000
 #define EMAC_ISR_BFCS           0x00080000
 #define EMAC_ISR_PTLE           0x00040000
 #define EMAC_ISR_ORE            0x00020000
 #define EMAC_ISR_IRE            0x00010000
 #define EMAC_ISR_SQE            0x00000080
 #define EMAC_ISR_TE         0x00000040
 #define EMAC_ISR_MOS            0x00000002
 #define EMAC_ISR_MOF            0x00000001
 
 /* EMACx_STACR */
 #define EMAC_STACR_PHYD_MASK        0xffff
 #define EMAC_STACR_PHYD_SHIFT       16
 #define EMAC_STACR_OC           0x00008000
 #define EMAC_STACR_PHYE         0x00004000
 #define EMAC_STACR_STAC_MASK        0x00003000
 #define EMAC_STACR_STAC_READ        0x00001000
 #define EMAC_STACR_STAC_WRITE       0x00002000
 #define EMAC_STACR_OPBC_MASK        0x00000C00
 #define EMAC_STACR_OPBC_50      0x00000000
 #define EMAC_STACR_OPBC_66      0x00000400
 #define EMAC_STACR_OPBC_83      0x00000800
 #define EMAC_STACR_OPBC_100     0x00000C00
 #define EMAC_STACR_OPBC(freq)       ((freq) <= 50 ? EMAC_STACR_OPBC_50 : \
                      (freq) <= 66 ? EMAC_STACR_OPBC_66 : \
                      (freq) <= 83 ? EMAC_STACR_OPBC_83 : EMAC_STACR_OPBC_100)
 #define EMAC_STACR_BASE(opb)        EMAC_STACR_OPBC(opb)
 #define EMAC4_STACR_BASE(opb)       0x00000000
 #define EMAC_STACR_PCDA_MASK        0x1f
 #define EMAC_STACR_PCDA_SHIFT       5
 #define EMAC_STACR_PRA_MASK     0x1f
 #define EMACX_STACR_STAC_MASK       0x00003800
 #define EMACX_STACR_STAC_READ       0x00001000
 #define EMACX_STACR_STAC_WRITE      0x00000800
 #define EMACX_STACR_STAC_IND_ADDR   0x00002000
 #define EMACX_STACR_STAC_IND_READ   0x00003800
 #define EMACX_STACR_STAC_IND_READINC    0x00003000
 #define EMACX_STACR_STAC_IND_WRITE  0x00002800
 
 
 /* EMACx_TRTR */
 #define EMAC_TRTR_SHIFT_EMAC4       24
 #define EMAC_TRTR_SHIFT     27
 
 /* EMAC specific TX descriptor control fields (write access) */
 #define EMAC_TX_CTRL_GFCS       0x0200
 #define EMAC_TX_CTRL_GP         0x0100
 #define EMAC_TX_CTRL_ISA        0x0080
 #define EMAC_TX_CTRL_RSA        0x0040
 #define EMAC_TX_CTRL_IVT        0x0020
 #define EMAC_TX_CTRL_RVT        0x0010
 #define EMAC_TX_CTRL_TAH_CSUM       0x000e
 
 /* EMAC specific TX descriptor status fields (read access) */
 #define EMAC_TX_ST_BFCS         0x0200
 #define EMAC_TX_ST_LCS          0x0080
 #define EMAC_TX_ST_ED           0x0040
 #define EMAC_TX_ST_EC           0x0020
 #define EMAC_TX_ST_LC           0x0010
 #define EMAC_TX_ST_MC           0x0008
 #define EMAC_TX_ST_SC           0x0004
 #define EMAC_TX_ST_UR           0x0002
 #define EMAC_TX_ST_SQE          0x0001
 #define EMAC_IS_BAD_TX          (EMAC_TX_ST_LCS | EMAC_TX_ST_ED | \
                      EMAC_TX_ST_EC | EMAC_TX_ST_LC | \
                      EMAC_TX_ST_MC | EMAC_TX_ST_UR)
 #define EMAC_IS_BAD_TX_TAH      (EMAC_TX_ST_LCS | EMAC_TX_ST_ED | \
                      EMAC_TX_ST_EC | EMAC_TX_ST_LC)
 
 /* EMAC specific RX descriptor status fields (read access) */
 #define EMAC_RX_ST_OE           0x0200
 #define EMAC_RX_ST_PP           0x0100
 #define EMAC_RX_ST_BP           0x0080
 #define EMAC_RX_ST_RP           0x0040
 #define EMAC_RX_ST_SE           0x0020
 #define EMAC_RX_ST_AE           0x0010
 #define EMAC_RX_ST_BFCS         0x0008
 #define EMAC_RX_ST_PTL          0x0004
 #define EMAC_RX_ST_ORE          0x0002
 #define EMAC_RX_ST_IRE          0x0001
 #define EMAC_RX_TAH_BAD_CSUM        0x0003
 #define EMAC_BAD_RX_MASK        (EMAC_RX_ST_OE | EMAC_RX_ST_BP | \
                      EMAC_RX_ST_RP | EMAC_RX_ST_SE | \
                      EMAC_RX_ST_AE | EMAC_RX_ST_BFCS | \
                      EMAC_RX_ST_PTL | EMAC_RX_ST_ORE | \
                      EMAC_RX_ST_IRE )
 #endif /* __IBM_NEWEMAC_H */