2 * SuperH Ethernet device driver
4 * Copyright (C) 2006-2008 Nobuhiro Iwamatsu
5 * Copyright (C) 2008-2011 Renesas Solutions Corp.
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms and conditions of the GNU General Public License,
9 * version 2, as published by the Free Software Foundation.
11 * This program is distributed in the hope it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 * The full GNU General Public License is included in this distribution in
20 * the file called "COPYING".
26 #include <linux/module.h>
27 #include <linux/kernel.h>
28 #include <linux/spinlock.h>
29 #include <linux/netdevice.h>
30 #include <linux/phy.h>
32 #include <asm/sh_eth.h>
34 #define CARDNAME "sh-eth"
35 #define TX_TIMEOUT (5*HZ)
36 #define TX_RING_SIZE 64 /* Tx ring size */
37 #define RX_RING_SIZE 64 /* Rx ring size */
39 #define PKT_BUF_SZ 1538
42 /* E-DMAC registers */
108 /* TSU Absolute address */
155 /* This value must be written at last. */
156 SH_ETH_MAX_REGISTER_OFFSET,
159 static const u16 sh_eth_offset_gigabit[SH_ETH_MAX_REGISTER_OFFSET] = {
210 [TSU_CTRST] = 0x0004,
211 [TSU_FWEN0] = 0x0010,
212 [TSU_FWEN1] = 0x0014,
214 [TSU_BSYSL0] = 0x0020,
215 [TSU_BSYSL1] = 0x0024,
216 [TSU_PRISL0] = 0x0028,
217 [TSU_PRISL1] = 0x002c,
218 [TSU_FWSL0] = 0x0030,
219 [TSU_FWSL1] = 0x0034,
220 [TSU_FWSLC] = 0x0038,
221 [TSU_QTAG0] = 0x0040,
222 [TSU_QTAG1] = 0x0044,
224 [TSU_FWINMK] = 0x0054,
225 [TSU_ADQT0] = 0x0048,
226 [TSU_ADQT1] = 0x004c,
227 [TSU_VTAG0] = 0x0058,
228 [TSU_VTAG1] = 0x005c,
229 [TSU_ADSBSY] = 0x0060,
231 [TSU_POST1] = 0x0070,
232 [TSU_POST2] = 0x0074,
233 [TSU_POST3] = 0x0078,
234 [TSU_POST4] = 0x007c,
235 [TSU_ADRH0] = 0x0100,
236 [TSU_ADRL0] = 0x0104,
237 [TSU_ADRH31] = 0x01f8,
238 [TSU_ADRL31] = 0x01fc,
254 static const u16 sh_eth_offset_fast_sh4[SH_ETH_MAX_REGISTER_OFFSET] = {
306 static const u16 sh_eth_offset_fast_sh3_sh2[SH_ETH_MAX_REGISTER_OFFSET] = {
331 [TSU_CTRST] = 0x0004,
332 [TSU_FWEN0] = 0x0010,
333 [TSU_FWEN1] = 0x0014,
335 [TSU_BSYSL0] = 0x0020,
336 [TSU_BSYSL1] = 0x0024,
337 [TSU_PRISL0] = 0x0028,
338 [TSU_PRISL1] = 0x002c,
339 [TSU_FWSL0] = 0x0030,
340 [TSU_FWSL1] = 0x0034,
341 [TSU_FWSLC] = 0x0038,
342 [TSU_QTAGM0] = 0x0040,
343 [TSU_QTAGM1] = 0x0044,
344 [TSU_ADQT0] = 0x0048,
345 [TSU_ADQT1] = 0x004c,
347 [TSU_FWINMK] = 0x0054,
348 [TSU_ADSBSY] = 0x0060,
350 [TSU_POST1] = 0x0070,
351 [TSU_POST2] = 0x0074,
352 [TSU_POST3] = 0x0078,
353 [TSU_POST4] = 0x007c,
368 [TSU_ADRH0] = 0x0100,
369 [TSU_ADRL0] = 0x0104,
370 [TSU_ADRL31] = 0x01fc,
374 #if defined(CONFIG_CPU_SUBTYPE_SH7763)
375 /* This CPU register maps is very difference by other SH4 CPU */
376 /* Chip Base Address */
377 # define SH_TSU_ADDR 0xFEE01800
378 # define ARSTR SH_TSU_ADDR
379 #elif defined(CONFIG_CPU_SH4) /* #if defined(CONFIG_CPU_SUBTYPE_SH7763) */
380 #else /* #elif defined(CONFIG_CPU_SH4) */
381 /* This section is SH3 or SH2 */
382 #ifndef CONFIG_CPU_SUBTYPE_SH7619
383 /* Chip base address */
384 # define SH_TSU_ADDR 0xA7000804
385 # define ARSTR 0xA7000800
387 #endif /* CONFIG_CPU_SUBTYPE_SH7763 */
389 /* Driver's parameters */
390 #if defined(CONFIG_CPU_SH4)
391 #define SH4_SKB_RX_ALIGN 32
393 #define SH2_SH3_SKB_RX_ALIGN 2
399 #ifdef CONFIG_CPU_SUBTYPE_SH7763
402 EDSR_ENT = 0x01, EDSR_ENR = 0x02,
404 #define EDSR_ENALL (EDSR_ENT|EDSR_ENR)
408 GECMR_10 = 0x0, GECMR_100 = 0x04, GECMR_1000 = 0x01,
414 EDMR_EL = 0x40, /* Litte endian */
415 EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
416 #ifdef CONFIG_CPU_SUBTYPE_SH7763
418 #else /* CONFIG_CPU_SUBTYPE_SH7763 */
425 #ifdef CONFIG_CPU_SUBTYPE_SH7763
439 TPAUSER_TPAUSE = 0x0000ffff,
440 TPAUSER_UNLIMITED = 0,
445 BCFR_RPAUSE = 0x0000ffff,
451 PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
455 enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };
459 EESR_TWB1 = 0x80000000,
460 EESR_TWB = 0x40000000, /* same as TWB0 */
461 EESR_TC1 = 0x20000000,
462 EESR_TUC = 0x10000000,
463 EESR_ROC = 0x08000000,
464 EESR_TABT = 0x04000000,
465 EESR_RABT = 0x02000000,
466 EESR_RFRMER = 0x01000000, /* same as RFCOF */
467 EESR_ADE = 0x00800000,
468 EESR_ECI = 0x00400000,
469 EESR_FTC = 0x00200000, /* same as TC or TC0 */
470 EESR_TDE = 0x00100000,
471 EESR_TFE = 0x00080000, /* same as TFUF */
472 EESR_FRC = 0x00040000, /* same as FR */
473 EESR_RDE = 0x00020000,
474 EESR_RFE = 0x00010000,
475 EESR_CND = 0x00000800,
476 EESR_DLC = 0x00000400,
477 EESR_CD = 0x00000200,
478 EESR_RTO = 0x00000100,
479 EESR_RMAF = 0x00000080,
480 EESR_CEEF = 0x00000040,
481 EESR_CELF = 0x00000020,
482 EESR_RRF = 0x00000010,
483 EESR_RTLF = 0x00000008,
484 EESR_RTSF = 0x00000004,
485 EESR_PRE = 0x00000002,
486 EESR_CERF = 0x00000001,
489 #define DEFAULT_TX_CHECK (EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | \
491 #define DEFAULT_EESR_ERR_CHECK (EESR_TWB | EESR_TABT | EESR_RABT | \
492 EESR_RDE | EESR_RFRMER | EESR_ADE | \
493 EESR_TFE | EESR_TDE | EESR_ECI)
494 #define DEFAULT_TX_ERROR_CHECK (EESR_TWB | EESR_TABT | EESR_ADE | EESR_TDE | \
499 DMAC_M_TWB = 0x40000000, DMAC_M_TABT = 0x04000000,
500 DMAC_M_RABT = 0x02000000,
501 DMAC_M_RFRMER = 0x01000000, DMAC_M_ADF = 0x00800000,
502 DMAC_M_ECI = 0x00400000, DMAC_M_FTC = 0x00200000,
503 DMAC_M_TDE = 0x00100000, DMAC_M_TFE = 0x00080000,
504 DMAC_M_FRC = 0x00040000, DMAC_M_RDE = 0x00020000,
505 DMAC_M_RFE = 0x00010000, DMAC_M_TINT4 = 0x00000800,
506 DMAC_M_TINT3 = 0x00000400, DMAC_M_TINT2 = 0x00000200,
507 DMAC_M_TINT1 = 0x00000100, DMAC_M_RINT8 = 0x00000080,
508 DMAC_M_RINT5 = 0x00000010, DMAC_M_RINT4 = 0x00000008,
509 DMAC_M_RINT3 = 0x00000004, DMAC_M_RINT2 = 0x00000002,
510 DMAC_M_RINT1 = 0x00000001,
513 /* Receive descriptor bit */
515 RD_RACT = 0x80000000, RD_RDEL = 0x40000000,
516 RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
517 RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
518 RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
519 RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
520 RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
521 RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
522 RD_RFS1 = 0x00000001,
524 #define RDF1ST RD_RFP1
525 #define RDFEND RD_RFP0
526 #define RD_RFP (RD_RFP1|RD_RFP0)
530 FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
531 FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
532 FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
534 #define DEFAULT_FIFO_F_D_RFF (FCFTR_RFF2 | FCFTR_RFF1 | FCFTR_RFF0)
535 #define DEFAULT_FIFO_F_D_RFD (FCFTR_RFD2 | FCFTR_RFD1 | FCFTR_RFD0)
537 /* Transfer descriptor bit */
539 TD_TACT = 0x80000000,
540 TD_TDLE = 0x40000000, TD_TFP1 = 0x20000000,
541 TD_TFP0 = 0x10000000,
543 #define TDF1ST TD_TFP1
544 #define TDFEND TD_TFP0
545 #define TD_TFP (TD_TFP1|TD_TFP0)
548 #define DEFAULT_RMCR_VALUE 0x00000000
551 enum FELIC_MODE_BIT {
552 ECMR_TRCCM = 0x04000000, ECMR_RCSC = 0x00800000,
553 ECMR_DPAD = 0x00200000, ECMR_RZPF = 0x00100000,
554 ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
555 ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
556 ECMR_PMDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
557 ECMR_RTM = 0x00000010, ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004,
558 ECMR_DM = 0x00000002, ECMR_PRM = 0x00000001,
562 enum ECSR_STATUS_BIT {
563 ECSR_BRCRX = 0x20, ECSR_PSRTO = 0x10,
565 ECSR_MPD = 0x02, ECSR_ICD = 0x01,
568 #define DEFAULT_ECSR_INIT (ECSR_BRCRX | ECSR_PSRTO | ECSR_LCHNG | \
569 ECSR_ICD | ECSIPR_MPDIP)
572 enum ECSIPR_STATUS_MASK_BIT {
573 ECSIPR_BRCRXIP = 0x20, ECSIPR_PSRTOIP = 0x10,
574 ECSIPR_LCHNGIP = 0x04,
575 ECSIPR_MPDIP = 0x02, ECSIPR_ICDIP = 0x01,
578 #define DEFAULT_ECSIPR_INIT (ECSIPR_BRCRXIP | ECSIPR_PSRTOIP | \
579 ECSIPR_LCHNGIP | ECSIPR_ICDIP | ECSIPR_MPDIP)
593 DESC_I_TINT4 = 0x0800, DESC_I_TINT3 = 0x0400, DESC_I_TINT2 = 0x0200,
594 DESC_I_TINT1 = 0x0100, DESC_I_RINT8 = 0x0080, DESC_I_RINT5 = 0x0010,
595 DESC_I_RINT4 = 0x0008, DESC_I_RINT3 = 0x0004, DESC_I_RINT2 = 0x0002,
596 DESC_I_RINT1 = 0x0001,
601 RPADIR_PADS1 = 0x20000, RPADIR_PADS0 = 0x10000,
602 RPADIR_PADR = 0x0003f,
606 #define RFLR_VALUE 0x1000
609 #define DEFAULT_FDR_INIT 0x00000707
612 PHY_CTRL = 0, PHY_STAT = 1, PHY_IDT1 = 2, PHY_IDT2 = 3,
613 PHY_ANA = 4, PHY_ANL = 5, PHY_ANE = 6,
619 PHY_C_RESET = 0x8000, PHY_C_LOOPBK = 0x4000, PHY_C_SPEEDSL = 0x2000,
620 PHY_C_ANEGEN = 0x1000, PHY_C_PWRDN = 0x0800, PHY_C_ISO = 0x0400,
621 PHY_C_RANEG = 0x0200, PHY_C_DUPLEX = 0x0100, PHY_C_COLT = 0x0080,
623 #define DM9161_PHY_C_ANEGEN 0 /* auto nego special */
627 PHY_S_100T4 = 0x8000, PHY_S_100X_F = 0x4000, PHY_S_100X_H = 0x2000,
628 PHY_S_10T_F = 0x1000, PHY_S_10T_H = 0x0800, PHY_S_ANEGC = 0x0020,
629 PHY_S_RFAULT = 0x0010, PHY_S_ANEGA = 0x0008, PHY_S_LINK = 0x0004,
630 PHY_S_JAB = 0x0002, PHY_S_EXTD = 0x0001,
635 PHY_A_NP = 0x8000, PHY_A_ACK = 0x4000, PHY_A_RF = 0x2000,
636 PHY_A_FCS = 0x0400, PHY_A_T4 = 0x0200, PHY_A_FDX = 0x0100,
637 PHY_A_HDX = 0x0080, PHY_A_10FDX = 0x0040, PHY_A_10HDX = 0x0020,
642 PHY_L_NP = 0x8000, PHY_L_ACK = 0x4000, PHY_L_RF = 0x2000,
643 PHY_L_FCS = 0x0400, PHY_L_T4 = 0x0200, PHY_L_FDX = 0x0100,
644 PHY_L_HDX = 0x0080, PHY_L_10FDX = 0x0040, PHY_L_10HDX = 0x0020,
650 PHY_E_PDF = 0x0010, PHY_E_LPNPA = 0x0008, PHY_E_NPA = 0x0004,
651 PHY_E_PRX = 0x0002, PHY_E_LPANEGA = 0x0001,
656 PHY_16_BP4B45 = 0x8000, PHY_16_BPSCR = 0x4000, PHY_16_BPALIGN = 0x2000,
657 PHY_16_BP_ADPOK = 0x1000, PHY_16_Repeatmode = 0x0800,
658 PHY_16_TXselect = 0x0400,
659 PHY_16_Rsvd = 0x0200, PHY_16_RMIIEnable = 0x0100,
660 PHY_16_Force100LNK = 0x0080,
661 PHY_16_APDLED_CTL = 0x0040, PHY_16_COLLED_CTL = 0x0020,
662 PHY_16_RPDCTR_EN = 0x0010,
663 PHY_16_ResetStMch = 0x0008, PHY_16_PreamSupr = 0x0004,
664 PHY_16_Sleepmode = 0x0002,
665 PHY_16_RemoteLoopOut = 0x0001,
670 #define POST0_RX (POST_RX)
671 #define POST0_FW (POST_FW)
672 #define POST1_RX (POST_RX >> 2)
673 #define POST1_FW (POST_FW >> 2)
674 #define POST_ALL (POST0_RX | POST0_FW | POST1_RX | POST1_FW)
677 enum ARSTR_BIT { ARSTR_ARSTR = 0x00000001, };
681 TSU_FWEN0_0 = 0x00000001,
685 enum TSU_ADSBSY_BIT {
686 TSU_ADSBSY_0 = 0x00000001,
691 TSU_TEN_0 = 0x80000000,
696 TSU_FWSL0_FW50 = 0x1000, TSU_FWSL0_FW40 = 0x0800,
697 TSU_FWSL0_FW30 = 0x0400, TSU_FWSL0_FW20 = 0x0200,
698 TSU_FWSL0_FW10 = 0x0100, TSU_FWSL0_RMSA0 = 0x0010,
703 TSU_FWSLC_POSTENU = 0x2000, TSU_FWSLC_POSTENL = 0x1000,
704 TSU_FWSLC_CAMSEL03 = 0x0080, TSU_FWSLC_CAMSEL02 = 0x0040,
705 TSU_FWSLC_CAMSEL01 = 0x0020, TSU_FWSLC_CAMSEL00 = 0x0010,
706 TSU_FWSLC_CAMSEL13 = 0x0008, TSU_FWSLC_CAMSEL12 = 0x0004,
707 TSU_FWSLC_CAMSEL11 = 0x0002, TSU_FWSLC_CAMSEL10 = 0x0001,
711 * The sh ether Tx buffer descriptors.
712 * This structure should be 20 bytes.
714 struct sh_eth_txdesc {
715 u32 status; /* TD0 */
716 #if defined(CONFIG_CPU_LITTLE_ENDIAN)
718 u16 buffer_length; /* TD1 */
720 u16 buffer_length; /* TD1 */
724 u32 pad1; /* padding data */
725 } __attribute__((aligned(2), packed));
728 * The sh ether Rx buffer descriptors.
729 * This structure should be 20 bytes.
731 struct sh_eth_rxdesc {
732 u32 status; /* RD0 */
733 #if defined(CONFIG_CPU_LITTLE_ENDIAN)
734 u16 frame_length; /* RD1 */
735 u16 buffer_length; /* RD1 */
737 u16 buffer_length; /* RD1 */
738 u16 frame_length; /* RD1 */
741 u32 pad0; /* padding data */
742 } __attribute__((aligned(2), packed));
744 /* This structure is used by each CPU dependency handling. */
745 struct sh_eth_cpu_data {
746 /* optional functions */
747 void (*chip_reset)(struct net_device *ndev);
748 void (*set_duplex)(struct net_device *ndev);
749 void (*set_rate)(struct net_device *ndev);
751 /* mandatory initialize value */
752 unsigned long eesipr_value;
754 /* optional initialize value */
755 unsigned long ecsr_value;
756 unsigned long ecsipr_value;
757 unsigned long fdr_value;
758 unsigned long fcftr_value;
759 unsigned long rpadir_value;
760 unsigned long rmcr_value;
762 /* interrupt checking mask */
763 unsigned long tx_check;
764 unsigned long eesr_err_check;
765 unsigned long tx_error_check;
767 /* hardware features */
768 unsigned no_psr:1; /* EtherC DO NOT have PSR */
769 unsigned apr:1; /* EtherC have APR */
770 unsigned mpr:1; /* EtherC have MPR */
771 unsigned tpauser:1; /* EtherC have TPAUSER */
772 unsigned bculr:1; /* EtherC have BCULR */
773 unsigned hw_swap:1; /* E-DMAC have DE bit in EDMR */
774 unsigned rpadir:1; /* E-DMAC have RPADIR */
775 unsigned no_trimd:1; /* E-DMAC DO NOT have TRIMD */
776 unsigned no_ade:1; /* E-DMAC DO NOT have ADE bit in EESR */
779 struct sh_eth_private {
780 struct platform_device *pdev;
781 struct sh_eth_cpu_data *cd;
782 const u16 *reg_offset;
783 void __iomem *tsu_addr;
784 dma_addr_t rx_desc_dma;
785 dma_addr_t tx_desc_dma;
786 struct sh_eth_rxdesc *rx_ring;
787 struct sh_eth_txdesc *tx_ring;
788 struct sk_buff **rx_skbuff;
789 struct sk_buff **tx_skbuff;
790 struct net_device_stats stats;
791 struct timer_list timer;
793 u32 cur_rx, dirty_rx; /* Producer/consumer ring indices */
794 u32 cur_tx, dirty_tx;
795 u32 rx_buf_sz; /* Based on MTU+slack. */
797 /* MII transceiver section. */
798 u32 phy_id; /* PHY ID */
799 struct mii_bus *mii_bus; /* MDIO bus control */
800 struct phy_device *phydev; /* PHY device control */
805 u32 rx_int_var, tx_int_var; /* interrupt control variables */
806 char post_rx; /* POST receive */
807 char post_fw; /* POST forward */
808 struct net_device_stats tsu_stats; /* TSU forward status */
810 unsigned no_ether_link:1;
811 unsigned ether_link_active_low:1;
814 static inline void sh_eth_soft_swap(char *src, int len)
816 #ifdef __LITTLE_ENDIAN__
819 maxp = p + ((len + sizeof(u32) - 1) / sizeof(u32));
821 for (; p < maxp; p++)
826 static inline void sh_eth_write(struct net_device *ndev, unsigned long data,
829 struct sh_eth_private *mdp = netdev_priv(ndev);
831 writel(data, ndev->base_addr + mdp->reg_offset[enum_index]);
834 static inline unsigned long sh_eth_read(struct net_device *ndev,
837 struct sh_eth_private *mdp = netdev_priv(ndev);
839 return readl(ndev->base_addr + mdp->reg_offset[enum_index]);
842 static inline void sh_eth_tsu_write(struct sh_eth_private *mdp,
843 unsigned long data, int enum_index)
845 writel(data, mdp->tsu_addr + mdp->reg_offset[enum_index]);
848 static inline unsigned long sh_eth_tsu_read(struct sh_eth_private *mdp,
851 return readl(mdp->tsu_addr + mdp->reg_offset[enum_index]);
854 #endif /* #ifndef __SH_ETH_H__ */