LXR linux/drivers/net/ethernet/freescale/ucc

   1/*
   2 * Copyright (C) Freescale Semicondutor, Inc. 2006-2009. All rights reserved.
   3 *
   4 * Author: Shlomi Gridish <gridish@freescale.com>
   5 *
   6 * Description:
   7 * Internal header file for UCC Gigabit Ethernet unit routines.
   8 *
   9 * Changelog:
  10 * Jun 28, 2006 Li Yang <LeoLi@freescale.com>
  11 * - Rearrange code and style fixes
  12 *
  13 * This program is free software; you can redistribute  it and/or modify it
  14 * under  the terms of  the GNU General  Public License as published by the
  15 * Free Software Foundation;  either version 2 of the  License, or (at your
  16 * option) any later version.
  17 */
  18#ifndef __UCC_GETH_H__
  19#define __UCC_GETH_H__
  20
  21#include <linux/kernel.h>
  22#include <linux/list.h>
  23#include <linux/if_ether.h>
  24
  25#include <soc/fsl/qe/immap_qe.h>
  26#include <soc/fsl/qe/qe.h>
  27
  28#include <soc/fsl/qe/ucc.h>
  29#include <soc/fsl/qe/ucc_fast.h>
  30
  31#define DRV_DESC "QE UCC Gigabit Ethernet Controller"
  32#define DRV_NAME "ucc_geth"
  33#define DRV_VERSION "1.1"
  34
  35#define NUM_TX_QUEUES                   8
  36#define NUM_RX_QUEUES                   8
  37#define NUM_BDS_IN_PREFETCHED_BDS       4
  38#define TX_IP_OFFSET_ENTRY_MAX          8
  39#define NUM_OF_PADDRS                   4
  40#define ENET_INIT_PARAM_MAX_ENTRIES_RX  9
  41#define ENET_INIT_PARAM_MAX_ENTRIES_TX  8
  42
  43struct ucc_geth {
  44        struct ucc_fast uccf;
  45        u8 res0[0x100 - sizeof(struct ucc_fast)];
  46
  47        u32 maccfg1;            /* mac configuration reg. 1 */
  48        u32 maccfg2;            /* mac configuration reg. 2 */
  49        u32 ipgifg;             /* interframe gap reg.  */
  50        u32 hafdup;             /* half-duplex reg.  */
  51        u8 res1[0x10];
  52        u8 miimng[0x18];        /* MII management structure moved to _mii.h */
  53        u32 ifctl;              /* interface control reg */
  54        u32 ifstat;             /* interface statux reg */
  55        u32 macstnaddr1;        /* mac station address part 1 reg */
  56        u32 macstnaddr2;        /* mac station address part 2 reg */
  57        u8 res2[0x8];
  58        u32 uempr;              /* UCC Ethernet Mac parameter reg */
  59        u32 utbipar;            /* UCC tbi address reg */
  60        u16 uescr;              /* UCC Ethernet statistics control reg */
  61        u8 res3[0x180 - 0x15A];
  62        u32 tx64;               /* Total number of frames (including bad
  63                                   frames) transmitted that were exactly of the
  64                                   minimal length (64 for un tagged, 68 for
  65                                   tagged, or with length exactly equal to the
  66                                   parameter MINLength */
  67        u32 tx127;              /* Total number of frames (including bad
  68                                   frames) transmitted that were between
  69                                   MINLength (Including FCS length==4) and 127
  70                                   octets */
  71        u32 tx255;              /* Total number of frames (including bad
  72                                   frames) transmitted that were between 128
  73                                   (Including FCS length==4) and 255 octets */
  74        u32 rx64;               /* Total number of frames received including
  75                                   bad frames that were exactly of the mninimal
  76                                   length (64 bytes) */
  77        u32 rx127;              /* Total number of frames (including bad
  78                                   frames) received that were between MINLength
  79                                   (Including FCS length==4) and 127 octets */
  80        u32 rx255;              /* Total number of frames (including bad
  81                                   frames) received that were between 128
  82                                   (Including FCS length==4) and 255 octets */
  83        u32 txok;               /* Total number of octets residing in frames
  84                                   that where involved in successful
  85                                   transmission */
  86        u16 txcf;               /* Total number of PAUSE control frames
  87                                   transmitted by this MAC */
  88        u8 res4[0x2];
  89        u32 tmca;               /* Total number of frames that were transmitted
  90                                   successfully with the group address bit set
  91                                   that are not broadcast frames */
  92        u32 tbca;               /* Total number of frames transmitted
  93                                   successfully that had destination address
  94                                   field equal to the broadcast address */
  95        u32 rxfok;              /* Total number of frames received OK */
  96        u32 rxbok;              /* Total number of octets received OK */
  97        u32 rbyt;               /* Total number of octets received including
  98                                   octets in bad frames. Must be implemented in
  99                                   HW because it includes octets in frames that
 100                                   never even reach the UCC */
 101        u32 rmca;               /* Total number of frames that were received
 102                                   successfully with the group address bit set
 103                                   that are not broadcast frames */
 104        u32 rbca;               /* Total number of frames received successfully
 105                                   that had destination address equal to the
 106                                   broadcast address */
 107        u32 scar;               /* Statistics carry register */
 108        u32 scam;               /* Statistics caryy mask register */
 109        u8 res5[0x200 - 0x1c4];
 110} __packed;
 111
 112/* UCC GETH TEMODR Register */
 113#define TEMODER_TX_RMON_STATISTICS_ENABLE       0x0100  /* enable Tx statistics
 114                                                         */
 115#define TEMODER_SCHEDULER_ENABLE                0x2000  /* enable scheduler */
 116#define TEMODER_IP_CHECKSUM_GENERATE            0x0400  /* generate IPv4
 117                                                           checksums */
 118#define TEMODER_PERFORMANCE_OPTIMIZATION_MODE1  0x0200  /* enable performance
 119                                                           optimization
 120                                                           enhancement (mode1) */
 121#define TEMODER_RMON_STATISTICS                 0x0100  /* enable tx statistics
 122                                                         */
 123#define TEMODER_NUM_OF_QUEUES_SHIFT             (15-15) /* Number of queues <<
 124                                                           shift */
 125
 126/* UCC GETH TEMODR Register */
 127#define REMODER_RX_RMON_STATISTICS_ENABLE       0x00001000      /* enable Rx
 128                                                                   statistics */
 129#define REMODER_RX_EXTENDED_FEATURES            0x80000000      /* enable
 130                                                                   extended
 131                                                                   features */
 132#define REMODER_VLAN_OPERATION_TAGGED_SHIFT     (31-9 ) /* vlan operation
 133                                                           tagged << shift */
 134#define REMODER_VLAN_OPERATION_NON_TAGGED_SHIFT (31-10) /* vlan operation non
 135                                                           tagged << shift */
 136#define REMODER_RX_QOS_MODE_SHIFT               (31-15) /* rx QoS mode << shift
 137                                                         */
 138#define REMODER_RMON_STATISTICS                 0x00001000      /* enable rx
 139                                                                   statistics */
 140#define REMODER_RX_EXTENDED_FILTERING           0x00000800      /* extended
 141                                                                   filtering
 142                                                                   vs.
 143                                                                   mpc82xx-like
 144                                                                   filtering */
 145#define REMODER_NUM_OF_QUEUES_SHIFT             (31-23) /* Number of queues <<
 146                                                           shift */
 147#define REMODER_DYNAMIC_MAX_FRAME_LENGTH        0x00000008      /* enable
 148                                                                   dynamic max
 149                                                                   frame length
 150                                                                 */
 151#define REMODER_DYNAMIC_MIN_FRAME_LENGTH        0x00000004      /* enable
 152                                                                   dynamic min
 153                                                                   frame length
 154                                                                 */
 155#define REMODER_IP_CHECKSUM_CHECK               0x00000002      /* check IPv4
 156                                                                   checksums */
 157#define REMODER_IP_ADDRESS_ALIGNMENT            0x00000001      /* align ip
 158                                                                   address to
 159                                                                   4-byte
 160                                                                   boundary */
 161
 162/* UCC GETH Event Register */
 163#define UCCE_TXB   (UCC_GETH_UCCE_TXB7 | UCC_GETH_UCCE_TXB6 | \
 164                    UCC_GETH_UCCE_TXB5 | UCC_GETH_UCCE_TXB4 | \
 165                    UCC_GETH_UCCE_TXB3 | UCC_GETH_UCCE_TXB2 | \
 166                    UCC_GETH_UCCE_TXB1 | UCC_GETH_UCCE_TXB0)
 167
 168#define UCCE_RXB   (UCC_GETH_UCCE_RXB7 | UCC_GETH_UCCE_RXB6 | \
 169                    UCC_GETH_UCCE_RXB5 | UCC_GETH_UCCE_RXB4 | \
 170                    UCC_GETH_UCCE_RXB3 | UCC_GETH_UCCE_RXB2 | \
 171                    UCC_GETH_UCCE_RXB1 | UCC_GETH_UCCE_RXB0)
 172
 173#define UCCE_RXF   (UCC_GETH_UCCE_RXF7 | UCC_GETH_UCCE_RXF6 | \
 174                    UCC_GETH_UCCE_RXF5 | UCC_GETH_UCCE_RXF4 | \
 175                    UCC_GETH_UCCE_RXF3 | UCC_GETH_UCCE_RXF2 | \
 176                    UCC_GETH_UCCE_RXF1 | UCC_GETH_UCCE_RXF0)
 177
 178#define UCCE_OTHER (UCC_GETH_UCCE_SCAR | UCC_GETH_UCCE_GRA | \
 179                    UCC_GETH_UCCE_CBPR | UCC_GETH_UCCE_BSY | \
 180                    UCC_GETH_UCCE_RXC  | UCC_GETH_UCCE_TXC | UCC_GETH_UCCE_TXE)
 181
 182#define UCCE_RX_EVENTS  (UCCE_RXF | UCC_GETH_UCCE_BSY)
 183#define UCCE_TX_EVENTS  (UCCE_TXB | UCC_GETH_UCCE_TXE)
 184
 185/* TBI defines */
 186#define ENET_TBI_MII_CR         0x00    /* Control */
 187#define ENET_TBI_MII_SR         0x01    /* Status */
 188#define ENET_TBI_MII_ANA        0x04    /* AN advertisement */
 189#define ENET_TBI_MII_ANLPBPA    0x05    /* AN link partner base page ability */
 190#define ENET_TBI_MII_ANEX       0x06    /* AN expansion */
 191#define ENET_TBI_MII_ANNPT      0x07    /* AN next page transmit */
 192#define ENET_TBI_MII_ANLPANP    0x08    /* AN link partner ability next page */
 193#define ENET_TBI_MII_EXST       0x0F    /* Extended status */
 194#define ENET_TBI_MII_JD         0x10    /* Jitter diagnostics */
 195#define ENET_TBI_MII_TBICON     0x11    /* TBI control */
 196
 197/* TBI MDIO register bit fields*/
 198#define TBISR_LSTATUS          0x0004
 199#define TBICON_CLK_SELECT       0x0020
 200#define TBIANA_ASYMMETRIC_PAUSE 0x0100
 201#define TBIANA_SYMMETRIC_PAUSE  0x0080
 202#define TBIANA_HALF_DUPLEX      0x0040
 203#define TBIANA_FULL_DUPLEX      0x0020
 204#define TBICR_PHY_RESET         0x8000
 205#define TBICR_ANEG_ENABLE       0x1000
 206#define TBICR_RESTART_ANEG      0x0200
 207#define TBICR_FULL_DUPLEX       0x0100
 208#define TBICR_SPEED1_SET        0x0040
 209
 210#define TBIANA_SETTINGS ( \
 211                TBIANA_ASYMMETRIC_PAUSE \
 212                | TBIANA_SYMMETRIC_PAUSE \
 213                | TBIANA_FULL_DUPLEX \
 214                )
 215#define TBICR_SETTINGS ( \
 216                TBICR_PHY_RESET \
 217                | TBICR_ANEG_ENABLE \
 218                | TBICR_FULL_DUPLEX \
 219                | TBICR_SPEED1_SET \
 220                )
 221
 222/* UCC GETH MACCFG1 (MAC Configuration 1 Register) */
 223#define MACCFG1_FLOW_RX                         0x00000020      /* Flow Control
 224                                                                   Rx */
 225#define MACCFG1_FLOW_TX                         0x00000010      /* Flow Control
 226                                                                   Tx */
 227#define MACCFG1_ENABLE_SYNCHED_RX               0x00000008      /* Rx Enable
 228                                                                   synchronized
 229                                                                   to Rx stream
 230                                                                 */
 231#define MACCFG1_ENABLE_RX                       0x00000004      /* Enable Rx */
 232#define MACCFG1_ENABLE_SYNCHED_TX               0x00000002      /* Tx Enable
 233                                                                   synchronized
 234                                                                   to Tx stream
 235                                                                 */
 236#define MACCFG1_ENABLE_TX                       0x00000001      /* Enable Tx */
 237
 238/* UCC GETH MACCFG2 (MAC Configuration 2 Register) */
 239#define MACCFG2_PREL_SHIFT                      (31 - 19)       /* Preamble
 240                                                                   Length <<
 241                                                                   shift */
 242#define MACCFG2_PREL_MASK                       0x0000f000      /* Preamble
 243                                                                   Length mask */
 244#define MACCFG2_SRP                             0x00000080      /* Soft Receive
 245                                                                   Preamble */
 246#define MACCFG2_STP                             0x00000040      /* Soft
 247                                                                   Transmit
 248                                                                   Preamble */
 249#define MACCFG2_RESERVED_1                      0x00000020      /* Reserved -
 250                                                                   must be set
 251                                                                   to 1 */
 252#define MACCFG2_LC                              0x00000010      /* Length Check
 253                                                                 */
 254#define MACCFG2_MPE                             0x00000008      /* Magic packet
 255                                                                   detect */
 256#define MACCFG2_FDX                             0x00000001      /* Full Duplex */
 257#define MACCFG2_FDX_MASK                        0x00000001      /* Full Duplex
 258                                                                   mask */
 259#define MACCFG2_PAD_CRC                         0x00000004
 260#define MACCFG2_CRC_EN                          0x00000002
 261#define MACCFG2_PAD_AND_CRC_MODE_NONE           0x00000000      /* Neither
 262                                                                   Padding
 263                                                                   short frames
 264                                                                   nor CRC */
 265#define MACCFG2_PAD_AND_CRC_MODE_CRC_ONLY       0x00000002      /* Append CRC
 266                                                                   only */
 267#define MACCFG2_PAD_AND_CRC_MODE_PAD_AND_CRC    0x00000004
 268#define MACCFG2_INTERFACE_MODE_NIBBLE           0x00000100      /* nibble mode
 269                                                                   (MII/RMII/RGMII
 270                                                                   10/100bps) */
 271#define MACCFG2_INTERFACE_MODE_BYTE             0x00000200      /* byte mode
 272                                                                   (GMII/TBI/RTB/RGMII
 273                                                                   1000bps ) */
 274#define MACCFG2_INTERFACE_MODE_MASK             0x00000300      /* mask
 275                                                                   covering all
 276                                                                   relevant
 277                                                                   bits */
 278
 279/* UCC GETH IPGIFG (Inter-frame Gap / Inter-Frame Gap Register) */
 280#define IPGIFG_NON_BACK_TO_BACK_IFG_PART1_SHIFT (31 -  7)       /* Non
 281                                                                   back-to-back
 282                                                                   inter frame
 283                                                                   gap part 1.
 284                                                                   << shift */
 285#define IPGIFG_NON_BACK_TO_BACK_IFG_PART2_SHIFT (31 - 15)       /* Non
 286                                                                   back-to-back
 287                                                                   inter frame
 288                                                                   gap part 2.
 289                                                                   << shift */
 290#define IPGIFG_MINIMUM_IFG_ENFORCEMENT_SHIFT    (31 - 23)       /* Mimimum IFG
 291                                                                   Enforcement
 292                                                                   << shift */
 293#define IPGIFG_BACK_TO_BACK_IFG_SHIFT           (31 - 31)       /* back-to-back
 294                                                                   inter frame
 295                                                                   gap << shift
 296                                                                 */
 297#define IPGIFG_NON_BACK_TO_BACK_IFG_PART1_MAX   127     /* Non back-to-back
 298                                                           inter frame gap part
 299                                                           1. max val */
 300#define IPGIFG_NON_BACK_TO_BACK_IFG_PART2_MAX   127     /* Non back-to-back
 301                                                           inter frame gap part
 302                                                           2. max val */
 303#define IPGIFG_MINIMUM_IFG_ENFORCEMENT_MAX      255     /* Mimimum IFG
 304                                                           Enforcement max val */
 305#define IPGIFG_BACK_TO_BACK_IFG_MAX             127     /* back-to-back inter
 306                                                           frame gap max val */
 307#define IPGIFG_NBTB_CS_IPG_MASK                 0x7F000000
 308#define IPGIFG_NBTB_IPG_MASK                    0x007F0000
 309#define IPGIFG_MIN_IFG_MASK                     0x0000FF00
 310#define IPGIFG_BTB_IPG_MASK                     0x0000007F
 311
 312/* UCC GETH HAFDUP (Half Duplex Register) */
 313#define HALFDUP_ALT_BEB_TRUNCATION_SHIFT        (31 - 11)       /* Alternate
 314                                                                   Binary
 315                                                                   Exponential
 316                                                                   Backoff
 317                                                                   Truncation
 318                                                                   << shift */
 319#define HALFDUP_ALT_BEB_TRUNCATION_MAX          0xf     /* Alternate Binary
 320                                                           Exponential Backoff
 321                                                           Truncation max val */
 322#define HALFDUP_ALT_BEB                         0x00080000      /* Alternate
 323                                                                   Binary
 324                                                                   Exponential
 325                                                                   Backoff */
 326#define HALFDUP_BACK_PRESSURE_NO_BACKOFF        0x00040000      /* Back
 327                                                                   pressure no
 328                                                                   backoff */
 329#define HALFDUP_NO_BACKOFF                      0x00020000      /* No Backoff */
 330#define HALFDUP_EXCESSIVE_DEFER                 0x00010000      /* Excessive
 331                                                                   Defer */
 332#define HALFDUP_MAX_RETRANSMISSION_SHIFT        (31 - 19)       /* Maximum
 333                                                                   Retransmission
 334                                                                   << shift */
 335#define HALFDUP_MAX_RETRANSMISSION_MAX          0xf     /* Maximum
 336                                                           Retransmission max
 337                                                           val */
 338#define HALFDUP_COLLISION_WINDOW_SHIFT          (31 - 31)       /* Collision
 339                                                                   Window <<
 340                                                                   shift */
 341#define HALFDUP_COLLISION_WINDOW_MAX            0x3f    /* Collision Window max
 342                                                           val */
 343#define HALFDUP_ALT_BEB_TR_MASK                 0x00F00000
 344#define HALFDUP_RETRANS_MASK                    0x0000F000
 345#define HALFDUP_COL_WINDOW_MASK                 0x0000003F
 346
 347/* UCC GETH UCCS (Ethernet Status Register) */
 348#define UCCS_BPR                                0x02    /* Back pressure (in
 349                                                           half duplex mode) */
 350#define UCCS_PAU                                0x02    /* Pause state (in full
 351                                                           duplex mode) */
 352#define UCCS_MPD                                0x01    /* Magic Packet
 353                                                           Detected */
 354
 355/* UCC GETH IFSTAT (Interface Status Register) */
 356#define IFSTAT_EXCESS_DEFER                     0x00000200      /* Excessive
 357                                                                   transmission
 358                                                                   defer */
 359
 360/* UCC GETH MACSTNADDR1 (Station Address Part 1 Register) */
 361#define MACSTNADDR1_OCTET_6_SHIFT               (31 -  7)       /* Station
 362                                                                   address 6th
 363                                                                   octet <<
 364                                                                   shift */
 365#define MACSTNADDR1_OCTET_5_SHIFT               (31 - 15)       /* Station
 366                                                                   address 5th
 367                                                                   octet <<
 368                                                                   shift */
 369#define MACSTNADDR1_OCTET_4_SHIFT               (31 - 23)       /* Station
 370                                                                   address 4th
 371                                                                   octet <<
 372                                                                   shift */
 373#define MACSTNADDR1_OCTET_3_SHIFT               (31 - 31)       /* Station
 374                                                                   address 3rd
 375                                                                   octet <<
 376                                                                   shift */
 377
 378/* UCC GETH MACSTNADDR2 (Station Address Part 2 Register) */
 379#define MACSTNADDR2_OCTET_2_SHIFT               (31 -  7)       /* Station
 380                                                                   address 2nd
 381                                                                   octet <<
 382                                                                   shift */
 383#define MACSTNADDR2_OCTET_1_SHIFT               (31 - 15)       /* Station
 384                                                                   address 1st
 385                                                                   octet <<
 386                                                                   shift */
 387
 388/* UCC GETH UEMPR (Ethernet Mac Parameter Register) */
 389#define UEMPR_PAUSE_TIME_VALUE_SHIFT            (31 - 15)       /* Pause time
 390                                                                   value <<
 391                                                                   shift */
 392#define UEMPR_EXTENDED_PAUSE_TIME_VALUE_SHIFT   (31 - 31)       /* Extended
 393                                                                   pause time
 394                                                                   value <<
 395                                                                   shift */
 396
 397/* UCC GETH UTBIPAR (Ten Bit Interface Physical Address Register) */
 398#define UTBIPAR_PHY_ADDRESS_SHIFT               (31 - 31)       /* Phy address
 399                                                                   << shift */
 400#define UTBIPAR_PHY_ADDRESS_MASK                0x0000001f      /* Phy address
 401                                                                   mask */
 402
 403/* UCC GETH UESCR (Ethernet Statistics Control Register) */
 404#define UESCR_AUTOZ                             0x8000  /* Automatically zero
 405                                                           addressed
 406                                                           statistical counter
 407                                                           values */
 408#define UESCR_CLRCNT                            0x4000  /* Clear all statistics
 409                                                           counters */
 410#define UESCR_MAXCOV_SHIFT                      (15 -  7)       /* Max
 411                                                                   Coalescing
 412                                                                   Value <<
 413                                                                   shift */
 414#define UESCR_SCOV_SHIFT                        (15 - 15)       /* Status
 415                                                                   Coalescing
 416                                                                   Value <<
 417                                                                   shift */
 418
 419/* UCC GETH UDSR (Data Synchronization Register) */
 420#define UDSR_MAGIC                              0x067E
 421
 422struct ucc_geth_thread_data_tx {
 423        u8 res0[104];
 424} __packed;
 425
 426struct ucc_geth_thread_data_rx {
 427        u8 res0[40];
 428} __packed;
 429
 430/* Send Queue Queue-Descriptor */
 431struct ucc_geth_send_queue_qd {
 432        u32 bd_ring_base;       /* pointer to BD ring base address */
 433        u8 res0[0x8];
 434        u32 last_bd_completed_address;/* initialize to last entry in BD ring */
 435        u8 res1[0x30];
 436} __packed;
 437
 438struct ucc_geth_send_queue_mem_region {
 439        struct ucc_geth_send_queue_qd sqqd[NUM_TX_QUEUES];
 440} __packed;
 441
 442struct ucc_geth_thread_tx_pram {
 443        u8 res0[64];
 444} __packed;
 445
 446struct ucc_geth_thread_rx_pram {
 447        u8 res0[128];
 448} __packed;
 449
 450#define THREAD_RX_PRAM_ADDITIONAL_FOR_EXTENDED_FILTERING        64
 451#define THREAD_RX_PRAM_ADDITIONAL_FOR_EXTENDED_FILTERING_8      64
 452#define THREAD_RX_PRAM_ADDITIONAL_FOR_EXTENDED_FILTERING_16     96
 453
 454struct ucc_geth_scheduler {
 455        u16 cpucount0;          /* CPU packet counter */
 456        u16 cpucount1;          /* CPU packet counter */
 457        u16 cecount0;           /* QE packet counter */
 458        u16 cecount1;           /* QE packet counter */
 459        u16 cpucount2;          /* CPU packet counter */
 460        u16 cpucount3;          /* CPU packet counter */
 461        u16 cecount2;           /* QE packet counter */
 462        u16 cecount3;           /* QE packet counter */
 463        u16 cpucount4;          /* CPU packet counter */
 464        u16 cpucount5;          /* CPU packet counter */
 465        u16 cecount4;           /* QE packet counter */
 466        u16 cecount5;           /* QE packet counter */
 467        u16 cpucount6;          /* CPU packet counter */
 468        u16 cpucount7;          /* CPU packet counter */
 469        u16 cecount6;           /* QE packet counter */
 470        u16 cecount7;           /* QE packet counter */
 471        u32 weightstatus[NUM_TX_QUEUES];        /* accumulated weight factor */
 472        u32 rtsrshadow;         /* temporary variable handled by QE */
 473        u32 time;               /* temporary variable handled by QE */
 474        u32 ttl;                /* temporary variable handled by QE */
 475        u32 mblinterval;        /* max burst length interval */
 476        u16 nortsrbytetime;     /* normalized value of byte time in tsr units */
 477        u8 fracsiz;             /* radix 2 log value of denom. of
 478                                   NorTSRByteTime */
 479        u8 res0[1];
 480        u8 strictpriorityq;     /* Strict Priority Mask register */
 481        u8 txasap;              /* Transmit ASAP register */
 482        u8 extrabw;             /* Extra BandWidth register */
 483        u8 oldwfqmask;          /* temporary variable handled by QE */
 484        u8 weightfactor[NUM_TX_QUEUES];
 485                                      /**< weight factor for queues   */
 486        u32 minw;               /* temporary variable handled by QE */
 487        u8 res1[0x70 - 0x64];
 488} __packed;
 489
 490struct ucc_geth_tx_firmware_statistics_pram {
 491        u32 sicoltx;            /* single collision */
 492        u32 mulcoltx;           /* multiple collision */
 493        u32 latecoltxfr;        /* late collision */
 494        u32 frabortduecol;      /* frames aborted due to transmit collision */
 495        u32 frlostinmactxer;    /* frames lost due to internal MAC error
 496                                   transmission that are not counted on any
 497                                   other counter */
 498        u32 carriersenseertx;   /* carrier sense error */
 499        u32 frtxok;             /* frames transmitted OK */
 500        u32 txfrexcessivedefer; /* frames with defferal time greater than
 501                                   specified threshold */
 502        u32 txpkts256;          /* total packets (including bad) between 256
 503                                   and 511 octets */
 504        u32 txpkts512;          /* total packets (including bad) between 512
 505                                   and 1023 octets */
 506        u32 txpkts1024;         /* total packets (including bad) between 1024
 507                                   and 1518 octets */
 508        u32 txpktsjumbo;        /* total packets (including bad) between 1024
 509                                   and MAXLength octets */
 510} __packed;
 511
 512struct ucc_geth_rx_firmware_statistics_pram {
 513        u32 frrxfcser;          /* frames with crc error */
 514        u32 fraligner;          /* frames with alignment error */
 515        u32 inrangelenrxer;     /* in range length error */
 516        u32 outrangelenrxer;    /* out of range length error */
 517        u32 frtoolong;          /* frame too long */
 518        u32 runt;               /* runt */
 519        u32 verylongevent;      /* very long event */
 520        u32 symbolerror;        /* symbol error */
 521        u32 dropbsy;            /* drop because of BD not ready */
 522        u8 res0[0x8];
 523        u32 mismatchdrop;       /* drop because of MAC filtering (e.g. address
 524                                   or type mismatch) */
 525        u32 underpkts;          /* total frames less than 64 octets */
 526        u32 pkts256;            /* total frames (including bad) between 256 and
 527                                   511 octets */
 528        u32 pkts512;            /* total frames (including bad) between 512 and
 529                                   1023 octets */
 530        u32 pkts1024;           /* total frames (including bad) between 1024
 531                                   and 1518 octets */
 532        u32 pktsjumbo;          /* total frames (including bad) between 1024
 533                                   and MAXLength octets */
 534        u32 frlossinmacer;      /* frames lost because of internal MAC error
 535                                   that is not counted in any other counter */
 536        u32 pausefr;            /* pause frames */
 537        u8 res1[0x4];
 538        u32 removevlan;         /* total frames that had their VLAN tag removed
 539                                 */
 540        u32 replacevlan;        /* total frames that had their VLAN tag
 541                                   replaced */
 542        u32 insertvlan;         /* total frames that had their VLAN tag
 543                                   inserted */
 544} __packed;
 545
 546struct ucc_geth_rx_interrupt_coalescing_entry {
 547        u32 interruptcoalescingmaxvalue;        /* interrupt coalescing max
 548                                                   value */
 549        u32 interruptcoalescingcounter; /* interrupt coalescing counter,
 550                                           initialize to
 551                                           interruptcoalescingmaxvalue */
 552} __packed;
 553
 554struct ucc_geth_rx_interrupt_coalescing_table {
 555        struct ucc_geth_rx_interrupt_coalescing_entry coalescingentry[NUM_RX_QUEUES];
 556                                       /**< interrupt coalescing entry */
 557} __packed;
 558
 559struct ucc_geth_rx_prefetched_bds {
 560        struct qe_bd bd[NUM_BDS_IN_PREFETCHED_BDS];     /* prefetched bd */
 561} __packed;
 562
 563struct ucc_geth_rx_bd_queues_entry {
 564        u32 bdbaseptr;          /* BD base pointer */
 565        u32 bdptr;              /* BD pointer */
 566        u32 externalbdbaseptr;  /* external BD base pointer */
 567        u32 externalbdptr;      /* external BD pointer */
 568} __packed;
 569
 570struct ucc_geth_tx_global_pram {
 571        u16 temoder;
 572        u8 res0[0x38 - 0x02];
 573        u32 sqptr;              /* a base pointer to send queue memory region */
 574        u32 schedulerbasepointer;       /* a base pointer to scheduler memory
 575                                           region */
 576        u32 txrmonbaseptr;      /* base pointer to Tx RMON statistics counter */
 577        u32 tstate;             /* tx internal state. High byte contains
 578                                   function code */
 579        u8 iphoffset[TX_IP_OFFSET_ENTRY_MAX];
 580        u32 vtagtable[0x8];     /* 8 4-byte VLAN tags */
 581        u32 tqptr;              /* a base pointer to the Tx Queues Memory
 582                                   Region */
 583        u8 res2[0x80 - 0x74];
 584} __packed;
 585
 586/* structure representing Extended Filtering Global Parameters in PRAM */
 587struct ucc_geth_exf_global_pram {
 588        u32 l2pcdptr;           /* individual address filter, high */
 589        u8 res0[0x10 - 0x04];
 590} __packed;
 591
 592struct ucc_geth_rx_global_pram {
 593        u32 remoder;            /* ethernet mode reg. */
 594        u32 rqptr;              /* base pointer to the Rx Queues Memory Region*/
 595        u32 res0[0x1];
 596        u8 res1[0x20 - 0xC];
 597        u16 typeorlen;          /* cutoff point less than which, type/len field
 598                                   is considered length */
 599        u8 res2[0x1];
 600        u8 rxgstpack;           /* acknowledgement on GRACEFUL STOP RX command*/
 601        u32 rxrmonbaseptr;      /* base pointer to Rx RMON statistics counter */
 602        u8 res3[0x30 - 0x28];
 603        u32 intcoalescingptr;   /* Interrupt coalescing table pointer */
 604        u8 res4[0x36 - 0x34];
 605        u8 rstate;              /* rx internal state. High byte contains
 606                                   function code */
 607        u8 res5[0x46 - 0x37];
 608        u16 mrblr;              /* max receive buffer length reg. */
 609        u32 rbdqptr;            /* base pointer to RxBD parameter table
 610                                   description */
 611        u16 mflr;               /* max frame length reg. */
 612        u16 minflr;             /* min frame length reg. */
 613        u16 maxd1;              /* max dma1 length reg. */
 614        u16 maxd2;              /* max dma2 length reg. */
 615        u32 ecamptr;            /* external CAM address */
 616        u32 l2qt;               /* VLAN priority mapping table. */
 617        u32 l3qt[0x8];          /* IP priority mapping table. */
 618        u16 vlantype;           /* vlan type */
 619        u16 vlantci;            /* default vlan tci */
 620        u8 addressfiltering[64];        /* address filtering data structure */
 621        u32 exfGlobalParam;     /* base address for extended filtering global
 622                                   parameters */
 623        u8 res6[0x100 - 0xC4];  /* Initialize to zero */
 624} __packed;
 625
 626#define GRACEFUL_STOP_ACKNOWLEDGE_RX            0x01
 627
 628/* structure representing InitEnet command */
 629struct ucc_geth_init_pram {
 630        u8 resinit1;
 631        u8 resinit2;
 632        u8 resinit3;
 633        u8 resinit4;
 634        u16 resinit5;
 635        u8 res1[0x1];
 636        u8 largestexternallookupkeysize;
 637        u32 rgftgfrxglobal;
 638        u32 rxthread[ENET_INIT_PARAM_MAX_ENTRIES_RX];   /* rx threads */
 639        u8 res2[0x38 - 0x30];
 640        u32 txglobal;           /* tx global */
 641        u32 txthread[ENET_INIT_PARAM_MAX_ENTRIES_TX];   /* tx threads */
 642        u8 res3[0x1];
 643} __packed;
 644
 645#define ENET_INIT_PARAM_RGF_SHIFT               (32 - 4)
 646#define ENET_INIT_PARAM_TGF_SHIFT               (32 - 8)
 647
 648#define ENET_INIT_PARAM_RISC_MASK               0x0000003f
 649#define ENET_INIT_PARAM_PTR_MASK                0x00ffffc0
 650#define ENET_INIT_PARAM_SNUM_MASK               0xff000000
 651#define ENET_INIT_PARAM_SNUM_SHIFT              24
 652
 653#define ENET_INIT_PARAM_MAGIC_RES_INIT1         0x06
 654#define ENET_INIT_PARAM_MAGIC_RES_INIT2         0x30
 655#define ENET_INIT_PARAM_MAGIC_RES_INIT3         0xff
 656#define ENET_INIT_PARAM_MAGIC_RES_INIT4         0x00
 657#define ENET_INIT_PARAM_MAGIC_RES_INIT5         0x0400
 658
 659/* structure representing 82xx Address Filtering Enet Address in PRAM */
 660struct ucc_geth_82xx_enet_address {
 661        u8 res1[0x2];
 662        u16 h;                  /* address (MSB) */
 663        u16 m;                  /* address */
 664        u16 l;                  /* address (LSB) */
 665} __packed;
 666
 667/* structure representing 82xx Address Filtering PRAM */
 668struct ucc_geth_82xx_address_filtering_pram {
 669        u32 iaddr_h;            /* individual address filter, high */
 670        u32 iaddr_l;            /* individual address filter, low */
 671        u32 gaddr_h;            /* group address filter, high */
 672        u32 gaddr_l;            /* group address filter, low */
 673        struct ucc_geth_82xx_enet_address __iomem taddr;
 674        struct ucc_geth_82xx_enet_address __iomem paddr[NUM_OF_PADDRS];
 675        u8 res0[0x40 - 0x38];
 676} __packed;
 677
 678/* GETH Tx firmware statistics structure, used when calling
 679   UCC_GETH_GetStatistics. */
 680struct ucc_geth_tx_firmware_statistics {
 681        u32 sicoltx;            /* single collision */
 682        u32 mulcoltx;           /* multiple collision */
 683        u32 latecoltxfr;        /* late collision */
 684        u32 frabortduecol;      /* frames aborted due to transmit collision */
 685        u32 frlostinmactxer;    /* frames lost due to internal MAC error
 686                                   transmission that are not counted on any
 687                                   other counter */
 688        u32 carriersenseertx;   /* carrier sense error */
 689        u32 frtxok;             /* frames transmitted OK */
 690        u32 txfrexcessivedefer; /* frames with defferal time greater than
 691                                   specified threshold */
 692        u32 txpkts256;          /* total packets (including bad) between 256
 693                                   and 511 octets */
 694        u32 txpkts512;          /* total packets (including bad) between 512
 695                                   and 1023 octets */
 696        u32 txpkts1024;         /* total packets (including bad) between 1024
 697                                   and 1518 octets */
 698        u32 txpktsjumbo;        /* total packets (including bad) between 1024
 699                                   and MAXLength octets */
 700} __packed;
 701
 702/* GETH Rx firmware statistics structure, used when calling
 703   UCC_GETH_GetStatistics. */
 704struct ucc_geth_rx_firmware_statistics {
 705        u32 frrxfcser;          /* frames with crc error */
 706        u32 fraligner;          /* frames with alignment error */
 707        u32 inrangelenrxer;     /* in range length error */
 708        u32 outrangelenrxer;    /* out of range length error */
 709        u32 frtoolong;          /* frame too long */
 710        u32 runt;               /* runt */
 711        u32 verylongevent;      /* very long event */
 712        u32 symbolerror;        /* symbol error */
 713        u32 dropbsy;            /* drop because of BD not ready */
 714        u8 res0[0x8];
 715        u32 mismatchdrop;       /* drop because of MAC filtering (e.g. address
 716                                   or type mismatch) */
 717        u32 underpkts;          /* total frames less than 64 octets */
 718        u32 pkts256;            /* total frames (including bad) between 256 and
 719                                   511 octets */
 720        u32 pkts512;            /* total frames (including bad) between 512 and
 721                                   1023 octets */
 722        u32 pkts1024;           /* total frames (including bad) between 1024
 723                                   and 1518 octets */
 724        u32 pktsjumbo;          /* total frames (including bad) between 1024
 725                                   and MAXLength octets */
 726        u32 frlossinmacer;      /* frames lost because of internal MAC error
 727                                   that is not counted in any other counter */
 728        u32 pausefr;            /* pause frames */
 729        u8 res1[0x4];
 730        u32 removevlan;         /* total frames that had their VLAN tag removed
 731                                 */
 732        u32 replacevlan;        /* total frames that had their VLAN tag
 733                                   replaced */
 734        u32 insertvlan;         /* total frames that had their VLAN tag
 735                                   inserted */
 736} __packed;
 737
 738/* GETH hardware statistics structure, used when calling
 739   UCC_GETH_GetStatistics. */
 740struct ucc_geth_hardware_statistics {
 741        u32 tx64;               /* Total number of frames (including bad
 742                                   frames) transmitted that were exactly of the
 743                                   minimal length (64 for un tagged, 68 for
 744                                   tagged, or with length exactly equal to the
 745                                   parameter MINLength */
 746        u32 tx127;              /* Total number of frames (including bad
 747                                   frames) transmitted that were between
 748                                   MINLength (Including FCS length==4) and 127
 749                                   octets */
 750        u32 tx255;              /* Total number of frames (including bad
 751                                   frames) transmitted that were between 128
 752                                   (Including FCS length==4) and 255 octets */
 753        u32 rx64;               /* Total number of frames received including
 754                                   bad frames that were exactly of the mninimal
 755                                   length (64 bytes) */
 756        u32 rx127;              /* Total number of frames (including bad
 757                                   frames) received that were between MINLength
 758                                   (Including FCS length==4) and 127 octets */
 759        u32 rx255;              /* Total number of frames (including bad
 760                                   frames) received that were between 128
 761                                   (Including FCS length==4) and 255 octets */
 762        u32 txok;               /* Total number of octets residing in frames
 763                                   that where involved in successful
 764                                   transmission */
 765        u16 txcf;               /* Total number of PAUSE control frames
 766                                   transmitted by this MAC */
 767        u32 tmca;               /* Total number of frames that were transmitted
 768                                   successfully with the group address bit set
 769                                   that are not broadcast frames */
 770        u32 tbca;               /* Total number of frames transmitted
 771                                   successfully that had destination address
 772                                   field equal to the broadcast address */
 773        u32 rxfok;              /* Total number of frames received OK */
 774        u32 rxbok;              /* Total number of octets received OK */
 775        u32 rbyt;               /* Total number of octets received including
 776                                   octets in bad frames. Must be implemented in
 777                                   HW because it includes octets in frames that
 778                                   never even reach the UCC */
 779        u32 rmca;               /* Total number of frames that were received
 780                                   successfully with the group address bit set
 781                                   that are not broadcast frames */
 782        u32 rbca;               /* Total number of frames received successfully
 783                                   that had destination address equal to the
 784                                   broadcast address */
 785} __packed;
 786
 787/* UCC GETH Tx errors returned via TxConf callback */
 788#define TX_ERRORS_DEF      0x0200
 789#define TX_ERRORS_EXDEF    0x0100
 790#define TX_ERRORS_LC       0x0080
 791#define TX_ERRORS_RL       0x0040
 792#define TX_ERRORS_RC_MASK  0x003C
 793#define TX_ERRORS_RC_SHIFT 2
 794#define TX_ERRORS_UN       0x0002
 795#define TX_ERRORS_CSL      0x0001
 796
 797/* UCC GETH Rx errors returned via RxStore callback */
 798#define RX_ERRORS_CMR      0x0200
 799#define RX_ERRORS_M        0x0100
 800#define RX_ERRORS_BC       0x0080
 801#define RX_ERRORS_MC       0x0040
 802
 803/* Transmit BD. These are in addition to values defined in uccf. */
 804#define T_VID      0x003c0000   /* insert VLAN id index mask. */
 805#define T_DEF      (((u32) TX_ERRORS_DEF     ) << 16)
 806#define T_EXDEF    (((u32) TX_ERRORS_EXDEF   ) << 16)
 807#define T_LC       (((u32) TX_ERRORS_LC      ) << 16)
 808#define T_RL       (((u32) TX_ERRORS_RL      ) << 16)
 809#define T_RC_MASK  (((u32) TX_ERRORS_RC_MASK ) << 16)
 810#define T_UN       (((u32) TX_ERRORS_UN      ) << 16)
 811#define T_CSL      (((u32) TX_ERRORS_CSL     ) << 16)
 812#define T_ERRORS_REPORT  (T_DEF | T_EXDEF | T_LC | T_RL | T_RC_MASK \
 813                | T_UN | T_CSL) /* transmit errors to report */
 814
 815/* Receive BD. These are in addition to values defined in uccf. */
 816#define R_LG    0x00200000      /* Frame length violation.  */
 817#define R_NO    0x00100000      /* Non-octet aligned frame.  */
 818#define R_SH    0x00080000      /* Short frame.  */
 819#define R_CR    0x00040000      /* CRC error.  */
 820#define R_OV    0x00020000      /* Overrun.  */
 821#define R_IPCH  0x00010000      /* IP checksum check failed. */
 822#define R_CMR   (((u32) RX_ERRORS_CMR  ) << 16)
 823#define R_M     (((u32) RX_ERRORS_M    ) << 16)
 824#define R_BC    (((u32) RX_ERRORS_BC   ) << 16)
 825#define R_MC    (((u32) RX_ERRORS_MC   ) << 16)
 826#define R_ERRORS_REPORT (R_CMR | R_M | R_BC | R_MC)     /* receive errors to
 827                                                           report */
 828#define R_ERRORS_FATAL  (R_LG  | R_NO | R_SH | R_CR | \
 829                R_OV | R_IPCH)  /* receive errors to discard */
 830
 831/* Alignments */
 832#define UCC_GETH_RX_GLOBAL_PRAM_ALIGNMENT       256
 833#define UCC_GETH_TX_GLOBAL_PRAM_ALIGNMENT       128
 834#define UCC_GETH_THREAD_RX_PRAM_ALIGNMENT       128
 835#define UCC_GETH_THREAD_TX_PRAM_ALIGNMENT       64
 836#define UCC_GETH_THREAD_DATA_ALIGNMENT          256     /* spec gives values
 837                                                           based on num of
 838                                                           threads, but always
 839                                                           using the maximum is
 840                                                           easier */
 841#define UCC_GETH_SEND_QUEUE_QUEUE_DESCRIPTOR_ALIGNMENT  32
 842#define UCC_GETH_SCHEDULER_ALIGNMENT            8       /* This is a guess */
 843#define UCC_GETH_TX_STATISTICS_ALIGNMENT        4       /* This is a guess */
 844#define UCC_GETH_RX_STATISTICS_ALIGNMENT        4       /* This is a guess */
 845#define UCC_GETH_RX_INTERRUPT_COALESCING_ALIGNMENT      64
 846#define UCC_GETH_RX_BD_QUEUES_ALIGNMENT         8       /* This is a guess */
 847#define UCC_GETH_RX_PREFETCHED_BDS_ALIGNMENT    128     /* This is a guess */
 848#define UCC_GETH_RX_EXTENDED_FILTERING_GLOBAL_PARAMETERS_ALIGNMENT 8    /* This
 849                                                                           is a
 850                                                                           guess
 851                                                                         */
 852#define UCC_GETH_RX_BD_RING_ALIGNMENT           32
 853#define UCC_GETH_TX_BD_RING_ALIGNMENT           32
 854#define UCC_GETH_MRBLR_ALIGNMENT                128
 855#define UCC_GETH_RX_BD_RING_SIZE_ALIGNMENT      4
 856#define UCC_GETH_TX_BD_RING_SIZE_MEMORY_ALIGNMENT       32
 857#define UCC_GETH_RX_DATA_BUF_ALIGNMENT          64
 858
 859#define UCC_GETH_TAD_EF                         0x80
 860#define UCC_GETH_TAD_V                          0x40
 861#define UCC_GETH_TAD_REJ                        0x20
 862#define UCC_GETH_TAD_VTAG_OP_RIGHT_SHIFT        2
 863#define UCC_GETH_TAD_VTAG_OP_SHIFT              6
 864#define UCC_GETH_TAD_V_NON_VTAG_OP              0x20
 865#define UCC_GETH_TAD_RQOS_SHIFT                 0
 866#define UCC_GETH_TAD_V_PRIORITY_SHIFT           5
 867#define UCC_GETH_TAD_CFI                        0x10
 868
 869#define UCC_GETH_VLAN_PRIORITY_MAX              8
 870#define UCC_GETH_IP_PRIORITY_MAX                64
 871#define UCC_GETH_TX_VTAG_TABLE_ENTRY_MAX        8
 872#define UCC_GETH_RX_BD_RING_SIZE_MIN            8
 873#define UCC_GETH_TX_BD_RING_SIZE_MIN            2
 874#define UCC_GETH_BD_RING_SIZE_MAX               0xffff
 875
 876#define UCC_GETH_SIZE_OF_BD                     QE_SIZEOF_BD
 877
 878/* Driver definitions */
 879#define TX_BD_RING_LEN                          0x10
 880#define RX_BD_RING_LEN                          0x20
 881
 882#define TX_RING_MOD_MASK(size)                  (size-1)
 883#define RX_RING_MOD_MASK(size)                  (size-1)
 884
 885#define ENET_GROUP_ADDR                         0x01    /* Group address mask
 886                                                           for ethernet
 887                                                           addresses */
 888
 889#define TX_TIMEOUT                              (1*HZ)
 890#define SKB_ALLOC_TIMEOUT                       100000
 891#define PHY_INIT_TIMEOUT                        100000
 892#define PHY_CHANGE_TIME                         2
 893
 894/* Fast Ethernet (10/100 Mbps) */
 895#define UCC_GETH_URFS_INIT                      512     /* Rx virtual FIFO size
 896                                                         */
 897#define UCC_GETH_URFET_INIT                     256     /* 1/2 urfs */
 898#define UCC_GETH_URFSET_INIT                    384     /* 3/4 urfs */
 899#define UCC_GETH_UTFS_INIT                      512     /* Tx virtual FIFO size
 900                                                         */
 901#define UCC_GETH_UTFET_INIT                     256     /* 1/2 utfs */
 902#define UCC_GETH_UTFTT_INIT                     256     /* 1/2 utfs
 903                                                           due to errata */
 904/* Gigabit Ethernet (1000 Mbps) */
 905#define UCC_GETH_URFS_GIGA_INIT                 4096/*2048*/    /* Rx virtual
 906                                                                   FIFO size */
 907#define UCC_GETH_URFET_GIGA_INIT                2048/*1024*/    /* 1/2 urfs */
 908#define UCC_GETH_URFSET_GIGA_INIT               3072/*1536*/    /* 3/4 urfs */
 909#define UCC_GETH_UTFS_GIGA_INIT                 4096/*2048*/    /* Tx virtual
 910                                                                   FIFO size */
 911#define UCC_GETH_UTFET_GIGA_INIT                2048/*1024*/    /* 1/2 utfs */
 912#define UCC_GETH_UTFTT_GIGA_INIT                4096/*0x40*/    /* Tx virtual
 913                                                                   FIFO size */
 914
 915#define UCC_GETH_REMODER_INIT                   0       /* bits that must be
 916                                                           set */
 917#define UCC_GETH_TEMODER_INIT                   0xC000  /* bits that must */
 918
 919/* Initial value for UPSMR */
 920#define UCC_GETH_UPSMR_INIT                     UCC_GETH_UPSMR_RES1
 921
 922#define UCC_GETH_MACCFG1_INIT                   0
 923#define UCC_GETH_MACCFG2_INIT                   (MACCFG2_RESERVED_1)
 924
 925/* Ethernet Address Type. */
 926enum enet_addr_type {
 927        ENET_ADDR_TYPE_INDIVIDUAL,
 928        ENET_ADDR_TYPE_GROUP,
 929        ENET_ADDR_TYPE_BROADCAST
 930};
 931
 932/* UCC GETH 82xx Ethernet Address Recognition Location */
 933enum ucc_geth_enet_address_recognition_location {
 934        UCC_GETH_ENET_ADDRESS_RECOGNITION_LOCATION_STATION_ADDRESS,/* station
 935                                                                      address */
 936        UCC_GETH_ENET_ADDRESS_RECOGNITION_LOCATION_PADDR_FIRST, /* additional
 937                                                                   station
 938                                                                   address
 939                                                                   paddr1 */
 940        UCC_GETH_ENET_ADDRESS_RECOGNITION_LOCATION_PADDR2,      /* additional
 941                                                                   station
 942                                                                   address
 943                                                                   paddr2 */
 944        UCC_GETH_ENET_ADDRESS_RECOGNITION_LOCATION_PADDR3,      /* additional
 945                                                                   station
 946                                                                   address
 947                                                                   paddr3 */
 948        UCC_GETH_ENET_ADDRESS_RECOGNITION_LOCATION_PADDR_LAST,  /* additional
 949                                                                   station
 950                                                                   address
 951                                                                   paddr4 */
 952        UCC_GETH_ENET_ADDRESS_RECOGNITION_LOCATION_GROUP_HASH,  /* group hash */
 953        UCC_GETH_ENET_ADDRESS_RECOGNITION_LOCATION_INDIVIDUAL_HASH /* individual
 954                                                                      hash */
 955};
 956
 957/* UCC GETH vlan operation tagged */
 958enum ucc_geth_vlan_operation_tagged {
 959        UCC_GETH_VLAN_OPERATION_TAGGED_NOP = 0x0,       /* Tagged - nop */
 960        UCC_GETH_VLAN_OPERATION_TAGGED_REPLACE_VID_PORTION_OF_Q_TAG
 961                = 0x1,  /* Tagged - replace vid portion of q tag */
 962        UCC_GETH_VLAN_OPERATION_TAGGED_IF_VID0_REPLACE_VID_WITH_DEFAULT_VALUE
 963                = 0x2,  /* Tagged - if vid0 replace vid with default value  */
 964        UCC_GETH_VLAN_OPERATION_TAGGED_EXTRACT_Q_TAG_FROM_FRAME
 965                = 0x3   /* Tagged - extract q tag from frame */
 966};
 967
 968/* UCC GETH vlan operation non-tagged */
 969enum ucc_geth_vlan_operation_non_tagged {
 970        UCC_GETH_VLAN_OPERATION_NON_TAGGED_NOP = 0x0,   /* Non tagged - nop */
 971        UCC_GETH_VLAN_OPERATION_NON_TAGGED_Q_TAG_INSERT = 0x1   /* Non tagged -
 972                                                                   q tag insert
 973                                                                 */
 974};
 975
 976/* UCC GETH Rx Quality of Service Mode */
 977enum ucc_geth_qos_mode {
 978        UCC_GETH_QOS_MODE_DEFAULT = 0x0,        /* default queue */
 979        UCC_GETH_QOS_MODE_QUEUE_NUM_FROM_L2_CRITERIA = 0x1,     /* queue
 980                                                                   determined
 981                                                                   by L2
 982                                                                   criteria */
 983        UCC_GETH_QOS_MODE_QUEUE_NUM_FROM_L3_CRITERIA = 0x2      /* queue
 984                                                                   determined
 985                                                                   by L3
 986                                                                   criteria */
 987};
 988
 989/* UCC GETH Statistics Gathering Mode - These are bit flags, 'or' them together
 990   for combined functionality */
 991enum ucc_geth_statistics_gathering_mode {
 992        UCC_GETH_STATISTICS_GATHERING_MODE_NONE = 0x00000000,   /* No
 993                                                                   statistics
 994                                                                   gathering */
 995        UCC_GETH_STATISTICS_GATHERING_MODE_HARDWARE = 0x00000001,/* Enable
 996                                                                    hardware
 997                                                                    statistics
 998                                                                    gathering
 999                                                                  */
1000        UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_TX = 0x00000004,/*Enable

1001                                                                      firmware
1002                                                                      tx
1003                                                                      statistics
1004                                                                      gathering
1005                                                                     */
1006        UCC_GETH_STATISTICS_GATHERING_MODE_FIRMWARE_RX = 0x00000008/* Enable
1007                                                                      firmware
1008                                                                      rx
1009                                                                      statistics
1010                                                                      gathering
1011                                                                    */
1012};
1013
1014/* UCC GETH Pad and CRC Mode - Note, Padding without CRC is not possible */
1015enum ucc_geth_maccfg2_pad_and_crc_mode {
1016        UCC_GETH_PAD_AND_CRC_MODE_NONE
1017                = MACCFG2_PAD_AND_CRC_MODE_NONE,        /* Neither Padding
1018                                                           short frames
1019                                                           nor CRC */
1020        UCC_GETH_PAD_AND_CRC_MODE_CRC_ONLY
1021                = MACCFG2_PAD_AND_CRC_MODE_CRC_ONLY,    /* Append
1022                                                           CRC only */
1023        UCC_GETH_PAD_AND_CRC_MODE_PAD_AND_CRC =
1024            MACCFG2_PAD_AND_CRC_MODE_PAD_AND_CRC
1025};
1026
1027/* UCC GETH upsmr Flow Control Mode */
1028enum ucc_geth_flow_control_mode {
1029        UPSMR_AUTOMATIC_FLOW_CONTROL_MODE_NONE = 0x00000000,    /* No automatic
1030                                                                   flow control
1031                                                                 */
1032        UPSMR_AUTOMATIC_FLOW_CONTROL_MODE_PAUSE_WHEN_EMERGENCY
1033                = 0x00004000    /* Send pause frame when RxFIFO reaches its
1034                                   emergency threshold */
1035};
1036
1037/* UCC GETH number of threads */
1038enum ucc_geth_num_of_threads {
1039        UCC_GETH_NUM_OF_THREADS_1 = 0x1,        /* 1 */
1040        UCC_GETH_NUM_OF_THREADS_2 = 0x2,        /* 2 */
1041        UCC_GETH_NUM_OF_THREADS_4 = 0x0,        /* 4 */
1042        UCC_GETH_NUM_OF_THREADS_6 = 0x3,        /* 6 */
1043        UCC_GETH_NUM_OF_THREADS_8 = 0x4 /* 8 */
1044};
1045
1046/* UCC GETH number of station addresses */
1047enum ucc_geth_num_of_station_addresses {
1048        UCC_GETH_NUM_OF_STATION_ADDRESSES_1,    /* 1 */
1049        UCC_GETH_NUM_OF_STATION_ADDRESSES_5     /* 5 */
1050};
1051
1052/* UCC GETH 82xx Ethernet Address Container */
1053struct enet_addr_container {
1054        u8 address[ETH_ALEN];   /* ethernet address */
1055        enum ucc_geth_enet_address_recognition_location location;       /* location in
1056                                                                   82xx address
1057                                                                   recognition
1058                                                                   hardware */
1059        struct list_head node;
1060};
1061
1062#define ENET_ADDR_CONT_ENTRY(ptr) list_entry(ptr, struct enet_addr_container, node)
1063
1064/* UCC GETH Termination Action Descriptor (TAD) structure. */
1065struct ucc_geth_tad_params {
1066        int rx_non_dynamic_extended_features_mode;
1067        int reject_frame;
1068        enum ucc_geth_vlan_operation_tagged vtag_op;
1069        enum ucc_geth_vlan_operation_non_tagged vnontag_op;
1070        enum ucc_geth_qos_mode rqos;
1071        u8 vpri;
1072        u16 vid;
1073};
1074
1075/* GETH protocol initialization structure */
1076struct ucc_geth_info {
1077        struct ucc_fast_info uf_info;
1078        u8 numQueuesTx;
1079        u8 numQueuesRx;
1080        int ipCheckSumCheck;
1081        int ipCheckSumGenerate;
1082        int rxExtendedFiltering;
1083        u32 extendedFilteringChainPointer;
1084        u16 typeorlen;
1085        int dynamicMaxFrameLength;
1086        int dynamicMinFrameLength;
1087        u8 nonBackToBackIfgPart1;
1088        u8 nonBackToBackIfgPart2;
1089        u8 miminumInterFrameGapEnforcement;
1090        u8 backToBackInterFrameGap;
1091        int ipAddressAlignment;
1092        int lengthCheckRx;
1093        u32 mblinterval;
1094        u16 nortsrbytetime;
1095        u8 fracsiz;
1096        u8 strictpriorityq;
1097        u8 txasap;
1098        u8 extrabw;
1099        int miiPreambleSupress;
1100        u8 altBebTruncation;
1101        int altBeb;
1102        int backPressureNoBackoff;
1103        int noBackoff;
1104        int excessDefer;
1105        u8 maxRetransmission;
1106        u8 collisionWindow;
1107        int pro;
1108        int cap;
1109        int rsh;
1110        int rlpb;
1111        int cam;
1112        int bro;
1113        int ecm;
1114        int receiveFlowControl;
1115        int transmitFlowControl;
1116        u8 maxGroupAddrInHash;
1117        u8 maxIndAddrInHash;
1118        u8 prel;
1119        u16 maxFrameLength;
1120        u16 minFrameLength;
1121        u16 maxD1Length;
1122        u16 maxD2Length;
1123        u16 vlantype;
1124        u16 vlantci;
1125        u32 ecamptr;
1126        u32 eventRegMask;
1127        u16 pausePeriod;
1128        u16 extensionField;
1129        struct device_node *phy_node;
1130        struct device_node *tbi_node;
1131        u8 weightfactor[NUM_TX_QUEUES];
1132        u8 interruptcoalescingmaxvalue[NUM_RX_QUEUES];
1133        u8 l2qt[UCC_GETH_VLAN_PRIORITY_MAX];
1134        u8 l3qt[UCC_GETH_IP_PRIORITY_MAX];
1135        u32 vtagtable[UCC_GETH_TX_VTAG_TABLE_ENTRY_MAX];
1136        u8 iphoffset[TX_IP_OFFSET_ENTRY_MAX];
1137        u16 bdRingLenTx[NUM_TX_QUEUES];
1138        u16 bdRingLenRx[NUM_RX_QUEUES];
1139        enum ucc_geth_num_of_station_addresses numStationAddresses;
1140        enum qe_fltr_largest_external_tbl_lookup_key_size
1141            largestexternallookupkeysize;
1142        enum ucc_geth_statistics_gathering_mode statisticsMode;
1143        enum ucc_geth_vlan_operation_tagged vlanOperationTagged;
1144        enum ucc_geth_vlan_operation_non_tagged vlanOperationNonTagged;
1145        enum ucc_geth_qos_mode rxQoSMode;
1146        enum ucc_geth_flow_control_mode aufc;
1147        enum ucc_geth_maccfg2_pad_and_crc_mode padAndCrc;
1148        enum ucc_geth_num_of_threads numThreadsTx;
1149        enum ucc_geth_num_of_threads numThreadsRx;
1150        unsigned int riscTx;
1151        unsigned int riscRx;
1152};
1153
1154/* structure representing UCC GETH */
1155struct ucc_geth_private {
1156        struct ucc_geth_info *ug_info;
1157        struct ucc_fast_private *uccf;
1158        struct device *dev;
1159        struct net_device *ndev;
1160        struct napi_struct napi;
1161        struct work_struct timeout_work;
1162        struct ucc_geth __iomem *ug_regs;
1163        struct ucc_geth_init_pram *p_init_enet_param_shadow;
1164        struct ucc_geth_exf_global_pram __iomem *p_exf_glbl_param;
1165        u32 exf_glbl_param_offset;
1166        struct ucc_geth_rx_global_pram __iomem *p_rx_glbl_pram;
1167        u32 rx_glbl_pram_offset;
1168        struct ucc_geth_tx_global_pram __iomem *p_tx_glbl_pram;
1169        u32 tx_glbl_pram_offset;
1170        struct ucc_geth_send_queue_mem_region __iomem *p_send_q_mem_reg;
1171        u32 send_q_mem_reg_offset;
1172        struct ucc_geth_thread_data_tx __iomem *p_thread_data_tx;
1173        u32 thread_dat_tx_offset;
1174        struct ucc_geth_thread_data_rx __iomem *p_thread_data_rx;
1175        u32 thread_dat_rx_offset;
1176        struct ucc_geth_scheduler __iomem *p_scheduler;
1177        u32 scheduler_offset;
1178        struct ucc_geth_tx_firmware_statistics_pram __iomem *p_tx_fw_statistics_pram;
1179        u32 tx_fw_statistics_pram_offset;
1180        struct ucc_geth_rx_firmware_statistics_pram __iomem *p_rx_fw_statistics_pram;
1181        u32 rx_fw_statistics_pram_offset;
1182        struct ucc_geth_rx_interrupt_coalescing_table __iomem *p_rx_irq_coalescing_tbl;
1183        u32 rx_irq_coalescing_tbl_offset;
1184        struct ucc_geth_rx_bd_queues_entry __iomem *p_rx_bd_qs_tbl;
1185        u32 rx_bd_qs_tbl_offset;
1186        u8 __iomem *p_tx_bd_ring[NUM_TX_QUEUES];
1187        u32 tx_bd_ring_offset[NUM_TX_QUEUES];
1188        u8 __iomem *p_rx_bd_ring[NUM_RX_QUEUES];
1189        u32 rx_bd_ring_offset[NUM_RX_QUEUES];
1190        u8 __iomem *confBd[NUM_TX_QUEUES];
1191        u8 __iomem *txBd[NUM_TX_QUEUES];
1192        u8 __iomem *rxBd[NUM_RX_QUEUES];
1193        int badFrame[NUM_RX_QUEUES];
1194        u16 cpucount[NUM_TX_QUEUES];
1195        u16 __iomem *p_cpucount[NUM_TX_QUEUES];
1196        int indAddrRegUsed[NUM_OF_PADDRS];
1197        u8 paddr[NUM_OF_PADDRS][ETH_ALEN];      /* ethernet address */
1198        u8 numGroupAddrInHash;
1199        u8 numIndAddrInHash;
1200        u8 numIndAddrInReg;
1201        int rx_extended_features;
1202        int rx_non_dynamic_extended_features;
1203        struct list_head conf_skbs;
1204        struct list_head group_hash_q;
1205        struct list_head ind_hash_q;
1206        u32 saved_uccm;
1207        spinlock_t lock;
1208        /* pointers to arrays of skbuffs for tx and rx */
1209        struct sk_buff **tx_skbuff[NUM_TX_QUEUES];
1210        struct sk_buff **rx_skbuff[NUM_RX_QUEUES];
1211        /* indices pointing to the next free sbk in skb arrays */
1212        u16 skb_curtx[NUM_TX_QUEUES];
1213        u16 skb_currx[NUM_RX_QUEUES];
1214        /* index of the first skb which hasn't been transmitted yet. */
1215        u16 skb_dirtytx[NUM_TX_QUEUES];
1216
1217        struct ugeth_mii_info *mii_info;
1218        struct phy_device *phydev;
1219        phy_interface_t phy_interface;
1220        int max_speed;
1221        uint32_t msg_enable;
1222        int oldspeed;
1223        int oldduplex;
1224        int oldlink;
1225        int wol_en;
1226
1227        struct device_node *node;
1228};
1229
1230void uec_set_ethtool_ops(struct net_device *netdev);
1231int init_flow_control_params(u32 automatic_flow_control_mode,
1232                int rx_flow_control_enable, int tx_flow_control_enable,
1233                u16 pause_period, u16 extension_field,
1234                u32 __iomem *upsmr_register, u32 __iomem *uempr_register,
1235                u32 __iomem *maccfg1_register);
1236
1237
1238#endif                          /* __UCC_GETH_H__ */
1239