2 * SuperH Ethernet device driver
4 * Copyright (C) 2006-2012 Nobuhiro Iwamatsu
5 * Copyright (C) 2008-2012 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 #define CARDNAME "sh-eth"
27 #define TX_TIMEOUT (5*HZ)
28 #define TX_RING_SIZE 64 /* Tx ring size */
29 #define RX_RING_SIZE 64 /* Rx ring size */
30 #define TX_RING_MIN 64
31 #define RX_RING_MIN 64
32 #define TX_RING_MAX 1024
33 #define RX_RING_MAX 1024
35 #define PKT_BUF_SZ 1538
36 #define SH_ETH_TSU_TIMEOUT_MS 500
37 #define SH_ETH_TSU_CAM_ENTRIES 32
40 /* E-DMAC registers */
108 /* TSU Absolute address */
155 /* This value must be written at last. */
156 SH_ETH_MAX_REGISTER_OFFSET,
159 /* Driver's parameters */
160 #if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
161 #define SH4_SKB_RX_ALIGN 32
163 #define SH2_SH3_SKB_RX_ALIGN 2
169 /* EDSR : sh7734, sh7757, sh7763, and r8a7740 only */
171 EDSR_ENT = 0x01, EDSR_ENR = 0x02,
173 #define EDSR_ENALL (EDSR_ENT|EDSR_ENR)
175 /* GECMR : sh7734, sh7763 and r8a7740 only */
177 GECMR_10 = 0x0, GECMR_100 = 0x04, GECMR_1000 = 0x01,
182 EDMR_EL = 0x40, /* Litte endian */
183 EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
184 EDMR_SRST_GETHER = 0x03,
185 EDMR_SRST_ETHER = 0x01,
190 EDTRR_TRNS_GETHER = 0x03,
191 EDTRR_TRNS_ETHER = 0x01,
201 TPAUSER_TPAUSE = 0x0000ffff,
202 TPAUSER_UNLIMITED = 0,
207 BCFR_RPAUSE = 0x0000ffff,
213 PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
217 enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };
221 EESR_TWB1 = 0x80000000,
222 EESR_TWB = 0x40000000, /* same as TWB0 */
223 EESR_TC1 = 0x20000000,
224 EESR_TUC = 0x10000000,
225 EESR_ROC = 0x08000000,
226 EESR_TABT = 0x04000000,
227 EESR_RABT = 0x02000000,
228 EESR_RFRMER = 0x01000000, /* same as RFCOF */
229 EESR_ADE = 0x00800000,
230 EESR_ECI = 0x00400000,
231 EESR_FTC = 0x00200000, /* same as TC or TC0 */
232 EESR_TDE = 0x00100000,
233 EESR_TFE = 0x00080000, /* same as TFUF */
234 EESR_FRC = 0x00040000, /* same as FR */
235 EESR_RDE = 0x00020000,
236 EESR_RFE = 0x00010000,
237 EESR_CND = 0x00000800,
238 EESR_DLC = 0x00000400,
239 EESR_CD = 0x00000200,
240 EESR_RTO = 0x00000100,
241 EESR_RMAF = 0x00000080,
242 EESR_CEEF = 0x00000040,
243 EESR_CELF = 0x00000020,
244 EESR_RRF = 0x00000010,
245 EESR_RTLF = 0x00000008,
246 EESR_RTSF = 0x00000004,
247 EESR_PRE = 0x00000002,
248 EESR_CERF = 0x00000001,
251 #define EESR_RX_CHECK (EESR_FRC | /* Frame recv */ \
252 EESR_RMAF | /* Multicast address recv */ \
253 EESR_RRF | /* Bit frame recv */ \
254 EESR_RTLF | /* Long frame recv */ \
255 EESR_RTSF | /* Short frame recv */ \
256 EESR_PRE | /* PHY-LSI recv error */ \
257 EESR_CERF) /* Recv frame CRC error */
259 #define DEFAULT_TX_CHECK (EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | \
261 #define DEFAULT_EESR_ERR_CHECK (EESR_TWB | EESR_TABT | EESR_RABT | \
262 EESR_RDE | EESR_RFRMER | EESR_ADE | \
263 EESR_TFE | EESR_TDE | EESR_ECI)
264 #define DEFAULT_TX_ERROR_CHECK (EESR_TWB | EESR_TABT | EESR_ADE | EESR_TDE | \
269 DMAC_M_TWB = 0x40000000, DMAC_M_TABT = 0x04000000,
270 DMAC_M_RABT = 0x02000000,
271 DMAC_M_RFRMER = 0x01000000, DMAC_M_ADF = 0x00800000,
272 DMAC_M_ECI = 0x00400000, DMAC_M_FTC = 0x00200000,
273 DMAC_M_TDE = 0x00100000, DMAC_M_TFE = 0x00080000,
274 DMAC_M_FRC = 0x00040000, DMAC_M_RDE = 0x00020000,
275 DMAC_M_RFE = 0x00010000, DMAC_M_TINT4 = 0x00000800,
276 DMAC_M_TINT3 = 0x00000400, DMAC_M_TINT2 = 0x00000200,
277 DMAC_M_TINT1 = 0x00000100, DMAC_M_RINT8 = 0x00000080,
278 DMAC_M_RINT5 = 0x00000010, DMAC_M_RINT4 = 0x00000008,
279 DMAC_M_RINT3 = 0x00000004, DMAC_M_RINT2 = 0x00000002,
280 DMAC_M_RINT1 = 0x00000001,
283 /* Receive descriptor bit */
285 RD_RACT = 0x80000000, RD_RDEL = 0x40000000,
286 RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
287 RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
288 RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
289 RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
290 RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
291 RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
292 RD_RFS1 = 0x00000001,
294 #define RDF1ST RD_RFP1
295 #define RDFEND RD_RFP0
296 #define RD_RFP (RD_RFP1|RD_RFP0)
300 FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
301 FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
302 FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
304 #define DEFAULT_FIFO_F_D_RFF (FCFTR_RFF2 | FCFTR_RFF1 | FCFTR_RFF0)
305 #define DEFAULT_FIFO_F_D_RFD (FCFTR_RFD2 | FCFTR_RFD1 | FCFTR_RFD0)
307 /* Transfer descriptor bit */
309 TD_TACT = 0x80000000,
310 TD_TDLE = 0x40000000, TD_TFP1 = 0x20000000,
311 TD_TFP0 = 0x10000000,
313 #define TDF1ST TD_TFP1
314 #define TDFEND TD_TFP0
315 #define TD_TFP (TD_TFP1|TD_TFP0)
318 #define DEFAULT_RMCR_VALUE 0x00000000
321 enum FELIC_MODE_BIT {
322 ECMR_TRCCM = 0x04000000, ECMR_RCSC = 0x00800000,
323 ECMR_DPAD = 0x00200000, ECMR_RZPF = 0x00100000,
324 ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
325 ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
326 ECMR_PMDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
327 ECMR_RTM = 0x00000010, ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004,
328 ECMR_DM = 0x00000002, ECMR_PRM = 0x00000001,
332 enum ECSR_STATUS_BIT {
333 ECSR_BRCRX = 0x20, ECSR_PSRTO = 0x10,
335 ECSR_MPD = 0x02, ECSR_ICD = 0x01,
338 #define DEFAULT_ECSR_INIT (ECSR_BRCRX | ECSR_PSRTO | ECSR_LCHNG | \
339 ECSR_ICD | ECSIPR_MPDIP)
342 enum ECSIPR_STATUS_MASK_BIT {
343 ECSIPR_BRCRXIP = 0x20, ECSIPR_PSRTOIP = 0x10,
344 ECSIPR_LCHNGIP = 0x04,
345 ECSIPR_MPDIP = 0x02, ECSIPR_ICDIP = 0x01,
348 #define DEFAULT_ECSIPR_INIT (ECSIPR_BRCRXIP | ECSIPR_PSRTOIP | \
349 ECSIPR_LCHNGIP | ECSIPR_ICDIP | ECSIPR_MPDIP)
363 DESC_I_TINT4 = 0x0800, DESC_I_TINT3 = 0x0400, DESC_I_TINT2 = 0x0200,
364 DESC_I_TINT1 = 0x0100, DESC_I_RINT8 = 0x0080, DESC_I_RINT5 = 0x0010,
365 DESC_I_RINT4 = 0x0008, DESC_I_RINT3 = 0x0004, DESC_I_RINT2 = 0x0002,
366 DESC_I_RINT1 = 0x0001,
371 RPADIR_PADS1 = 0x20000, RPADIR_PADS0 = 0x10000,
372 RPADIR_PADR = 0x0003f,
376 #define DEFAULT_FDR_INIT 0x00000707
379 enum ARSTR_BIT { ARSTR_ARSTR = 0x00000001, };
383 TSU_FWEN0_0 = 0x00000001,
387 enum TSU_ADSBSY_BIT {
388 TSU_ADSBSY_0 = 0x00000001,
393 TSU_TEN_0 = 0x80000000,
398 TSU_FWSL0_FW50 = 0x1000, TSU_FWSL0_FW40 = 0x0800,
399 TSU_FWSL0_FW30 = 0x0400, TSU_FWSL0_FW20 = 0x0200,
400 TSU_FWSL0_FW10 = 0x0100, TSU_FWSL0_RMSA0 = 0x0010,
405 TSU_FWSLC_POSTENU = 0x2000, TSU_FWSLC_POSTENL = 0x1000,
406 TSU_FWSLC_CAMSEL03 = 0x0080, TSU_FWSLC_CAMSEL02 = 0x0040,
407 TSU_FWSLC_CAMSEL01 = 0x0020, TSU_FWSLC_CAMSEL00 = 0x0010,
408 TSU_FWSLC_CAMSEL13 = 0x0008, TSU_FWSLC_CAMSEL12 = 0x0004,
409 TSU_FWSLC_CAMSEL11 = 0x0002, TSU_FWSLC_CAMSEL10 = 0x0001,
413 #define TSU_VTAG_ENABLE 0x80000000
414 #define TSU_VTAG_VID_MASK 0x00000fff
417 * The sh ether Tx buffer descriptors.
418 * This structure should be 20 bytes.
420 struct sh_eth_txdesc {
421 u32 status; /* TD0 */
422 #if defined(__LITTLE_ENDIAN)
424 u16 buffer_length; /* TD1 */
426 u16 buffer_length; /* TD1 */
430 u32 pad1; /* padding data */
431 } __attribute__((aligned(2), packed));
434 * The sh ether Rx buffer descriptors.
435 * This structure should be 20 bytes.
437 struct sh_eth_rxdesc {
438 u32 status; /* RD0 */
439 #if defined(__LITTLE_ENDIAN)
440 u16 frame_length; /* RD1 */
441 u16 buffer_length; /* RD1 */
443 u16 buffer_length; /* RD1 */
444 u16 frame_length; /* RD1 */
447 u32 pad0; /* padding data */
448 } __attribute__((aligned(2), packed));
450 /* This structure is used by each CPU dependency handling. */
451 struct sh_eth_cpu_data {
452 /* optional functions */
453 void (*chip_reset)(struct net_device *ndev);
454 void (*set_duplex)(struct net_device *ndev);
455 void (*set_rate)(struct net_device *ndev);
457 /* mandatory initialize value */
458 unsigned long eesipr_value;
460 /* optional initialize value */
461 unsigned long ecsr_value;
462 unsigned long ecsipr_value;
463 unsigned long fdr_value;
464 unsigned long fcftr_value;
465 unsigned long rpadir_value;
466 unsigned long rmcr_value;
468 /* interrupt checking mask */
469 unsigned long tx_check;
470 unsigned long eesr_err_check;
471 unsigned long tx_error_check;
473 /* hardware features */
474 unsigned long irq_flags; /* IRQ configuration flags */
475 unsigned no_psr:1; /* EtherC DO NOT have PSR */
476 unsigned apr:1; /* EtherC have APR */
477 unsigned mpr:1; /* EtherC have MPR */
478 unsigned tpauser:1; /* EtherC have TPAUSER */
479 unsigned bculr:1; /* EtherC have BCULR */
480 unsigned tsu:1; /* EtherC have TSU */
481 unsigned hw_swap:1; /* E-DMAC have DE bit in EDMR */
482 unsigned rpadir:1; /* E-DMAC have RPADIR */
483 unsigned no_trimd:1; /* E-DMAC DO NOT have TRIMD */
484 unsigned no_ade:1; /* E-DMAC DO NOT have ADE bit in EESR */
485 unsigned hw_crc:1; /* E-DMAC have CSMR */
486 unsigned select_mii:1; /* EtherC have RMII_MII (MII select register) */
489 struct sh_eth_private {
490 struct platform_device *pdev;
491 struct sh_eth_cpu_data *cd;
492 const u16 *reg_offset;
494 void __iomem *tsu_addr;
497 dma_addr_t rx_desc_dma;
498 dma_addr_t tx_desc_dma;
499 struct sh_eth_rxdesc *rx_ring;
500 struct sh_eth_txdesc *tx_ring;
501 struct sk_buff **rx_skbuff;
502 struct sk_buff **tx_skbuff;
504 u32 cur_rx, dirty_rx; /* Producer/consumer ring indices */
505 u32 cur_tx, dirty_tx;
506 u32 rx_buf_sz; /* Based on MTU+slack. */
508 /* MII transceiver section. */
509 u32 phy_id; /* PHY ID */
510 struct mii_bus *mii_bus; /* MDIO bus control */
511 struct phy_device *phydev; /* PHY device control */
513 phy_interface_t phy_interface;
517 int port; /* for TSU */
518 int vlan_num_ids; /* for VLAN tag filter */
520 unsigned no_ether_link:1;
521 unsigned ether_link_active_low:1;
524 static inline void sh_eth_soft_swap(char *src, int len)
526 #ifdef __LITTLE_ENDIAN__
529 maxp = p + ((len + sizeof(u32) - 1) / sizeof(u32));
531 for (; p < maxp; p++)
536 static inline void sh_eth_write(struct net_device *ndev, unsigned long data,
539 struct sh_eth_private *mdp = netdev_priv(ndev);
541 iowrite32(data, mdp->addr + mdp->reg_offset[enum_index]);
544 static inline unsigned long sh_eth_read(struct net_device *ndev,
547 struct sh_eth_private *mdp = netdev_priv(ndev);
549 return ioread32(mdp->addr + mdp->reg_offset[enum_index]);
552 static inline void *sh_eth_tsu_get_offset(struct sh_eth_private *mdp,
555 return mdp->tsu_addr + mdp->reg_offset[enum_index];
558 static inline void sh_eth_tsu_write(struct sh_eth_private *mdp,
559 unsigned long data, int enum_index)
561 iowrite32(data, mdp->tsu_addr + mdp->reg_offset[enum_index]);
564 static inline unsigned long sh_eth_tsu_read(struct sh_eth_private *mdp,
567 return ioread32(mdp->tsu_addr + mdp->reg_offset[enum_index]);
570 #endif /* #ifndef __SH_ETH_H__ */