include/440gx_enet.h

   1 /*----------------------------------------------------------------------------+
   2 |
   3 |       This source code has been made available to you by IBM on an AS-IS
   4 |       basis.  Anyone receiving this source is licensed under IBM
   5 |       copyrights to use it in any way he or she deems fit, including
   6 |       copying it, modifying it, compiling it, and redistributing it either
   7 |       with or without modifications.  No license under IBM patents or
   8 |       patent applications is to be implied by the copyright license.
   9 |
  10 |       Any user of this software should understand that IBM cannot provide
  11 |       technical support for this software and will not be responsible for
  12 |       any consequences resulting from the use of this software.
  13 |
  14 |       Any person who transfers this source code or any derivative work
  15 |       must include the IBM copyright notice, this paragraph, and the
  16 |       preceding two paragraphs in the transferred software.
  17 |
  18 |       COPYRIGHT   I B M   CORPORATION 1999
  19 |       LICENSED MATERIAL  -  PROGRAM PROPERTY OF I B M
  20 +----------------------------------------------------------------------------*/
  21 /*----------------------------------------------------------------------------+
  22 |
  23 |  File Name:   enetemac.h
  24 |
  25 |  Function:    Header file for the EMAC3 macro on the 405GP.
  26 |
  27 |  Author:      Mark Wisner
  28 |
  29 |  Change Activity-
  30 |
  31 |  Date        Description of Change                                       BY
  32 |  ---------   ---------------------                                       ---
  33 |  29-Apr-99   Created                                                     MKW
  34 |
  35 +----------------------------------------------------------------------------*/
  36 /*----------------------------------------------------------------------------+
  37 |  19-Nov-03   Travis Sawyer, Sandburst Corporation, tsawyer@sandburst.com
  38 |              ported to handle 440GP and 440GX multiple EMACs
  39 +----------------------------------------------------------------------------*/
  40
  41 #ifndef _emacgx_enet_h_
  42 #define _emacgx_enet_h_
  43
  44 #if defined(CONFIG_440)
  45 #include <net.h>
  46 #include "405_mal.h"
  47
  48
  49 /*-----------------------------------------------------------------------------+
  50 | General enternet defines.  802 frames are not supported.
  51 +-----------------------------------------------------------------------------*/
  52 #define ENET_ADDR_LENGTH                6
  53 #define ENET_ARPTYPE                    0x806
  54 #define ARP_REQUEST                     1
  55 #define ARP_REPLY                       2
  56 #define ENET_IPTYPE                     0x800
  57 #define ARP_CACHE_SIZE                  5
  58
  59 #define NUM_TX_BUFF 1
  60 #define NUM_RX_BUFF PKTBUFSRX
  61
  62 struct enet_frame {
  63    unsigned char        dest_addr[ENET_ADDR_LENGTH];
  64    unsigned char        source_addr[ENET_ADDR_LENGTH];
  65    unsigned short       type;
  66    unsigned char        enet_data[1];
  67 };
  68
  69 struct arp_entry {
  70    unsigned long        inet_address;
  71    unsigned char        mac_address[ENET_ADDR_LENGTH];
  72    unsigned long        valid;
  73    unsigned long        sec;
  74    unsigned long        nsec;
  75 };
  76
  77
  78 /* Statistic Areas */
  79 #define MAX_ERR_LOG 10
  80
  81 typedef struct emac_stats_st{   /* Statistic Block */
  82         int data_len_err;
  83         int rx_frames;
  84         int rx;
  85         int rx_prot_err;
  86         int int_err;
  87     int pkts_tx;
  88     int pkts_rx;
  89     int pkts_handled;
  90         short tx_err_log[MAX_ERR_LOG];
  91         short rx_err_log[MAX_ERR_LOG];
  92 } EMAC_STATS_ST, *EMAC_STATS_PST;
  93
  94 /* Structure containing variables used by the shared code (440gx_enet.c) */
  95 typedef struct emac_440gx_hw_st {
  96     uint32_t            hw_addr;                /* EMAC offset */
  97     uint32_t            tah_addr;               /* TAH offset */
  98     uint32_t            phy_id;
  99     uint32_t            phy_addr;
 100     uint32_t            original_fc;
 101     uint32_t            txcw;
 102     uint32_t            autoneg_failed;
 103     uint32_t            emac_ier;
 104     volatile mal_desc_t *tx;
 105     volatile mal_desc_t *rx;
 106     bd_t                *bis;   /* for eth_init upon mal error */
 107     mal_desc_t          *alloc_tx_buf;
 108     mal_desc_t          *alloc_rx_buf;
 109     char                *txbuf_ptr;
 110     uint16_t            devnum;
 111     int                 get_link_status;
 112     int                 tbi_compatibility_en;
 113     int                 tbi_compatibility_on;
 114     int                 fc_send_xon;
 115     int                 report_tx_early;
 116     int                 first_init;
 117     int                 tx_err_index;
 118     int                 rx_err_index;
 119     int                 rx_slot;                        /* MAL Receive Slot */
 120     int                 rx_i_index;             /* Receive Interrupt Queue Index */
 121     int                 rx_u_index;             /* Receive User Queue Index */
 122     int                 tx_slot;                        /* MAL Transmit Slot */
 123     int                 tx_i_index;             /* Transmit Interrupt Queue Index */
 124     int                 tx_u_index;             /* Transmit User Queue Index */
 125     int                 rx_ready[NUM_RX_BUFF];  /* Receive Ready Queue */
 126     int                 tx_run[NUM_TX_BUFF];    /* Transmit Running Queue */
 127     int                 is_receiving;   /* sync with eth interrupt */
 128     int                 print_speed;    /* print speed message upon start */
 129     EMAC_STATS_ST       stats;
 130 } EMAC_440GX_HW_ST, *EMAC_440GX_HW_PST;
 131
 132
 133 #if defined(CONFIG_440_GX)
 134 #define EMAC_NUM_DEV        4
 135 #elif defined(CONFIG_440) && !defined(CONFIG_440_GX)
 136 #define EMAC_NUM_DEV        2
 137 #else
 138 #warning Bad configuration
 139 #endif
 140
 141
 142 /*ZMII Bridge Register addresses */
 143 #define ZMII_BASE                       (CFG_PERIPHERAL_BASE + 0x0780)
 144 #define ZMII_FER                        (ZMII_BASE)
 145 #define ZMII_SSR                        (ZMII_BASE + 4)
 146 #define ZMII_SMIISR                     (ZMII_BASE + 8)
 147
 148 #define ZMII_RMII                       0x22000000
 149 #define ZMII_MDI0                       0x80000000
 150
 151 /* ZMII FER Register Bit Definitions */
 152 #define ZMII_FER_MDI            (0x8)
 153 #define ZMII_FER_SMII           (0x4)
 154 #define ZMII_FER_RMII           (0x2)
 155 #define ZMII_FER_MII            (0x1)
 156
 157 #define ZMII_FER_RSVD11         (0x00200000)
 158 #define ZMII_FER_RSVD10         (0x00100000)
 159 #define ZMII_FER_RSVD14_31      (0x0003FFFF)
 160
 161 #define ZMII_FER_V(__x)         (((3 - __x) * 4) + 16)
 162
 163
 164 /* ZMII Speed Selection Register Bit Definitions */
 165 #define ZMII_SSR_SCI            (0x4)
 166 #define ZMII_SSR_FSS            (0x2)
 167 #define ZMII_SSR_SP             (0x1)
 168 #define ZMII_SSR_RSVD16_31      (0x0000FFFF)
 169
 170 #define ZMII_SSR_V(__x)         (((3 - __x) * 4) + 16)
 171
 172
 173 /* ZMII SMII Status Register Bit Definitions */
 174 #define ZMII_SMIISR_E1          (0x80)
 175 #define ZMII_SMIISR_EC          (0x40)
 176 #define ZMII_SMIISR_EN          (0x20)
 177 #define ZMII_SMIISR_EJ          (0x10)
 178 #define ZMII_SMIISR_EL          (0x08)
 179 #define ZMII_SMIISR_ED          (0x04)
 180 #define ZMII_SMIISR_ES          (0x02)
 181 #define ZMII_SMIISR_EF          (0x01)
 182
 183 #define ZMII_SMIISR_V(__x)      ((3 - __x) * 8)
 184
 185 /* RGMII Register Addresses */
 186 #define RGMII_BASE              (CFG_PERIPHERAL_BASE + 0x0790)
 187 #define RGMII_FER               (RGMII_BASE + 0x00)
 188 #define RGMII_SSR               (RGMII_BASE + 0x04)
 189
 190 /* RGMII Function Enable (FER) Register Bit Definitions */
 191 /* Note: for EMAC 2 and 3 only, 440GX only */
 192 #define RGMII_FER_DIS           (0x00)
 193 #define RGMII_FER_RTBI          (0x04)
 194 #define RGMII_FER_RGMII         (0x05)
 195 #define RGMII_FER_TBI           (0x06)
 196 #define RGMII_FER_GMII          (0x07)
 197
 198 #define RGMII_FER_V(__x)        ((__x - 2) * 4)
 199
 200 /* RGMII Speed Selection Register Bit Definitions */
 201 #define RGMII_SSR_SP_10MBPS     (0x00)
 202 #define RGMII_SSR_SP_100MBPS    (0x02)
 203 #define RGMII_SSR_SP_1000MBPS   (0x04)
 204
 205 #define RGMII_SSR_V(__x)        ((__x -2) * 8)
 206
 207
 208 /*---------------------------------------------------------------------------+
 209 |  TCP/IP Acceleration Hardware (TAH) 440GX Only
 210 +---------------------------------------------------------------------------*/
 211 #if defined(CONFIG_440_GX)
 212 #define TAH_BASE                (CFG_PERIPHERAL_BASE + 0x0B50)
 213 #define TAH_REVID               (TAH_BASE + 0x0)    /* Revision ID (RO)*/
 214 #define TAH_MR                  (TAH_BASE + 0x10)   /* Mode Register (R/W) */
 215 #define TAH_SSR0                (TAH_BASE + 0x14)   /* Segment Size Reg 0 (R/W) */
 216 #define TAH_SSR1                (TAH_BASE + 0x18)   /* Segment Size Reg 1 (R/W) */
 217 #define TAH_SSR2                (TAH_BASE + 0x1C)   /* Segment Size Reg 2 (R/W) */
 218 #define TAH_SSR3                (TAH_BASE + 0x20)   /* Segment Size Reg 3 (R/W) */
 219 #define TAH_SSR4                (TAH_BASE + 0x24)   /* Segment Size Reg 4 (R/W) */
 220 #define TAH_SSR5                (TAH_BASE + 0x28)   /* Segment Size Reg 5 (R/W) */
 221 #define TAH_TSR                 (TAH_BASE + 0x2C)   /* Transmit Status Register (RO) */
 222
 223
 224 /* TAH Revision */
 225 #define TAH_REV_RN_M            (0x000FFF00)        /* Revision Number */
 226 #define TAH_REV_BN_M            (0x000000FF)        /* Branch Revision Number */
 227
 228 #define TAH_REV_RN_V            (8)
 229 #define TAH_REV_BN_V            (0)
 230
 231 /* TAH Mode Register */
 232 #define TAH_MR_CVR              (0x80000000)        /* Checksum verification on RX */
 233 #define TAH_MR_SR               (0x40000000)        /* Software reset */
 234 #define TAH_MR_ST               (0x3F000000)        /* Send Threshold */
 235 #define TAH_MR_TFS              (0x00E00000)        /* Transmit FIFO size */
 236 #define TAH_MR_DTFP             (0x00100000)        /* Disable TX FIFO parity */
 237 #define TAH_MR_DIG              (0x00080000)        /* Disable interrupt generation */
 238 #define TAH_MR_RSVD             (0x0007FFFF)        /* Reserved */
 239
 240 #define TAH_MR_ST_V             (20)
 241 #define TAH_MR_TFS_V            (17)
 242
 243 #define TAH_MR_TFS_2K           (0x1)               /* Transmit FIFO size 2Kbyte */
 244 #define TAH_MR_TFS_4K           (0x2)               /* Transmit FIFO size 4Kbyte */
 245 #define TAH_MR_TFS_6K           (0x3)               /* Transmit FIFO size 6Kbyte */
 246 #define TAH_MR_TFS_8K           (0x4)               /* Transmit FIFO size 8Kbyte */
 247 #define TAH_MR_TFS_10K          (0x5)               /* Transmit FIFO size 10Kbyte (max)*/
 248
 249
 250 /* TAH Segment Size Registers 0:5 */
 251 #define TAH_SSR_RSVD0           (0xC0000000)        /* Reserved */
 252 #define TAH_SSR_SS              (0x3FFE0000)        /* Segment size in multiples of 2 */
 253 #define TAH_SSR_RSVD1           (0x0001FFFF)        /* Reserved */
 254
 255 /* TAH Transmit Status Register */
 256 #define TAH_TSR_TFTS            (0x80000000)        /* Transmit FIFO too small */
 257 #define TAH_TSR_UH              (0x40000000)        /* Unrecognized header */
 258 #define TAH_TSR_NIPF            (0x20000000)        /* Not IPv4 */
 259 #define TAH_TSR_IPOP            (0x10000000)        /* IP option present */
 260 #define TAH_TSR_NISF            (0x08000000)        /* No IEEE SNAP format */
 261 #define TAH_TSR_ILTS            (0x04000000)        /* IP length too short */
 262 #define TAH_TSR_IPFP            (0x02000000)        /* IP fragment present */
 263 #define TAH_TSR_UP              (0x01000000)        /* Unsupported protocol */
 264 #define TAH_TSR_TFP             (0x00800000)        /* TCP flags present */
 265 #define TAH_TSR_SUDP            (0x00400000)        /* Segmentation for UDP */
 266 #define TAH_TSR_DLM             (0x00200000)        /* Data length mismatch */
 267 #define TAH_TSR_SIEEE           (0x00100000)        /* Segmentation for IEEE */
 268 #define TAH_TSR_TFPE            (0x00080000)        /* Transmit FIFO parity error */
 269 #define TAH_TSR_SSTS            (0x00040000)        /* Segment size too small */
 270 #define TAH_TSR_RSVD            (0x0003FFFF)        /* Reserved */
 271 #endif /* CONFIG_440_GX */
 272
 273
 274 /* Ethernet MAC Regsiter Addresses */
 275 #define EMAC_BASE                           (CFG_PERIPHERAL_BASE + 0x0800)
 276
 277 #define EMAC_M0                             (EMAC_BASE)
 278 #define EMAC_M1                             (EMAC_BASE + 4)
 279 #define EMAC_TXM0                               (EMAC_BASE + 8)
 280 #define EMAC_TXM1                               (EMAC_BASE + 12)
 281 #define EMAC_RXM                                (EMAC_BASE + 16)
 282 #define EMAC_ISR                                (EMAC_BASE + 20)
 283 #define EMAC_IER                                (EMAC_BASE + 24)
 284 #define EMAC_IAH                                (EMAC_BASE + 28)
 285 #define EMAC_IAL                                (EMAC_BASE + 32)
 286 #define EMAC_VLAN_TPID_REG              (EMAC_BASE + 36)
 287 #define EMAC_VLAN_TCI_REG               (EMAC_BASE + 40)
 288 #define EMAC_PAUSE_TIME_REG     (EMAC_BASE + 44)
 289 #define EMAC_IND_HASH_1                 (EMAC_BASE + 48)
 290 #define EMAC_IND_HASH_2                 (EMAC_BASE + 52)
 291 #define EMAC_IND_HASH_3                 (EMAC_BASE + 56)
 292 #define EMAC_IND_HASH_4                 (EMAC_BASE + 60)
 293 #define EMAC_GRP_HASH_1                 (EMAC_BASE + 64)
 294 #define EMAC_GRP_HASH_2                 (EMAC_BASE + 68)
 295 #define EMAC_GRP_HASH_3                 (EMAC_BASE + 72)
 296 #define EMAC_GRP_HASH_4                 (EMAC_BASE + 76)
 297 #define EMAC_LST_SRC_LOW                (EMAC_BASE + 80)
 298 #define EMAC_LST_SRC_HI                 (EMAC_BASE + 84)
 299 #define EMAC_I_FRAME_GAP_REG    (EMAC_BASE + 88)
 300 #define EMAC_STACR                          (EMAC_BASE + 92)
 301 #define EMAC_TRTR                               (EMAC_BASE + 96)
 302 #define EMAC_RX_HI_LO_WMARK             (EMAC_BASE + 100)
 303
 304 /* bit definitions */
 305 /* MODE REG 0 */
 306 #define EMAC_M0_RXI                         (0x80000000)
 307 #define EMAC_M0_TXI                         (0x40000000)
 308 #define EMAC_M0_SRST                    (0x20000000)
 309 #define EMAC_M0_TXE                         (0x10000000)
 310 #define EMAC_M0_RXE                         (0x08000000)
 311 #define EMAC_M0_WKE                         (0x04000000)
 312
 313 /* MODE Reg 1 */
 314 #define EMAC_M1_FDE             (0x80000000)
 315 #define EMAC_M1_ILE             (0x40000000)
 316 #define EMAC_M1_VLE             (0x20000000)
 317 #define EMAC_M1_EIFC                    (0x10000000)
 318 #define EMAC_M1_APP                         (0x08000000)
 319 #define EMAC_M1_RSVD                    (0x06000000)
 320 #define EMAC_M1_IST                         (0x01000000)
 321 #define EMAC_M1_MF_1000MBPS             (0x00800000)    /* 0's for 10MBPS */
 322 #define EMAC_M1_MF_100MBPS              (0x00400000)
 323 #define EMAC_M1_RFS_16K                 (0x00280000)    /* ~4k for 512 byte */
 324 #define EMAC_M1_RFS_8K                  (0x00200000)    /* ~4k for 512 byte */
 325 #define EMAC_M1_RFS_4K                  (0x00180000)    /* ~4k for 512 byte */
 326 #define EMAC_M1_RFS_2K                  (0x00100000)
 327 #define EMAC_M1_RFS_1K                  (0x00080000)
 328 #define EMAC_M1_TX_FIFO_16K             (0x00050000)    /* 0's for 512 byte */
 329 #define EMAC_M1_TX_FIFO_8K              (0x00040000)
 330 #define EMAC_M1_TX_FIFO_4K              (0x00030000)
 331 #define EMAC_M1_TX_FIFO_2K      (0x00020000)
 332 #define EMAC_M1_TX_FIFO_1K              (0x00010000)
 333 #define EMAC_M1_TR_MULTI                (0x00008000)    /* 0'x for single packet */
 334 #define EMAC_M1_MWSW            (0x00007000)
 335 #define EMAC_M1_JUMBO_ENABLE    (0x00000800)
 336 #define EMAC_M1_IPPA            (0x000007c0)
 337 #define EMAC_M1_OBCI_GT100      (0x00000020)
 338 #define EMAC_M1_OBCI_100        (0x00000018)
 339 #define EMAC_M1_OBCI_83         (0x00000010)
 340 #define EMAC_M1_OBCI_66         (0x00000008)
 341 #define EMAC_M1_RSVD1           (0x00000007)
 342 /* Transmit Mode Register 0 */
 343 #define EMAC_TXM0_GNP0                  (0x80000000)
 344 #define EMAC_TXM0_GNP1                  (0x40000000)
 345 #define EMAC_TXM0_GNPD                  (0x20000000)
 346 #define EMAC_TXM0_FC                    (0x10000000)
 347
 348 /* Receive Mode Register */
 349 #define EMAC_RMR_SP             (0x80000000)
 350 #define EMAC_RMR_SFCS           (0x40000000)
 351 #define EMAC_RMR_ARRP           (0x20000000)
 352 #define EMAC_RMR_ARP            (0x10000000)
 353 #define EMAC_RMR_AROP           (0x08000000)
 354 #define EMAC_RMR_ARPI           (0x04000000)
 355 #define EMAC_RMR_PPP            (0x02000000)
 356 #define EMAC_RMR_PME            (0x01000000)
 357 #define EMAC_RMR_PMME           (0x00800000)
 358 #define EMAC_RMR_IAE            (0x00400000)
 359 #define EMAC_RMR_MIAE           (0x00200000)
 360 #define EMAC_RMR_BAE            (0x00100000)
 361 #define EMAC_RMR_MAE            (0x00080000)
 362
 363 /* Interrupt Status & enable Regs */
 364 #define EMAC_ISR_OVR            (0x02000000)
 365 #define EMAC_ISR_PP             (0x01000000)
 366 #define EMAC_ISR_BP             (0x00800000)
 367 #define EMAC_ISR_RP             (0x00400000)
 368 #define EMAC_ISR_SE                     (0x00200000)
 369 #define EMAC_ISR_SYE                    (0x00100000)
 370 #define EMAC_ISR_BFCS                   (0x00080000)
 371 #define EMAC_ISR_PTLE                   (0x00040000)
 372 #define EMAC_ISR_ORE                    (0x00020000)
 373 #define EMAC_ISR_IRE                    (0x00010000)
 374 #define EMAC_ISR_DBDM                   (0x00000200)
 375 #define EMAC_ISR_DB0                    (0x00000100)
 376 #define EMAC_ISR_SE0                    (0x00000080)
 377 #define EMAC_ISR_TE0                    (0x00000040)
 378 #define EMAC_ISR_DB1                    (0x00000020)
 379 #define EMAC_ISR_SE1                    (0x00000010)
 380 #define EMAC_ISR_TE1                    (0x00000008)
 381 #define EMAC_ISR_MOS                    (0x00000002)
 382 #define EMAC_ISR_MOF                    (0x00000001)
 383
 384
 385 /* STA CONTROL REG */
 386 #define EMAC_STACR_OC                   (0x00008000)
 387 #define EMAC_STACR_PHYE                 (0x00004000)
 388 #define EMAC_STACR_WRITE                (0x00002000)
 389 #define EMAC_STACR_READ                 (0x00001000)
 390 #define EMAC_STACR_CLK_83MHZ    (0x00000800)  /* 0's for 50Mhz */
 391 #define EMAC_STACR_CLK_66MHZ    (0x00000400)
 392 #define EMAC_STACR_CLK_100MHZ   (0x00000C00)
 393
 394 /* Transmit Request Threshold Register */
 395 #define EMAC_TRTR_256                   (0x18000000)   /* 0's for 64 Bytes */
 396 #define EMAC_TRTR_192                   (0x10000000)
 397 #define EMAC_TRTR_128                   (0x01000000)
 398
 399 /* the follwing defines are for the MadMAL status and control registers. */
 400 /* For bits 0..5 look at the mal.h file                                  */
 401 #define EMAC_TX_CTRL_GFCS       (0x0200)
 402 #define EMAC_TX_CTRL_GP         (0x0100)
 403 #define EMAC_TX_CTRL_ISA        (0x0080)
 404 #define EMAC_TX_CTRL_RSA        (0x0040)
 405 #define EMAC_TX_CTRL_IVT        (0x0020)
 406 #define EMAC_TX_CTRL_RVT        (0x0010)
 407
 408 #define EMAC_TX_CTRL_DEFAULT (EMAC_TX_CTRL_GFCS |EMAC_TX_CTRL_GP)
 409
 410 #define EMAC_TX_ST_BFCS         (0x0200)
 411 #define EMAC_TX_ST_BPP          (0x0100)
 412 #define EMAC_TX_ST_LCS          (0x0080)
 413 #define EMAC_TX_ST_ED           (0x0040)
 414 #define EMAC_TX_ST_EC           (0x0020)
 415 #define EMAC_TX_ST_LC           (0x0010)
 416 #define EMAC_TX_ST_MC           (0x0008)
 417 #define EMAC_TX_ST_SC           (0x0004)
 418 #define EMAC_TX_ST_UR           (0x0002)
 419 #define EMAC_TX_ST_SQE          (0x0001)
 420
 421 #define EMAC_TX_ST_DEFAULT      (0x03F3)
 422
 423
 424 /* madmal receive status / Control bits */
 425
 426 #define EMAC_RX_ST_OE           (0x0200)
 427 #define EMAC_RX_ST_PP           (0x0100)
 428 #define EMAC_RX_ST_BP           (0x0080)
 429 #define EMAC_RX_ST_RP           (0x0040)
 430 #define EMAC_RX_ST_SE           (0x0020)
 431 #define EMAC_RX_ST_AE           (0x0010)
 432 #define EMAC_RX_ST_BFCS         (0x0008)
 433 #define EMAC_RX_ST_PTL          (0x0004)
 434 #define EMAC_RX_ST_ORE          (0x0002)
 435 #define EMAC_RX_ST_IRE          (0x0001)
 436 /* all the errors we care about */
 437 #define EMAC_RX_ERRORS          (0x03FF)
 438
 439 #endif /* CONFIG_440 */
 440 #endif /* _enetLib_h_ */