drivers/net/ethernet/broadcom/genet/bcmgenet.h

   1 /*
   2  * Copyright (c) 2014 Broadcom Corporation
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  16  *
  17  *
  18 */
  19 #ifndef __BCMGENET_H__
  20 #define __BCMGENET_H__
  21
  22 #include <linux/skbuff.h>
  23 #include <linux/netdevice.h>
  24 #include <linux/spinlock.h>
  25 #include <linux/clk.h>
  26 #include <linux/mii.h>
  27 #include <linux/if_vlan.h>
  28 #include <linux/phy.h>
  29
  30 /* total number of Buffer Descriptors, same for Rx/Tx */
  31 #define TOTAL_DESC                              256
  32
  33 /* which ring is descriptor based */
  34 #define DESC_INDEX                              16
  35
  36 /* Body(1500) + EH_SIZE(14) + VLANTAG(4) + BRCMTAG(6) + FCS(4) = 1528.
  37  * 1536 is multiple of 256 bytes
  38  */
  39 #define ENET_BRCM_TAG_LEN       6
  40 #define ENET_PAD                8
  41 #define ENET_MAX_MTU_SIZE       (ETH_DATA_LEN + ETH_HLEN + VLAN_HLEN + \
  42                                  ENET_BRCM_TAG_LEN + ETH_FCS_LEN + ENET_PAD)
  43 #define DMA_MAX_BURST_LENGTH    0x10
  44
  45 /* misc. configuration */
  46 #define CLEAR_ALL_HFB                   0xFF
  47 #define DMA_FC_THRESH_HI                (TOTAL_DESC >> 4)
  48 #define DMA_FC_THRESH_LO                5
  49
  50 /* 64B receive/transmit status block */
  51 struct status_64 {
  52         u32     length_status;          /* length and peripheral status */
  53         u32     ext_status;             /* Extended status*/
  54         u32     rx_csum;                /* partial rx checksum */
  55         u32     unused1[9];             /* unused */
  56         u32     tx_csum_info;           /* Tx checksum info. */
  57         u32     unused2[3];             /* unused */
  58 };
  59
  60 /* Rx status bits */
  61 #define STATUS_RX_EXT_MASK              0x1FFFFF
  62 #define STATUS_RX_CSUM_MASK             0xFFFF
  63 #define STATUS_RX_CSUM_OK               0x10000
  64 #define STATUS_RX_CSUM_FR               0x20000
  65 #define STATUS_RX_PROTO_TCP             0
  66 #define STATUS_RX_PROTO_UDP             1
  67 #define STATUS_RX_PROTO_ICMP            2
  68 #define STATUS_RX_PROTO_OTHER           3
  69 #define STATUS_RX_PROTO_MASK            3
  70 #define STATUS_RX_PROTO_SHIFT           18
  71 #define STATUS_FILTER_INDEX_MASK        0xFFFF
  72 /* Tx status bits */
  73 #define STATUS_TX_CSUM_START_MASK       0X7FFF
  74 #define STATUS_TX_CSUM_START_SHIFT      16
  75 #define STATUS_TX_CSUM_PROTO_UDP        0x8000
  76 #define STATUS_TX_CSUM_OFFSET_MASK      0x7FFF
  77 #define STATUS_TX_CSUM_LV               0x80000000
  78
  79 /* DMA Descriptor */
  80 #define DMA_DESC_LENGTH_STATUS  0x00    /* in bytes of data in buffer */
  81 #define DMA_DESC_ADDRESS_LO     0x04    /* lower bits of PA */
  82 #define DMA_DESC_ADDRESS_HI     0x08    /* upper 32 bits of PA, GENETv4+ */
  83
  84 /* Rx/Tx common counter group */
  85 struct bcmgenet_pkt_counters {
  86         u32     cnt_64;         /* RO Received/Transmited 64 bytes packet */
  87         u32     cnt_127;        /* RO Rx/Tx 127 bytes packet */
  88         u32     cnt_255;        /* RO Rx/Tx 65-255 bytes packet */
  89         u32     cnt_511;        /* RO Rx/Tx 256-511 bytes packet */
  90         u32     cnt_1023;       /* RO Rx/Tx 512-1023 bytes packet */
  91         u32     cnt_1518;       /* RO Rx/Tx 1024-1518 bytes packet */
  92         u32     cnt_mgv;        /* RO Rx/Tx 1519-1522 good VLAN packet */
  93         u32     cnt_2047;       /* RO Rx/Tx 1522-2047 bytes packet*/
  94         u32     cnt_4095;       /* RO Rx/Tx 2048-4095 bytes packet*/
  95         u32     cnt_9216;       /* RO Rx/Tx 4096-9216 bytes packet*/
  96 };
  97
  98 /* RSV, Receive Status Vector */
  99 struct bcmgenet_rx_counters {
 100         struct  bcmgenet_pkt_counters pkt_cnt;
 101         u32     pkt;            /* RO (0x428) Received pkt count*/
 102         u32     bytes;          /* RO Received byte count */
 103         u32     mca;            /* RO # of Received multicast pkt */
 104         u32     bca;            /* RO # of Receive broadcast pkt */
 105         u32     fcs;            /* RO # of Received FCS error  */
 106         u32     cf;             /* RO # of Received control frame pkt*/
 107         u32     pf;             /* RO # of Received pause frame pkt */
 108         u32     uo;             /* RO # of unknown op code pkt */
 109         u32     aln;            /* RO # of alignment error count */
 110         u32     flr;            /* RO # of frame length out of range count */
 111         u32     cde;            /* RO # of code error pkt */
 112         u32     fcr;            /* RO # of carrier sense error pkt */
 113         u32     ovr;            /* RO # of oversize pkt*/
 114         u32     jbr;            /* RO # of jabber count */
 115         u32     mtue;           /* RO # of MTU error pkt*/
 116         u32     pok;            /* RO # of Received good pkt */
 117         u32     uc;             /* RO # of unicast pkt */
 118         u32     ppp;            /* RO # of PPP pkt */
 119         u32     rcrc;           /* RO (0x470),# of CRC match pkt */
 120 };
 121
 122 /* TSV, Transmit Status Vector */
 123 struct bcmgenet_tx_counters {
 124         struct bcmgenet_pkt_counters pkt_cnt;
 125         u32     pkts;           /* RO (0x4a8) Transmited pkt */
 126         u32     mca;            /* RO # of xmited multicast pkt */
 127         u32     bca;            /* RO # of xmited broadcast pkt */
 128         u32     pf;             /* RO # of xmited pause frame count */
 129         u32     cf;             /* RO # of xmited control frame count */
 130         u32     fcs;            /* RO # of xmited FCS error count */
 131         u32     ovr;            /* RO # of xmited oversize pkt */
 132         u32     drf;            /* RO # of xmited deferral pkt */
 133         u32     edf;            /* RO # of xmited Excessive deferral pkt*/
 134         u32     scl;            /* RO # of xmited single collision pkt */
 135         u32     mcl;            /* RO # of xmited multiple collision pkt*/
 136         u32     lcl;            /* RO # of xmited late collision pkt */
 137         u32     ecl;            /* RO # of xmited excessive collision pkt*/
 138         u32     frg;            /* RO # of xmited fragments pkt*/
 139         u32     ncl;            /* RO # of xmited total collision count */
 140         u32     jbr;            /* RO # of xmited jabber count*/
 141         u32     bytes;          /* RO # of xmited byte count */
 142         u32     pok;            /* RO # of xmited good pkt */
 143         u32     uc;             /* RO (0x0x4f0)# of xmited unitcast pkt */
 144 };
 145
 146 struct bcmgenet_mib_counters {
 147         struct bcmgenet_rx_counters rx;
 148         struct bcmgenet_tx_counters tx;
 149         u32     rx_runt_cnt;
 150         u32     rx_runt_fcs;
 151         u32     rx_runt_fcs_align;
 152         u32     rx_runt_bytes;
 153         u32     rbuf_ovflow_cnt;
 154         u32     rbuf_err_cnt;
 155         u32     mdf_err_cnt;
 156 };
 157
 158 #define UMAC_HD_BKP_CTRL                0x004
 159 #define  HD_FC_EN                       (1 << 0)
 160 #define  HD_FC_BKOFF_OK                 (1 << 1)
 161 #define  IPG_CONFIG_RX_SHIFT            2
 162 #define  IPG_CONFIG_RX_MASK             0x1F
 163
 164 #define UMAC_CMD                        0x008
 165 #define  CMD_TX_EN                      (1 << 0)
 166 #define  CMD_RX_EN                      (1 << 1)
 167 #define  UMAC_SPEED_10                  0
 168 #define  UMAC_SPEED_100                 1
 169 #define  UMAC_SPEED_1000                2
 170 #define  UMAC_SPEED_2500                3
 171 #define  CMD_SPEED_SHIFT                2
 172 #define  CMD_SPEED_MASK                 3
 173 #define  CMD_PROMISC                    (1 << 4)
 174 #define  CMD_PAD_EN                     (1 << 5)
 175 #define  CMD_CRC_FWD                    (1 << 6)
 176 #define  CMD_PAUSE_FWD                  (1 << 7)
 177 #define  CMD_RX_PAUSE_IGNORE            (1 << 8)
 178 #define  CMD_TX_ADDR_INS                (1 << 9)
 179 #define  CMD_HD_EN                      (1 << 10)
 180 #define  CMD_SW_RESET                   (1 << 13)
 181 #define  CMD_LCL_LOOP_EN                (1 << 15)
 182 #define  CMD_AUTO_CONFIG                (1 << 22)
 183 #define  CMD_CNTL_FRM_EN                (1 << 23)
 184 #define  CMD_NO_LEN_CHK                 (1 << 24)
 185 #define  CMD_RMT_LOOP_EN                (1 << 25)
 186 #define  CMD_PRBL_EN                    (1 << 27)
 187 #define  CMD_TX_PAUSE_IGNORE            (1 << 28)
 188 #define  CMD_TX_RX_EN                   (1 << 29)
 189 #define  CMD_RUNT_FILTER_DIS            (1 << 30)
 190
 191 #define UMAC_MAC0                       0x00C
 192 #define UMAC_MAC1                       0x010
 193 #define UMAC_MAX_FRAME_LEN              0x014
 194
 195 #define UMAC_TX_FLUSH                   0x334
 196
 197 #define UMAC_MIB_START                  0x400
 198
 199 #define UMAC_MDIO_CMD                   0x614
 200 #define  MDIO_START_BUSY                (1 << 29)
 201 #define  MDIO_READ_FAIL                 (1 << 28)
 202 #define  MDIO_RD                        (2 << 26)
 203 #define  MDIO_WR                        (1 << 26)
 204 #define  MDIO_PMD_SHIFT                 21
 205 #define  MDIO_PMD_MASK                  0x1F
 206 #define  MDIO_REG_SHIFT                 16
 207 #define  MDIO_REG_MASK                  0x1F
 208
 209 #define UMAC_RBUF_OVFL_CNT              0x61C
 210
 211 #define UMAC_MPD_CTRL                   0x620
 212 #define  MPD_EN                         (1 << 0)
 213 #define  MPD_PW_EN                      (1 << 27)
 214 #define  MPD_MSEQ_LEN_SHIFT             16
 215 #define  MPD_MSEQ_LEN_MASK              0xFF
 216
 217 #define UMAC_MPD_PW_MS                  0x624
 218 #define UMAC_MPD_PW_LS                  0x628
 219 #define UMAC_RBUF_ERR_CNT               0x634
 220 #define UMAC_MDF_ERR_CNT                0x638
 221 #define UMAC_MDF_CTRL                   0x650
 222 #define UMAC_MDF_ADDR                   0x654
 223 #define UMAC_MIB_CTRL                   0x580
 224 #define  MIB_RESET_RX                   (1 << 0)
 225 #define  MIB_RESET_RUNT                 (1 << 1)
 226 #define  MIB_RESET_TX                   (1 << 2)
 227
 228 #define RBUF_CTRL                       0x00
 229 #define  RBUF_64B_EN                    (1 << 0)
 230 #define  RBUF_ALIGN_2B                  (1 << 1)
 231 #define  RBUF_BAD_DIS                   (1 << 2)
 232
 233 #define RBUF_STATUS                     0x0C
 234 #define  RBUF_STATUS_WOL                (1 << 0)
 235 #define  RBUF_STATUS_MPD_INTR_ACTIVE    (1 << 1)
 236 #define  RBUF_STATUS_ACPI_INTR_ACTIVE   (1 << 2)
 237
 238 #define RBUF_CHK_CTRL                   0x14
 239 #define  RBUF_RXCHK_EN                  (1 << 0)
 240 #define  RBUF_SKIP_FCS                  (1 << 4)
 241
 242 #define RBUF_TBUF_SIZE_CTRL             0xb4
 243
 244 #define RBUF_HFB_CTRL_V1                0x38
 245 #define  RBUF_HFB_FILTER_EN_SHIFT       16
 246 #define  RBUF_HFB_FILTER_EN_MASK        0xffff0000
 247 #define  RBUF_HFB_EN                    (1 << 0)
 248 #define  RBUF_HFB_256B                  (1 << 1)
 249 #define  RBUF_ACPI_EN                   (1 << 2)
 250
 251 #define RBUF_HFB_LEN_V1                 0x3C
 252 #define  RBUF_FLTR_LEN_MASK             0xFF
 253 #define  RBUF_FLTR_LEN_SHIFT            8
 254
 255 #define TBUF_CTRL                       0x00
 256 #define TBUF_BP_MC                      0x0C
 257
 258 #define TBUF_CTRL_V1                    0x80
 259 #define TBUF_BP_MC_V1                   0xA0
 260
 261 #define HFB_CTRL                        0x00
 262 #define HFB_FLT_ENABLE_V3PLUS           0x04
 263 #define HFB_FLT_LEN_V2                  0x04
 264 #define HFB_FLT_LEN_V3PLUS              0x1C
 265
 266 /* uniMac intrl2 registers */
 267 #define INTRL2_CPU_STAT                 0x00
 268 #define INTRL2_CPU_SET                  0x04
 269 #define INTRL2_CPU_CLEAR                0x08
 270 #define INTRL2_CPU_MASK_STATUS          0x0C
 271 #define INTRL2_CPU_MASK_SET             0x10
 272 #define INTRL2_CPU_MASK_CLEAR           0x14
 273
 274 /* INTRL2 instance 0 definitions */
 275 #define UMAC_IRQ_SCB                    (1 << 0)
 276 #define UMAC_IRQ_EPHY                   (1 << 1)
 277 #define UMAC_IRQ_PHY_DET_R              (1 << 2)
 278 #define UMAC_IRQ_PHY_DET_F              (1 << 3)
 279 #define UMAC_IRQ_LINK_UP                (1 << 4)
 280 #define UMAC_IRQ_LINK_DOWN              (1 << 5)
 281 #define UMAC_IRQ_UMAC                   (1 << 6)
 282 #define UMAC_IRQ_UMAC_TSV               (1 << 7)
 283 #define UMAC_IRQ_TBUF_UNDERRUN          (1 << 8)
 284 #define UMAC_IRQ_RBUF_OVERFLOW          (1 << 9)
 285 #define UMAC_IRQ_HFB_SM                 (1 << 10)
 286 #define UMAC_IRQ_HFB_MM                 (1 << 11)
 287 #define UMAC_IRQ_MPD_R                  (1 << 12)
 288 #define UMAC_IRQ_RXDMA_MBDONE           (1 << 13)
 289 #define UMAC_IRQ_RXDMA_PDONE            (1 << 14)
 290 #define UMAC_IRQ_RXDMA_BDONE            (1 << 15)
 291 #define UMAC_IRQ_TXDMA_MBDONE           (1 << 16)
 292 #define UMAC_IRQ_TXDMA_PDONE            (1 << 17)
 293 #define UMAC_IRQ_TXDMA_BDONE            (1 << 18)
 294 /* Only valid for GENETv3+ */
 295 #define UMAC_IRQ_MDIO_DONE              (1 << 23)
 296 #define UMAC_IRQ_MDIO_ERROR             (1 << 24)
 297
 298 /* Register block offsets */
 299 #define GENET_SYS_OFF                   0x0000
 300 #define GENET_GR_BRIDGE_OFF             0x0040
 301 #define GENET_EXT_OFF                   0x0080
 302 #define GENET_INTRL2_0_OFF              0x0200
 303 #define GENET_INTRL2_1_OFF              0x0240
 304 #define GENET_RBUF_OFF                  0x0300
 305 #define GENET_UMAC_OFF                  0x0800
 306
 307 /* SYS block offsets and register definitions */
 308 #define SYS_REV_CTRL                    0x00
 309 #define SYS_PORT_CTRL                   0x04
 310 #define  PORT_MODE_INT_EPHY             0
 311 #define  PORT_MODE_INT_GPHY             1
 312 #define  PORT_MODE_EXT_EPHY             2
 313 #define  PORT_MODE_EXT_GPHY             3
 314 #define  PORT_MODE_EXT_RVMII_25         (4 | BIT(4))
 315 #define  PORT_MODE_EXT_RVMII_50         4
 316 #define  LED_ACT_SOURCE_MAC             (1 << 9)
 317
 318 #define SYS_RBUF_FLUSH_CTRL             0x08
 319 #define SYS_TBUF_FLUSH_CTRL             0x0C
 320 #define RBUF_FLUSH_CTRL_V1              0x04
 321
 322 /* Ext block register offsets and definitions */
 323 #define EXT_EXT_PWR_MGMT                0x00
 324 #define  EXT_PWR_DOWN_BIAS              (1 << 0)
 325 #define  EXT_PWR_DOWN_DLL               (1 << 1)
 326 #define  EXT_PWR_DOWN_PHY               (1 << 2)
 327 #define  EXT_PWR_DN_EN_LD               (1 << 3)
 328 #define  EXT_ENERGY_DET                 (1 << 4)
 329 #define  EXT_IDDQ_FROM_PHY              (1 << 5)
 330 #define  EXT_PHY_RESET                  (1 << 8)
 331 #define  EXT_ENERGY_DET_MASK            (1 << 12)
 332
 333 #define EXT_RGMII_OOB_CTRL              0x0C
 334 #define  RGMII_LINK                     (1 << 4)
 335 #define  OOB_DISABLE                    (1 << 5)
 336 #define  RGMII_MODE_EN                  (1 << 6)
 337 #define  ID_MODE_DIS                    (1 << 16)
 338
 339 #define EXT_GPHY_CTRL                   0x1C
 340 #define  EXT_CFG_IDDQ_BIAS              (1 << 0)
 341 #define  EXT_CFG_PWR_DOWN               (1 << 1)
 342 #define  EXT_GPHY_RESET                 (1 << 5)
 343
 344 /* DMA rings size */
 345 #define DMA_RING_SIZE                   (0x40)
 346 #define DMA_RINGS_SIZE                  (DMA_RING_SIZE * (DESC_INDEX + 1))
 347
 348 /* DMA registers common definitions */
 349 #define DMA_RW_POINTER_MASK             0x1FF
 350 #define DMA_P_INDEX_DISCARD_CNT_MASK    0xFFFF
 351 #define DMA_P_INDEX_DISCARD_CNT_SHIFT   16
 352 #define DMA_BUFFER_DONE_CNT_MASK        0xFFFF
 353 #define DMA_BUFFER_DONE_CNT_SHIFT       16
 354 #define DMA_P_INDEX_MASK                0xFFFF
 355 #define DMA_C_INDEX_MASK                0xFFFF
 356
 357 /* DMA ring size register */
 358 #define DMA_RING_SIZE_MASK              0xFFFF
 359 #define DMA_RING_SIZE_SHIFT             16
 360 #define DMA_RING_BUFFER_SIZE_MASK       0xFFFF
 361
 362 /* DMA interrupt threshold register */
 363 #define DMA_INTR_THRESHOLD_MASK         0x00FF
 364
 365 /* DMA XON/XOFF register */
 366 #define DMA_XON_THREHOLD_MASK           0xFFFF
 367 #define DMA_XOFF_THRESHOLD_MASK         0xFFFF
 368 #define DMA_XOFF_THRESHOLD_SHIFT        16
 369
 370 /* DMA flow period register */
 371 #define DMA_FLOW_PERIOD_MASK            0xFFFF
 372 #define DMA_MAX_PKT_SIZE_MASK           0xFFFF
 373 #define DMA_MAX_PKT_SIZE_SHIFT          16
 374
 375
 376 /* DMA control register */
 377 #define DMA_EN                          (1 << 0)
 378 #define DMA_RING_BUF_EN_SHIFT           0x01
 379 #define DMA_RING_BUF_EN_MASK            0xFFFF
 380 #define DMA_TSB_SWAP_EN                 (1 << 20)
 381
 382 /* DMA status register */
 383 #define DMA_DISABLED                    (1 << 0)
 384 #define DMA_DESC_RAM_INIT_BUSY          (1 << 1)
 385
 386 /* DMA SCB burst size register */
 387 #define DMA_SCB_BURST_SIZE_MASK         0x1F
 388
 389 /* DMA activity vector register */
 390 #define DMA_ACTIVITY_VECTOR_MASK        0x1FFFF
 391
 392 /* DMA backpressure mask register */
 393 #define DMA_BACKPRESSURE_MASK           0x1FFFF
 394 #define DMA_PFC_ENABLE                  (1 << 31)
 395
 396 /* DMA backpressure status register */
 397 #define DMA_BACKPRESSURE_STATUS_MASK    0x1FFFF
 398
 399 /* DMA override register */
 400 #define DMA_LITTLE_ENDIAN_MODE          (1 << 0)
 401 #define DMA_REGISTER_MODE               (1 << 1)
 402
 403 /* DMA timeout register */
 404 #define DMA_TIMEOUT_MASK                0xFFFF
 405 #define DMA_TIMEOUT_VAL                 5000    /* micro seconds */
 406
 407 /* TDMA rate limiting control register */
 408 #define DMA_RATE_LIMIT_EN_MASK          0xFFFF
 409
 410 /* TDMA arbitration control register */
 411 #define DMA_ARBITER_MODE_MASK           0x03
 412 #define DMA_RING_BUF_PRIORITY_MASK      0x1F
 413 #define DMA_RING_BUF_PRIORITY_SHIFT     5
 414 #define DMA_RATE_ADJ_MASK               0xFF
 415
 416 /* Tx/Rx Dma Descriptor common bits*/
 417 #define DMA_BUFLENGTH_MASK              0x0fff
 418 #define DMA_BUFLENGTH_SHIFT             16
 419 #define DMA_OWN                         0x8000
 420 #define DMA_EOP                         0x4000
 421 #define DMA_SOP                         0x2000
 422 #define DMA_WRAP                        0x1000
 423 /* Tx specific Dma descriptor bits */
 424 #define DMA_TX_UNDERRUN                 0x0200
 425 #define DMA_TX_APPEND_CRC               0x0040
 426 #define DMA_TX_OW_CRC                   0x0020
 427 #define DMA_TX_DO_CSUM                  0x0010
 428 #define DMA_TX_QTAG_SHIFT               7
 429
 430 /* Rx Specific Dma descriptor bits */
 431 #define DMA_RX_CHK_V3PLUS               0x8000
 432 #define DMA_RX_CHK_V12                  0x1000
 433 #define DMA_RX_BRDCAST                  0x0040
 434 #define DMA_RX_MULT                     0x0020
 435 #define DMA_RX_LG                       0x0010
 436 #define DMA_RX_NO                       0x0008
 437 #define DMA_RX_RXER                     0x0004
 438 #define DMA_RX_CRC_ERROR                0x0002
 439 #define DMA_RX_OV                       0x0001
 440 #define DMA_RX_FI_MASK                  0x001F
 441 #define DMA_RX_FI_SHIFT                 0x0007
 442 #define DMA_DESC_ALLOC_MASK             0x00FF
 443
 444 #define DMA_ARBITER_RR                  0x00
 445 #define DMA_ARBITER_WRR                 0x01
 446 #define DMA_ARBITER_SP                  0x02
 447
 448 struct enet_cb {
 449         struct sk_buff      *skb;
 450         void __iomem *bd_addr;
 451         DEFINE_DMA_UNMAP_ADDR(dma_addr);
 452         DEFINE_DMA_UNMAP_LEN(dma_len);
 453 };
 454
 455 /* power management mode */
 456 enum bcmgenet_power_mode {
 457         GENET_POWER_CABLE_SENSE = 0,
 458         GENET_POWER_PASSIVE,
 459 };
 460
 461 struct bcmgenet_priv;
 462
 463 /* We support both runtime GENET detection and compile-time
 464  * to optimize code-paths for a given hardware
 465  */
 466 enum bcmgenet_version {
 467         GENET_V1 = 1,
 468         GENET_V2,
 469         GENET_V3,
 470         GENET_V4
 471 };
 472
 473 #define GENET_IS_V1(p)  ((p)->version == GENET_V1)
 474 #define GENET_IS_V2(p)  ((p)->version == GENET_V2)
 475 #define GENET_IS_V3(p)  ((p)->version == GENET_V3)
 476 #define GENET_IS_V4(p)  ((p)->version == GENET_V4)
 477
 478 /* Hardware flags */
 479 #define GENET_HAS_40BITS        (1 << 0)
 480 #define GENET_HAS_EXT           (1 << 1)
 481 #define GENET_HAS_MDIO_INTR     (1 << 2)
 482
 483 /* BCMGENET hardware parameters, keep this structure nicely aligned
 484  * since it is going to be used in hot paths
 485  */
 486 struct bcmgenet_hw_params {
 487         u8              tx_queues;
 488         u8              rx_queues;
 489         u8              bds_cnt;
 490         u8              bp_in_en_shift;
 491         u32             bp_in_mask;
 492         u8              hfb_filter_cnt;
 493         u8              qtag_mask;
 494         u16             tbuf_offset;
 495         u32             hfb_offset;
 496         u32             hfb_reg_offset;
 497         u32             rdma_offset;
 498         u32             tdma_offset;
 499         u32             words_per_bd;
 500         u32             flags;
 501 };
 502
 503 struct bcmgenet_tx_ring {
 504         spinlock_t      lock;           /* ring lock */
 505         unsigned int    index;          /* ring index */
 506         unsigned int    queue;          /* queue index */
 507         struct enet_cb  *cbs;           /* tx ring buffer control block*/
 508         unsigned int    size;           /* size of each tx ring */
 509         unsigned int    c_index;        /* last consumer index of each ring*/
 510         unsigned int    free_bds;       /* # of free bds for each ring */
 511         unsigned int    write_ptr;      /* Tx ring write pointer SW copy */
 512         unsigned int    prod_index;     /* Tx ring producer index SW copy */
 513         unsigned int    cb_ptr;         /* Tx ring initial CB ptr */
 514         unsigned int    end_ptr;        /* Tx ring end CB ptr */
 515         void (*int_enable)(struct bcmgenet_priv *priv,
 516                                 struct bcmgenet_tx_ring *);
 517         void (*int_disable)(struct bcmgenet_priv *priv,
 518                                 struct bcmgenet_tx_ring *);
 519 };
 520
 521 /* device context */
 522 struct bcmgenet_priv {
 523         void __iomem *base;
 524         enum bcmgenet_version version;
 525         struct net_device *dev;
 526         u32 int0_mask;
 527         u32 int1_mask;
 528
 529         /* NAPI for descriptor based rx */
 530         struct napi_struct napi ____cacheline_aligned;
 531
 532         /* transmit variables */
 533         void __iomem *tx_bds;
 534         struct enet_cb *tx_cbs;
 535         unsigned int num_tx_bds;
 536
 537         struct bcmgenet_tx_ring tx_rings[DESC_INDEX + 1];
 538
 539         /* receive variables */
 540         void __iomem *rx_bds;
 541         void __iomem *rx_bd_assign_ptr;
 542         int rx_bd_assign_index;
 543         struct enet_cb *rx_cbs;
 544         unsigned int num_rx_bds;
 545         unsigned int rx_buf_len;
 546         unsigned int rx_read_ptr;
 547         unsigned int rx_c_index;
 548
 549         /* other misc variables */
 550         struct bcmgenet_hw_params *hw_params;
 551
 552         /* MDIO bus variables */
 553         wait_queue_head_t wq;
 554         struct phy_device *phydev;
 555         struct device_node *phy_dn;
 556         struct mii_bus *mii_bus;
 557
 558         /* PHY device variables */
 559         int old_duplex;
 560         int old_link;
 561         int old_pause;
 562         phy_interface_t phy_interface;
 563         int phy_addr;
 564         int ext_phy;
 565
 566         /* Interrupt variables */
 567         struct work_struct bcmgenet_irq_work;
 568         int irq0;
 569         int irq1;
 570         unsigned int irq0_stat;
 571         unsigned int irq1_stat;
 572
 573         /* HW descriptors/checksum variables */
 574         bool desc_64b_en;
 575         bool desc_rxchk_en;
 576         bool crc_fwd_en;
 577
 578         unsigned int dma_rx_chk_bit;
 579
 580         u32 msg_enable;
 581
 582         struct clk *clk;
 583         struct platform_device *pdev;
 584
 585         /* WOL */
 586         unsigned long wol_enabled;
 587         struct clk *clk_wol;
 588         u32 wolopts;
 589
 590         struct bcmgenet_mib_counters mib;
 591 };
 592
 593 #define GENET_IO_MACRO(name, offset)                                    \
 594 static inline u32 bcmgenet_##name##_readl(struct bcmgenet_priv *priv,   \
 595                                         u32 off)                        \
 596 {                                                                       \
 597         return __raw_readl(priv->base + offset + off);                  \
 598 }                                                                       \
 599 static inline void bcmgenet_##name##_writel(struct bcmgenet_priv *priv, \
 600                                         u32 val, u32 off)               \
 601 {                                                                       \
 602         __raw_writel(val, priv->base + offset + off);                   \
 603 }
 604
 605 GENET_IO_MACRO(ext, GENET_EXT_OFF);
 606 GENET_IO_MACRO(umac, GENET_UMAC_OFF);
 607 GENET_IO_MACRO(sys, GENET_SYS_OFF);
 608
 609 /* interrupt l2 registers accessors */
 610 GENET_IO_MACRO(intrl2_0, GENET_INTRL2_0_OFF);
 611 GENET_IO_MACRO(intrl2_1, GENET_INTRL2_1_OFF);
 612
 613 /* HFB register accessors  */
 614 GENET_IO_MACRO(hfb, priv->hw_params->hfb_offset);
 615
 616 /* GENET v2+ HFB control and filter len helpers */
 617 GENET_IO_MACRO(hfb_reg, priv->hw_params->hfb_reg_offset);
 618
 619 /* RBUF register accessors */
 620 GENET_IO_MACRO(rbuf, GENET_RBUF_OFF);
 621
 622 /* MDIO routines */
 623 int bcmgenet_mii_init(struct net_device *dev);
 624 int bcmgenet_mii_config(struct net_device *dev);
 625 void bcmgenet_mii_exit(struct net_device *dev);
 626 void bcmgenet_mii_reset(struct net_device *dev);
 627
 628 #endif /* __BCMGENET_H__ */