1 /* 2 * DWMAC4 Header file. 3 * 4 * Copyright (C) 2015 STMicroelectronics Ltd 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms and conditions of the GNU General Public License, 8 * version 2, as published by the Free Software Foundation. 9 * 10 * Author: Alexandre Torgue <alexandre.torgue@st.com> 11 */ 12 13 #ifndef __DWMAC4_H__ 14 #define __DWMAC4_H__ 15 16 #include "common.h" 17 18 /* MAC registers */ 19 #define GMAC_CONFIG 0x00000000 20 #define GMAC_PACKET_FILTER 0x00000008 21 #define GMAC_HASH_TAB_0_31 0x00000010 22 #define GMAC_HASH_TAB_32_63 0x00000014 23 #define GMAC_RX_FLOW_CTRL 0x00000090 24 #define GMAC_QX_TX_FLOW_CTRL(x) (0x70 + x * 4) 25 #define GMAC_RXQ_CTRL0 0x000000a0 26 #define GMAC_INT_STATUS 0x000000b0 27 #define GMAC_INT_EN 0x000000b4 28 #define GMAC_PCS_BASE 0x000000e0 29 #define GMAC_PHYIF_CONTROL_STATUS 0x000000f8 30 #define GMAC_PMT 0x000000c0 31 #define GMAC_VERSION 0x00000110 32 #define GMAC_DEBUG 0x00000114 33 #define GMAC_HW_FEATURE0 0x0000011c 34 #define GMAC_HW_FEATURE1 0x00000120 35 #define GMAC_HW_FEATURE2 0x00000124 36 #define GMAC_MDIO_ADDR 0x00000200 37 #define GMAC_MDIO_DATA 0x00000204 38 #define GMAC_ADDR_HIGH(reg) (0x300 + reg * 8) 39 #define GMAC_ADDR_LOW(reg) (0x304 + reg * 8) 40 41 /* MAC Packet Filtering */ 42 #define GMAC_PACKET_FILTER_PR BIT(0) 43 #define GMAC_PACKET_FILTER_HMC BIT(2) 44 #define GMAC_PACKET_FILTER_PM BIT(4) 45 46 #define GMAC_MAX_PERFECT_ADDRESSES 128 47 48 /* MAC RX Queue Enable */ 49 #define GMAC_RX_QUEUE_CLEAR(queue) ~(GENMASK(1, 0) << ((queue) * 2)) 50 #define GMAC_RX_AV_QUEUE_ENABLE(queue) BIT((queue) * 2) 51 #define GMAC_RX_DCB_QUEUE_ENABLE(queue) BIT(((queue) * 2) + 1) 52 53 /* MAC Flow Control RX */ 54 #define GMAC_RX_FLOW_CTRL_RFE BIT(0) 55 56 /* MAC Flow Control TX */ 57 #define GMAC_TX_FLOW_CTRL_TFE BIT(1) 58 #define GMAC_TX_FLOW_CTRL_PT_SHIFT 16 59 60 /* MAC Interrupt bitmap*/ 61 #define GMAC_INT_RGSMIIS BIT(0) 62 #define GMAC_INT_PCS_LINK BIT(1) 63 #define GMAC_INT_PCS_ANE BIT(2) 64 #define GMAC_INT_PCS_PHYIS BIT(3) 65 #define GMAC_INT_PMT_EN BIT(4) 66 #define GMAC_INT_LPI_EN BIT(5) 67 68 #define GMAC_PCS_IRQ_DEFAULT (GMAC_INT_RGSMIIS | GMAC_INT_PCS_LINK | \ 69 GMAC_INT_PCS_ANE) 70 71 #define GMAC_INT_DEFAULT_MASK GMAC_INT_PMT_EN 72 73 enum dwmac4_irq_status { 74 time_stamp_irq = 0x00001000, 75 mmc_rx_csum_offload_irq = 0x00000800, 76 mmc_tx_irq = 0x00000400, 77 mmc_rx_irq = 0x00000200, 78 mmc_irq = 0x00000100, 79 pmt_irq = 0x00000010, 80 }; 81 82 /* MAC PMT bitmap */ 83 enum power_event { 84 pointer_reset = 0x80000000, 85 global_unicast = 0x00000200, 86 wake_up_rx_frame = 0x00000040, 87 magic_frame = 0x00000020, 88 wake_up_frame_en = 0x00000004, 89 magic_pkt_en = 0x00000002, 90 power_down = 0x00000001, 91 }; 92 93 /* Energy Efficient Ethernet (EEE) for GMAC4 94 * 95 * LPI status, timer and control register offset 96 */ 97 #define GMAC4_LPI_CTRL_STATUS 0xd0 98 #define GMAC4_LPI_TIMER_CTRL 0xd4 99 100 /* LPI control and status defines */ 101 #define GMAC4_LPI_CTRL_STATUS_LPITCSE BIT(21) /* LPI Tx Clock Stop Enable */ 102 #define GMAC4_LPI_CTRL_STATUS_LPITXA BIT(19) /* Enable LPI TX Automate */ 103 #define GMAC4_LPI_CTRL_STATUS_PLS BIT(17) /* PHY Link Status */ 104 #define GMAC4_LPI_CTRL_STATUS_LPIEN BIT(16) /* LPI Enable */ 105 106 /* MAC Debug bitmap */ 107 #define GMAC_DEBUG_TFCSTS_MASK GENMASK(18, 17) 108 #define GMAC_DEBUG_TFCSTS_SHIFT 17 109 #define GMAC_DEBUG_TFCSTS_IDLE 0 110 #define GMAC_DEBUG_TFCSTS_WAIT 1 111 #define GMAC_DEBUG_TFCSTS_GEN_PAUSE 2 112 #define GMAC_DEBUG_TFCSTS_XFER 3 113 #define GMAC_DEBUG_TPESTS BIT(16) 114 #define GMAC_DEBUG_RFCFCSTS_MASK GENMASK(2, 1) 115 #define GMAC_DEBUG_RFCFCSTS_SHIFT 1 116 #define GMAC_DEBUG_RPESTS BIT(0) 117 118 /* MAC config */ 119 #define GMAC_CONFIG_IPC BIT(27) 120 #define GMAC_CONFIG_2K BIT(22) 121 #define GMAC_CONFIG_ACS BIT(20) 122 #define GMAC_CONFIG_BE BIT(18) 123 #define GMAC_CONFIG_JD BIT(17) 124 #define GMAC_CONFIG_JE BIT(16) 125 #define GMAC_CONFIG_PS BIT(15) 126 #define GMAC_CONFIG_FES BIT(14) 127 #define GMAC_CONFIG_DM BIT(13) 128 #define GMAC_CONFIG_DCRS BIT(9) 129 #define GMAC_CONFIG_TE BIT(1) 130 #define GMAC_CONFIG_RE BIT(0) 131 132 /* MAC HW features0 bitmap */ 133 #define GMAC_HW_FEAT_ADDMAC BIT(18) 134 #define GMAC_HW_FEAT_RXCOESEL BIT(16) 135 #define GMAC_HW_FEAT_TXCOSEL BIT(14) 136 #define GMAC_HW_FEAT_EEESEL BIT(13) 137 #define GMAC_HW_FEAT_TSSEL BIT(12) 138 #define GMAC_HW_FEAT_MMCSEL BIT(8) 139 #define GMAC_HW_FEAT_MGKSEL BIT(7) 140 #define GMAC_HW_FEAT_RWKSEL BIT(6) 141 #define GMAC_HW_FEAT_SMASEL BIT(5) 142 #define GMAC_HW_FEAT_VLHASH BIT(4) 143 #define GMAC_HW_FEAT_PCSSEL BIT(3) 144 #define GMAC_HW_FEAT_HDSEL BIT(2) 145 #define GMAC_HW_FEAT_GMIISEL BIT(1) 146 #define GMAC_HW_FEAT_MIISEL BIT(0) 147 148 /* MAC HW features1 bitmap */ 149 #define GMAC_HW_FEAT_AVSEL BIT(20) 150 #define GMAC_HW_TSOEN BIT(18) 151 #define GMAC_HW_TXFIFOSIZE GENMASK(10, 6) 152 #define GMAC_HW_RXFIFOSIZE GENMASK(4, 0) 153 154 /* MAC HW features2 bitmap */ 155 #define GMAC_HW_FEAT_TXCHCNT GENMASK(21, 18) 156 #define GMAC_HW_FEAT_RXCHCNT GENMASK(15, 12) 157 #define GMAC_HW_FEAT_TXQCNT GENMASK(9, 6) 158 #define GMAC_HW_FEAT_RXQCNT GENMASK(3, 0) 159 160 /* MAC HW ADDR regs */ 161 #define GMAC_HI_DCS GENMASK(18, 16) 162 #define GMAC_HI_DCS_SHIFT 16 163 #define GMAC_HI_REG_AE BIT(31) 164 165 /* MTL registers */ 166 #define MTL_INT_STATUS 0x00000c20 167 #define MTL_INT_Q0 BIT(0) 168 169 #define MTL_CHAN_BASE_ADDR 0x00000d00 170 #define MTL_CHAN_BASE_OFFSET 0x40 171 #define MTL_CHANX_BASE_ADDR(x) (MTL_CHAN_BASE_ADDR + \ 172 (x * MTL_CHAN_BASE_OFFSET)) 173 174 #define MTL_CHAN_TX_OP_MODE(x) MTL_CHANX_BASE_ADDR(x) 175 #define MTL_CHAN_TX_DEBUG(x) (MTL_CHANX_BASE_ADDR(x) + 0x8) 176 #define MTL_CHAN_INT_CTRL(x) (MTL_CHANX_BASE_ADDR(x) + 0x2c) 177 #define MTL_CHAN_RX_OP_MODE(x) (MTL_CHANX_BASE_ADDR(x) + 0x30) 178 #define MTL_CHAN_RX_DEBUG(x) (MTL_CHANX_BASE_ADDR(x) + 0x38) 179 180 #define MTL_OP_MODE_RSF BIT(5) 181 #define MTL_OP_MODE_TXQEN BIT(3) 182 #define MTL_OP_MODE_TSF BIT(1) 183 184 #define MTL_OP_MODE_TQS_MASK GENMASK(24, 16) 185 #define MTL_OP_MODE_TQS_SHIFT 16 186 187 #define MTL_OP_MODE_TTC_MASK 0x70 188 #define MTL_OP_MODE_TTC_SHIFT 4 189 190 #define MTL_OP_MODE_TTC_32 0 191 #define MTL_OP_MODE_TTC_64 (1 << MTL_OP_MODE_TTC_SHIFT) 192 #define MTL_OP_MODE_TTC_96 (2 << MTL_OP_MODE_TTC_SHIFT) 193 #define MTL_OP_MODE_TTC_128 (3 << MTL_OP_MODE_TTC_SHIFT) 194 #define MTL_OP_MODE_TTC_192 (4 << MTL_OP_MODE_TTC_SHIFT) 195 #define MTL_OP_MODE_TTC_256 (5 << MTL_OP_MODE_TTC_SHIFT) 196 #define MTL_OP_MODE_TTC_384 (6 << MTL_OP_MODE_TTC_SHIFT) 197 #define MTL_OP_MODE_TTC_512 (7 << MTL_OP_MODE_TTC_SHIFT) 198 199 #define MTL_OP_MODE_RQS_MASK GENMASK(29, 20) 200 #define MTL_OP_MODE_RQS_SHIFT 20 201 202 #define MTL_OP_MODE_RFD_MASK GENMASK(19, 14) 203 #define MTL_OP_MODE_RFD_SHIFT 14 204 205 #define MTL_OP_MODE_RFA_MASK GENMASK(13, 8) 206 #define MTL_OP_MODE_RFA_SHIFT 8 207 208 #define MTL_OP_MODE_EHFC BIT(7) 209 210 #define MTL_OP_MODE_RTC_MASK 0x18 211 #define MTL_OP_MODE_RTC_SHIFT 3 212 213 #define MTL_OP_MODE_RTC_32 (1 << MTL_OP_MODE_RTC_SHIFT) 214 #define MTL_OP_MODE_RTC_64 0 215 #define MTL_OP_MODE_RTC_96 (2 << MTL_OP_MODE_RTC_SHIFT) 216 #define MTL_OP_MODE_RTC_128 (3 << MTL_OP_MODE_RTC_SHIFT) 217 218 /* MTL debug */ 219 #define MTL_DEBUG_TXSTSFSTS BIT(5) 220 #define MTL_DEBUG_TXFSTS BIT(4) 221 #define MTL_DEBUG_TWCSTS BIT(3) 222 223 /* MTL debug: Tx FIFO Read Controller Status */ 224 #define MTL_DEBUG_TRCSTS_MASK GENMASK(2, 1) 225 #define MTL_DEBUG_TRCSTS_SHIFT 1 226 #define MTL_DEBUG_TRCSTS_IDLE 0 227 #define MTL_DEBUG_TRCSTS_READ 1 228 #define MTL_DEBUG_TRCSTS_TXW 2 229 #define MTL_DEBUG_TRCSTS_WRITE 3 230 #define MTL_DEBUG_TXPAUSED BIT(0) 231 232 /* MAC debug: GMII or MII Transmit Protocol Engine Status */ 233 #define MTL_DEBUG_RXFSTS_MASK GENMASK(5, 4) 234 #define MTL_DEBUG_RXFSTS_SHIFT 4 235 #define MTL_DEBUG_RXFSTS_EMPTY 0 236 #define MTL_DEBUG_RXFSTS_BT 1 237 #define MTL_DEBUG_RXFSTS_AT 2 238 #define MTL_DEBUG_RXFSTS_FULL 3 239 #define MTL_DEBUG_RRCSTS_MASK GENMASK(2, 1) 240 #define MTL_DEBUG_RRCSTS_SHIFT 1 241 #define MTL_DEBUG_RRCSTS_IDLE 0 242 #define MTL_DEBUG_RRCSTS_RDATA 1 243 #define MTL_DEBUG_RRCSTS_RSTAT 2 244 #define MTL_DEBUG_RRCSTS_FLUSH 3 245 #define MTL_DEBUG_RWCSTS BIT(0) 246 247 /* MTL interrupt */ 248 #define MTL_RX_OVERFLOW_INT_EN BIT(24) 249 #define MTL_RX_OVERFLOW_INT BIT(16) 250 251 /* Default operating mode of the MAC */ 252 #define GMAC_CORE_INIT (GMAC_CONFIG_JD | GMAC_CONFIG_PS | GMAC_CONFIG_ACS | \ 253 GMAC_CONFIG_BE | GMAC_CONFIG_DCRS) 254 255 /* To dump the core regs excluding the Address Registers */ 256 #define GMAC_REG_NUM 132 257 258 /* MTL debug */ 259 #define MTL_DEBUG_TXSTSFSTS BIT(5) 260 #define MTL_DEBUG_TXFSTS BIT(4) 261 #define MTL_DEBUG_TWCSTS BIT(3) 262 263 /* MTL debug: Tx FIFO Read Controller Status */ 264 #define MTL_DEBUG_TRCSTS_MASK GENMASK(2, 1) 265 #define MTL_DEBUG_TRCSTS_SHIFT 1 266 #define MTL_DEBUG_TRCSTS_IDLE 0 267 #define MTL_DEBUG_TRCSTS_READ 1 268 #define MTL_DEBUG_TRCSTS_TXW 2 269 #define MTL_DEBUG_TRCSTS_WRITE 3 270 #define MTL_DEBUG_TXPAUSED BIT(0) 271 272 /* MAC debug: GMII or MII Transmit Protocol Engine Status */ 273 #define MTL_DEBUG_RXFSTS_MASK GENMASK(5, 4) 274 #define MTL_DEBUG_RXFSTS_SHIFT 4 275 #define MTL_DEBUG_RXFSTS_EMPTY 0 276 #define MTL_DEBUG_RXFSTS_BT 1 277 #define MTL_DEBUG_RXFSTS_AT 2 278 #define MTL_DEBUG_RXFSTS_FULL 3 279 #define MTL_DEBUG_RRCSTS_MASK GENMASK(2, 1) 280 #define MTL_DEBUG_RRCSTS_SHIFT 1 281 #define MTL_DEBUG_RRCSTS_IDLE 0 282 #define MTL_DEBUG_RRCSTS_RDATA 1 283 #define MTL_DEBUG_RRCSTS_RSTAT 2 284 #define MTL_DEBUG_RRCSTS_FLUSH 3 285 #define MTL_DEBUG_RWCSTS BIT(0) 286 287 /* SGMII/RGMII status register */ 288 #define GMAC_PHYIF_CTRLSTATUS_TC BIT(0) 289 #define GMAC_PHYIF_CTRLSTATUS_LUD BIT(1) 290 #define GMAC_PHYIF_CTRLSTATUS_SMIDRXS BIT(4) 291 #define GMAC_PHYIF_CTRLSTATUS_LNKMOD BIT(16) 292 #define GMAC_PHYIF_CTRLSTATUS_SPEED GENMASK(18, 17) 293 #define GMAC_PHYIF_CTRLSTATUS_SPEED_SHIFT 17 294 #define GMAC_PHYIF_CTRLSTATUS_LNKSTS BIT(19) 295 #define GMAC_PHYIF_CTRLSTATUS_JABTO BIT(20) 296 #define GMAC_PHYIF_CTRLSTATUS_FALSECARDET BIT(21) 297 /* LNKMOD */ 298 #define GMAC_PHYIF_CTRLSTATUS_LNKMOD_MASK 0x1 299 /* LNKSPEED */ 300 #define GMAC_PHYIF_CTRLSTATUS_SPEED_125 0x2 301 #define GMAC_PHYIF_CTRLSTATUS_SPEED_25 0x1 302 #define GMAC_PHYIF_CTRLSTATUS_SPEED_2_5 0x0 303 304 extern const struct stmmac_dma_ops dwmac4_dma_ops; 305 extern const struct stmmac_dma_ops dwmac410_dma_ops; 306 #endif /* __DWMAC4_H__ */ 307