Linux 3.14.25
[platform/adaptation/renesas_rcar/renesas_kernel.git] / drivers / net / ethernet / renesas / sh_eth.h
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 ETHERSMALL              60
31 #define PKT_BUF_SZ              1538
32 #define SH_ETH_TSU_TIMEOUT_MS   500
33 #define SH_ETH_TSU_CAM_ENTRIES  32
34
35 enum {
36         /* E-DMAC registers */
37         EDSR = 0,
38         EDMR,
39         EDTRR,
40         EDRRR,
41         EESR,
42         EESIPR,
43         TDLAR,
44         TDFAR,
45         TDFXR,
46         TDFFR,
47         RDLAR,
48         RDFAR,
49         RDFXR,
50         RDFFR,
51         TRSCER,
52         RMFCR,
53         TFTR,
54         FDR,
55         RMCR,
56         EDOCR,
57         TFUCR,
58         RFOCR,
59         RMIIMODE,
60         FCFTR,
61         RPADIR,
62         TRIMD,
63         RBWAR,
64         TBRAR,
65
66         /* Ether registers */
67         ECMR,
68         ECSR,
69         ECSIPR,
70         PIR,
71         PSR,
72         RDMLR,
73         PIPR,
74         RFLR,
75         IPGR,
76         APR,
77         MPR,
78         PFTCR,
79         PFRCR,
80         RFCR,
81         RFCF,
82         TPAUSER,
83         TPAUSECR,
84         BCFR,
85         BCFRR,
86         GECMR,
87         BCULR,
88         MAHR,
89         MALR,
90         TROCR,
91         CDCR,
92         LCCR,
93         CNDCR,
94         CEFCR,
95         FRECR,
96         TSFRCR,
97         TLFRCR,
98         CERCR,
99         CEECR,
100         MAFCR,
101         RTRATE,
102         CSMR,
103         RMII_MII,
104
105         /* TSU Absolute address */
106         ARSTR,
107         TSU_CTRST,
108         TSU_FWEN0,
109         TSU_FWEN1,
110         TSU_FCM,
111         TSU_BSYSL0,
112         TSU_BSYSL1,
113         TSU_PRISL0,
114         TSU_PRISL1,
115         TSU_FWSL0,
116         TSU_FWSL1,
117         TSU_FWSLC,
118         TSU_QTAG0,
119         TSU_QTAG1,
120         TSU_QTAGM0,
121         TSU_QTAGM1,
122         TSU_FWSR,
123         TSU_FWINMK,
124         TSU_ADQT0,
125         TSU_ADQT1,
126         TSU_VTAG0,
127         TSU_VTAG1,
128         TSU_ADSBSY,
129         TSU_TEN,
130         TSU_POST1,
131         TSU_POST2,
132         TSU_POST3,
133         TSU_POST4,
134         TSU_ADRH0,
135         TSU_ADRL0,
136         TSU_ADRH31,
137         TSU_ADRL31,
138
139         TXNLCR0,
140         TXALCR0,
141         RXNLCR0,
142         RXALCR0,
143         FWNLCR0,
144         FWALCR0,
145         TXNLCR1,
146         TXALCR1,
147         RXNLCR1,
148         RXALCR1,
149         FWNLCR1,
150         FWALCR1,
151
152         /* This value must be written at last. */
153         SH_ETH_MAX_REGISTER_OFFSET,
154 };
155
156 enum {
157         SH_ETH_REG_GIGABIT,
158         SH_ETH_REG_FAST_RZ,
159         SH_ETH_REG_FAST_RCAR,
160         SH_ETH_REG_FAST_SH4,
161         SH_ETH_REG_FAST_SH3_SH2
162 };
163
164 /* Driver's parameters */
165 #if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
166 #define SH4_SKB_RX_ALIGN        32
167 #else
168 #define SH2_SH3_SKB_RX_ALIGN    2
169 #endif
170
171 /* Register's bits
172  */
173 /* EDSR : sh7734, sh7757, sh7763, r8a7740, and r7s72100 only */
174 enum EDSR_BIT {
175         EDSR_ENT = 0x01, EDSR_ENR = 0x02,
176 };
177 #define EDSR_ENALL (EDSR_ENT|EDSR_ENR)
178
179 /* GECMR : sh7734, sh7763 and r8a7740 only */
180 enum GECMR_BIT {
181         GECMR_10 = 0x0, GECMR_100 = 0x04, GECMR_1000 = 0x01,
182 };
183
184 /* EDMR */
185 enum DMAC_M_BIT {
186         EDMR_EL = 0x40, /* Litte endian */
187         EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
188         EDMR_SRST_GETHER = 0x03,
189         EDMR_SRST_ETHER = 0x01,
190 };
191
192 /* EDTRR */
193 enum DMAC_T_BIT {
194         EDTRR_TRNS_GETHER = 0x03,
195         EDTRR_TRNS_ETHER = 0x01,
196 };
197
198 /* EDRRR */
199 enum EDRRR_R_BIT {
200         EDRRR_R = 0x01,
201 };
202
203 /* TPAUSER */
204 enum TPAUSER_BIT {
205         TPAUSER_TPAUSE = 0x0000ffff,
206         TPAUSER_UNLIMITED = 0,
207 };
208
209 /* BCFR */
210 enum BCFR_BIT {
211         BCFR_RPAUSE = 0x0000ffff,
212         BCFR_UNLIMITED = 0,
213 };
214
215 /* PIR */
216 enum PIR_BIT {
217         PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
218 };
219
220 /* PSR */
221 enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };
222
223 /* EESR */
224 enum EESR_BIT {
225         EESR_TWB1       = 0x80000000,
226         EESR_TWB        = 0x40000000,   /* same as TWB0 */
227         EESR_TC1        = 0x20000000,
228         EESR_TUC        = 0x10000000,
229         EESR_ROC        = 0x08000000,
230         EESR_TABT       = 0x04000000,
231         EESR_RABT       = 0x02000000,
232         EESR_RFRMER     = 0x01000000,   /* same as RFCOF */
233         EESR_ADE        = 0x00800000,
234         EESR_ECI        = 0x00400000,
235         EESR_FTC        = 0x00200000,   /* same as TC or TC0 */
236         EESR_TDE        = 0x00100000,
237         EESR_TFE        = 0x00080000,   /* same as TFUF */
238         EESR_FRC        = 0x00040000,   /* same as FR */
239         EESR_RDE        = 0x00020000,
240         EESR_RFE        = 0x00010000,
241         EESR_CND        = 0x00000800,
242         EESR_DLC        = 0x00000400,
243         EESR_CD         = 0x00000200,
244         EESR_RTO        = 0x00000100,
245         EESR_RMAF       = 0x00000080,
246         EESR_CEEF       = 0x00000040,
247         EESR_CELF       = 0x00000020,
248         EESR_RRF        = 0x00000010,
249         EESR_RTLF       = 0x00000008,
250         EESR_RTSF       = 0x00000004,
251         EESR_PRE        = 0x00000002,
252         EESR_CERF       = 0x00000001,
253 };
254
255 #define EESR_RX_CHECK           (EESR_FRC  | /* Frame recv */           \
256                                  EESR_RMAF | /* Multicast address recv */ \
257                                  EESR_RRF  | /* Bit frame recv */       \
258                                  EESR_RTLF | /* Long frame recv */      \
259                                  EESR_RTSF | /* Short frame recv */     \
260                                  EESR_PRE  | /* PHY-LSI recv error */   \
261                                  EESR_CERF)  /* Recv frame CRC error */
262
263 #define DEFAULT_TX_CHECK        (EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | \
264                                  EESR_RTO)
265 #define DEFAULT_EESR_ERR_CHECK  (EESR_TWB | EESR_TABT | EESR_RABT | EESR_RFE | \
266                                  EESR_RDE | EESR_RFRMER | EESR_ADE | \
267                                  EESR_TFE | EESR_TDE | EESR_ECI)
268
269 /* EESIPR */
270 enum DMAC_IM_BIT {
271         DMAC_M_TWB = 0x40000000, DMAC_M_TABT = 0x04000000,
272         DMAC_M_RABT = 0x02000000,
273         DMAC_M_RFRMER = 0x01000000, DMAC_M_ADF = 0x00800000,
274         DMAC_M_ECI = 0x00400000, DMAC_M_FTC = 0x00200000,
275         DMAC_M_TDE = 0x00100000, DMAC_M_TFE = 0x00080000,
276         DMAC_M_FRC = 0x00040000, DMAC_M_RDE = 0x00020000,
277         DMAC_M_RFE = 0x00010000, DMAC_M_TINT4 = 0x00000800,
278         DMAC_M_TINT3 = 0x00000400, DMAC_M_TINT2 = 0x00000200,
279         DMAC_M_TINT1 = 0x00000100, DMAC_M_RINT8 = 0x00000080,
280         DMAC_M_RINT5 = 0x00000010, DMAC_M_RINT4 = 0x00000008,
281         DMAC_M_RINT3 = 0x00000004, DMAC_M_RINT2 = 0x00000002,
282         DMAC_M_RINT1 = 0x00000001,
283 };
284
285 /* Receive descriptor bit */
286 enum RD_STS_BIT {
287         RD_RACT = 0x80000000, RD_RDEL = 0x40000000,
288         RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
289         RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
290         RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
291         RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
292         RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
293         RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
294         RD_RFS1 = 0x00000001,
295 };
296 #define RDF1ST  RD_RFP1
297 #define RDFEND  RD_RFP0
298 #define RD_RFP  (RD_RFP1|RD_RFP0)
299
300 /* FCFTR */
301 enum FCFTR_BIT {
302         FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
303         FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
304         FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
305 };
306 #define DEFAULT_FIFO_F_D_RFF    (FCFTR_RFF2 | FCFTR_RFF1 | FCFTR_RFF0)
307 #define DEFAULT_FIFO_F_D_RFD    (FCFTR_RFD2 | FCFTR_RFD1 | FCFTR_RFD0)
308
309 /* Transmit descriptor bit */
310 enum TD_STS_BIT {
311         TD_TACT = 0x80000000, TD_TDLE = 0x40000000,
312         TD_TFP1 = 0x20000000, TD_TFP0 = 0x10000000,
313         TD_TFE  = 0x08000000, TD_TWBI = 0x04000000,
314 };
315 #define TDF1ST  TD_TFP1
316 #define TDFEND  TD_TFP0
317 #define TD_TFP  (TD_TFP1|TD_TFP0)
318
319 /* RMCR */
320 enum RMCR_BIT {
321         RMCR_RNC = 0x00000001,
322 };
323
324 /* ECMR */
325 enum 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 */
336 enum 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 */
346 enum 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 */
356 enum APR_BIT {
357         APR_AP = 0x00000001,
358 };
359
360 /* MPR */
361 enum MPR_BIT {
362         MPR_MP = 0x00000001,
363 };
364
365 /* TRSCER */
366 enum 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 */
374 enum 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 */
383 enum ARSTR_BIT { ARSTR_ARSTR = 0x00000001, };
384
385 /* TSU_FWEN0 */
386 enum TSU_FWEN0_BIT {
387         TSU_FWEN0_0 = 0x00000001,
388 };
389
390 /* TSU_ADSBSY */
391 enum TSU_ADSBSY_BIT {
392         TSU_ADSBSY_0 = 0x00000001,
393 };
394
395 /* TSU_TEN */
396 enum TSU_TEN_BIT {
397         TSU_TEN_0 = 0x80000000,
398 };
399
400 /* TSU_FWSL0 */
401 enum 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 */
408 enum 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  */
423 struct 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  */
439 struct 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. */
453 struct 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
470         /* interrupt checking mask */
471         unsigned long tx_check;
472         unsigned long eesr_err_check;
473
474         /* hardware features */
475         unsigned long irq_flags; /* IRQ configuration flags */
476         unsigned no_psr:1;      /* EtherC DO NOT have PSR */
477         unsigned apr:1;         /* EtherC have APR */
478         unsigned mpr:1;         /* EtherC have MPR */
479         unsigned tpauser:1;     /* EtherC have TPAUSER */
480         unsigned bculr:1;       /* EtherC have BCULR */
481         unsigned tsu:1;         /* EtherC have TSU */
482         unsigned hw_swap:1;     /* E-DMAC have DE bit in EDMR */
483         unsigned rpadir:1;      /* E-DMAC have RPADIR */
484         unsigned no_trimd:1;    /* E-DMAC DO NOT have TRIMD */
485         unsigned no_ade:1;      /* E-DMAC DO NOT have ADE bit in EESR */
486         unsigned hw_crc:1;      /* E-DMAC have CSMR */
487         unsigned select_mii:1;  /* EtherC have RMII_MII (MII select register) */
488         unsigned shift_rd0:1;   /* shift Rx descriptor word 0 right by 16 */
489         unsigned rmiimode:1;    /* EtherC has RMIIMODE register */
490 };
491
492 struct sh_eth_private {
493         struct platform_device *pdev;
494         struct sh_eth_cpu_data *cd;
495         const u16 *reg_offset;
496         void __iomem *addr;
497         void __iomem *tsu_addr;
498         u32 num_rx_ring;
499         u32 num_tx_ring;
500         dma_addr_t rx_desc_dma;
501         dma_addr_t tx_desc_dma;
502         struct sh_eth_rxdesc *rx_ring;
503         struct sh_eth_txdesc *tx_ring;
504         struct sk_buff **rx_skbuff;
505         struct sk_buff **tx_skbuff;
506         spinlock_t lock;                /* Register access lock */
507         u32 cur_rx, dirty_rx;           /* Producer/consumer ring indices */
508         u32 cur_tx, dirty_tx;
509         u32 rx_buf_sz;                  /* Based on MTU+slack. */
510         int edmac_endian;
511         struct napi_struct napi;
512         /* MII transceiver section. */
513         u32 phy_id;                     /* PHY ID */
514         struct mii_bus *mii_bus;        /* MDIO bus control */
515         struct phy_device *phydev;      /* PHY device control */
516         int link;
517         phy_interface_t phy_interface;
518         int msg_enable;
519         int speed;
520         int duplex;
521         int port;                       /* for TSU */
522         int vlan_num_ids;               /* for VLAN tag filter */
523
524         unsigned no_ether_link:1;
525         unsigned ether_link_active_low:1;
526 };
527
528 static inline void sh_eth_soft_swap(char *src, int len)
529 {
530 #ifdef __LITTLE_ENDIAN__
531         u32 *p = (u32 *)src;
532         u32 *maxp;
533         maxp = p + ((len + sizeof(u32) - 1) / sizeof(u32));
534
535         for (; p < maxp; p++)
536                 *p = swab32(*p);
537 #endif
538 }
539
540 static inline void sh_eth_write(struct net_device *ndev, unsigned long data,
541                                 int enum_index)
542 {
543         struct sh_eth_private *mdp = netdev_priv(ndev);
544
545         iowrite32(data, mdp->addr + mdp->reg_offset[enum_index]);
546 }
547
548 static inline unsigned long sh_eth_read(struct net_device *ndev,
549                                         int enum_index)
550 {
551         struct sh_eth_private *mdp = netdev_priv(ndev);
552
553         return ioread32(mdp->addr + mdp->reg_offset[enum_index]);
554 }
555
556 static inline void *sh_eth_tsu_get_offset(struct sh_eth_private *mdp,
557                                           int enum_index)
558 {
559         return mdp->tsu_addr + mdp->reg_offset[enum_index];
560 }
561
562 static inline void sh_eth_tsu_write(struct sh_eth_private *mdp,
563                                 unsigned long data, int enum_index)
564 {
565         iowrite32(data, mdp->tsu_addr + mdp->reg_offset[enum_index]);
566 }
567
568 static inline unsigned long sh_eth_tsu_read(struct sh_eth_private *mdp,
569                                         int enum_index)
570 {
571         return ioread32(mdp->tsu_addr + mdp->reg_offset[enum_index]);
572 }
573
574 #endif  /* #ifndef __SH_ETH_H__ */