2 * Freescale Ethernet controllers
4 * Copyright (c) 2005 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/config.h>
16 #include <linux/module.h>
17 #include <linux/kernel.h>
18 #include <linux/types.h>
19 #include <linux/sched.h>
20 #include <linux/string.h>
21 #include <linux/ptrace.h>
22 #include <linux/errno.h>
23 #include <linux/ioport.h>
24 #include <linux/slab.h>
25 #include <linux/interrupt.h>
26 #include <linux/pci.h>
27 #include <linux/init.h>
28 #include <linux/delay.h>
29 #include <linux/netdevice.h>
30 #include <linux/etherdevice.h>
31 #include <linux/skbuff.h>
32 #include <linux/spinlock.h>
33 #include <linux/mii.h>
34 #include <linux/ethtool.h>
35 #include <linux/bitops.h>
37 #include <linux/platform_device.h>
40 #include <asm/uaccess.h>
43 #include <asm/8xx_immap.h>
44 #include <asm/pgtable.h>
45 #include <asm/mpc8xx.h>
46 #include <asm/commproc.h>
51 /*************************************************/
53 #if defined(CONFIG_CPM1)
54 /* for a CPM1 __raw_xxx's are sufficient */
55 #define __fs_out32(addr, x) __raw_writel(x, addr)
56 #define __fs_out16(addr, x) __raw_writew(x, addr)
57 #define __fs_in32(addr) __raw_readl(addr)
58 #define __fs_in16(addr) __raw_readw(addr)
60 /* for others play it safe */
61 #define __fs_out32(addr, x) out_be32(addr, x)
62 #define __fs_out16(addr, x) out_be16(addr, x)
63 #define __fs_in32(addr) in_be32(addr)
64 #define __fs_in16(addr) in_be16(addr)
68 #define FW(_fecp, _reg, _v) __fs_out32(&(_fecp)->fec_ ## _reg, (_v))
71 #define FR(_fecp, _reg) __fs_in32(&(_fecp)->fec_ ## _reg)
74 #define FS(_fecp, _reg, _v) FW(_fecp, _reg, FR(_fecp, _reg) | (_v))
77 #define FC(_fecp, _reg, _v) FW(_fecp, _reg, FR(_fecp, _reg) & ~(_v))
80 /* CRC polynomium used by the FEC for the multicast group filtering */
81 #define FEC_CRC_POLY 0x04C11DB7
83 #define FEC_MAX_MULTICAST_ADDRS 64
85 /* Interrupt events/masks.
87 #define FEC_ENET_HBERR 0x80000000U /* Heartbeat error */
88 #define FEC_ENET_BABR 0x40000000U /* Babbling receiver */
89 #define FEC_ENET_BABT 0x20000000U /* Babbling transmitter */
90 #define FEC_ENET_GRA 0x10000000U /* Graceful stop complete */
91 #define FEC_ENET_TXF 0x08000000U /* Full frame transmitted */
92 #define FEC_ENET_TXB 0x04000000U /* A buffer was transmitted */
93 #define FEC_ENET_RXF 0x02000000U /* Full frame received */
94 #define FEC_ENET_RXB 0x01000000U /* A buffer was received */
95 #define FEC_ENET_MII 0x00800000U /* MII interrupt */
96 #define FEC_ENET_EBERR 0x00400000U /* SDMA bus error */
98 #define FEC_ECNTRL_PINMUX 0x00000004
99 #define FEC_ECNTRL_ETHER_EN 0x00000002
100 #define FEC_ECNTRL_RESET 0x00000001
102 #define FEC_RCNTRL_BC_REJ 0x00000010
103 #define FEC_RCNTRL_PROM 0x00000008
104 #define FEC_RCNTRL_MII_MODE 0x00000004
105 #define FEC_RCNTRL_DRT 0x00000002
106 #define FEC_RCNTRL_LOOP 0x00000001
108 #define FEC_TCNTRL_FDEN 0x00000004
109 #define FEC_TCNTRL_HBC 0x00000002
110 #define FEC_TCNTRL_GTS 0x00000001
113 /* Make MII read/write commands for the FEC.
115 #define mk_mii_read(REG) (0x60020000 | ((REG & 0x1f) << 18))
116 #define mk_mii_write(REG, VAL) (0x50020000 | ((REG & 0x1f) << 18) | (VAL & 0xffff))
119 #define FEC_MII_LOOPS 10000
122 * Delay to wait for FEC reset command to complete (in us)
124 #define FEC_RESET_DELAY 50
126 static int whack_reset(fec_t * fecp)
130 FW(fecp, ecntrl, FEC_ECNTRL_PINMUX | FEC_ECNTRL_RESET);
131 for (i = 0; i < FEC_RESET_DELAY; i++) {
132 if ((FR(fecp, ecntrl) & FEC_ECNTRL_RESET) == 0)
140 static int do_pd_setup(struct fs_enet_private *fep)
142 struct platform_device *pdev = to_platform_device(fep->dev);
145 /* Fill out IRQ field */
146 fep->interrupt = platform_get_irq_byname(pdev,"interrupt");
148 r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "regs");
149 fep->fec.fecp =(void*)r->start;
151 if(fep->fec.fecp == NULL)
158 #define FEC_NAPI_RX_EVENT_MSK (FEC_ENET_RXF | FEC_ENET_RXB)
159 #define FEC_RX_EVENT (FEC_ENET_RXF)
160 #define FEC_TX_EVENT (FEC_ENET_TXF)
161 #define FEC_ERR_EVENT_MSK (FEC_ENET_HBERR | FEC_ENET_BABR | \
162 FEC_ENET_BABT | FEC_ENET_EBERR)
164 static int setup_data(struct net_device *dev)
166 struct fs_enet_private *fep = netdev_priv(dev);
168 if (do_pd_setup(fep) != 0)
174 fep->ev_napi_rx = FEC_NAPI_RX_EVENT_MSK;
175 fep->ev_rx = FEC_RX_EVENT;
176 fep->ev_tx = FEC_TX_EVENT;
177 fep->ev_err = FEC_ERR_EVENT_MSK;
182 static int allocate_bd(struct net_device *dev)
184 struct fs_enet_private *fep = netdev_priv(dev);
185 const struct fs_platform_info *fpi = fep->fpi;
187 fep->ring_base = dma_alloc_coherent(fep->dev,
188 (fpi->tx_ring + fpi->rx_ring) *
189 sizeof(cbd_t), &fep->ring_mem_addr,
191 if (fep->ring_base == NULL)
197 static void free_bd(struct net_device *dev)
199 struct fs_enet_private *fep = netdev_priv(dev);
200 const struct fs_platform_info *fpi = fep->fpi;
203 dma_free_coherent(fep->dev, (fpi->tx_ring + fpi->rx_ring)
209 static void cleanup_data(struct net_device *dev)
214 static void set_promiscuous_mode(struct net_device *dev)
216 struct fs_enet_private *fep = netdev_priv(dev);
217 fec_t *fecp = fep->fec.fecp;
219 FS(fecp, r_cntrl, FEC_RCNTRL_PROM);
222 static void set_multicast_start(struct net_device *dev)
224 struct fs_enet_private *fep = netdev_priv(dev);
230 static void set_multicast_one(struct net_device *dev, const u8 *mac)
232 struct fs_enet_private *fep = netdev_priv(dev);
233 int temp, hash_index, i, j;
238 for (i = 0; i < 6; i++) {
240 for (j = 0; j < 8; j++) {
243 if (msb ^ (byte & 0x1))
249 temp = (crc & 0x3f) >> 1;
250 hash_index = ((temp & 0x01) << 4) |
251 ((temp & 0x02) << 2) |
253 ((temp & 0x08) >> 2) |
254 ((temp & 0x10) >> 4);
255 csrVal = 1 << hash_index;
257 fep->fec.hthi |= csrVal;
259 fep->fec.htlo |= csrVal;
262 static void set_multicast_finish(struct net_device *dev)
264 struct fs_enet_private *fep = netdev_priv(dev);
265 fec_t *fecp = fep->fec.fecp;
267 /* if all multi or too many multicasts; just enable all */
268 if ((dev->flags & IFF_ALLMULTI) != 0 ||
269 dev->mc_count > FEC_MAX_MULTICAST_ADDRS) {
270 fep->fec.hthi = 0xffffffffU;
271 fep->fec.htlo = 0xffffffffU;
274 FC(fecp, r_cntrl, FEC_RCNTRL_PROM);
275 FW(fecp, hash_table_high, fep->fec.hthi);
276 FW(fecp, hash_table_low, fep->fec.htlo);
279 static void set_multicast_list(struct net_device *dev)
281 struct dev_mc_list *pmc;
283 if ((dev->flags & IFF_PROMISC) == 0) {
284 set_multicast_start(dev);
285 for (pmc = dev->mc_list; pmc != NULL; pmc = pmc->next)
286 set_multicast_one(dev, pmc->dmi_addr);
287 set_multicast_finish(dev);
289 set_promiscuous_mode(dev);
292 static void restart(struct net_device *dev)
295 immap_t *immap = fs_enet_immap;
298 struct fs_enet_private *fep = netdev_priv(dev);
299 fec_t *fecp = fep->fec.fecp;
300 const struct fs_platform_info *fpi = fep->fpi;
301 dma_addr_t rx_bd_base_phys, tx_bd_base_phys;
305 r = whack_reset(fep->fec.fecp);
307 printk(KERN_ERR DRV_MODULE_NAME
308 ": %s FEC Reset FAILED!\n", dev->name);
311 * Set station address.
313 addrhi = ((u32) dev->dev_addr[0] << 24) |
314 ((u32) dev->dev_addr[1] << 16) |
315 ((u32) dev->dev_addr[2] << 8) |
316 (u32) dev->dev_addr[3];
317 addrlo = ((u32) dev->dev_addr[4] << 24) |
318 ((u32) dev->dev_addr[5] << 16);
319 FW(fecp, addr_low, addrhi);
320 FW(fecp, addr_high, addrlo);
323 * Reset all multicast.
325 FW(fecp, hash_table_high, fep->fec.hthi);
326 FW(fecp, hash_table_low, fep->fec.htlo);
329 * Set maximum receive buffer size.
331 FW(fecp, r_buff_size, PKT_MAXBLR_SIZE);
332 FW(fecp, r_hash, PKT_MAXBUF_SIZE);
334 /* get physical address */
335 rx_bd_base_phys = fep->ring_mem_addr;
336 tx_bd_base_phys = rx_bd_base_phys + sizeof(cbd_t) * fpi->rx_ring;
339 * Set receive and transmit descriptor base.
341 FW(fecp, r_des_start, rx_bd_base_phys);
342 FW(fecp, x_des_start, tx_bd_base_phys);
347 * Enable big endian and don't care about SDMA FC.
349 FW(fecp, fun_code, 0x78000000);
354 FW(fecp, mii_speed, fep->mii_bus->fec.mii_speed);
357 * Clear any outstanding interrupt.
359 FW(fecp, ievent, 0xffc0);
360 FW(fecp, ivec, (fep->interrupt / 2) << 29);
364 * adjust to speed (only for DUET & RMII)
368 cptr = in_be32(&immap->im_cpm.cp_cptr);
369 switch (fs_get_fec_index(fpi->fs_no)) {
372 if (fep->speed == 10)
374 else if (fep->speed == 100)
379 if (fep->speed == 10)
381 else if (fep->speed == 100)
385 BUG(); /* should never happen */
388 out_be32(&immap->im_cpm.cp_cptr, cptr);
392 FW(fecp, r_cntrl, FEC_RCNTRL_MII_MODE); /* MII enable */
394 * adjust to duplex mode
397 FC(fecp, r_cntrl, FEC_RCNTRL_DRT);
398 FS(fecp, x_cntrl, FEC_TCNTRL_FDEN); /* FD enable */
400 FS(fecp, r_cntrl, FEC_RCNTRL_DRT);
401 FC(fecp, x_cntrl, FEC_TCNTRL_FDEN); /* FD disable */
405 * Enable interrupts we wish to service.
407 FW(fecp, imask, FEC_ENET_TXF | FEC_ENET_TXB |
408 FEC_ENET_RXF | FEC_ENET_RXB);
411 * And last, enable the transmit and receive processing.
413 FW(fecp, ecntrl, FEC_ECNTRL_PINMUX | FEC_ECNTRL_ETHER_EN);
414 FW(fecp, r_des_active, 0x01000000);
417 static void stop(struct net_device *dev)
419 struct fs_enet_private *fep = netdev_priv(dev);
420 fec_t *fecp = fep->fec.fecp;
421 struct fs_enet_mii_bus *bus = fep->mii_bus;
422 const struct fs_mii_bus_info *bi = bus->bus_info;
425 if ((FR(fecp, ecntrl) & FEC_ECNTRL_ETHER_EN) == 0)
426 return; /* already down */
428 FW(fecp, x_cntrl, 0x01); /* Graceful transmit stop */
429 for (i = 0; ((FR(fecp, ievent) & 0x10000000) == 0) &&
430 i < FEC_RESET_DELAY; i++)
433 if (i == FEC_RESET_DELAY)
434 printk(KERN_WARNING DRV_MODULE_NAME
435 ": %s FEC timeout on graceful transmit stop\n",
438 * Disable FEC. Let only MII interrupts.
441 FC(fecp, ecntrl, FEC_ECNTRL_ETHER_EN);
445 /* shut down FEC1? that's where the mii bus is */
446 if (fep->fec.idx == 0 && bus->refs > 1 && bi->method == fsmii_fec) {
447 FS(fecp, r_cntrl, FEC_RCNTRL_MII_MODE); /* MII enable */
448 FS(fecp, ecntrl, FEC_ECNTRL_PINMUX | FEC_ECNTRL_ETHER_EN);
449 FW(fecp, ievent, FEC_ENET_MII);
450 FW(fecp, mii_speed, bus->fec.mii_speed);
454 static void pre_request_irq(struct net_device *dev, int irq)
456 immap_t *immap = fs_enet_immap;
460 if (irq >= SIU_IRQ0 && irq < SIU_LEVEL7) {
462 siel = in_be32(&immap->im_siu_conf.sc_siel);
464 siel |= (0x80000000 >> irq);
466 siel &= ~(0x80000000 >> (irq & ~1));
467 out_be32(&immap->im_siu_conf.sc_siel, siel);
471 static void post_free_irq(struct net_device *dev, int irq)
476 static void napi_clear_rx_event(struct net_device *dev)
478 struct fs_enet_private *fep = netdev_priv(dev);
479 fec_t *fecp = fep->fec.fecp;
481 FW(fecp, ievent, FEC_NAPI_RX_EVENT_MSK);
484 static void napi_enable_rx(struct net_device *dev)
486 struct fs_enet_private *fep = netdev_priv(dev);
487 fec_t *fecp = fep->fec.fecp;
489 FS(fecp, imask, FEC_NAPI_RX_EVENT_MSK);
492 static void napi_disable_rx(struct net_device *dev)
494 struct fs_enet_private *fep = netdev_priv(dev);
495 fec_t *fecp = fep->fec.fecp;
497 FC(fecp, imask, FEC_NAPI_RX_EVENT_MSK);
500 static void rx_bd_done(struct net_device *dev)
502 struct fs_enet_private *fep = netdev_priv(dev);
503 fec_t *fecp = fep->fec.fecp;
505 FW(fecp, r_des_active, 0x01000000);
508 static void tx_kickstart(struct net_device *dev)
510 struct fs_enet_private *fep = netdev_priv(dev);
511 fec_t *fecp = fep->fec.fecp;
513 FW(fecp, x_des_active, 0x01000000);
516 static u32 get_int_events(struct net_device *dev)
518 struct fs_enet_private *fep = netdev_priv(dev);
519 fec_t *fecp = fep->fec.fecp;
521 return FR(fecp, ievent) & FR(fecp, imask);
524 static void clear_int_events(struct net_device *dev, u32 int_events)
526 struct fs_enet_private *fep = netdev_priv(dev);
527 fec_t *fecp = fep->fec.fecp;
529 FW(fecp, ievent, int_events);
532 static void ev_error(struct net_device *dev, u32 int_events)
534 printk(KERN_WARNING DRV_MODULE_NAME
535 ": %s FEC ERROR(s) 0x%x\n", dev->name, int_events);
538 int get_regs(struct net_device *dev, void *p, int *sizep)
540 struct fs_enet_private *fep = netdev_priv(dev);
542 if (*sizep < sizeof(fec_t))
545 memcpy_fromio(p, fep->fec.fecp, sizeof(fec_t));
550 int get_regs_len(struct net_device *dev)
552 return sizeof(fec_t);
555 void tx_restart(struct net_device *dev)
560 /*************************************************************************/
562 const struct fs_ops fs_fec_ops = {
563 .setup_data = setup_data,
564 .cleanup_data = cleanup_data,
565 .set_multicast_list = set_multicast_list,
568 .pre_request_irq = pre_request_irq,
569 .post_free_irq = post_free_irq,
570 .napi_clear_rx_event = napi_clear_rx_event,
571 .napi_enable_rx = napi_enable_rx,
572 .napi_disable_rx = napi_disable_rx,
573 .rx_bd_done = rx_bd_done,
574 .tx_kickstart = tx_kickstart,
575 .get_int_events = get_int_events,
576 .clear_int_events = clear_int_events,
577 .ev_error = ev_error,
578 .get_regs = get_regs,
579 .get_regs_len = get_regs_len,
580 .tx_restart = tx_restart,
581 .allocate_bd = allocate_bd,
585 /***********************************************************************/
587 static int mii_read(struct fs_enet_mii_bus *bus, int phy_id, int location)
589 fec_t *fecp = bus->fec.fecp;
592 if ((FR(fecp, r_cntrl) & FEC_RCNTRL_MII_MODE) == 0)
595 /* Add PHY address to register command. */
596 FW(fecp, mii_data, (phy_id << 23) | mk_mii_read(location));
598 for (i = 0; i < FEC_MII_LOOPS; i++)
599 if ((FR(fecp, ievent) & FEC_ENET_MII) != 0)
602 if (i < FEC_MII_LOOPS) {
603 FW(fecp, ievent, FEC_ENET_MII);
604 ret = FR(fecp, mii_data) & 0xffff;
610 static void mii_write(struct fs_enet_mii_bus *bus, int phy_id, int location, int value)
612 fec_t *fecp = bus->fec.fecp;
615 /* this must never happen */
616 if ((FR(fecp, r_cntrl) & FEC_RCNTRL_MII_MODE) == 0)
619 /* Add PHY address to register command. */
620 FW(fecp, mii_data, (phy_id << 23) | mk_mii_write(location, value));
622 for (i = 0; i < FEC_MII_LOOPS; i++)
623 if ((FR(fecp, ievent) & FEC_ENET_MII) != 0)
626 if (i < FEC_MII_LOOPS)
627 FW(fecp, ievent, FEC_ENET_MII);
630 int fs_mii_fec_init(struct fs_enet_mii_bus *bus)
632 bd_t *bd = (bd_t *)__res;
633 const struct fs_mii_bus_info *bi = bus->bus_info;
639 bus->fec.fecp = &((immap_t *)fs_enet_immap)->im_cpm.cp_fec;
640 bus->fec.mii_speed = ((((bd->bi_intfreq + 4999999) / 2500000) / 2)
643 fecp = bus->fec.fecp;
645 FS(fecp, r_cntrl, FEC_RCNTRL_MII_MODE); /* MII enable */
646 FS(fecp, ecntrl, FEC_ECNTRL_PINMUX | FEC_ECNTRL_ETHER_EN);
647 FW(fecp, ievent, FEC_ENET_MII);
648 FW(fecp, mii_speed, bus->fec.mii_speed);
650 bus->mii_read = mii_read;
651 bus->mii_write = mii_write;