2 * ks8842_main.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>
32 #define DRV_NAME "ks8842"
34 /* Timberdale specific Registers */
35 #define REG_TIMB_RST 0x1c
37 /* KS8842 registers */
39 #define REG_SELECT_BANK 0x0e
41 /* bank 0 registers */
42 #define REG_QRFCR 0x04
44 /* bank 2 registers */
49 /* bank 3 registers */
52 /* bank 16 registers */
56 #define REG_TXMIR 0x08
57 #define REG_RXMIR 0x0A
59 /* bank 17 registers */
60 #define REG_TXQCR 0x00
61 #define REG_RXQCR 0x02
62 #define REG_TXFDPR 0x04
63 #define REG_RXFDPR 0x06
64 #define REG_QMU_DATA_LO 0x08
65 #define REG_QMU_DATA_HI 0x0A
67 /* bank 18 registers */
69 #define IRQ_LINK_CHANGE 0x8000
72 #define IRQ_RX_OVERRUN 0x0800
73 #define IRQ_TX_STOPPED 0x0200
74 #define IRQ_RX_STOPPED 0x0100
75 #define IRQ_RX_ERROR 0x0080
76 #define ENABLED_IRQS (IRQ_LINK_CHANGE | IRQ_TX | IRQ_RX | IRQ_RX_STOPPED | \
77 IRQ_TX_STOPPED | IRQ_RX_OVERRUN | IRQ_RX_ERROR)
80 #define RXSR_VALID 0x8000
81 #define RXSR_BROADCAST 0x80
82 #define RXSR_MULTICAST 0x40
83 #define RXSR_UNICAST 0x20
84 #define RXSR_FRAMETYPE 0x08
85 #define RXSR_TOO_LONG 0x04
86 #define RXSR_RUNT 0x02
87 #define RXSR_CRC_ERROR 0x01
88 #define RXSR_ERROR (RXSR_TOO_LONG | RXSR_RUNT | RXSR_CRC_ERROR)
90 /* bank 32 registers */
91 #define REG_SW_ID_AND_ENABLE 0x00
92 #define REG_SGCR1 0x02
93 #define REG_SGCR2 0x04
94 #define REG_SGCR3 0x06
96 /* bank 39 registers */
97 #define REG_MACAR1 0x00
98 #define REG_MACAR2 0x02
99 #define REG_MACAR3 0x04
101 /* bank 45 registers */
102 #define REG_P1MBCR 0x00
103 #define REG_P1MBSR 0x02
105 /* bank 46 registers */
106 #define REG_P2MBCR 0x00
107 #define REG_P2MBSR 0x02
109 /* bank 48 registers */
110 #define REG_P1CR2 0x02
112 /* bank 49 registers */
113 #define REG_P1CR4 0x02
114 #define REG_P1SR 0x04
116 struct ks8842_adapter {
117 void __iomem *hw_addr;
119 struct tasklet_struct tasklet;
120 spinlock_t lock; /* spinlock to be interrupt safe */
121 struct platform_device *pdev;
124 static inline void ks8842_select_bank(struct ks8842_adapter *adapter, u16 bank)
126 iowrite16(bank, adapter->hw_addr + REG_SELECT_BANK);
129 static inline void ks8842_write8(struct ks8842_adapter *adapter, u16 bank,
130 u8 value, int offset)
132 ks8842_select_bank(adapter, bank);
133 iowrite8(value, adapter->hw_addr + offset);
136 static inline void ks8842_write16(struct ks8842_adapter *adapter, u16 bank,
137 u16 value, int offset)
139 ks8842_select_bank(adapter, bank);
140 iowrite16(value, adapter->hw_addr + offset);
143 static inline void ks8842_enable_bits(struct ks8842_adapter *adapter, u16 bank,
144 u16 bits, int offset)
147 ks8842_select_bank(adapter, bank);
148 reg = ioread16(adapter->hw_addr + offset);
150 iowrite16(reg, adapter->hw_addr + offset);
153 static inline void ks8842_clear_bits(struct ks8842_adapter *adapter, u16 bank,
154 u16 bits, int offset)
157 ks8842_select_bank(adapter, bank);
158 reg = ioread16(adapter->hw_addr + offset);
160 iowrite16(reg, adapter->hw_addr + offset);
163 static inline void ks8842_write32(struct ks8842_adapter *adapter, u16 bank,
164 u32 value, int offset)
166 ks8842_select_bank(adapter, bank);
167 iowrite32(value, adapter->hw_addr + offset);
170 static inline u8 ks8842_read8(struct ks8842_adapter *adapter, u16 bank,
173 ks8842_select_bank(adapter, bank);
174 return ioread8(adapter->hw_addr + offset);
177 static inline u16 ks8842_read16(struct ks8842_adapter *adapter, u16 bank,
180 ks8842_select_bank(adapter, bank);
181 return ioread16(adapter->hw_addr + offset);
184 static inline u32 ks8842_read32(struct ks8842_adapter *adapter, u16 bank,
187 ks8842_select_bank(adapter, bank);
188 return ioread32(adapter->hw_addr + offset);
191 static void ks8842_reset(struct ks8842_adapter *adapter)
193 /* The KS8842 goes haywire when doing softare reset
194 * a work around in the timberdale IP is implemented to
195 * do a hardware reset instead
196 ks8842_write16(adapter, 3, 1, REG_GRR);
198 iowrite16(0, adapter->hw_addr + REG_GRR);
200 iowrite16(32, adapter->hw_addr + REG_SELECT_BANK);
201 iowrite32(0x1, adapter->hw_addr + REG_TIMB_RST);
205 static void ks8842_update_link_status(struct net_device *netdev,
206 struct ks8842_adapter *adapter)
208 /* check the status of the link */
209 if (ks8842_read16(adapter, 45, REG_P1MBSR) & 0x4) {
210 netif_carrier_on(netdev);
211 netif_wake_queue(netdev);
213 netif_stop_queue(netdev);
214 netif_carrier_off(netdev);
218 static void ks8842_enable_tx(struct ks8842_adapter *adapter)
220 ks8842_enable_bits(adapter, 16, 0x01, REG_TXCR);
223 static void ks8842_disable_tx(struct ks8842_adapter *adapter)
225 ks8842_clear_bits(adapter, 16, 0x01, REG_TXCR);
228 static void ks8842_enable_rx(struct ks8842_adapter *adapter)
230 ks8842_enable_bits(adapter, 16, 0x01, REG_RXCR);
233 static void ks8842_disable_rx(struct ks8842_adapter *adapter)
235 ks8842_clear_bits(adapter, 16, 0x01, REG_RXCR);
238 static void ks8842_reset_hw(struct ks8842_adapter *adapter)
241 ks8842_reset(adapter);
243 /* Enable QMU Transmit flow control / transmit padding / Transmit CRC */
244 ks8842_write16(adapter, 16, 0x000E, REG_TXCR);
246 /* enable the receiver, uni + multi + broadcast + flow ctrl
248 ks8842_write16(adapter, 16, 0x8 | 0x20 | 0x40 | 0x80 | 0x400,
251 /* TX frame pointer autoincrement */
252 ks8842_write16(adapter, 17, 0x4000, REG_TXFDPR);
254 /* RX frame pointer autoincrement */
255 ks8842_write16(adapter, 17, 0x4000, REG_RXFDPR);
257 /* RX 2 kb high watermark */
258 ks8842_write16(adapter, 0, 0x1000, REG_QRFCR);
260 /* aggresive back off in half duplex */
261 ks8842_enable_bits(adapter, 32, 1 << 8, REG_SGCR1);
263 /* enable no excessive collison drop */
264 ks8842_enable_bits(adapter, 32, 1 << 3, REG_SGCR2);
266 /* Enable port 1 force flow control / back pressure / transmit / recv */
267 ks8842_write16(adapter, 48, 0x1E07, REG_P1CR2);
269 /* restart port auto-negotiation */
270 ks8842_enable_bits(adapter, 49, 1 << 13, REG_P1CR4);
271 /* only advertise 10Mbps */
272 ks8842_clear_bits(adapter, 49, 3 << 2, REG_P1CR4);
274 /* Enable the transmitter */
275 ks8842_enable_tx(adapter);
277 /* Enable the receiver */
278 ks8842_enable_rx(adapter);
280 /* clear all interrupts */
281 ks8842_write16(adapter, 18, 0xffff, REG_ISR);
283 /* enable interrupts */
284 ks8842_write16(adapter, 18, ENABLED_IRQS, REG_IER);
286 /* enable the switch */
287 ks8842_write16(adapter, 32, 0x1, REG_SW_ID_AND_ENABLE);
290 static void ks8842_read_mac_addr(struct ks8842_adapter *adapter, u8 *dest)
295 for (i = 0; i < ETH_ALEN; i++)
296 dest[ETH_ALEN - i - 1] = ks8842_read8(adapter, 2, REG_MARL + i);
298 /* make sure the switch port uses the same MAC as the QMU */
299 mac = ks8842_read16(adapter, 2, REG_MARL);
300 ks8842_write16(adapter, 39, mac, REG_MACAR1);
301 mac = ks8842_read16(adapter, 2, REG_MARM);
302 ks8842_write16(adapter, 39, mac, REG_MACAR2);
303 mac = ks8842_read16(adapter, 2, REG_MARH);
304 ks8842_write16(adapter, 39, mac, REG_MACAR3);
307 static inline u16 ks8842_tx_fifo_space(struct ks8842_adapter *adapter)
309 return ks8842_read16(adapter, 16, REG_TXMIR) & 0x1fff;
312 static int ks8842_tx_frame(struct sk_buff *skb, struct net_device *netdev)
314 struct ks8842_adapter *adapter = netdev_priv(netdev);
316 u32 *ptr = (u32 *)skb->data;
319 dev_dbg(&adapter->pdev->dev,
320 "%s: len %u head %p data %p tail %p end %p\n",
321 __func__, skb->len, skb->head, skb->data,
322 skb_tail_pointer(skb), skb_end_pointer(skb));
324 /* check FIFO buffer space, we need space for CRC and command bits */
325 if (ks8842_tx_fifo_space(adapter) < len + 8)
326 return NETDEV_TX_BUSY;
328 /* the control word, enable IRQ, port 1 and the length */
329 ctrl = 0x8000 | 0x100 | (len << 16);
330 ks8842_write32(adapter, 17, ctrl, REG_QMU_DATA_LO);
332 netdev->stats.tx_bytes += len;
336 iowrite32(*ptr, adapter->hw_addr + REG_QMU_DATA_LO);
342 ks8842_write16(adapter, 17, 1, REG_TXQCR);
349 static void ks8842_rx_frame(struct net_device *netdev,
350 struct ks8842_adapter *adapter)
352 u32 status = ks8842_read32(adapter, 17, REG_QMU_DATA_LO);
353 int len = (status >> 16) & 0x7ff;
357 dev_dbg(&adapter->pdev->dev, "%s - rx_data: status: %x\n",
360 /* check the status */
361 if ((status & RXSR_VALID) && !(status & RXSR_ERROR)) {
362 struct sk_buff *skb = netdev_alloc_skb_ip_align(netdev, len);
364 dev_dbg(&adapter->pdev->dev, "%s, got package, len: %d\n",
369 netdev->stats.rx_packets++;
370 netdev->stats.rx_bytes += len;
371 if (status & RXSR_MULTICAST)
372 netdev->stats.multicast++;
374 data = (u32 *)skb_put(skb, len);
376 ks8842_select_bank(adapter, 17);
378 *data++ = ioread32(adapter->hw_addr +
383 skb->protocol = eth_type_trans(skb, netdev);
386 netdev->stats.rx_dropped++;
388 dev_dbg(&adapter->pdev->dev, "RX error, status: %x\n", status);
389 netdev->stats.rx_errors++;
390 if (status & RXSR_TOO_LONG)
391 netdev->stats.rx_length_errors++;
392 if (status & RXSR_CRC_ERROR)
393 netdev->stats.rx_crc_errors++;
394 if (status & RXSR_RUNT)
395 netdev->stats.rx_frame_errors++;
398 /* set high watermark to 3K */
399 ks8842_clear_bits(adapter, 0, 1 << 12, REG_QRFCR);
401 /* release the frame */
402 ks8842_write16(adapter, 17, 0x01, REG_RXQCR);
404 /* set high watermark to 2K */
405 ks8842_enable_bits(adapter, 0, 1 << 12, REG_QRFCR);
408 void ks8842_handle_rx(struct net_device *netdev, struct ks8842_adapter *adapter)
410 u16 rx_data = ks8842_read16(adapter, 16, REG_RXMIR) & 0x1fff;
411 dev_dbg(&adapter->pdev->dev, "%s Entry - rx_data: %d\n",
414 ks8842_rx_frame(netdev, adapter);
415 rx_data = ks8842_read16(adapter, 16, REG_RXMIR) & 0x1fff;
419 void ks8842_handle_tx(struct net_device *netdev, struct ks8842_adapter *adapter)
421 u16 sr = ks8842_read16(adapter, 16, REG_TXSR);
422 dev_dbg(&adapter->pdev->dev, "%s - entry, sr: %x\n", __func__, sr);
423 netdev->stats.tx_packets++;
424 if (netif_queue_stopped(netdev))
425 netif_wake_queue(netdev);
428 void ks8842_handle_rx_overrun(struct net_device *netdev,
429 struct ks8842_adapter *adapter)
431 dev_dbg(&adapter->pdev->dev, "%s: entry\n", __func__);
432 netdev->stats.rx_errors++;
433 netdev->stats.rx_fifo_errors++;
436 void ks8842_tasklet(unsigned long arg)
438 struct net_device *netdev = (struct net_device *)arg;
439 struct ks8842_adapter *adapter = netdev_priv(netdev);
444 /* read current bank to be able to set it back */
445 spin_lock_irqsave(&adapter->lock, flags);
446 entry_bank = ioread16(adapter->hw_addr + REG_SELECT_BANK);
447 spin_unlock_irqrestore(&adapter->lock, flags);
449 isr = ks8842_read16(adapter, 18, REG_ISR);
450 dev_dbg(&adapter->pdev->dev, "%s - ISR: 0x%x\n", __func__, isr);
453 ks8842_write16(adapter, 18, isr, REG_ISR);
455 if (!netif_running(netdev))
458 if (isr & IRQ_LINK_CHANGE)
459 ks8842_update_link_status(netdev, adapter);
461 if (isr & (IRQ_RX | IRQ_RX_ERROR))
462 ks8842_handle_rx(netdev, adapter);
465 ks8842_handle_tx(netdev, adapter);
467 if (isr & IRQ_RX_OVERRUN)
468 ks8842_handle_rx_overrun(netdev, adapter);
470 if (isr & IRQ_TX_STOPPED) {
471 ks8842_disable_tx(adapter);
472 ks8842_enable_tx(adapter);
475 if (isr & IRQ_RX_STOPPED) {
476 ks8842_disable_rx(adapter);
477 ks8842_enable_rx(adapter);
480 /* re-enable interrupts, put back the bank selection register */
481 spin_lock_irqsave(&adapter->lock, flags);
482 ks8842_write16(adapter, 18, ENABLED_IRQS, REG_IER);
483 iowrite16(entry_bank, adapter->hw_addr + REG_SELECT_BANK);
484 spin_unlock_irqrestore(&adapter->lock, flags);
487 static irqreturn_t ks8842_irq(int irq, void *devid)
489 struct ks8842_adapter *adapter = devid;
491 u16 entry_bank = ioread16(adapter->hw_addr + REG_SELECT_BANK);
492 irqreturn_t ret = IRQ_NONE;
494 isr = ks8842_read16(adapter, 18, REG_ISR);
495 dev_dbg(&adapter->pdev->dev, "%s - ISR: 0x%x\n", __func__, isr);
499 ks8842_write16(adapter, 18, 0x00, REG_IER);
501 /* schedule tasklet */
502 tasklet_schedule(&adapter->tasklet);
507 iowrite16(entry_bank, adapter->hw_addr + REG_SELECT_BANK);
513 /* Netdevice operations */
515 static int ks8842_open(struct net_device *netdev)
517 struct ks8842_adapter *adapter = netdev_priv(netdev);
520 dev_dbg(&adapter->pdev->dev, "%s - entry\n", __func__);
523 ks8842_reset_hw(adapter);
525 ks8842_update_link_status(netdev, adapter);
527 err = request_irq(adapter->irq, ks8842_irq, IRQF_SHARED, DRV_NAME,
530 pr_err("Failed to request IRQ: %d: %d\n", adapter->irq, err);
537 static int ks8842_close(struct net_device *netdev)
539 struct ks8842_adapter *adapter = netdev_priv(netdev);
541 dev_dbg(&adapter->pdev->dev, "%s - entry\n", __func__);
544 free_irq(adapter->irq, adapter);
546 /* disable the switch */
547 ks8842_write16(adapter, 32, 0x0, REG_SW_ID_AND_ENABLE);
552 static netdev_tx_t ks8842_xmit_frame(struct sk_buff *skb,
553 struct net_device *netdev)
556 struct ks8842_adapter *adapter = netdev_priv(netdev);
558 dev_dbg(&adapter->pdev->dev, "%s: entry\n", __func__);
560 ret = ks8842_tx_frame(skb, netdev);
562 if (ks8842_tx_fifo_space(adapter) < netdev->mtu + 8)
563 netif_stop_queue(netdev);
568 static int ks8842_set_mac(struct net_device *netdev, void *p)
570 struct ks8842_adapter *adapter = netdev_priv(netdev);
572 struct sockaddr *addr = p;
573 char *mac = (u8 *)addr->sa_data;
576 dev_dbg(&adapter->pdev->dev, "%s: entry\n", __func__);
578 if (!is_valid_ether_addr(addr->sa_data))
579 return -EADDRNOTAVAIL;
581 memcpy(netdev->dev_addr, mac, netdev->addr_len);
583 spin_lock_irqsave(&adapter->lock, flags);
584 for (i = 0; i < ETH_ALEN; i++) {
585 ks8842_write8(adapter, 2, mac[ETH_ALEN - i - 1], REG_MARL + i);
586 ks8842_write8(adapter, 39, mac[ETH_ALEN - i - 1],
589 spin_unlock_irqrestore(&adapter->lock, flags);
593 static void ks8842_tx_timeout(struct net_device *netdev)
595 struct ks8842_adapter *adapter = netdev_priv(netdev);
598 dev_dbg(&adapter->pdev->dev, "%s: entry\n", __func__);
600 spin_lock_irqsave(&adapter->lock, flags);
601 /* disable interrupts */
602 ks8842_write16(adapter, 18, 0, REG_IER);
603 ks8842_write16(adapter, 18, 0xFFFF, REG_ISR);
604 spin_unlock_irqrestore(&adapter->lock, flags);
606 ks8842_reset_hw(adapter);
608 ks8842_update_link_status(netdev, adapter);
611 static const struct net_device_ops ks8842_netdev_ops = {
612 .ndo_open = ks8842_open,
613 .ndo_stop = ks8842_close,
614 .ndo_start_xmit = ks8842_xmit_frame,
615 .ndo_set_mac_address = ks8842_set_mac,
616 .ndo_tx_timeout = ks8842_tx_timeout,
617 .ndo_validate_addr = eth_validate_addr
620 static const struct ethtool_ops ks8842_ethtool_ops = {
621 .get_link = ethtool_op_get_link,
624 static int __devinit ks8842_probe(struct platform_device *pdev)
627 struct resource *iomem;
628 struct net_device *netdev;
629 struct ks8842_adapter *adapter;
632 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
633 if (!request_mem_region(iomem->start, resource_size(iomem), DRV_NAME))
636 netdev = alloc_etherdev(sizeof(struct ks8842_adapter));
638 goto err_alloc_etherdev;
640 SET_NETDEV_DEV(netdev, &pdev->dev);
642 adapter = netdev_priv(netdev);
643 adapter->hw_addr = ioremap(iomem->start, resource_size(iomem));
644 if (!adapter->hw_addr)
647 adapter->irq = platform_get_irq(pdev, 0);
648 if (adapter->irq < 0) {
653 adapter->pdev = pdev;
655 tasklet_init(&adapter->tasklet, ks8842_tasklet, (unsigned long)netdev);
656 spin_lock_init(&adapter->lock);
658 netdev->netdev_ops = &ks8842_netdev_ops;
659 netdev->ethtool_ops = &ks8842_ethtool_ops;
661 ks8842_read_mac_addr(adapter, netdev->dev_addr);
663 id = ks8842_read16(adapter, 32, REG_SW_ID_AND_ENABLE);
665 strcpy(netdev->name, "eth%d");
666 err = register_netdev(netdev);
670 platform_set_drvdata(pdev, netdev);
672 pr_info("Found chip, family: 0x%x, id: 0x%x, rev: 0x%x\n",
673 (id >> 8) & 0xff, (id >> 4) & 0xf, (id >> 1) & 0x7);
679 iounmap(adapter->hw_addr);
683 release_mem_region(iomem->start, resource_size(iomem));
688 static int __devexit ks8842_remove(struct platform_device *pdev)
690 struct net_device *netdev = platform_get_drvdata(pdev);
691 struct ks8842_adapter *adapter = netdev_priv(netdev);
692 struct resource *iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
694 unregister_netdev(netdev);
695 tasklet_kill(&adapter->tasklet);
696 iounmap(adapter->hw_addr);
698 release_mem_region(iomem->start, resource_size(iomem));
699 platform_set_drvdata(pdev, NULL);
704 static struct platform_driver ks8842_platform_driver = {
707 .owner = THIS_MODULE,
709 .probe = ks8842_probe,
710 .remove = ks8842_remove,
713 static int __init ks8842_init(void)
715 return platform_driver_register(&ks8842_platform_driver);
718 static void __exit ks8842_exit(void)
720 platform_driver_unregister(&ks8842_platform_driver);
723 module_init(ks8842_init);
724 module_exit(ks8842_exit);
726 MODULE_DESCRIPTION("Timberdale KS8842 ethernet driver");
727 MODULE_AUTHOR("Mocean Laboratories <info@mocean-labs.com>");
728 MODULE_LICENSE("GPL v2");
729 MODULE_ALIAS("platform:ks8842");