2 * ks8842.c timberdale KS8842 ethernet driver
3 * Copyright (c) 2009 Intel Corporation
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * The Micrel KS8842 behind the timberdale FPGA
23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/platform_device.h>
28 #include <linux/netdevice.h>
29 #include <linux/etherdevice.h>
30 #include <linux/ethtool.h>
31 #include <linux/ks8842.h>
33 #define DRV_NAME "ks8842"
35 /* Timberdale specific Registers */
36 #define REG_TIMB_RST 0x1c
38 /* KS8842 registers */
40 #define REG_SELECT_BANK 0x0e
42 /* bank 0 registers */
43 #define REG_QRFCR 0x04
45 /* bank 2 registers */
50 /* bank 3 registers */
53 /* bank 16 registers */
57 #define REG_TXMIR 0x08
58 #define REG_RXMIR 0x0A
60 /* bank 17 registers */
61 #define REG_TXQCR 0x00
62 #define REG_RXQCR 0x02
63 #define REG_TXFDPR 0x04
64 #define REG_RXFDPR 0x06
65 #define REG_QMU_DATA_LO 0x08
66 #define REG_QMU_DATA_HI 0x0A
68 /* bank 18 registers */
70 #define IRQ_LINK_CHANGE 0x8000
73 #define IRQ_RX_OVERRUN 0x0800
74 #define IRQ_TX_STOPPED 0x0200
75 #define IRQ_RX_STOPPED 0x0100
76 #define IRQ_RX_ERROR 0x0080
77 #define ENABLED_IRQS (IRQ_LINK_CHANGE | IRQ_TX | IRQ_RX | IRQ_RX_STOPPED | \
78 IRQ_TX_STOPPED | IRQ_RX_OVERRUN | IRQ_RX_ERROR)
81 #define RXSR_VALID 0x8000
82 #define RXSR_BROADCAST 0x80
83 #define RXSR_MULTICAST 0x40
84 #define RXSR_UNICAST 0x20
85 #define RXSR_FRAMETYPE 0x08
86 #define RXSR_TOO_LONG 0x04
87 #define RXSR_RUNT 0x02
88 #define RXSR_CRC_ERROR 0x01
89 #define RXSR_ERROR (RXSR_TOO_LONG | RXSR_RUNT | RXSR_CRC_ERROR)
91 /* bank 32 registers */
92 #define REG_SW_ID_AND_ENABLE 0x00
93 #define REG_SGCR1 0x02
94 #define REG_SGCR2 0x04
95 #define REG_SGCR3 0x06
97 /* bank 39 registers */
98 #define REG_MACAR1 0x00
99 #define REG_MACAR2 0x02
100 #define REG_MACAR3 0x04
102 /* bank 45 registers */
103 #define REG_P1MBCR 0x00
104 #define REG_P1MBSR 0x02
106 /* bank 46 registers */
107 #define REG_P2MBCR 0x00
108 #define REG_P2MBSR 0x02
110 /* bank 48 registers */
111 #define REG_P1CR2 0x02
113 /* bank 49 registers */
114 #define REG_P1CR4 0x02
115 #define REG_P1SR 0x04
117 struct ks8842_adapter {
118 void __iomem *hw_addr;
120 struct tasklet_struct tasklet;
121 spinlock_t lock; /* spinlock to be interrupt safe */
122 struct work_struct timeout_work;
123 struct net_device *netdev;
126 static inline void ks8842_select_bank(struct ks8842_adapter *adapter, u16 bank)
128 iowrite16(bank, adapter->hw_addr + REG_SELECT_BANK);
131 static inline void ks8842_write8(struct ks8842_adapter *adapter, u16 bank,
132 u8 value, int offset)
134 ks8842_select_bank(adapter, bank);
135 iowrite8(value, adapter->hw_addr + offset);
138 static inline void ks8842_write16(struct ks8842_adapter *adapter, u16 bank,
139 u16 value, int offset)
141 ks8842_select_bank(adapter, bank);
142 iowrite16(value, adapter->hw_addr + offset);
145 static inline void ks8842_enable_bits(struct ks8842_adapter *adapter, u16 bank,
146 u16 bits, int offset)
149 ks8842_select_bank(adapter, bank);
150 reg = ioread16(adapter->hw_addr + offset);
152 iowrite16(reg, adapter->hw_addr + offset);
155 static inline void ks8842_clear_bits(struct ks8842_adapter *adapter, u16 bank,
156 u16 bits, int offset)
159 ks8842_select_bank(adapter, bank);
160 reg = ioread16(adapter->hw_addr + offset);
162 iowrite16(reg, adapter->hw_addr + offset);
165 static inline void ks8842_write32(struct ks8842_adapter *adapter, u16 bank,
166 u32 value, int offset)
168 ks8842_select_bank(adapter, bank);
169 iowrite32(value, adapter->hw_addr + offset);
172 static inline u8 ks8842_read8(struct ks8842_adapter *adapter, u16 bank,
175 ks8842_select_bank(adapter, bank);
176 return ioread8(adapter->hw_addr + offset);
179 static inline u16 ks8842_read16(struct ks8842_adapter *adapter, u16 bank,
182 ks8842_select_bank(adapter, bank);
183 return ioread16(adapter->hw_addr + offset);
186 static inline u32 ks8842_read32(struct ks8842_adapter *adapter, u16 bank,
189 ks8842_select_bank(adapter, bank);
190 return ioread32(adapter->hw_addr + offset);
193 static void ks8842_reset(struct ks8842_adapter *adapter)
195 /* The KS8842 goes haywire when doing softare reset
196 * a work around in the timberdale IP is implemented to
197 * do a hardware reset instead
198 ks8842_write16(adapter, 3, 1, REG_GRR);
200 iowrite16(0, adapter->hw_addr + REG_GRR);
202 iowrite32(0x1, adapter->hw_addr + REG_TIMB_RST);
206 static void ks8842_update_link_status(struct net_device *netdev,
207 struct ks8842_adapter *adapter)
209 /* check the status of the link */
210 if (ks8842_read16(adapter, 45, REG_P1MBSR) & 0x4) {
211 netif_carrier_on(netdev);
212 netif_wake_queue(netdev);
214 netif_stop_queue(netdev);
215 netif_carrier_off(netdev);
219 static void ks8842_enable_tx(struct ks8842_adapter *adapter)
221 ks8842_enable_bits(adapter, 16, 0x01, REG_TXCR);
224 static void ks8842_disable_tx(struct ks8842_adapter *adapter)
226 ks8842_clear_bits(adapter, 16, 0x01, REG_TXCR);
229 static void ks8842_enable_rx(struct ks8842_adapter *adapter)
231 ks8842_enable_bits(adapter, 16, 0x01, REG_RXCR);
234 static void ks8842_disable_rx(struct ks8842_adapter *adapter)
236 ks8842_clear_bits(adapter, 16, 0x01, REG_RXCR);
239 static void ks8842_reset_hw(struct ks8842_adapter *adapter)
242 ks8842_reset(adapter);
244 /* Enable QMU Transmit flow control / transmit padding / Transmit CRC */
245 ks8842_write16(adapter, 16, 0x000E, REG_TXCR);
247 /* enable the receiver, uni + multi + broadcast + flow ctrl
249 ks8842_write16(adapter, 16, 0x8 | 0x20 | 0x40 | 0x80 | 0x400,
252 /* TX frame pointer autoincrement */
253 ks8842_write16(adapter, 17, 0x4000, REG_TXFDPR);
255 /* RX frame pointer autoincrement */
256 ks8842_write16(adapter, 17, 0x4000, REG_RXFDPR);
258 /* RX 2 kb high watermark */
259 ks8842_write16(adapter, 0, 0x1000, REG_QRFCR);
261 /* aggresive back off in half duplex */
262 ks8842_enable_bits(adapter, 32, 1 << 8, REG_SGCR1);
264 /* enable no excessive collison drop */
265 ks8842_enable_bits(adapter, 32, 1 << 3, REG_SGCR2);
267 /* Enable port 1 force flow control / back pressure / transmit / recv */
268 ks8842_write16(adapter, 48, 0x1E07, REG_P1CR2);
270 /* restart port auto-negotiation */
271 ks8842_enable_bits(adapter, 49, 1 << 13, REG_P1CR4);
272 /* only advertise 10Mbps */
273 ks8842_clear_bits(adapter, 49, 3 << 2, REG_P1CR4);
275 /* Enable the transmitter */
276 ks8842_enable_tx(adapter);
278 /* Enable the receiver */
279 ks8842_enable_rx(adapter);
281 /* clear all interrupts */
282 ks8842_write16(adapter, 18, 0xffff, REG_ISR);
284 /* enable interrupts */
285 ks8842_write16(adapter, 18, ENABLED_IRQS, REG_IER);
287 /* enable the switch */
288 ks8842_write16(adapter, 32, 0x1, REG_SW_ID_AND_ENABLE);
291 static void ks8842_read_mac_addr(struct ks8842_adapter *adapter, u8 *dest)
296 for (i = 0; i < ETH_ALEN; i++)
297 dest[ETH_ALEN - i - 1] = ks8842_read8(adapter, 2, REG_MARL + i);
299 /* make sure the switch port uses the same MAC as the QMU */
300 mac = ks8842_read16(adapter, 2, REG_MARL);
301 ks8842_write16(adapter, 39, mac, REG_MACAR1);
302 mac = ks8842_read16(adapter, 2, REG_MARM);
303 ks8842_write16(adapter, 39, mac, REG_MACAR2);
304 mac = ks8842_read16(adapter, 2, REG_MARH);
305 ks8842_write16(adapter, 39, mac, REG_MACAR3);
308 static void ks8842_write_mac_addr(struct ks8842_adapter *adapter, u8 *mac)
313 spin_lock_irqsave(&adapter->lock, flags);
314 for (i = 0; i < ETH_ALEN; i++) {
315 ks8842_write8(adapter, 2, mac[ETH_ALEN - i - 1], REG_MARL + i);
316 ks8842_write8(adapter, 39, mac[ETH_ALEN - i - 1],
319 spin_unlock_irqrestore(&adapter->lock, flags);
322 static inline u16 ks8842_tx_fifo_space(struct ks8842_adapter *adapter)
324 return ks8842_read16(adapter, 16, REG_TXMIR) & 0x1fff;
327 static int ks8842_tx_frame(struct sk_buff *skb, struct net_device *netdev)
329 struct ks8842_adapter *adapter = netdev_priv(netdev);
331 u32 *ptr = (u32 *)skb->data;
334 netdev_dbg(netdev, "%s: len %u head %p data %p tail %p end %p\n",
335 __func__, skb->len, skb->head, skb->data,
336 skb_tail_pointer(skb), skb_end_pointer(skb));
338 /* check FIFO buffer space, we need space for CRC and command bits */
339 if (ks8842_tx_fifo_space(adapter) < len + 8)
340 return NETDEV_TX_BUSY;
342 /* the control word, enable IRQ, port 1 and the length */
343 ctrl = 0x8000 | 0x100 | (len << 16);
344 ks8842_write32(adapter, 17, ctrl, REG_QMU_DATA_LO);
346 netdev->stats.tx_bytes += len;
350 iowrite32(*ptr, adapter->hw_addr + REG_QMU_DATA_LO);
356 ks8842_write16(adapter, 17, 1, REG_TXQCR);
363 static void ks8842_rx_frame(struct net_device *netdev,
364 struct ks8842_adapter *adapter)
366 u32 status = ks8842_read32(adapter, 17, REG_QMU_DATA_LO);
367 int len = (status >> 16) & 0x7ff;
371 netdev_dbg(netdev, "%s - rx_data: status: %x\n", __func__, status);
373 /* check the status */
374 if ((status & RXSR_VALID) && !(status & RXSR_ERROR)) {
375 struct sk_buff *skb = netdev_alloc_skb_ip_align(netdev, len);
377 netdev_dbg(netdev, "%s, got package, len: %d\n", __func__, len);
381 netdev->stats.rx_packets++;
382 netdev->stats.rx_bytes += len;
383 if (status & RXSR_MULTICAST)
384 netdev->stats.multicast++;
386 data = (u32 *)skb_put(skb, len);
388 ks8842_select_bank(adapter, 17);
390 *data++ = ioread32(adapter->hw_addr +
395 skb->protocol = eth_type_trans(skb, netdev);
398 netdev->stats.rx_dropped++;
400 netdev_dbg(netdev, "RX error, status: %x\n", status);
401 netdev->stats.rx_errors++;
402 if (status & RXSR_TOO_LONG)
403 netdev->stats.rx_length_errors++;
404 if (status & RXSR_CRC_ERROR)
405 netdev->stats.rx_crc_errors++;
406 if (status & RXSR_RUNT)
407 netdev->stats.rx_frame_errors++;
410 /* set high watermark to 3K */
411 ks8842_clear_bits(adapter, 0, 1 << 12, REG_QRFCR);
413 /* release the frame */
414 ks8842_write16(adapter, 17, 0x01, REG_RXQCR);
416 /* set high watermark to 2K */
417 ks8842_enable_bits(adapter, 0, 1 << 12, REG_QRFCR);
420 void ks8842_handle_rx(struct net_device *netdev, struct ks8842_adapter *adapter)
422 u16 rx_data = ks8842_read16(adapter, 16, REG_RXMIR) & 0x1fff;
423 netdev_dbg(netdev, "%s Entry - rx_data: %d\n", __func__, rx_data);
425 ks8842_rx_frame(netdev, adapter);
426 rx_data = ks8842_read16(adapter, 16, REG_RXMIR) & 0x1fff;
430 void ks8842_handle_tx(struct net_device *netdev, struct ks8842_adapter *adapter)
432 u16 sr = ks8842_read16(adapter, 16, REG_TXSR);
433 netdev_dbg(netdev, "%s - entry, sr: %x\n", __func__, sr);
434 netdev->stats.tx_packets++;
435 if (netif_queue_stopped(netdev))
436 netif_wake_queue(netdev);
439 void ks8842_handle_rx_overrun(struct net_device *netdev,
440 struct ks8842_adapter *adapter)
442 netdev_dbg(netdev, "%s: entry\n", __func__);
443 netdev->stats.rx_errors++;
444 netdev->stats.rx_fifo_errors++;
447 void ks8842_tasklet(unsigned long arg)
449 struct net_device *netdev = (struct net_device *)arg;
450 struct ks8842_adapter *adapter = netdev_priv(netdev);
455 /* read current bank to be able to set it back */
456 spin_lock_irqsave(&adapter->lock, flags);
457 entry_bank = ioread16(adapter->hw_addr + REG_SELECT_BANK);
458 spin_unlock_irqrestore(&adapter->lock, flags);
460 isr = ks8842_read16(adapter, 18, REG_ISR);
461 netdev_dbg(netdev, "%s - ISR: 0x%x\n", __func__, isr);
464 ks8842_write16(adapter, 18, isr, REG_ISR);
466 if (!netif_running(netdev))
469 if (isr & IRQ_LINK_CHANGE)
470 ks8842_update_link_status(netdev, adapter);
472 if (isr & (IRQ_RX | IRQ_RX_ERROR))
473 ks8842_handle_rx(netdev, adapter);
476 ks8842_handle_tx(netdev, adapter);
478 if (isr & IRQ_RX_OVERRUN)
479 ks8842_handle_rx_overrun(netdev, adapter);
481 if (isr & IRQ_TX_STOPPED) {
482 ks8842_disable_tx(adapter);
483 ks8842_enable_tx(adapter);
486 if (isr & IRQ_RX_STOPPED) {
487 ks8842_disable_rx(adapter);
488 ks8842_enable_rx(adapter);
491 /* re-enable interrupts, put back the bank selection register */
492 spin_lock_irqsave(&adapter->lock, flags);
493 ks8842_write16(adapter, 18, ENABLED_IRQS, REG_IER);
494 iowrite16(entry_bank, adapter->hw_addr + REG_SELECT_BANK);
495 spin_unlock_irqrestore(&adapter->lock, flags);
498 static irqreturn_t ks8842_irq(int irq, void *devid)
500 struct net_device *netdev = devid;
501 struct ks8842_adapter *adapter = netdev_priv(netdev);
503 u16 entry_bank = ioread16(adapter->hw_addr + REG_SELECT_BANK);
504 irqreturn_t ret = IRQ_NONE;
506 isr = ks8842_read16(adapter, 18, REG_ISR);
507 netdev_dbg(netdev, "%s - ISR: 0x%x\n", __func__, isr);
511 ks8842_write16(adapter, 18, 0x00, REG_IER);
513 /* schedule tasklet */
514 tasklet_schedule(&adapter->tasklet);
519 iowrite16(entry_bank, adapter->hw_addr + REG_SELECT_BANK);
525 /* Netdevice operations */
527 static int ks8842_open(struct net_device *netdev)
529 struct ks8842_adapter *adapter = netdev_priv(netdev);
532 netdev_dbg(netdev, "%s - entry\n", __func__);
535 ks8842_reset_hw(adapter);
537 ks8842_write_mac_addr(adapter, netdev->dev_addr);
539 ks8842_update_link_status(netdev, adapter);
541 err = request_irq(adapter->irq, ks8842_irq, IRQF_SHARED, DRV_NAME,
544 pr_err("Failed to request IRQ: %d: %d\n", adapter->irq, err);
551 static int ks8842_close(struct net_device *netdev)
553 struct ks8842_adapter *adapter = netdev_priv(netdev);
555 netdev_dbg(netdev, "%s - entry\n", __func__);
557 cancel_work_sync(&adapter->timeout_work);
560 free_irq(adapter->irq, netdev);
562 /* disable the switch */
563 ks8842_write16(adapter, 32, 0x0, REG_SW_ID_AND_ENABLE);
568 static netdev_tx_t ks8842_xmit_frame(struct sk_buff *skb,
569 struct net_device *netdev)
572 struct ks8842_adapter *adapter = netdev_priv(netdev);
574 netdev_dbg(netdev, "%s: entry\n", __func__);
576 ret = ks8842_tx_frame(skb, netdev);
578 if (ks8842_tx_fifo_space(adapter) < netdev->mtu + 8)
579 netif_stop_queue(netdev);
584 static int ks8842_set_mac(struct net_device *netdev, void *p)
586 struct ks8842_adapter *adapter = netdev_priv(netdev);
587 struct sockaddr *addr = p;
588 char *mac = (u8 *)addr->sa_data;
590 netdev_dbg(netdev, "%s: entry\n", __func__);
592 if (!is_valid_ether_addr(addr->sa_data))
593 return -EADDRNOTAVAIL;
595 memcpy(netdev->dev_addr, mac, netdev->addr_len);
597 ks8842_write_mac_addr(adapter, mac);
601 static void ks8842_tx_timeout_work(struct work_struct *work)
603 struct ks8842_adapter *adapter =
604 container_of(work, struct ks8842_adapter, timeout_work);
605 struct net_device *netdev = adapter->netdev;
608 netdev_dbg(netdev, "%s: entry\n", __func__);
610 spin_lock_irqsave(&adapter->lock, flags);
611 /* disable interrupts */
612 ks8842_write16(adapter, 18, 0, REG_IER);
613 ks8842_write16(adapter, 18, 0xFFFF, REG_ISR);
615 netif_stop_queue(netdev);
617 spin_unlock_irqrestore(&adapter->lock, flags);
619 ks8842_reset_hw(adapter);
621 ks8842_write_mac_addr(adapter, netdev->dev_addr);
623 ks8842_update_link_status(netdev, adapter);
626 static void ks8842_tx_timeout(struct net_device *netdev)
628 struct ks8842_adapter *adapter = netdev_priv(netdev);
630 netdev_dbg(netdev, "%s: entry\n", __func__);
632 schedule_work(&adapter->timeout_work);
635 static const struct net_device_ops ks8842_netdev_ops = {
636 .ndo_open = ks8842_open,
637 .ndo_stop = ks8842_close,
638 .ndo_start_xmit = ks8842_xmit_frame,
639 .ndo_set_mac_address = ks8842_set_mac,
640 .ndo_tx_timeout = ks8842_tx_timeout,
641 .ndo_validate_addr = eth_validate_addr
644 static const struct ethtool_ops ks8842_ethtool_ops = {
645 .get_link = ethtool_op_get_link,
648 static int __devinit ks8842_probe(struct platform_device *pdev)
651 struct resource *iomem;
652 struct net_device *netdev;
653 struct ks8842_adapter *adapter;
654 struct ks8842_platform_data *pdata = pdev->dev.platform_data;
658 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
659 if (!request_mem_region(iomem->start, resource_size(iomem), DRV_NAME))
662 netdev = alloc_etherdev(sizeof(struct ks8842_adapter));
664 goto err_alloc_etherdev;
666 SET_NETDEV_DEV(netdev, &pdev->dev);
668 adapter = netdev_priv(netdev);
669 adapter->netdev = netdev;
670 INIT_WORK(&adapter->timeout_work, ks8842_tx_timeout_work);
671 adapter->hw_addr = ioremap(iomem->start, resource_size(iomem));
672 if (!adapter->hw_addr)
675 adapter->irq = platform_get_irq(pdev, 0);
676 if (adapter->irq < 0) {
681 tasklet_init(&adapter->tasklet, ks8842_tasklet, (unsigned long)netdev);
682 spin_lock_init(&adapter->lock);
684 netdev->netdev_ops = &ks8842_netdev_ops;
685 netdev->ethtool_ops = &ks8842_ethtool_ops;
687 /* Check if a mac address was given */
688 i = netdev->addr_len;
690 for (i = 0; i < netdev->addr_len; i++)
691 if (pdata->macaddr[i] != 0)
694 if (i < netdev->addr_len)
695 /* an address was passed, use it */
696 memcpy(netdev->dev_addr, pdata->macaddr,
700 if (i == netdev->addr_len) {
701 ks8842_read_mac_addr(adapter, netdev->dev_addr);
703 if (!is_valid_ether_addr(netdev->dev_addr))
704 random_ether_addr(netdev->dev_addr);
707 id = ks8842_read16(adapter, 32, REG_SW_ID_AND_ENABLE);
709 strcpy(netdev->name, "eth%d");
710 err = register_netdev(netdev);
714 platform_set_drvdata(pdev, netdev);
716 pr_info("Found chip, family: 0x%x, id: 0x%x, rev: 0x%x\n",
717 (id >> 8) & 0xff, (id >> 4) & 0xf, (id >> 1) & 0x7);
723 iounmap(adapter->hw_addr);
727 release_mem_region(iomem->start, resource_size(iomem));
732 static int __devexit ks8842_remove(struct platform_device *pdev)
734 struct net_device *netdev = platform_get_drvdata(pdev);
735 struct ks8842_adapter *adapter = netdev_priv(netdev);
736 struct resource *iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
738 unregister_netdev(netdev);
739 tasklet_kill(&adapter->tasklet);
740 iounmap(adapter->hw_addr);
742 release_mem_region(iomem->start, resource_size(iomem));
743 platform_set_drvdata(pdev, NULL);
748 static struct platform_driver ks8842_platform_driver = {
751 .owner = THIS_MODULE,
753 .probe = ks8842_probe,
754 .remove = ks8842_remove,
757 static int __init ks8842_init(void)
759 return platform_driver_register(&ks8842_platform_driver);
762 static void __exit ks8842_exit(void)
764 platform_driver_unregister(&ks8842_platform_driver);
767 module_init(ks8842_init);
768 module_exit(ks8842_exit);
770 MODULE_DESCRIPTION("Timberdale KS8842 ethernet driver");
771 MODULE_AUTHOR("Mocean Laboratories <info@mocean-labs.com>");
772 MODULE_LICENSE("GPL v2");
773 MODULE_ALIAS("platform:ks8842");