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