[PATCH] remove many unneeded #includes of sched.h
[linux-2.6.git] / drivers / net / fs_enet / mac-fcc.c
1 /*
2  * FCC driver for Motorola MPC82xx (PQ2).
3  *
4  * Copyright (c) 2003 Intracom S.A. 
5  *  by Pantelis Antoniou <panto@intracom.gr>
6  *
7  * 2005 (c) MontaVista Software, Inc. 
8  * Vitaly Bordug <vbordug@ru.mvista.com>
9  *
10  * This file is licensed under the terms of the GNU General Public License 
11  * version 2. This program is licensed "as is" without any warranty of any 
12  * kind, whether express or implied.
13  */
14
15 #include <linux/module.h>
16 #include <linux/kernel.h>
17 #include <linux/types.h>
18 #include <linux/string.h>
19 #include <linux/ptrace.h>
20 #include <linux/errno.h>
21 #include <linux/ioport.h>
22 #include <linux/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/pci.h>
25 #include <linux/init.h>
26 #include <linux/delay.h>
27 #include <linux/netdevice.h>
28 #include <linux/etherdevice.h>
29 #include <linux/skbuff.h>
30 #include <linux/spinlock.h>
31 #include <linux/mii.h>
32 #include <linux/ethtool.h>
33 #include <linux/bitops.h>
34 #include <linux/fs.h>
35 #include <linux/platform_device.h>
36 #include <linux/phy.h>
37
38 #include <asm/immap_cpm2.h>
39 #include <asm/mpc8260.h>
40 #include <asm/cpm2.h>
41
42 #include <asm/pgtable.h>
43 #include <asm/irq.h>
44 #include <asm/uaccess.h>
45
46 #include "fs_enet.h"
47
48 /*************************************************/
49
50 /* FCC access macros */
51
52 #define __fcc_out32(addr, x)    out_be32((unsigned *)addr, x)
53 #define __fcc_out16(addr, x)    out_be16((unsigned short *)addr, x)
54 #define __fcc_out8(addr, x)     out_8((unsigned char *)addr, x)
55 #define __fcc_in32(addr)        in_be32((unsigned *)addr)
56 #define __fcc_in16(addr)        in_be16((unsigned short *)addr)
57 #define __fcc_in8(addr)         in_8((unsigned char *)addr)
58
59 /* parameter space */
60
61 /* write, read, set bits, clear bits */
62 #define W32(_p, _m, _v) __fcc_out32(&(_p)->_m, (_v))
63 #define R32(_p, _m)     __fcc_in32(&(_p)->_m)
64 #define S32(_p, _m, _v) W32(_p, _m, R32(_p, _m) | (_v))
65 #define C32(_p, _m, _v) W32(_p, _m, R32(_p, _m) & ~(_v))
66
67 #define W16(_p, _m, _v) __fcc_out16(&(_p)->_m, (_v))
68 #define R16(_p, _m)     __fcc_in16(&(_p)->_m)
69 #define S16(_p, _m, _v) W16(_p, _m, R16(_p, _m) | (_v))
70 #define C16(_p, _m, _v) W16(_p, _m, R16(_p, _m) & ~(_v))
71
72 #define W8(_p, _m, _v)  __fcc_out8(&(_p)->_m, (_v))
73 #define R8(_p, _m)      __fcc_in8(&(_p)->_m)
74 #define S8(_p, _m, _v)  W8(_p, _m, R8(_p, _m) | (_v))
75 #define C8(_p, _m, _v)  W8(_p, _m, R8(_p, _m) & ~(_v))
76
77 /*************************************************/
78
79 #define FCC_MAX_MULTICAST_ADDRS 64
80
81 #define mk_mii_read(REG)        (0x60020000 | ((REG & 0x1f) << 18))
82 #define mk_mii_write(REG, VAL)  (0x50020000 | ((REG & 0x1f) << 18) | (VAL & 0xffff))
83 #define mk_mii_end              0
84
85 #define MAX_CR_CMD_LOOPS        10000
86
87 static inline int fcc_cr_cmd(struct fs_enet_private *fep, u32 mcn, u32 op)
88 {
89         const struct fs_platform_info *fpi = fep->fpi;
90
91         cpm2_map_t *immap = fs_enet_immap;
92         cpm_cpm2_t *cpmp = &immap->im_cpm;
93         u32 v;
94         int i;
95
96         /* Currently I don't know what feature call will look like. But 
97            I guess there'd be something like do_cpm_cmd() which will require page & sblock */
98         v = mk_cr_cmd(fpi->cp_page, fpi->cp_block, mcn, op);
99         W32(cpmp, cp_cpcr, v | CPM_CR_FLG);
100         for (i = 0; i < MAX_CR_CMD_LOOPS; i++)
101                 if ((R32(cpmp, cp_cpcr) & CPM_CR_FLG) == 0)
102                         break;
103
104         if (i >= MAX_CR_CMD_LOOPS) {
105                 printk(KERN_ERR "%s(): Not able to issue CPM command\n",
106                        __FUNCTION__);
107                 return 1;
108         }
109
110         return 0;
111 }
112
113 static int do_pd_setup(struct fs_enet_private *fep)
114 {
115         struct platform_device *pdev = to_platform_device(fep->dev);
116         struct resource *r;
117
118         /* Fill out IRQ field */
119         fep->interrupt = platform_get_irq(pdev, 0);
120         if (fep->interrupt < 0)
121                 return -EINVAL;
122
123         /* Attach the memory for the FCC Parameter RAM */
124         r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "fcc_pram");
125         fep->fcc.ep = (void *)ioremap(r->start, r->end - r->start + 1);
126         if (fep->fcc.ep == NULL)
127                 return -EINVAL;
128
129         r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "fcc_regs");
130         fep->fcc.fccp = (void *)ioremap(r->start, r->end - r->start + 1);
131         if (fep->fcc.fccp == NULL)
132                 return -EINVAL;
133
134         if (fep->fpi->fcc_regs_c) {
135
136                 fep->fcc.fcccp = (void *)fep->fpi->fcc_regs_c;
137         } else {
138                 r = platform_get_resource_byname(pdev, IORESOURCE_MEM,
139                                 "fcc_regs_c");
140                 fep->fcc.fcccp = (void *)ioremap(r->start,
141                                 r->end - r->start + 1);
142         }
143
144         if (fep->fcc.fcccp == NULL)
145                 return -EINVAL;
146
147         fep->fcc.mem = (void *)fep->fpi->mem_offset;
148         if (fep->fcc.mem == NULL)
149                 return -EINVAL;
150
151         return 0;
152 }
153
154 #define FCC_NAPI_RX_EVENT_MSK   (FCC_ENET_RXF | FCC_ENET_RXB)
155 #define FCC_RX_EVENT            (FCC_ENET_RXF)
156 #define FCC_TX_EVENT            (FCC_ENET_TXB)
157 #define FCC_ERR_EVENT_MSK       (FCC_ENET_TXE | FCC_ENET_BSY)
158
159 static int setup_data(struct net_device *dev)
160 {
161         struct fs_enet_private *fep = netdev_priv(dev);
162         const struct fs_platform_info *fpi = fep->fpi;
163
164         fep->fcc.idx = fs_get_fcc_index(fpi->fs_no);
165         if ((unsigned int)fep->fcc.idx >= 3)    /* max 3 FCCs */
166                 return -EINVAL;
167
168         if (do_pd_setup(fep) != 0)
169                 return -EINVAL;
170
171         fep->ev_napi_rx = FCC_NAPI_RX_EVENT_MSK;
172         fep->ev_rx = FCC_RX_EVENT;
173         fep->ev_tx = FCC_TX_EVENT;
174         fep->ev_err = FCC_ERR_EVENT_MSK;
175
176         return 0;
177 }
178
179 static int allocate_bd(struct net_device *dev)
180 {
181         struct fs_enet_private *fep = netdev_priv(dev);
182         const struct fs_platform_info *fpi = fep->fpi;
183
184         fep->ring_base = dma_alloc_coherent(fep->dev,
185                                             (fpi->tx_ring + fpi->rx_ring) *
186                                             sizeof(cbd_t), &fep->ring_mem_addr,
187                                             GFP_KERNEL);
188         if (fep->ring_base == NULL)
189                 return -ENOMEM;
190
191         return 0;
192 }
193
194 static void free_bd(struct net_device *dev)
195 {
196         struct fs_enet_private *fep = netdev_priv(dev);
197         const struct fs_platform_info *fpi = fep->fpi;
198
199         if (fep->ring_base)
200                 dma_free_coherent(fep->dev,
201                         (fpi->tx_ring + fpi->rx_ring) * sizeof(cbd_t),
202                         fep->ring_base, fep->ring_mem_addr);
203 }
204
205 static void cleanup_data(struct net_device *dev)
206 {
207         /* nothing */
208 }
209
210 static void set_promiscuous_mode(struct net_device *dev)
211 {
212         struct fs_enet_private *fep = netdev_priv(dev);
213         fcc_t *fccp = fep->fcc.fccp;
214
215         S32(fccp, fcc_fpsmr, FCC_PSMR_PRO);
216 }
217
218 static void set_multicast_start(struct net_device *dev)
219 {
220         struct fs_enet_private *fep = netdev_priv(dev);
221         fcc_enet_t *ep = fep->fcc.ep;
222
223         W32(ep, fen_gaddrh, 0);
224         W32(ep, fen_gaddrl, 0);
225 }
226
227 static void set_multicast_one(struct net_device *dev, const u8 *mac)
228 {
229         struct fs_enet_private *fep = netdev_priv(dev);
230         fcc_enet_t *ep = fep->fcc.ep;
231         u16 taddrh, taddrm, taddrl;
232
233         taddrh = ((u16)mac[5] << 8) | mac[4];
234         taddrm = ((u16)mac[3] << 8) | mac[2];
235         taddrl = ((u16)mac[1] << 8) | mac[0];
236
237         W16(ep, fen_taddrh, taddrh);
238         W16(ep, fen_taddrm, taddrm);
239         W16(ep, fen_taddrl, taddrl);
240         fcc_cr_cmd(fep, 0x0C, CPM_CR_SET_GADDR);
241 }
242
243 static void set_multicast_finish(struct net_device *dev)
244 {
245         struct fs_enet_private *fep = netdev_priv(dev);
246         fcc_t *fccp = fep->fcc.fccp;
247         fcc_enet_t *ep = fep->fcc.ep;
248
249         /* clear promiscuous always */
250         C32(fccp, fcc_fpsmr, FCC_PSMR_PRO);
251
252         /* if all multi or too many multicasts; just enable all */
253         if ((dev->flags & IFF_ALLMULTI) != 0 ||
254             dev->mc_count > FCC_MAX_MULTICAST_ADDRS) {
255
256                 W32(ep, fen_gaddrh, 0xffffffff);
257                 W32(ep, fen_gaddrl, 0xffffffff);
258         }
259
260         /* read back */
261         fep->fcc.gaddrh = R32(ep, fen_gaddrh);
262         fep->fcc.gaddrl = R32(ep, fen_gaddrl);
263 }
264
265 static void set_multicast_list(struct net_device *dev)
266 {
267         struct dev_mc_list *pmc;
268
269         if ((dev->flags & IFF_PROMISC) == 0) {
270                 set_multicast_start(dev);
271                 for (pmc = dev->mc_list; pmc != NULL; pmc = pmc->next)
272                         set_multicast_one(dev, pmc->dmi_addr);
273                 set_multicast_finish(dev);
274         } else
275                 set_promiscuous_mode(dev);
276 }
277
278 static void restart(struct net_device *dev)
279 {
280         struct fs_enet_private *fep = netdev_priv(dev);
281         const struct fs_platform_info *fpi = fep->fpi;
282         fcc_t *fccp = fep->fcc.fccp;
283         fcc_c_t *fcccp = fep->fcc.fcccp;
284         fcc_enet_t *ep = fep->fcc.ep;
285         dma_addr_t rx_bd_base_phys, tx_bd_base_phys;
286         u16 paddrh, paddrm, paddrl;
287         u16 mem_addr;
288         const unsigned char *mac;
289         int i;
290
291         C32(fccp, fcc_gfmr, FCC_GFMR_ENR | FCC_GFMR_ENT);
292
293         /* clear everything (slow & steady does it) */
294         for (i = 0; i < sizeof(*ep); i++)
295                 __fcc_out8((char *)ep + i, 0);
296
297         /* get physical address */
298         rx_bd_base_phys = fep->ring_mem_addr;
299         tx_bd_base_phys = rx_bd_base_phys + sizeof(cbd_t) * fpi->rx_ring;
300
301         /* point to bds */
302         W32(ep, fen_genfcc.fcc_rbase, rx_bd_base_phys);
303         W32(ep, fen_genfcc.fcc_tbase, tx_bd_base_phys);
304
305         /* Set maximum bytes per receive buffer.
306          * It must be a multiple of 32.
307          */
308         W16(ep, fen_genfcc.fcc_mrblr, PKT_MAXBLR_SIZE);
309
310         W32(ep, fen_genfcc.fcc_rstate, (CPMFCR_GBL | CPMFCR_EB) << 24);
311         W32(ep, fen_genfcc.fcc_tstate, (CPMFCR_GBL | CPMFCR_EB) << 24);
312
313         /* Allocate space in the reserved FCC area of DPRAM for the
314          * internal buffers.  No one uses this space (yet), so we
315          * can do this.  Later, we will add resource management for
316          * this area.
317          */
318
319         mem_addr = (u32) fep->fcc.mem;  /* de-fixup dpram offset */
320
321         W16(ep, fen_genfcc.fcc_riptr, (mem_addr & 0xffff));
322         W16(ep, fen_genfcc.fcc_tiptr, ((mem_addr + 32) & 0xffff));
323         W16(ep, fen_padptr, mem_addr + 64);
324
325         /* fill with special symbol...  */
326         memset(fep->fcc.mem + fpi->dpram_offset + 64, 0x88, 32);
327
328         W32(ep, fen_genfcc.fcc_rbptr, 0);
329         W32(ep, fen_genfcc.fcc_tbptr, 0);
330         W32(ep, fen_genfcc.fcc_rcrc, 0);
331         W32(ep, fen_genfcc.fcc_tcrc, 0);
332         W16(ep, fen_genfcc.fcc_res1, 0);
333         W32(ep, fen_genfcc.fcc_res2, 0);
334
335         /* no CAM */
336         W32(ep, fen_camptr, 0);
337
338         /* Set CRC preset and mask */
339         W32(ep, fen_cmask, 0xdebb20e3);
340         W32(ep, fen_cpres, 0xffffffff);
341
342         W32(ep, fen_crcec, 0);          /* CRC Error counter       */
343         W32(ep, fen_alec, 0);           /* alignment error counter */
344         W32(ep, fen_disfc, 0);          /* discard frame counter   */
345         W16(ep, fen_retlim, 15);        /* Retry limit threshold   */
346         W16(ep, fen_pper, 0);           /* Normal persistence      */
347
348         /* set group address */
349         W32(ep, fen_gaddrh, fep->fcc.gaddrh);
350         W32(ep, fen_gaddrl, fep->fcc.gaddrh);
351
352         /* Clear hash filter tables */
353         W32(ep, fen_iaddrh, 0);
354         W32(ep, fen_iaddrl, 0);
355
356         /* Clear the Out-of-sequence TxBD  */
357         W16(ep, fen_tfcstat, 0);
358         W16(ep, fen_tfclen, 0);
359         W32(ep, fen_tfcptr, 0);
360
361         W16(ep, fen_mflr, PKT_MAXBUF_SIZE);     /* maximum frame length register */
362         W16(ep, fen_minflr, PKT_MINBUF_SIZE);   /* minimum frame length register */
363
364         /* set address */
365         mac = dev->dev_addr;
366         paddrh = ((u16)mac[5] << 8) | mac[4];
367         paddrm = ((u16)mac[3] << 8) | mac[2];
368         paddrl = ((u16)mac[1] << 8) | mac[0];
369
370         W16(ep, fen_paddrh, paddrh);
371         W16(ep, fen_paddrm, paddrm);
372         W16(ep, fen_paddrl, paddrl);
373
374         W16(ep, fen_taddrh, 0);
375         W16(ep, fen_taddrm, 0);
376         W16(ep, fen_taddrl, 0);
377
378         W16(ep, fen_maxd1, 1520);       /* maximum DMA1 length */
379         W16(ep, fen_maxd2, 1520);       /* maximum DMA2 length */
380
381         /* Clear stat counters, in case we ever enable RMON */
382         W32(ep, fen_octc, 0);
383         W32(ep, fen_colc, 0);
384         W32(ep, fen_broc, 0);
385         W32(ep, fen_mulc, 0);
386         W32(ep, fen_uspc, 0);
387         W32(ep, fen_frgc, 0);
388         W32(ep, fen_ospc, 0);
389         W32(ep, fen_jbrc, 0);
390         W32(ep, fen_p64c, 0);
391         W32(ep, fen_p65c, 0);
392         W32(ep, fen_p128c, 0);
393         W32(ep, fen_p256c, 0);
394         W32(ep, fen_p512c, 0);
395         W32(ep, fen_p1024c, 0);
396
397         W16(ep, fen_rfthr, 0);  /* Suggested by manual */
398         W16(ep, fen_rfcnt, 0);
399         W16(ep, fen_cftype, 0);
400
401         fs_init_bds(dev);
402
403         /* adjust to speed (for RMII mode) */
404         if (fpi->use_rmii) {
405                 if (fep->phydev->speed == 100)
406                         C8(fcccp, fcc_gfemr, 0x20);
407                 else
408                         S8(fcccp, fcc_gfemr, 0x20);
409         }
410
411         fcc_cr_cmd(fep, 0x0c, CPM_CR_INIT_TRX);
412
413         /* clear events */
414         W16(fccp, fcc_fcce, 0xffff);
415
416         /* Enable interrupts we wish to service */
417         W16(fccp, fcc_fccm, FCC_ENET_TXE | FCC_ENET_RXF | FCC_ENET_TXB);
418
419         /* Set GFMR to enable Ethernet operating mode */
420         W32(fccp, fcc_gfmr, FCC_GFMR_TCI | FCC_GFMR_MODE_ENET);
421
422         /* set sync/delimiters */
423         W16(fccp, fcc_fdsr, 0xd555);
424
425         W32(fccp, fcc_fpsmr, FCC_PSMR_ENCRC);
426
427         if (fpi->use_rmii)
428                 S32(fccp, fcc_fpsmr, FCC_PSMR_RMII);
429
430         /* adjust to duplex mode */
431         if (fep->phydev->duplex)
432                 S32(fccp, fcc_fpsmr, FCC_PSMR_FDE | FCC_PSMR_LPB);
433         else
434                 C32(fccp, fcc_fpsmr, FCC_PSMR_FDE | FCC_PSMR_LPB);
435
436         S32(fccp, fcc_gfmr, FCC_GFMR_ENR | FCC_GFMR_ENT);
437 }
438
439 static void stop(struct net_device *dev)
440 {
441         struct fs_enet_private *fep = netdev_priv(dev);
442         fcc_t *fccp = fep->fcc.fccp;
443
444         /* stop ethernet */
445         C32(fccp, fcc_gfmr, FCC_GFMR_ENR | FCC_GFMR_ENT);
446
447         /* clear events */
448         W16(fccp, fcc_fcce, 0xffff);
449
450         /* clear interrupt mask */
451         W16(fccp, fcc_fccm, 0);
452
453         fs_cleanup_bds(dev);
454 }
455
456 static void pre_request_irq(struct net_device *dev, int irq)
457 {
458         /* nothing */
459 }
460
461 static void post_free_irq(struct net_device *dev, int irq)
462 {
463         /* nothing */
464 }
465
466 static void napi_clear_rx_event(struct net_device *dev)
467 {
468         struct fs_enet_private *fep = netdev_priv(dev);
469         fcc_t *fccp = fep->fcc.fccp;
470
471         W16(fccp, fcc_fcce, FCC_NAPI_RX_EVENT_MSK);
472 }
473
474 static void napi_enable_rx(struct net_device *dev)
475 {
476         struct fs_enet_private *fep = netdev_priv(dev);
477         fcc_t *fccp = fep->fcc.fccp;
478
479         S16(fccp, fcc_fccm, FCC_NAPI_RX_EVENT_MSK);
480 }
481
482 static void napi_disable_rx(struct net_device *dev)
483 {
484         struct fs_enet_private *fep = netdev_priv(dev);
485         fcc_t *fccp = fep->fcc.fccp;
486
487         C16(fccp, fcc_fccm, FCC_NAPI_RX_EVENT_MSK);
488 }
489
490 static void rx_bd_done(struct net_device *dev)
491 {
492         /* nothing */
493 }
494
495 static void tx_kickstart(struct net_device *dev)
496 {
497         struct fs_enet_private *fep = netdev_priv(dev);
498         fcc_t *fccp = fep->fcc.fccp;
499
500         S32(fccp, fcc_ftodr, 0x80);
501 }
502
503 static u32 get_int_events(struct net_device *dev)
504 {
505         struct fs_enet_private *fep = netdev_priv(dev);
506         fcc_t *fccp = fep->fcc.fccp;
507
508         return (u32)R16(fccp, fcc_fcce);
509 }
510
511 static void clear_int_events(struct net_device *dev, u32 int_events)
512 {
513         struct fs_enet_private *fep = netdev_priv(dev);
514         fcc_t *fccp = fep->fcc.fccp;
515
516         W16(fccp, fcc_fcce, int_events & 0xffff);
517 }
518
519 static void ev_error(struct net_device *dev, u32 int_events)
520 {
521         printk(KERN_WARNING DRV_MODULE_NAME
522                ": %s FS_ENET ERROR(s) 0x%x\n", dev->name, int_events);
523 }
524
525 int get_regs(struct net_device *dev, void *p, int *sizep)
526 {
527         struct fs_enet_private *fep = netdev_priv(dev);
528
529         if (*sizep < sizeof(fcc_t) + sizeof(fcc_c_t) + sizeof(fcc_enet_t))
530                 return -EINVAL;
531
532         memcpy_fromio(p, fep->fcc.fccp, sizeof(fcc_t));
533         p = (char *)p + sizeof(fcc_t);
534
535         memcpy_fromio(p, fep->fcc.fcccp, sizeof(fcc_c_t));
536         p = (char *)p + sizeof(fcc_c_t);
537
538         memcpy_fromio(p, fep->fcc.ep, sizeof(fcc_enet_t));
539
540         return 0;
541 }
542
543 int get_regs_len(struct net_device *dev)
544 {
545         return sizeof(fcc_t) + sizeof(fcc_c_t) + sizeof(fcc_enet_t);
546 }
547
548 /* Some transmit errors cause the transmitter to shut
549  * down.  We now issue a restart transmit.  Since the
550  * errors close the BD and update the pointers, the restart
551  * _should_ pick up without having to reset any of our
552  * pointers either.  Also, To workaround 8260 device erratum 
553  * CPM37, we must disable and then re-enable the transmitter
554  * following a Late Collision, Underrun, or Retry Limit error.
555  */
556 void tx_restart(struct net_device *dev)
557 {
558         struct fs_enet_private *fep = netdev_priv(dev);
559         fcc_t *fccp = fep->fcc.fccp;
560
561         C32(fccp, fcc_gfmr, FCC_GFMR_ENT);
562         udelay(10);
563         S32(fccp, fcc_gfmr, FCC_GFMR_ENT);
564
565         fcc_cr_cmd(fep, 0x0C, CPM_CR_RESTART_TX);
566 }
567
568 /*************************************************************************/
569
570 const struct fs_ops fs_fcc_ops = {
571         .setup_data             = setup_data,
572         .cleanup_data           = cleanup_data,
573         .set_multicast_list     = set_multicast_list,
574         .restart                = restart,
575         .stop                   = stop,
576         .pre_request_irq        = pre_request_irq,
577         .post_free_irq          = post_free_irq,
578         .napi_clear_rx_event    = napi_clear_rx_event,
579         .napi_enable_rx         = napi_enable_rx,
580         .napi_disable_rx        = napi_disable_rx,
581         .rx_bd_done             = rx_bd_done,
582         .tx_kickstart           = tx_kickstart,
583         .get_int_events         = get_int_events,
584         .clear_int_events       = clear_int_events,
585         .ev_error               = ev_error,
586         .get_regs               = get_regs,
587         .get_regs_len           = get_regs_len,
588         .tx_restart             = tx_restart,
589         .allocate_bd            = allocate_bd,
590         .free_bd                = free_bd,
591 };