2 * FCC driver for Motorola MPC82xx (PQ2).
4 * Copyright (c) 2003 Intracom S.A.
5 * by Pantelis Antoniou <panto@intracom.gr>
7 * 2005 (c) MontaVista Software, Inc.
8 * Vitaly Bordug <vbordug@ru.mvista.com>
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.
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/init.h>
25 #include <linux/delay.h>
26 #include <linux/netdevice.h>
27 #include <linux/etherdevice.h>
28 #include <linux/skbuff.h>
29 #include <linux/spinlock.h>
30 #include <linux/mii.h>
31 #include <linux/ethtool.h>
32 #include <linux/bitops.h>
34 #include <linux/platform_device.h>
35 #include <linux/phy.h>
37 #include <asm/immap_cpm2.h>
38 #include <asm/mpc8260.h>
41 #include <asm/pgtable.h>
43 #include <asm/uaccess.h>
45 #ifdef CONFIG_PPC_CPM_NEW_BINDING
46 #include <asm/of_device.h>
51 /*************************************************/
53 /* FCC access macros */
55 /* write, read, set bits, clear bits */
56 #define W32(_p, _m, _v) out_be32(&(_p)->_m, (_v))
57 #define R32(_p, _m) in_be32(&(_p)->_m)
58 #define S32(_p, _m, _v) W32(_p, _m, R32(_p, _m) | (_v))
59 #define C32(_p, _m, _v) W32(_p, _m, R32(_p, _m) & ~(_v))
61 #define W16(_p, _m, _v) out_be16(&(_p)->_m, (_v))
62 #define R16(_p, _m) in_be16(&(_p)->_m)
63 #define S16(_p, _m, _v) W16(_p, _m, R16(_p, _m) | (_v))
64 #define C16(_p, _m, _v) W16(_p, _m, R16(_p, _m) & ~(_v))
66 #define W8(_p, _m, _v) out_8(&(_p)->_m, (_v))
67 #define R8(_p, _m) in_8(&(_p)->_m)
68 #define S8(_p, _m, _v) W8(_p, _m, R8(_p, _m) | (_v))
69 #define C8(_p, _m, _v) W8(_p, _m, R8(_p, _m) & ~(_v))
71 /*************************************************/
73 #define FCC_MAX_MULTICAST_ADDRS 64
75 #define mk_mii_read(REG) (0x60020000 | ((REG & 0x1f) << 18))
76 #define mk_mii_write(REG, VAL) (0x50020000 | ((REG & 0x1f) << 18) | (VAL & 0xffff))
79 #define MAX_CR_CMD_LOOPS 10000
81 static inline int fcc_cr_cmd(struct fs_enet_private *fep, u32 op)
83 const struct fs_platform_info *fpi = fep->fpi;
85 return cpm_command(fpi->cp_command, op);
88 static int do_pd_setup(struct fs_enet_private *fep)
90 #ifdef CONFIG_PPC_CPM_NEW_BINDING
91 struct of_device *ofdev = to_of_device(fep->dev);
92 struct fs_platform_info *fpi = fep->fpi;
95 fep->interrupt = of_irq_to_resource(ofdev->node, 0, NULL);
96 if (fep->interrupt == NO_IRQ)
99 fep->fcc.fccp = of_iomap(ofdev->node, 0);
103 fep->fcc.ep = of_iomap(ofdev->node, 1);
107 fep->fcc.fcccp = of_iomap(ofdev->node, 2);
111 fep->fcc.mem = (void __iomem *)cpm2_immr;
112 fpi->dpram_offset = cpm_dpalloc(128, 8);
113 if (IS_ERR_VALUE(fpi->dpram_offset)) {
114 ret = fpi->dpram_offset;
121 iounmap(fep->fcc.fcccp);
123 iounmap(fep->fcc.ep);
125 iounmap(fep->fcc.fccp);
129 struct platform_device *pdev = to_platform_device(fep->dev);
132 /* Fill out IRQ field */
133 fep->interrupt = platform_get_irq(pdev, 0);
134 if (fep->interrupt < 0)
137 /* Attach the memory for the FCC Parameter RAM */
138 r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "fcc_pram");
139 fep->fcc.ep = ioremap(r->start, r->end - r->start + 1);
140 if (fep->fcc.ep == NULL)
143 r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "fcc_regs");
144 fep->fcc.fccp = ioremap(r->start, r->end - r->start + 1);
145 if (fep->fcc.fccp == NULL)
148 if (fep->fpi->fcc_regs_c) {
149 fep->fcc.fcccp = (void __iomem *)fep->fpi->fcc_regs_c;
151 r = platform_get_resource_byname(pdev, IORESOURCE_MEM,
153 fep->fcc.fcccp = ioremap(r->start,
154 r->end - r->start + 1);
157 if (fep->fcc.fcccp == NULL)
160 fep->fcc.mem = (void __iomem *)fep->fpi->mem_offset;
161 if (fep->fcc.mem == NULL)
168 #define FCC_NAPI_RX_EVENT_MSK (FCC_ENET_RXF | FCC_ENET_RXB)
169 #define FCC_RX_EVENT (FCC_ENET_RXF)
170 #define FCC_TX_EVENT (FCC_ENET_TXB)
171 #define FCC_ERR_EVENT_MSK (FCC_ENET_TXE | FCC_ENET_BSY)
173 static int setup_data(struct net_device *dev)
175 struct fs_enet_private *fep = netdev_priv(dev);
176 #ifndef CONFIG_PPC_CPM_NEW_BINDING
177 struct fs_platform_info *fpi = fep->fpi;
179 fpi->cp_command = (fpi->cp_page << 26) |
180 (fpi->cp_block << 21) |
183 fep->fcc.idx = fs_get_fcc_index(fpi->fs_no);
184 if ((unsigned int)fep->fcc.idx >= 3) /* max 3 FCCs */
188 if (do_pd_setup(fep) != 0)
191 fep->ev_napi_rx = FCC_NAPI_RX_EVENT_MSK;
192 fep->ev_rx = FCC_RX_EVENT;
193 fep->ev_tx = FCC_TX_EVENT;
194 fep->ev_err = FCC_ERR_EVENT_MSK;
199 static int allocate_bd(struct net_device *dev)
201 struct fs_enet_private *fep = netdev_priv(dev);
202 const struct fs_platform_info *fpi = fep->fpi;
204 fep->ring_base = (void __iomem __force *)dma_alloc_coherent(fep->dev,
205 (fpi->tx_ring + fpi->rx_ring) *
206 sizeof(cbd_t), &fep->ring_mem_addr,
208 if (fep->ring_base == NULL)
214 static void free_bd(struct net_device *dev)
216 struct fs_enet_private *fep = netdev_priv(dev);
217 const struct fs_platform_info *fpi = fep->fpi;
220 dma_free_coherent(fep->dev,
221 (fpi->tx_ring + fpi->rx_ring) * sizeof(cbd_t),
222 (void __force *)fep->ring_base, fep->ring_mem_addr);
225 static void cleanup_data(struct net_device *dev)
230 static void set_promiscuous_mode(struct net_device *dev)
232 struct fs_enet_private *fep = netdev_priv(dev);
233 fcc_t __iomem *fccp = fep->fcc.fccp;
235 S32(fccp, fcc_fpsmr, FCC_PSMR_PRO);
238 static void set_multicast_start(struct net_device *dev)
240 struct fs_enet_private *fep = netdev_priv(dev);
241 fcc_enet_t __iomem *ep = fep->fcc.ep;
243 W32(ep, fen_gaddrh, 0);
244 W32(ep, fen_gaddrl, 0);
247 static void set_multicast_one(struct net_device *dev, const u8 *mac)
249 struct fs_enet_private *fep = netdev_priv(dev);
250 fcc_enet_t __iomem *ep = fep->fcc.ep;
251 u16 taddrh, taddrm, taddrl;
253 taddrh = ((u16)mac[5] << 8) | mac[4];
254 taddrm = ((u16)mac[3] << 8) | mac[2];
255 taddrl = ((u16)mac[1] << 8) | mac[0];
257 W16(ep, fen_taddrh, taddrh);
258 W16(ep, fen_taddrm, taddrm);
259 W16(ep, fen_taddrl, taddrl);
260 fcc_cr_cmd(fep, CPM_CR_SET_GADDR);
263 static void set_multicast_finish(struct net_device *dev)
265 struct fs_enet_private *fep = netdev_priv(dev);
266 fcc_t __iomem *fccp = fep->fcc.fccp;
267 fcc_enet_t __iomem *ep = fep->fcc.ep;
269 /* clear promiscuous always */
270 C32(fccp, fcc_fpsmr, FCC_PSMR_PRO);
272 /* if all multi or too many multicasts; just enable all */
273 if ((dev->flags & IFF_ALLMULTI) != 0 ||
274 dev->mc_count > FCC_MAX_MULTICAST_ADDRS) {
276 W32(ep, fen_gaddrh, 0xffffffff);
277 W32(ep, fen_gaddrl, 0xffffffff);
281 fep->fcc.gaddrh = R32(ep, fen_gaddrh);
282 fep->fcc.gaddrl = R32(ep, fen_gaddrl);
285 static void set_multicast_list(struct net_device *dev)
287 struct dev_mc_list *pmc;
289 if ((dev->flags & IFF_PROMISC) == 0) {
290 set_multicast_start(dev);
291 for (pmc = dev->mc_list; pmc != NULL; pmc = pmc->next)
292 set_multicast_one(dev, pmc->dmi_addr);
293 set_multicast_finish(dev);
295 set_promiscuous_mode(dev);
298 static void restart(struct net_device *dev)
300 struct fs_enet_private *fep = netdev_priv(dev);
301 const struct fs_platform_info *fpi = fep->fpi;
302 fcc_t __iomem *fccp = fep->fcc.fccp;
303 fcc_c_t __iomem *fcccp = fep->fcc.fcccp;
304 fcc_enet_t __iomem *ep = fep->fcc.ep;
305 dma_addr_t rx_bd_base_phys, tx_bd_base_phys;
306 u16 paddrh, paddrm, paddrl;
307 #ifndef CONFIG_PPC_CPM_NEW_BINDING
310 const unsigned char *mac;
313 C32(fccp, fcc_gfmr, FCC_GFMR_ENR | FCC_GFMR_ENT);
315 /* clear everything (slow & steady does it) */
316 for (i = 0; i < sizeof(*ep); i++)
317 out_8((u8 __iomem *)ep + i, 0);
319 /* get physical address */
320 rx_bd_base_phys = fep->ring_mem_addr;
321 tx_bd_base_phys = rx_bd_base_phys + sizeof(cbd_t) * fpi->rx_ring;
324 W32(ep, fen_genfcc.fcc_rbase, rx_bd_base_phys);
325 W32(ep, fen_genfcc.fcc_tbase, tx_bd_base_phys);
327 /* Set maximum bytes per receive buffer.
328 * It must be a multiple of 32.
330 W16(ep, fen_genfcc.fcc_mrblr, PKT_MAXBLR_SIZE);
332 W32(ep, fen_genfcc.fcc_rstate, (CPMFCR_GBL | CPMFCR_EB) << 24);
333 W32(ep, fen_genfcc.fcc_tstate, (CPMFCR_GBL | CPMFCR_EB) << 24);
335 /* Allocate space in the reserved FCC area of DPRAM for the
336 * internal buffers. No one uses this space (yet), so we
337 * can do this. Later, we will add resource management for
341 #ifdef CONFIG_PPC_CPM_NEW_BINDING
342 W16(ep, fen_genfcc.fcc_riptr, fpi->dpram_offset);
343 W16(ep, fen_genfcc.fcc_tiptr, fpi->dpram_offset + 32);
345 W16(ep, fen_padptr, fpi->dpram_offset + 64);
347 mem_addr = (u32) fep->fcc.mem; /* de-fixup dpram offset */
349 W16(ep, fen_genfcc.fcc_riptr, (mem_addr & 0xffff));
350 W16(ep, fen_genfcc.fcc_tiptr, ((mem_addr + 32) & 0xffff));
352 W16(ep, fen_padptr, mem_addr + 64);
355 /* fill with special symbol... */
356 memset_io(fep->fcc.mem + fpi->dpram_offset + 64, 0x88, 32);
358 W32(ep, fen_genfcc.fcc_rbptr, 0);
359 W32(ep, fen_genfcc.fcc_tbptr, 0);
360 W32(ep, fen_genfcc.fcc_rcrc, 0);
361 W32(ep, fen_genfcc.fcc_tcrc, 0);
362 W16(ep, fen_genfcc.fcc_res1, 0);
363 W32(ep, fen_genfcc.fcc_res2, 0);
366 W32(ep, fen_camptr, 0);
368 /* Set CRC preset and mask */
369 W32(ep, fen_cmask, 0xdebb20e3);
370 W32(ep, fen_cpres, 0xffffffff);
372 W32(ep, fen_crcec, 0); /* CRC Error counter */
373 W32(ep, fen_alec, 0); /* alignment error counter */
374 W32(ep, fen_disfc, 0); /* discard frame counter */
375 W16(ep, fen_retlim, 15); /* Retry limit threshold */
376 W16(ep, fen_pper, 0); /* Normal persistence */
378 /* set group address */
379 W32(ep, fen_gaddrh, fep->fcc.gaddrh);
380 W32(ep, fen_gaddrl, fep->fcc.gaddrh);
382 /* Clear hash filter tables */
383 W32(ep, fen_iaddrh, 0);
384 W32(ep, fen_iaddrl, 0);
386 /* Clear the Out-of-sequence TxBD */
387 W16(ep, fen_tfcstat, 0);
388 W16(ep, fen_tfclen, 0);
389 W32(ep, fen_tfcptr, 0);
391 W16(ep, fen_mflr, PKT_MAXBUF_SIZE); /* maximum frame length register */
392 W16(ep, fen_minflr, PKT_MINBUF_SIZE); /* minimum frame length register */
396 paddrh = ((u16)mac[5] << 8) | mac[4];
397 paddrm = ((u16)mac[3] << 8) | mac[2];
398 paddrl = ((u16)mac[1] << 8) | mac[0];
400 W16(ep, fen_paddrh, paddrh);
401 W16(ep, fen_paddrm, paddrm);
402 W16(ep, fen_paddrl, paddrl);
404 W16(ep, fen_taddrh, 0);
405 W16(ep, fen_taddrm, 0);
406 W16(ep, fen_taddrl, 0);
408 W16(ep, fen_maxd1, 1520); /* maximum DMA1 length */
409 W16(ep, fen_maxd2, 1520); /* maximum DMA2 length */
411 /* Clear stat counters, in case we ever enable RMON */
412 W32(ep, fen_octc, 0);
413 W32(ep, fen_colc, 0);
414 W32(ep, fen_broc, 0);
415 W32(ep, fen_mulc, 0);
416 W32(ep, fen_uspc, 0);
417 W32(ep, fen_frgc, 0);
418 W32(ep, fen_ospc, 0);
419 W32(ep, fen_jbrc, 0);
420 W32(ep, fen_p64c, 0);
421 W32(ep, fen_p65c, 0);
422 W32(ep, fen_p128c, 0);
423 W32(ep, fen_p256c, 0);
424 W32(ep, fen_p512c, 0);
425 W32(ep, fen_p1024c, 0);
427 W16(ep, fen_rfthr, 0); /* Suggested by manual */
428 W16(ep, fen_rfcnt, 0);
429 W16(ep, fen_cftype, 0);
433 /* adjust to speed (for RMII mode) */
435 if (fep->phydev->speed == 100)
436 C8(fcccp, fcc_gfemr, 0x20);
438 S8(fcccp, fcc_gfemr, 0x20);
441 fcc_cr_cmd(fep, CPM_CR_INIT_TRX);
444 W16(fccp, fcc_fcce, 0xffff);
446 /* Enable interrupts we wish to service */
447 W16(fccp, fcc_fccm, FCC_ENET_TXE | FCC_ENET_RXF | FCC_ENET_TXB);
449 /* Set GFMR to enable Ethernet operating mode */
450 W32(fccp, fcc_gfmr, FCC_GFMR_TCI | FCC_GFMR_MODE_ENET);
452 /* set sync/delimiters */
453 W16(fccp, fcc_fdsr, 0xd555);
455 W32(fccp, fcc_fpsmr, FCC_PSMR_ENCRC);
458 S32(fccp, fcc_fpsmr, FCC_PSMR_RMII);
460 /* adjust to duplex mode */
461 if (fep->phydev->duplex)
462 S32(fccp, fcc_fpsmr, FCC_PSMR_FDE | FCC_PSMR_LPB);
464 C32(fccp, fcc_fpsmr, FCC_PSMR_FDE | FCC_PSMR_LPB);
466 S32(fccp, fcc_gfmr, FCC_GFMR_ENR | FCC_GFMR_ENT);
469 static void stop(struct net_device *dev)
471 struct fs_enet_private *fep = netdev_priv(dev);
472 fcc_t __iomem *fccp = fep->fcc.fccp;
475 C32(fccp, fcc_gfmr, FCC_GFMR_ENR | FCC_GFMR_ENT);
478 W16(fccp, fcc_fcce, 0xffff);
480 /* clear interrupt mask */
481 W16(fccp, fcc_fccm, 0);
486 static void pre_request_irq(struct net_device *dev, int irq)
491 static void post_free_irq(struct net_device *dev, int irq)
496 static void napi_clear_rx_event(struct net_device *dev)
498 struct fs_enet_private *fep = netdev_priv(dev);
499 fcc_t __iomem *fccp = fep->fcc.fccp;
501 W16(fccp, fcc_fcce, FCC_NAPI_RX_EVENT_MSK);
504 static void napi_enable_rx(struct net_device *dev)
506 struct fs_enet_private *fep = netdev_priv(dev);
507 fcc_t __iomem *fccp = fep->fcc.fccp;
509 S16(fccp, fcc_fccm, FCC_NAPI_RX_EVENT_MSK);
512 static void napi_disable_rx(struct net_device *dev)
514 struct fs_enet_private *fep = netdev_priv(dev);
515 fcc_t __iomem *fccp = fep->fcc.fccp;
517 C16(fccp, fcc_fccm, FCC_NAPI_RX_EVENT_MSK);
520 static void rx_bd_done(struct net_device *dev)
525 static void tx_kickstart(struct net_device *dev)
527 struct fs_enet_private *fep = netdev_priv(dev);
528 fcc_t __iomem *fccp = fep->fcc.fccp;
530 S16(fccp, fcc_ftodr, 0x8000);
533 static u32 get_int_events(struct net_device *dev)
535 struct fs_enet_private *fep = netdev_priv(dev);
536 fcc_t __iomem *fccp = fep->fcc.fccp;
538 return (u32)R16(fccp, fcc_fcce);
541 static void clear_int_events(struct net_device *dev, u32 int_events)
543 struct fs_enet_private *fep = netdev_priv(dev);
544 fcc_t __iomem *fccp = fep->fcc.fccp;
546 W16(fccp, fcc_fcce, int_events & 0xffff);
549 static void ev_error(struct net_device *dev, u32 int_events)
551 printk(KERN_WARNING DRV_MODULE_NAME
552 ": %s FS_ENET ERROR(s) 0x%x\n", dev->name, int_events);
555 static int get_regs(struct net_device *dev, void *p, int *sizep)
557 struct fs_enet_private *fep = netdev_priv(dev);
559 if (*sizep < sizeof(fcc_t) + sizeof(fcc_enet_t) + 1)
562 memcpy_fromio(p, fep->fcc.fccp, sizeof(fcc_t));
563 p = (char *)p + sizeof(fcc_t);
565 memcpy_fromio(p, fep->fcc.ep, sizeof(fcc_enet_t));
566 p = (char *)p + sizeof(fcc_enet_t);
568 memcpy_fromio(p, fep->fcc.fcccp, 1);
572 static int get_regs_len(struct net_device *dev)
574 return sizeof(fcc_t) + sizeof(fcc_enet_t) + 1;
577 /* Some transmit errors cause the transmitter to shut
578 * down. We now issue a restart transmit. Since the
579 * errors close the BD and update the pointers, the restart
580 * _should_ pick up without having to reset any of our
581 * pointers either. Also, To workaround 8260 device erratum
582 * CPM37, we must disable and then re-enable the transmitter
583 * following a Late Collision, Underrun, or Retry Limit error.
585 static void tx_restart(struct net_device *dev)
587 struct fs_enet_private *fep = netdev_priv(dev);
588 fcc_t __iomem *fccp = fep->fcc.fccp;
590 C32(fccp, fcc_gfmr, FCC_GFMR_ENT);
592 S32(fccp, fcc_gfmr, FCC_GFMR_ENT);
594 fcc_cr_cmd(fep, CPM_CR_RESTART_TX);
597 /*************************************************************************/
599 const struct fs_ops fs_fcc_ops = {
600 .setup_data = setup_data,
601 .cleanup_data = cleanup_data,
602 .set_multicast_list = set_multicast_list,
605 .pre_request_irq = pre_request_irq,
606 .post_free_irq = post_free_irq,
607 .napi_clear_rx_event = napi_clear_rx_event,
608 .napi_enable_rx = napi_enable_rx,
609 .napi_disable_rx = napi_disable_rx,
610 .rx_bd_done = rx_bd_done,
611 .tx_kickstart = tx_kickstart,
612 .get_int_events = get_int_events,
613 .clear_int_events = clear_int_events,
614 .ev_error = ev_error,
615 .get_regs = get_regs,
616 .get_regs_len = get_regs_len,
617 .tx_restart = tx_restart,
618 .allocate_bd = allocate_bd,