Loading...
1/* SuperH Ethernet device driver
2 *
3 * Copyright (C) 2006-2012 Nobuhiro Iwamatsu
4 * Copyright (C) 2008-2012 Renesas Solutions Corp.
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 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * The full GNU General Public License is included in this distribution in
16 * the file called "COPYING".
17 */
18
19#ifndef __SH_ETH_H__
20#define __SH_ETH_H__
21
22#define CARDNAME "sh-eth"
23#define TX_TIMEOUT (5*HZ)
24#define TX_RING_SIZE 64 /* Tx ring size */
25#define RX_RING_SIZE 64 /* Rx ring size */
26#define TX_RING_MIN 64
27#define RX_RING_MIN 64
28#define TX_RING_MAX 1024
29#define RX_RING_MAX 1024
30#define PKT_BUF_SZ 1538
31#define SH_ETH_TSU_TIMEOUT_MS 500
32#define SH_ETH_TSU_CAM_ENTRIES 32
33
34enum {
35 /* E-DMAC registers */
36 EDSR = 0,
37 EDMR,
38 EDTRR,
39 EDRRR,
40 EESR,
41 EESIPR,
42 TDLAR,
43 TDFAR,
44 TDFXR,
45 TDFFR,
46 RDLAR,
47 RDFAR,
48 RDFXR,
49 RDFFR,
50 TRSCER,
51 RMFCR,
52 TFTR,
53 FDR,
54 RMCR,
55 EDOCR,
56 TFUCR,
57 RFOCR,
58 RMIIMODE,
59 FCFTR,
60 RPADIR,
61 TRIMD,
62 RBWAR,
63 TBRAR,
64
65 /* Ether registers */
66 ECMR,
67 ECSR,
68 ECSIPR,
69 PIR,
70 PSR,
71 RDMLR,
72 PIPR,
73 RFLR,
74 IPGR,
75 APR,
76 MPR,
77 PFTCR,
78 PFRCR,
79 RFCR,
80 RFCF,
81 TPAUSER,
82 TPAUSECR,
83 BCFR,
84 BCFRR,
85 GECMR,
86 BCULR,
87 MAHR,
88 MALR,
89 TROCR,
90 CDCR,
91 LCCR,
92 CNDCR,
93 CEFCR,
94 FRECR,
95 TSFRCR,
96 TLFRCR,
97 CERCR,
98 CEECR,
99 MAFCR,
100 RTRATE,
101 CSMR,
102 RMII_MII,
103
104 /* TSU Absolute address */
105 ARSTR,
106 TSU_CTRST,
107 TSU_FWEN0,
108 TSU_FWEN1,
109 TSU_FCM,
110 TSU_BSYSL0,
111 TSU_BSYSL1,
112 TSU_PRISL0,
113 TSU_PRISL1,
114 TSU_FWSL0,
115 TSU_FWSL1,
116 TSU_FWSLC,
117 TSU_QTAG0,
118 TSU_QTAG1,
119 TSU_QTAGM0,
120 TSU_QTAGM1,
121 TSU_FWSR,
122 TSU_FWINMK,
123 TSU_ADQT0,
124 TSU_ADQT1,
125 TSU_VTAG0,
126 TSU_VTAG1,
127 TSU_ADSBSY,
128 TSU_TEN,
129 TSU_POST1,
130 TSU_POST2,
131 TSU_POST3,
132 TSU_POST4,
133 TSU_ADRH0,
134 TSU_ADRL0,
135 TSU_ADRH31,
136 TSU_ADRL31,
137
138 TXNLCR0,
139 TXALCR0,
140 RXNLCR0,
141 RXALCR0,
142 FWNLCR0,
143 FWALCR0,
144 TXNLCR1,
145 TXALCR1,
146 RXNLCR1,
147 RXALCR1,
148 FWNLCR1,
149 FWALCR1,
150
151 /* This value must be written at last. */
152 SH_ETH_MAX_REGISTER_OFFSET,
153};
154
155enum {
156 SH_ETH_REG_GIGABIT,
157 SH_ETH_REG_FAST_RZ,
158 SH_ETH_REG_FAST_RCAR,
159 SH_ETH_REG_FAST_SH4,
160 SH_ETH_REG_FAST_SH3_SH2
161};
162
163/* Driver's parameters */
164#if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
165#define SH4_SKB_RX_ALIGN 32
166#else
167#define SH2_SH3_SKB_RX_ALIGN 2
168#endif
169
170/* Register's bits
171 */
172/* EDSR : sh7734, sh7757, sh7763, r8a7740, and r7s72100 only */
173enum EDSR_BIT {
174 EDSR_ENT = 0x01, EDSR_ENR = 0x02,
175};
176#define EDSR_ENALL (EDSR_ENT|EDSR_ENR)
177
178/* GECMR : sh7734, sh7763 and r8a7740 only */
179enum GECMR_BIT {
180 GECMR_10 = 0x0, GECMR_100 = 0x04, GECMR_1000 = 0x01,
181};
182
183/* EDMR */
184enum DMAC_M_BIT {
185 EDMR_EL = 0x40, /* Litte endian */
186 EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
187 EDMR_SRST_GETHER = 0x03,
188 EDMR_SRST_ETHER = 0x01,
189};
190
191/* EDTRR */
192enum DMAC_T_BIT {
193 EDTRR_TRNS_GETHER = 0x03,
194 EDTRR_TRNS_ETHER = 0x01,
195};
196
197/* EDRRR */
198enum EDRRR_R_BIT {
199 EDRRR_R = 0x01,
200};
201
202/* TPAUSER */
203enum TPAUSER_BIT {
204 TPAUSER_TPAUSE = 0x0000ffff,
205 TPAUSER_UNLIMITED = 0,
206};
207
208/* BCFR */
209enum BCFR_BIT {
210 BCFR_RPAUSE = 0x0000ffff,
211 BCFR_UNLIMITED = 0,
212};
213
214/* PIR */
215enum PIR_BIT {
216 PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
217};
218
219/* PSR */
220enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };
221
222/* EESR */
223enum EESR_BIT {
224 EESR_TWB1 = 0x80000000,
225 EESR_TWB = 0x40000000, /* same as TWB0 */
226 EESR_TC1 = 0x20000000,
227 EESR_TUC = 0x10000000,
228 EESR_ROC = 0x08000000,
229 EESR_TABT = 0x04000000,
230 EESR_RABT = 0x02000000,
231 EESR_RFRMER = 0x01000000, /* same as RFCOF */
232 EESR_ADE = 0x00800000,
233 EESR_ECI = 0x00400000,
234 EESR_FTC = 0x00200000, /* same as TC or TC0 */
235 EESR_TDE = 0x00100000,
236 EESR_TFE = 0x00080000, /* same as TFUF */
237 EESR_FRC = 0x00040000, /* same as FR */
238 EESR_RDE = 0x00020000,
239 EESR_RFE = 0x00010000,
240 EESR_CND = 0x00000800,
241 EESR_DLC = 0x00000400,
242 EESR_CD = 0x00000200,
243 EESR_RTO = 0x00000100,
244 EESR_RMAF = 0x00000080,
245 EESR_CEEF = 0x00000040,
246 EESR_CELF = 0x00000020,
247 EESR_RRF = 0x00000010,
248 EESR_RTLF = 0x00000008,
249 EESR_RTSF = 0x00000004,
250 EESR_PRE = 0x00000002,
251 EESR_CERF = 0x00000001,
252};
253
254#define EESR_RX_CHECK (EESR_FRC | /* Frame recv */ \
255 EESR_RMAF | /* Multicast address recv */ \
256 EESR_RRF | /* Bit frame recv */ \
257 EESR_RTLF | /* Long frame recv */ \
258 EESR_RTSF | /* Short frame recv */ \
259 EESR_PRE | /* PHY-LSI recv error */ \
260 EESR_CERF) /* Recv frame CRC error */
261
262#define DEFAULT_TX_CHECK (EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | \
263 EESR_RTO)
264#define DEFAULT_EESR_ERR_CHECK (EESR_TWB | EESR_TABT | EESR_RABT | EESR_RFE | \
265 EESR_RDE | EESR_RFRMER | EESR_ADE | \
266 EESR_TFE | EESR_TDE | EESR_ECI)
267
268/* EESIPR */
269enum DMAC_IM_BIT {
270 DMAC_M_TWB = 0x40000000, DMAC_M_TABT = 0x04000000,
271 DMAC_M_RABT = 0x02000000,
272 DMAC_M_RFRMER = 0x01000000, DMAC_M_ADF = 0x00800000,
273 DMAC_M_ECI = 0x00400000, DMAC_M_FTC = 0x00200000,
274 DMAC_M_TDE = 0x00100000, DMAC_M_TFE = 0x00080000,
275 DMAC_M_FRC = 0x00040000, DMAC_M_RDE = 0x00020000,
276 DMAC_M_RFE = 0x00010000, DMAC_M_TINT4 = 0x00000800,
277 DMAC_M_TINT3 = 0x00000400, DMAC_M_TINT2 = 0x00000200,
278 DMAC_M_TINT1 = 0x00000100, DMAC_M_RINT8 = 0x00000080,
279 DMAC_M_RINT5 = 0x00000010, DMAC_M_RINT4 = 0x00000008,
280 DMAC_M_RINT3 = 0x00000004, DMAC_M_RINT2 = 0x00000002,
281 DMAC_M_RINT1 = 0x00000001,
282};
283
284/* Receive descriptor bit */
285enum RD_STS_BIT {
286 RD_RACT = 0x80000000, RD_RDEL = 0x40000000,
287 RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
288 RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
289 RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
290 RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
291 RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
292 RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
293 RD_RFS1 = 0x00000001,
294};
295#define RDF1ST RD_RFP1
296#define RDFEND RD_RFP0
297#define RD_RFP (RD_RFP1|RD_RFP0)
298
299/* FCFTR */
300enum FCFTR_BIT {
301 FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
302 FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
303 FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
304};
305#define DEFAULT_FIFO_F_D_RFF (FCFTR_RFF2 | FCFTR_RFF1 | FCFTR_RFF0)
306#define DEFAULT_FIFO_F_D_RFD (FCFTR_RFD2 | FCFTR_RFD1 | FCFTR_RFD0)
307
308/* Transmit descriptor bit */
309enum TD_STS_BIT {
310 TD_TACT = 0x80000000, TD_TDLE = 0x40000000,
311 TD_TFP1 = 0x20000000, TD_TFP0 = 0x10000000,
312 TD_TFE = 0x08000000, TD_TWBI = 0x04000000,
313};
314#define TDF1ST TD_TFP1
315#define TDFEND TD_TFP0
316#define TD_TFP (TD_TFP1|TD_TFP0)
317
318/* RMCR */
319enum RMCR_BIT {
320 RMCR_RNC = 0x00000001,
321};
322#define DEFAULT_RMCR_VALUE 0x00000000
323
324/* ECMR */
325enum FELIC_MODE_BIT {
326 ECMR_TRCCM = 0x04000000, ECMR_RCSC = 0x00800000,
327 ECMR_DPAD = 0x00200000, ECMR_RZPF = 0x00100000,
328 ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
329 ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
330 ECMR_PMDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
331 ECMR_RTM = 0x00000010, ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004,
332 ECMR_DM = 0x00000002, ECMR_PRM = 0x00000001,
333};
334
335/* ECSR */
336enum ECSR_STATUS_BIT {
337 ECSR_BRCRX = 0x20, ECSR_PSRTO = 0x10,
338 ECSR_LCHNG = 0x04,
339 ECSR_MPD = 0x02, ECSR_ICD = 0x01,
340};
341
342#define DEFAULT_ECSR_INIT (ECSR_BRCRX | ECSR_PSRTO | ECSR_LCHNG | \
343 ECSR_ICD | ECSIPR_MPDIP)
344
345/* ECSIPR */
346enum ECSIPR_STATUS_MASK_BIT {
347 ECSIPR_BRCRXIP = 0x20, ECSIPR_PSRTOIP = 0x10,
348 ECSIPR_LCHNGIP = 0x04,
349 ECSIPR_MPDIP = 0x02, ECSIPR_ICDIP = 0x01,
350};
351
352#define DEFAULT_ECSIPR_INIT (ECSIPR_BRCRXIP | ECSIPR_PSRTOIP | \
353 ECSIPR_LCHNGIP | ECSIPR_ICDIP | ECSIPR_MPDIP)
354
355/* APR */
356enum APR_BIT {
357 APR_AP = 0x00000001,
358};
359
360/* MPR */
361enum MPR_BIT {
362 MPR_MP = 0x00000001,
363};
364
365/* TRSCER */
366enum DESC_I_BIT {
367 DESC_I_TINT4 = 0x0800, DESC_I_TINT3 = 0x0400, DESC_I_TINT2 = 0x0200,
368 DESC_I_TINT1 = 0x0100, DESC_I_RINT8 = 0x0080, DESC_I_RINT5 = 0x0010,
369 DESC_I_RINT4 = 0x0008, DESC_I_RINT3 = 0x0004, DESC_I_RINT2 = 0x0002,
370 DESC_I_RINT1 = 0x0001,
371};
372
373/* RPADIR */
374enum RPADIR_BIT {
375 RPADIR_PADS1 = 0x20000, RPADIR_PADS0 = 0x10000,
376 RPADIR_PADR = 0x0003f,
377};
378
379/* FDR */
380#define DEFAULT_FDR_INIT 0x00000707
381
382/* ARSTR */
383enum ARSTR_BIT { ARSTR_ARSTR = 0x00000001, };
384
385/* TSU_FWEN0 */
386enum TSU_FWEN0_BIT {
387 TSU_FWEN0_0 = 0x00000001,
388};
389
390/* TSU_ADSBSY */
391enum TSU_ADSBSY_BIT {
392 TSU_ADSBSY_0 = 0x00000001,
393};
394
395/* TSU_TEN */
396enum TSU_TEN_BIT {
397 TSU_TEN_0 = 0x80000000,
398};
399
400/* TSU_FWSL0 */
401enum TSU_FWSL0_BIT {
402 TSU_FWSL0_FW50 = 0x1000, TSU_FWSL0_FW40 = 0x0800,
403 TSU_FWSL0_FW30 = 0x0400, TSU_FWSL0_FW20 = 0x0200,
404 TSU_FWSL0_FW10 = 0x0100, TSU_FWSL0_RMSA0 = 0x0010,
405};
406
407/* TSU_FWSLC */
408enum TSU_FWSLC_BIT {
409 TSU_FWSLC_POSTENU = 0x2000, TSU_FWSLC_POSTENL = 0x1000,
410 TSU_FWSLC_CAMSEL03 = 0x0080, TSU_FWSLC_CAMSEL02 = 0x0040,
411 TSU_FWSLC_CAMSEL01 = 0x0020, TSU_FWSLC_CAMSEL00 = 0x0010,
412 TSU_FWSLC_CAMSEL13 = 0x0008, TSU_FWSLC_CAMSEL12 = 0x0004,
413 TSU_FWSLC_CAMSEL11 = 0x0002, TSU_FWSLC_CAMSEL10 = 0x0001,
414};
415
416/* TSU_VTAGn */
417#define TSU_VTAG_ENABLE 0x80000000
418#define TSU_VTAG_VID_MASK 0x00000fff
419
420/* The sh ether Tx buffer descriptors.
421 * This structure should be 20 bytes.
422 */
423struct sh_eth_txdesc {
424 u32 status; /* TD0 */
425#if defined(__LITTLE_ENDIAN)
426 u16 pad0; /* TD1 */
427 u16 buffer_length; /* TD1 */
428#else
429 u16 buffer_length; /* TD1 */
430 u16 pad0; /* TD1 */
431#endif
432 u32 addr; /* TD2 */
433 u32 pad1; /* padding data */
434} __aligned(2) __packed;
435
436/* The sh ether Rx buffer descriptors.
437 * This structure should be 20 bytes.
438 */
439struct sh_eth_rxdesc {
440 u32 status; /* RD0 */
441#if defined(__LITTLE_ENDIAN)
442 u16 frame_length; /* RD1 */
443 u16 buffer_length; /* RD1 */
444#else
445 u16 buffer_length; /* RD1 */
446 u16 frame_length; /* RD1 */
447#endif
448 u32 addr; /* RD2 */
449 u32 pad0; /* padding data */
450} __aligned(2) __packed;
451
452/* This structure is used by each CPU dependency handling. */
453struct sh_eth_cpu_data {
454 /* optional functions */
455 void (*chip_reset)(struct net_device *ndev);
456 void (*set_duplex)(struct net_device *ndev);
457 void (*set_rate)(struct net_device *ndev);
458
459 /* mandatory initialize value */
460 int register_type;
461 unsigned long eesipr_value;
462
463 /* optional initialize value */
464 unsigned long ecsr_value;
465 unsigned long ecsipr_value;
466 unsigned long fdr_value;
467 unsigned long fcftr_value;
468 unsigned long rpadir_value;
469 unsigned long rmcr_value;
470
471 /* interrupt checking mask */
472 unsigned long tx_check;
473 unsigned long eesr_err_check;
474
475 /* hardware features */
476 unsigned long irq_flags; /* IRQ configuration flags */
477 unsigned no_psr:1; /* EtherC DO NOT have PSR */
478 unsigned apr:1; /* EtherC have APR */
479 unsigned mpr:1; /* EtherC have MPR */
480 unsigned tpauser:1; /* EtherC have TPAUSER */
481 unsigned bculr:1; /* EtherC have BCULR */
482 unsigned tsu:1; /* EtherC have TSU */
483 unsigned hw_swap:1; /* E-DMAC have DE bit in EDMR */
484 unsigned rpadir:1; /* E-DMAC have RPADIR */
485 unsigned no_trimd:1; /* E-DMAC DO NOT have TRIMD */
486 unsigned no_ade:1; /* E-DMAC DO NOT have ADE bit in EESR */
487 unsigned hw_crc:1; /* E-DMAC have CSMR */
488 unsigned select_mii:1; /* EtherC have RMII_MII (MII select register) */
489 unsigned shift_rd0:1; /* shift Rx descriptor word 0 right by 16 */
490 unsigned rmiimode:1; /* EtherC has RMIIMODE register */
491};
492
493struct sh_eth_private {
494 struct platform_device *pdev;
495 struct sh_eth_cpu_data *cd;
496 const u16 *reg_offset;
497 void __iomem *addr;
498 void __iomem *tsu_addr;
499 u32 num_rx_ring;
500 u32 num_tx_ring;
501 dma_addr_t rx_desc_dma;
502 dma_addr_t tx_desc_dma;
503 struct sh_eth_rxdesc *rx_ring;
504 struct sh_eth_txdesc *tx_ring;
505 struct sk_buff **rx_skbuff;
506 struct sk_buff **tx_skbuff;
507 spinlock_t lock; /* Register access lock */
508 u32 cur_rx, dirty_rx; /* Producer/consumer ring indices */
509 u32 cur_tx, dirty_tx;
510 u32 rx_buf_sz; /* Based on MTU+slack. */
511 int edmac_endian;
512 struct napi_struct napi;
513 /* MII transceiver section. */
514 u32 phy_id; /* PHY ID */
515 struct mii_bus *mii_bus; /* MDIO bus control */
516 struct phy_device *phydev; /* PHY device control */
517 int link;
518 phy_interface_t phy_interface;
519 int msg_enable;
520 int speed;
521 int duplex;
522 int port; /* for TSU */
523 int vlan_num_ids; /* for VLAN tag filter */
524
525 unsigned no_ether_link:1;
526 unsigned ether_link_active_low:1;
527};
528
529static inline void sh_eth_soft_swap(char *src, int len)
530{
531#ifdef __LITTLE_ENDIAN__
532 u32 *p = (u32 *)src;
533 u32 *maxp;
534 maxp = p + ((len + sizeof(u32) - 1) / sizeof(u32));
535
536 for (; p < maxp; p++)
537 *p = swab32(*p);
538#endif
539}
540
541static inline void sh_eth_write(struct net_device *ndev, unsigned long data,
542 int enum_index)
543{
544 struct sh_eth_private *mdp = netdev_priv(ndev);
545
546 iowrite32(data, mdp->addr + mdp->reg_offset[enum_index]);
547}
548
549static inline unsigned long sh_eth_read(struct net_device *ndev,
550 int enum_index)
551{
552 struct sh_eth_private *mdp = netdev_priv(ndev);
553
554 return ioread32(mdp->addr + mdp->reg_offset[enum_index]);
555}
556
557static inline void *sh_eth_tsu_get_offset(struct sh_eth_private *mdp,
558 int enum_index)
559{
560 return mdp->tsu_addr + mdp->reg_offset[enum_index];
561}
562
563static inline void sh_eth_tsu_write(struct sh_eth_private *mdp,
564 unsigned long data, int enum_index)
565{
566 iowrite32(data, mdp->tsu_addr + mdp->reg_offset[enum_index]);
567}
568
569static inline unsigned long sh_eth_tsu_read(struct sh_eth_private *mdp,
570 int enum_index)
571{
572 return ioread32(mdp->tsu_addr + mdp->reg_offset[enum_index]);
573}
574
575#endif /* #ifndef __SH_ETH_H__ */
1/* SPDX-License-Identifier: GPL-2.0 */
2/* SuperH Ethernet device driver
3 *
4 * Copyright (C) 2006-2012 Nobuhiro Iwamatsu
5 * Copyright (C) 2008-2012 Renesas Solutions Corp.
6 */
7
8#ifndef __SH_ETH_H__
9#define __SH_ETH_H__
10
11#define CARDNAME "sh-eth"
12#define TX_TIMEOUT (5*HZ)
13#define TX_RING_SIZE 64 /* Tx ring size */
14#define RX_RING_SIZE 64 /* Rx ring size */
15#define TX_RING_MIN 64
16#define RX_RING_MIN 64
17#define TX_RING_MAX 1024
18#define RX_RING_MAX 1024
19#define PKT_BUF_SZ 1538
20#define SH_ETH_TSU_TIMEOUT_MS 500
21#define SH_ETH_TSU_CAM_ENTRIES 32
22
23enum {
24 /* IMPORTANT: To keep ethtool register dump working, add new
25 * register names immediately before SH_ETH_MAX_REGISTER_OFFSET.
26 */
27
28 /* E-DMAC registers */
29 EDSR = 0,
30 EDMR,
31 EDTRR,
32 EDRRR,
33 EESR,
34 EESIPR,
35 TDLAR,
36 TDFAR,
37 TDFXR,
38 TDFFR,
39 RDLAR,
40 RDFAR,
41 RDFXR,
42 RDFFR,
43 TRSCER,
44 RMFCR,
45 TFTR,
46 FDR,
47 RMCR,
48 EDOCR,
49 TFUCR,
50 RFOCR,
51 RMIIMODE,
52 FCFTR,
53 RPADIR,
54 TRIMD,
55 RBWAR,
56 TBRAR,
57
58 /* Ether registers */
59 ECMR,
60 ECSR,
61 ECSIPR,
62 PIR,
63 PSR,
64 RDMLR,
65 PIPR,
66 RFLR,
67 IPGR,
68 APR,
69 MPR,
70 PFTCR,
71 PFRCR,
72 RFCR,
73 RFCF,
74 TPAUSER,
75 TPAUSECR,
76 BCFR,
77 BCFRR,
78 GECMR,
79 BCULR,
80 MAHR,
81 MALR,
82 TROCR,
83 CDCR,
84 LCCR,
85 CNDCR,
86 CEFCR,
87 FRECR,
88 TSFRCR,
89 TLFRCR,
90 CERCR,
91 CEECR,
92 MAFCR,
93 RTRATE,
94 CSMR,
95 RMII_MII,
96
97 /* TSU Absolute address */
98 ARSTR,
99 TSU_CTRST,
100 TSU_FWEN0,
101 TSU_FWEN1,
102 TSU_FCM,
103 TSU_BSYSL0,
104 TSU_BSYSL1,
105 TSU_PRISL0,
106 TSU_PRISL1,
107 TSU_FWSL0,
108 TSU_FWSL1,
109 TSU_FWSLC,
110 TSU_QTAG0, /* Same as TSU_QTAGM0 */
111 TSU_QTAG1, /* Same as TSU_QTAGM1 */
112 TSU_QTAGM0,
113 TSU_QTAGM1,
114 TSU_FWSR,
115 TSU_FWINMK,
116 TSU_ADQT0,
117 TSU_ADQT1,
118 TSU_VTAG0,
119 TSU_VTAG1,
120 TSU_ADSBSY,
121 TSU_TEN,
122 TSU_POST1,
123 TSU_POST2,
124 TSU_POST3,
125 TSU_POST4,
126 TSU_ADRH0,
127 /* TSU_ADR{H,L}{0..31} are assumed to be contiguous */
128
129 TXNLCR0,
130 TXALCR0,
131 RXNLCR0,
132 RXALCR0,
133 FWNLCR0,
134 FWALCR0,
135 TXNLCR1,
136 TXALCR1,
137 RXNLCR1,
138 RXALCR1,
139 FWNLCR1,
140 FWALCR1,
141
142 /* This value must be written at last. */
143 SH_ETH_MAX_REGISTER_OFFSET,
144};
145
146enum {
147 SH_ETH_REG_GIGABIT,
148 SH_ETH_REG_FAST_RZ,
149 SH_ETH_REG_FAST_RCAR,
150 SH_ETH_REG_FAST_SH4,
151 SH_ETH_REG_FAST_SH3_SH2
152};
153
154/* Driver's parameters */
155#if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_RENESAS)
156#define SH_ETH_RX_ALIGN 32
157#else
158#define SH_ETH_RX_ALIGN 2
159#endif
160
161/* Register's bits
162 */
163/* EDSR : sh7734, sh7757, sh7763, r8a7740, and r7s72100 only */
164enum EDSR_BIT {
165 EDSR_ENT = 0x01, EDSR_ENR = 0x02,
166};
167#define EDSR_ENALL (EDSR_ENT|EDSR_ENR)
168
169/* GECMR : sh7734, sh7763 and r8a7740 only */
170enum GECMR_BIT {
171 GECMR_10 = 0x0, GECMR_100 = 0x04, GECMR_1000 = 0x01,
172};
173
174/* EDMR */
175enum DMAC_M_BIT {
176 EDMR_NBST = 0x80,
177 EDMR_EL = 0x40, /* Litte endian */
178 EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
179 EDMR_SRST_GETHER = 0x03,
180 EDMR_SRST_ETHER = 0x01,
181};
182
183/* EDTRR */
184enum DMAC_T_BIT {
185 EDTRR_TRNS_GETHER = 0x03,
186 EDTRR_TRNS_ETHER = 0x01,
187};
188
189/* EDRRR */
190enum EDRRR_R_BIT {
191 EDRRR_R = 0x01,
192};
193
194/* TPAUSER */
195enum TPAUSER_BIT {
196 TPAUSER_TPAUSE = 0x0000ffff,
197 TPAUSER_UNLIMITED = 0,
198};
199
200/* BCFR */
201enum BCFR_BIT {
202 BCFR_RPAUSE = 0x0000ffff,
203 BCFR_UNLIMITED = 0,
204};
205
206/* PIR */
207enum PIR_BIT {
208 PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
209};
210
211/* PSR */
212enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };
213
214/* EESR */
215enum EESR_BIT {
216 EESR_TWB1 = 0x80000000,
217 EESR_TWB = 0x40000000, /* same as TWB0 */
218 EESR_TC1 = 0x20000000,
219 EESR_TUC = 0x10000000,
220 EESR_ROC = 0x08000000,
221 EESR_TABT = 0x04000000,
222 EESR_RABT = 0x02000000,
223 EESR_RFRMER = 0x01000000, /* same as RFCOF */
224 EESR_ADE = 0x00800000,
225 EESR_ECI = 0x00400000,
226 EESR_FTC = 0x00200000, /* same as TC or TC0 */
227 EESR_TDE = 0x00100000,
228 EESR_TFE = 0x00080000, /* same as TFUF */
229 EESR_FRC = 0x00040000, /* same as FR */
230 EESR_RDE = 0x00020000,
231 EESR_RFE = 0x00010000,
232 EESR_CND = 0x00000800,
233 EESR_DLC = 0x00000400,
234 EESR_CD = 0x00000200,
235 EESR_TRO = 0x00000100,
236 EESR_RMAF = 0x00000080,
237 EESR_CEEF = 0x00000040,
238 EESR_CELF = 0x00000020,
239 EESR_RRF = 0x00000010,
240 EESR_RTLF = 0x00000008,
241 EESR_RTSF = 0x00000004,
242 EESR_PRE = 0x00000002,
243 EESR_CERF = 0x00000001,
244};
245
246#define EESR_RX_CHECK (EESR_FRC | /* Frame recv */ \
247 EESR_RMAF | /* Multicast address recv */ \
248 EESR_RRF | /* Bit frame recv */ \
249 EESR_RTLF | /* Long frame recv */ \
250 EESR_RTSF | /* Short frame recv */ \
251 EESR_PRE | /* PHY-LSI recv error */ \
252 EESR_CERF) /* Recv frame CRC error */
253
254#define DEFAULT_TX_CHECK (EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | \
255 EESR_TRO)
256#define DEFAULT_EESR_ERR_CHECK (EESR_TWB | EESR_TABT | EESR_RABT | EESR_RFE | \
257 EESR_RDE | EESR_RFRMER | EESR_ADE | \
258 EESR_TFE | EESR_TDE)
259
260/* EESIPR */
261enum EESIPR_BIT {
262 EESIPR_TWB1IP = 0x80000000,
263 EESIPR_TWBIP = 0x40000000, /* same as TWB0IP */
264 EESIPR_TC1IP = 0x20000000,
265 EESIPR_TUCIP = 0x10000000,
266 EESIPR_ROCIP = 0x08000000,
267 EESIPR_TABTIP = 0x04000000,
268 EESIPR_RABTIP = 0x02000000,
269 EESIPR_RFCOFIP = 0x01000000,
270 EESIPR_ADEIP = 0x00800000,
271 EESIPR_ECIIP = 0x00400000,
272 EESIPR_FTCIP = 0x00200000, /* same as TC0IP */
273 EESIPR_TDEIP = 0x00100000,
274 EESIPR_TFUFIP = 0x00080000,
275 EESIPR_FRIP = 0x00040000,
276 EESIPR_RDEIP = 0x00020000,
277 EESIPR_RFOFIP = 0x00010000,
278 EESIPR_CNDIP = 0x00000800,
279 EESIPR_DLCIP = 0x00000400,
280 EESIPR_CDIP = 0x00000200,
281 EESIPR_TROIP = 0x00000100,
282 EESIPR_RMAFIP = 0x00000080,
283 EESIPR_CEEFIP = 0x00000040,
284 EESIPR_CELFIP = 0x00000020,
285 EESIPR_RRFIP = 0x00000010,
286 EESIPR_RTLFIP = 0x00000008,
287 EESIPR_RTSFIP = 0x00000004,
288 EESIPR_PREIP = 0x00000002,
289 EESIPR_CERFIP = 0x00000001,
290};
291
292/* Receive descriptor 0 bits */
293enum RD_STS_BIT {
294 RD_RACT = 0x80000000, RD_RDLE = 0x40000000,
295 RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
296 RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
297 RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
298 RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
299 RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
300 RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
301 RD_RFS1 = 0x00000001,
302};
303#define RDF1ST RD_RFP1
304#define RDFEND RD_RFP0
305#define RD_RFP (RD_RFP1|RD_RFP0)
306
307/* Receive descriptor 1 bits */
308enum RD_LEN_BIT {
309 RD_RFL = 0x0000ffff, /* receive frame length */
310 RD_RBL = 0xffff0000, /* receive buffer length */
311};
312
313/* FCFTR */
314enum FCFTR_BIT {
315 FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
316 FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
317 FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
318};
319#define DEFAULT_FIFO_F_D_RFF (FCFTR_RFF2 | FCFTR_RFF1 | FCFTR_RFF0)
320#define DEFAULT_FIFO_F_D_RFD (FCFTR_RFD2 | FCFTR_RFD1 | FCFTR_RFD0)
321
322/* Transmit descriptor 0 bits */
323enum TD_STS_BIT {
324 TD_TACT = 0x80000000, TD_TDLE = 0x40000000,
325 TD_TFP1 = 0x20000000, TD_TFP0 = 0x10000000,
326 TD_TFE = 0x08000000, TD_TWBI = 0x04000000,
327};
328#define TDF1ST TD_TFP1
329#define TDFEND TD_TFP0
330#define TD_TFP (TD_TFP1|TD_TFP0)
331
332/* Transmit descriptor 1 bits */
333enum TD_LEN_BIT {
334 TD_TBL = 0xffff0000, /* transmit buffer length */
335};
336
337/* RMCR */
338enum RMCR_BIT {
339 RMCR_RNC = 0x00000001,
340};
341
342/* ECMR */
343enum FELIC_MODE_BIT {
344 ECMR_TRCCM = 0x04000000, ECMR_RCSC = 0x00800000,
345 ECMR_DPAD = 0x00200000, ECMR_RZPF = 0x00100000,
346 ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
347 ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
348 ECMR_MPDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
349 ECMR_RTM = 0x00000010, ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004,
350 ECMR_DM = 0x00000002, ECMR_PRM = 0x00000001,
351};
352
353/* ECSR */
354enum ECSR_STATUS_BIT {
355 ECSR_BRCRX = 0x20, ECSR_PSRTO = 0x10,
356 ECSR_LCHNG = 0x04,
357 ECSR_MPD = 0x02, ECSR_ICD = 0x01,
358};
359
360#define DEFAULT_ECSR_INIT (ECSR_BRCRX | ECSR_PSRTO | ECSR_LCHNG | \
361 ECSR_ICD | ECSIPR_MPDIP)
362
363/* ECSIPR */
364enum ECSIPR_STATUS_MASK_BIT {
365 ECSIPR_BRCRXIP = 0x20, ECSIPR_PSRTOIP = 0x10,
366 ECSIPR_LCHNGIP = 0x04,
367 ECSIPR_MPDIP = 0x02, ECSIPR_ICDIP = 0x01,
368};
369
370#define DEFAULT_ECSIPR_INIT (ECSIPR_BRCRXIP | ECSIPR_PSRTOIP | \
371 ECSIPR_LCHNGIP | ECSIPR_ICDIP | ECSIPR_MPDIP)
372
373/* APR */
374enum APR_BIT {
375 APR_AP = 0x0000ffff,
376};
377
378/* MPR */
379enum MPR_BIT {
380 MPR_MP = 0x0000ffff,
381};
382
383/* TRSCER */
384enum DESC_I_BIT {
385 DESC_I_TINT4 = 0x0800, DESC_I_TINT3 = 0x0400, DESC_I_TINT2 = 0x0200,
386 DESC_I_TINT1 = 0x0100, DESC_I_RINT8 = 0x0080, DESC_I_RINT5 = 0x0010,
387 DESC_I_RINT4 = 0x0008, DESC_I_RINT3 = 0x0004, DESC_I_RINT2 = 0x0002,
388 DESC_I_RINT1 = 0x0001,
389};
390
391#define DEFAULT_TRSCER_ERR_MASK (DESC_I_RINT8 | DESC_I_RINT5 | DESC_I_TINT2)
392
393/* RPADIR */
394enum RPADIR_BIT {
395 RPADIR_PADS = 0x1f0000, RPADIR_PADR = 0xffff,
396};
397
398/* FDR */
399#define DEFAULT_FDR_INIT 0x00000707
400
401/* ARSTR */
402enum ARSTR_BIT { ARSTR_ARST = 0x00000001, };
403
404/* TSU_FWEN0 */
405enum TSU_FWEN0_BIT {
406 TSU_FWEN0_0 = 0x00000001,
407};
408
409/* TSU_ADSBSY */
410enum TSU_ADSBSY_BIT {
411 TSU_ADSBSY_0 = 0x00000001,
412};
413
414/* TSU_TEN */
415enum TSU_TEN_BIT {
416 TSU_TEN_0 = 0x80000000,
417};
418
419/* TSU_FWSL0 */
420enum TSU_FWSL0_BIT {
421 TSU_FWSL0_FW50 = 0x1000, TSU_FWSL0_FW40 = 0x0800,
422 TSU_FWSL0_FW30 = 0x0400, TSU_FWSL0_FW20 = 0x0200,
423 TSU_FWSL0_FW10 = 0x0100, TSU_FWSL0_RMSA0 = 0x0010,
424};
425
426/* TSU_FWSLC */
427enum TSU_FWSLC_BIT {
428 TSU_FWSLC_POSTENU = 0x2000, TSU_FWSLC_POSTENL = 0x1000,
429 TSU_FWSLC_CAMSEL03 = 0x0080, TSU_FWSLC_CAMSEL02 = 0x0040,
430 TSU_FWSLC_CAMSEL01 = 0x0020, TSU_FWSLC_CAMSEL00 = 0x0010,
431 TSU_FWSLC_CAMSEL13 = 0x0008, TSU_FWSLC_CAMSEL12 = 0x0004,
432 TSU_FWSLC_CAMSEL11 = 0x0002, TSU_FWSLC_CAMSEL10 = 0x0001,
433};
434
435/* TSU_VTAGn */
436#define TSU_VTAG_ENABLE 0x80000000
437#define TSU_VTAG_VID_MASK 0x00000fff
438
439/* The sh ether Tx buffer descriptors.
440 * This structure should be 20 bytes.
441 */
442struct sh_eth_txdesc {
443 u32 status; /* TD0 */
444 u32 len; /* TD1 */
445 u32 addr; /* TD2 */
446 u32 pad0; /* padding data */
447} __aligned(2) __packed;
448
449/* The sh ether Rx buffer descriptors.
450 * This structure should be 20 bytes.
451 */
452struct sh_eth_rxdesc {
453 u32 status; /* RD0 */
454 u32 len; /* RD1 */
455 u32 addr; /* RD2 */
456 u32 pad0; /* padding data */
457} __aligned(2) __packed;
458
459/* This structure is used by each CPU dependency handling. */
460struct sh_eth_cpu_data {
461 /* mandatory functions */
462 int (*soft_reset)(struct net_device *ndev);
463
464 /* optional functions */
465 void (*chip_reset)(struct net_device *ndev);
466 void (*set_duplex)(struct net_device *ndev);
467 void (*set_rate)(struct net_device *ndev);
468
469 /* mandatory initialize value */
470 int register_type;
471 u32 edtrr_trns;
472 u32 eesipr_value;
473
474 /* optional initialize value */
475 u32 ecsr_value;
476 u32 ecsipr_value;
477 u32 fdr_value;
478 u32 fcftr_value;
479
480 /* interrupt checking mask */
481 u32 tx_check;
482 u32 eesr_err_check;
483
484 /* Error mask */
485 u32 trscer_err_mask;
486
487 /* hardware features */
488 unsigned long irq_flags; /* IRQ configuration flags */
489 unsigned no_psr:1; /* EtherC DOES NOT have PSR */
490 unsigned apr:1; /* EtherC has APR */
491 unsigned mpr:1; /* EtherC has MPR */
492 unsigned tpauser:1; /* EtherC has TPAUSER */
493 unsigned bculr:1; /* EtherC has BCULR */
494 unsigned tsu:1; /* EtherC has TSU */
495 unsigned hw_swap:1; /* E-DMAC has DE bit in EDMR */
496 unsigned nbst:1; /* E-DMAC has NBST bit in EDMR */
497 unsigned rpadir:1; /* E-DMAC has RPADIR */
498 unsigned no_trimd:1; /* E-DMAC DOES NOT have TRIMD */
499 unsigned no_ade:1; /* E-DMAC DOES NOT have ADE bit in EESR */
500 unsigned no_xdfar:1; /* E-DMAC DOES NOT have RDFAR/TDFAR */
501 unsigned xdfar_rw:1; /* E-DMAC has writeable RDFAR/TDFAR */
502 unsigned csmr:1; /* E-DMAC has CSMR */
503 unsigned rx_csum:1; /* EtherC has ECMR.RCSC */
504 unsigned select_mii:1; /* EtherC has RMII_MII (MII select register) */
505 unsigned rmiimode:1; /* EtherC has RMIIMODE register */
506 unsigned rtrate:1; /* EtherC has RTRATE register */
507 unsigned magic:1; /* EtherC has ECMR.MPDE and ECSR.MPD */
508 unsigned no_tx_cntrs:1; /* EtherC DOES NOT have TX error counters */
509 unsigned cexcr:1; /* EtherC has CERCR/CEECR */
510 unsigned dual_port:1; /* Dual EtherC/E-DMAC */
511};
512
513struct sh_eth_private {
514 struct platform_device *pdev;
515 struct sh_eth_cpu_data *cd;
516 const u16 *reg_offset;
517 void __iomem *addr;
518 void __iomem *tsu_addr;
519 struct clk *clk;
520 u32 num_rx_ring;
521 u32 num_tx_ring;
522 dma_addr_t rx_desc_dma;
523 dma_addr_t tx_desc_dma;
524 struct sh_eth_rxdesc *rx_ring;
525 struct sh_eth_txdesc *tx_ring;
526 struct sk_buff **rx_skbuff;
527 struct sk_buff **tx_skbuff;
528 spinlock_t lock; /* Register access lock */
529 u32 cur_rx, dirty_rx; /* Producer/consumer ring indices */
530 u32 cur_tx, dirty_tx;
531 u32 rx_buf_sz; /* Based on MTU+slack. */
532 struct napi_struct napi;
533 bool irq_enabled;
534 /* MII transceiver section. */
535 u32 phy_id; /* PHY ID */
536 struct mii_bus *mii_bus; /* MDIO bus control */
537 int link;
538 phy_interface_t phy_interface;
539 int msg_enable;
540 int speed;
541 int duplex;
542 int port; /* for TSU */
543 int vlan_num_ids; /* for VLAN tag filter */
544
545 unsigned no_ether_link:1;
546 unsigned ether_link_active_low:1;
547 unsigned is_opened:1;
548 unsigned wol_enabled:1;
549};
550
551#endif /* #ifndef __SH_ETH_H__ */