2 * sh_eth.h - Driver for Renesas SuperH ethernet controler.
4 * Copyright (C) 2008 - 2012 Renesas Solutions Corp.
5 * Copyright (c) 2008 - 2012 Nobuhiro Iwamatsu
6 * Copyright (c) 2007 Carlos Munoz <carlos@kenati.com>
8 * SPDX-License-Identifier: GPL-2.0+
12 #include <asm/types.h>
14 #define SHETHER_NAME "sh_eth"
16 #if defined(CONFIG_SH)
17 /* Malloc returns addresses in the P1 area (cacheable). However we need to
18 use area P2 (non-cacheable) */
19 #define ADDR_TO_P2(addr) ((((int)(addr) & ~0xe0000000) | 0xa0000000))
21 /* The ethernet controller needs to use physical addresses */
22 #if defined(CONFIG_SH_32BIT)
23 #define ADDR_TO_PHY(addr) ((((int)(addr) & ~0xe0000000) | 0x40000000))
25 #define ADDR_TO_PHY(addr) ((int)(addr) & ~0xe0000000)
27 #elif defined(CONFIG_ARM)
30 #define ADDR_TO_PHY(addr) ((int)(addr))
31 #define ADDR_TO_P2(addr) (addr)
32 #endif /* defined(CONFIG_SH) */
34 /* Number of supported ports */
35 #define MAX_PORT_NUM 2
37 /* Buffers must be big enough to hold the largest ethernet frame. Also, rx
38 buffers must be a multiple of 32 bytes */
39 #define MAX_BUF_SIZE (48 * 32)
41 /* The number of tx descriptors must be large enough to point to 5 or more
42 frames. If each frame uses 2 descriptors, at least 10 descriptors are needed.
43 We use one descriptor per frame */
46 /* The size of the tx descriptor is determined by how much padding is used.
47 4, 20, or 52 bytes of padding can be used */
48 #define TX_DESC_PADDING 4
49 #define TX_DESC_SIZE (12 + TX_DESC_PADDING)
51 /* Tx descriptor. We always use 3 bytes of padding */
55 u32 td2; /* Buffer start */
59 /* There is no limitation in the number of rx descriptors */
62 /* The size of the rx descriptor is determined by how much padding is used.
63 4, 20, or 52 bytes of padding can be used */
64 #define RX_DESC_PADDING 4
65 #define RX_DESC_SIZE (12 + RX_DESC_PADDING)
67 /* Rx descriptor. We always use 4 bytes of padding */
71 u32 rd2; /* Buffer start */
76 struct tx_desc_s *tx_desc_malloc;
77 struct tx_desc_s *tx_desc_base;
78 struct tx_desc_s *tx_desc_cur;
79 struct rx_desc_s *rx_desc_malloc;
80 struct rx_desc_s *rx_desc_base;
81 struct rx_desc_s *rx_desc_cur;
86 struct eth_device *dev;
87 struct phy_device *phydev;
92 struct sh_eth_info port_info[MAX_PORT_NUM];
95 /* from linux/drivers/net/ethernet/renesas/sh_eth.h */
97 /* E-DMAC registers */
126 /* Ether registers */
165 /* This value must be written at last. */
166 SH_ETH_MAX_REGISTER_OFFSET,
169 static const u16 sh_eth_offset_gigabit[SH_ETH_MAX_REGISTER_OFFSET] = {
223 static const u16 sh_eth_offset_fast_sh4[SH_ETH_MAX_REGISTER_OFFSET] = {
275 /* Register Address */
276 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
277 #define SH_ETH_TYPE_GETHER
278 #define BASE_IO_ADDR 0xfee00000
279 #elif defined(CONFIG_CPU_SH7757) || defined(CONFIG_CPU_SH7752)
280 #if defined(CONFIG_SH_ETHER_USE_GETHER)
281 #define SH_ETH_TYPE_GETHER
282 #define BASE_IO_ADDR 0xfee00000
284 #define SH_ETH_TYPE_ETHER
285 #define BASE_IO_ADDR 0xfef00000
287 #elif defined(CONFIG_CPU_SH7724)
288 #define SH_ETH_TYPE_ETHER
289 #define BASE_IO_ADDR 0xA4600000
290 #elif defined(CONFIG_R8A7740)
291 #define SH_ETH_TYPE_GETHER
292 #define BASE_IO_ADDR 0xE9A00000
297 * Copy from Linux driver source code
299 #if defined(SH_ETH_TYPE_GETHER)
302 EDSR_ENT = 0x01, EDSR_ENR = 0x02,
304 #define EDSR_ENALL (EDSR_ENT|EDSR_ENR)
309 EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
310 #if defined(SH_ETH_TYPE_GETHER)
311 EDMR_SRST = 0x03, /* Receive/Send reset */
312 EMDR_DESC_R = 0x30, /* Descriptor reserve size */
313 EDMR_EL = 0x40, /* Litte endian */
314 #elif defined(SH_ETH_TYPE_ETHER)
316 EMDR_DESC_R = 0x30, /* Descriptor reserve size */
317 EDMR_EL = 0x40, /* Litte endian */
324 #define RFLR_RFL_MIN 0x05EE /* Recv Frame length 1518 byte */
328 #if defined(SH_ETH_TYPE_GETHER)
337 #if defined(CONFIG_CPU_SH7757) || defined(CONFIG_CPU_SH7752)
338 GECMR_1000B = 0x20, GECMR_100B = 0x01, GECMR_10B = 0x00,
340 GECMR_1000B = 0x01, GECMR_100B = 0x04, GECMR_10B = 0x00,
351 TPAUSER_TPAUSE = 0x0000ffff,
352 TPAUSER_UNLIMITED = 0,
357 BCFR_RPAUSE = 0x0000ffff,
363 PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
367 enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };
372 #if defined(SH_ETH_TYPE_ETHER)
373 EESR_TWB = 0x40000000,
375 EESR_TWB = 0xC0000000,
376 EESR_TC1 = 0x20000000,
377 EESR_TUC = 0x10000000,
378 EESR_ROC = 0x80000000,
380 EESR_TABT = 0x04000000,
381 EESR_RABT = 0x02000000, EESR_RFRMER = 0x01000000,
382 #if defined(SH_ETH_TYPE_ETHER)
383 EESR_ADE = 0x00800000,
385 EESR_ECI = 0x00400000,
386 EESR_FTC = 0x00200000, EESR_TDE = 0x00100000,
387 EESR_TFE = 0x00080000, EESR_FRC = 0x00040000,
388 EESR_RDE = 0x00020000, EESR_RFE = 0x00010000,
389 #if defined(SH_ETH_TYPE_ETHER)
390 EESR_CND = 0x00000800,
392 EESR_DLC = 0x00000400,
393 EESR_CD = 0x00000200, EESR_RTO = 0x00000100,
394 EESR_RMAF = 0x00000080, EESR_CEEF = 0x00000040,
395 EESR_CELF = 0x00000020, EESR_RRF = 0x00000010,
396 rESR_RTLF = 0x00000008, EESR_RTSF = 0x00000004,
397 EESR_PRE = 0x00000002, EESR_CERF = 0x00000001,
401 #if defined(SH_ETH_TYPE_GETHER)
402 # define TX_CHECK (EESR_TC1 | EESR_FTC)
403 # define EESR_ERR_CHECK (EESR_TWB | EESR_TABT | EESR_RABT | EESR_RDE \
404 | EESR_RFRMER | EESR_TFE | EESR_TDE | EESR_ECI)
405 # define TX_ERROR_CEHCK (EESR_TWB | EESR_TABT | EESR_TDE | EESR_TFE)
408 # define TX_CHECK (EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | EESR_RTO)
409 # define EESR_ERR_CHECK (EESR_TWB | EESR_TABT | EESR_RABT | EESR_RDE \
410 | EESR_RFRMER | EESR_ADE | EESR_TFE | EESR_TDE | EESR_ECI)
411 # define TX_ERROR_CEHCK (EESR_TWB | EESR_TABT | EESR_ADE | EESR_TDE | EESR_TFE)
416 DMAC_M_TWB = 0x40000000, DMAC_M_TABT = 0x04000000,
417 DMAC_M_RABT = 0x02000000,
418 DMAC_M_RFRMER = 0x01000000, DMAC_M_ADF = 0x00800000,
419 DMAC_M_ECI = 0x00400000, DMAC_M_FTC = 0x00200000,
420 DMAC_M_TDE = 0x00100000, DMAC_M_TFE = 0x00080000,
421 DMAC_M_FRC = 0x00040000, DMAC_M_RDE = 0x00020000,
422 DMAC_M_RFE = 0x00010000, DMAC_M_TINT4 = 0x00000800,
423 DMAC_M_TINT3 = 0x00000400, DMAC_M_TINT2 = 0x00000200,
424 DMAC_M_TINT1 = 0x00000100, DMAC_M_RINT8 = 0x00000080,
425 DMAC_M_RINT5 = 0x00000010, DMAC_M_RINT4 = 0x00000008,
426 DMAC_M_RINT3 = 0x00000004, DMAC_M_RINT2 = 0x00000002,
427 DMAC_M_RINT1 = 0x00000001,
430 /* Receive descriptor bit */
432 RD_RACT = 0x80000000, RD_RDLE = 0x40000000,
433 RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
434 RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
435 RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
436 RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
437 RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
438 RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
439 RD_RFS1 = 0x00000001,
441 #define RDF1ST RD_RFP1
442 #define RDFEND RD_RFP0
443 #define RD_RFP (RD_RFP1|RD_RFP0)
452 FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
453 FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
454 FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
456 #define FIFO_F_D_RFF (FCFTR_RFF2|FCFTR_RFF1|FCFTR_RFF0)
457 #define FIFO_F_D_RFD (FCFTR_RFD2|FCFTR_RFD1|FCFTR_RFD0)
459 /* Transfer descriptor bit */
461 #if defined(SH_ETH_TYPE_GETHER) || defined(SH_ETH_TYPE_ETHER)
462 TD_TACT = 0x80000000,
464 TD_TACT = 0x7fffffff,
466 TD_TDLE = 0x40000000, TD_TFP1 = 0x20000000,
467 TD_TFP0 = 0x10000000,
469 #define TDF1ST TD_TFP1
470 #define TDFEND TD_TFP0
471 #define TD_TFP (TD_TFP1|TD_TFP0)
474 enum RECV_RST_BIT { RMCR_RST = 0x01, };
476 enum FELIC_MODE_BIT {
477 #if defined(SH_ETH_TYPE_GETHER)
478 ECMR_TRCCM=0x04000000, ECMR_RCSC= 0x00800000, ECMR_DPAD= 0x00200000,
479 ECMR_RZPF = 0x00100000,
481 ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
482 ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
483 ECMR_PMDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
484 ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004, ECMR_DM = 0x00000002,
485 ECMR_PRM = 0x00000001,
486 #ifdef CONFIG_CPU_SH7724
487 ECMR_RTM = 0x00000010,
492 #if defined(SH_ETH_TYPE_GETHER)
493 #define ECMR_CHG_DM (ECMR_TRCCM | ECMR_RZPF | ECMR_ZPF | ECMR_PFR | ECMR_RXF | \
495 #elif defined(SH_ETH_TYPE_ETHER)
496 #define ECMR_CHG_DM (ECMR_ZPF | ECMR_PFR | ECMR_RXF | ECMR_TXF)
498 #define ECMR_CHG_DM (ECMR_ZPF | ECMR_PFR | ECMR_RXF | ECMR_TXF | ECMR_MCT)
502 enum ECSR_STATUS_BIT {
503 #if defined(SH_ETH_TYPE_ETHER)
504 ECSR_BRCRX = 0x20, ECSR_PSRTO = 0x10,
507 ECSR_MPD = 0x02, ECSR_ICD = 0x01,
510 #if defined(SH_ETH_TYPE_GETHER)
511 # define ECSR_INIT (ECSR_ICD | ECSIPR_MPDIP)
513 # define ECSR_INIT (ECSR_BRCRX | ECSR_PSRTO | \
514 ECSR_LCHNG | ECSR_ICD | ECSIPR_MPDIP)
518 enum ECSIPR_STATUS_MASK_BIT {
519 #if defined(SH_ETH_TYPE_ETHER)
520 ECSIPR_BRCRXIP = 0x20,
521 ECSIPR_PSRTOIP = 0x10,
522 #elif defined(SH_ETY_TYPE_GETHER)
523 ECSIPR_PSRTOIP = 0x10,
526 ECSIPR_LCHNGIP = 0x04,
531 #if defined(SH_ETH_TYPE_GETHER)
532 # define ECSIPR_INIT (ECSIPR_LCHNGIP | ECSIPR_ICDIP | ECSIPR_MPDIP)
534 # define ECSIPR_INIT (ECSIPR_BRCRXIP | ECSIPR_PSRTOIP | ECSIPR_LCHNGIP | \
535 ECSIPR_ICDIP | ECSIPR_MPDIP)
550 DESC_I_TINT4 = 0x0800, DESC_I_TINT3 = 0x0400, DESC_I_TINT2 = 0x0200,
551 DESC_I_TINT1 = 0x0100, DESC_I_RINT8 = 0x0080, DESC_I_RINT5 = 0x0010,
552 DESC_I_RINT4 = 0x0008, DESC_I_RINT3 = 0x0004, DESC_I_RINT2 = 0x0002,
553 DESC_I_RINT1 = 0x0001,
558 RPADIR_PADS1 = 0x20000, RPADIR_PADS0 = 0x10000,
559 RPADIR_PADR = 0x0003f,
562 #if defined(SH_ETH_TYPE_GETHER)
563 # define RPADIR_INIT (0x00)
565 # define RPADIR_INIT (RPADIR_PADS1)
570 FIFO_SIZE_T = 0x00000700, FIFO_SIZE_R = 0x00000007,
573 static inline unsigned long sh_eth_reg_addr(struct sh_eth_dev *eth,
576 #if defined(SH_ETH_TYPE_GETHER)
577 const u16 *reg_offset = sh_eth_offset_gigabit;
578 #elif defined(SH_ETH_TYPE_ETHER)
579 const u16 *reg_offset = sh_eth_offset_fast_sh4;
583 return BASE_IO_ADDR + reg_offset[enum_index] + 0x800 * eth->port;
586 static inline void sh_eth_write(struct sh_eth_dev *eth, unsigned long data,
589 outl(data, sh_eth_reg_addr(eth, enum_index));
592 static inline unsigned long sh_eth_read(struct sh_eth_dev *eth,
595 return inl(sh_eth_reg_addr(eth, enum_index));