1/*
2 * ks8842.c timberdale KS8842 ethernet driver
3 * Copyright (c) 2009 Intel Corporation
4 *
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.
8 *
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.
13 *
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.
17 */
18
19/* Supports:
20 * The Micrel KS8842 behind the timberdale FPGA
21 * The genuine Micrel KS8841/42 device with ISA 16/32bit bus interface
22 */
23
24#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25
26#include <linux/interrupt.h>
27#include <linux/kernel.h>
28#include <linux/module.h>
29#include <linux/platform_device.h>
30#include <linux/netdevice.h>
31#include <linux/etherdevice.h>
32#include <linux/ethtool.h>
33#include <linux/ks8842.h>
34#include <linux/dmaengine.h>
35#include <linux/dma-mapping.h>
36#include <linux/scatterlist.h>
37
38#define DRV_NAME "ks8842"
39
40/* Timberdale specific Registers */
41#define REG_TIMB_RST		0x1c
42#define REG_TIMB_FIFO		0x20
43#define REG_TIMB_ISR		0x24
44#define REG_TIMB_IER		0x28
45#define REG_TIMB_IAR		0x2C
46#define REQ_TIMB_DMA_RESUME	0x30
47
48/* KS8842 registers */
49
50#define REG_SELECT_BANK 0x0e
51
52/* bank 0 registers */
53#define REG_QRFCR	0x04
54
55/* bank 2 registers */
56#define REG_MARL	0x00
57#define REG_MARM	0x02
58#define REG_MARH	0x04
59
60/* bank 3 registers */
61#define REG_GRR		0x06
62
63/* bank 16 registers */
64#define REG_TXCR	0x00
65#define REG_TXSR	0x02
66#define REG_RXCR	0x04
67#define REG_TXMIR	0x08
68#define REG_RXMIR	0x0A
69
70/* bank 17 registers */
71#define REG_TXQCR	0x00
72#define REG_RXQCR	0x02
73#define REG_TXFDPR	0x04
74#define REG_RXFDPR	0x06
75#define REG_QMU_DATA_LO 0x08
76#define REG_QMU_DATA_HI 0x0A
77
78/* bank 18 registers */
79#define REG_IER		0x00
80#define IRQ_LINK_CHANGE	0x8000
81#define IRQ_TX		0x4000
82#define IRQ_RX		0x2000
83#define IRQ_RX_OVERRUN	0x0800
84#define IRQ_TX_STOPPED	0x0200
85#define IRQ_RX_STOPPED	0x0100
86#define IRQ_RX_ERROR	0x0080
87#define ENABLED_IRQS	(IRQ_LINK_CHANGE | IRQ_TX | IRQ_RX | IRQ_RX_STOPPED | \
88		IRQ_TX_STOPPED | IRQ_RX_OVERRUN | IRQ_RX_ERROR)
89/* When running via timberdale in DMA mode, the RX interrupt should be
90   enabled in the KS8842, but not in the FPGA IP, since the IP handles
91   RX DMA internally.
92   TX interrupts are not needed it is handled by the FPGA the driver is
93   notified via DMA callbacks.
94*/
95#define ENABLED_IRQS_DMA_IP	(IRQ_LINK_CHANGE | IRQ_RX_STOPPED | \
96	IRQ_TX_STOPPED | IRQ_RX_OVERRUN | IRQ_RX_ERROR)
97#define ENABLED_IRQS_DMA	(ENABLED_IRQS_DMA_IP | IRQ_RX)
98#define REG_ISR		0x02
99#define REG_RXSR	0x04
100#define RXSR_VALID	0x8000
101#define RXSR_BROADCAST	0x80
102#define RXSR_MULTICAST	0x40
103#define RXSR_UNICAST	0x20
104#define RXSR_FRAMETYPE	0x08
105#define RXSR_TOO_LONG	0x04
106#define RXSR_RUNT	0x02
107#define RXSR_CRC_ERROR	0x01
108#define RXSR_ERROR	(RXSR_TOO_LONG | RXSR_RUNT | RXSR_CRC_ERROR)
109
110/* bank 32 registers */
111#define REG_SW_ID_AND_ENABLE	0x00
112#define REG_SGCR1		0x02
113#define REG_SGCR2		0x04
114#define REG_SGCR3		0x06
115
116/* bank 39 registers */
117#define REG_MACAR1		0x00
118#define REG_MACAR2		0x02
119#define REG_MACAR3		0x04
120
121/* bank 45 registers */
122#define REG_P1MBCR		0x00
123#define REG_P1MBSR		0x02
124
125/* bank 46 registers */
126#define REG_P2MBCR		0x00
127#define REG_P2MBSR		0x02
128
129/* bank 48 registers */
130#define REG_P1CR2		0x02
131
132/* bank 49 registers */
133#define REG_P1CR4		0x02
134#define REG_P1SR		0x04
135
136/* flags passed by platform_device for configuration */
137#define	MICREL_KS884X		0x01	/* 0=Timeberdale(FPGA), 1=Micrel */
138#define	KS884X_16BIT		0x02	/*  1=16bit, 0=32bit */
139
140#define DMA_BUFFER_SIZE		2048
141
142struct ks8842_tx_dma_ctl {
143	struct dma_chan *chan;
144	struct dma_async_tx_descriptor *adesc;
145	void *buf;
146	struct scatterlist sg;
147	int channel;
148};
149
150struct ks8842_rx_dma_ctl {
151	struct dma_chan *chan;
152	struct dma_async_tx_descriptor *adesc;
153	struct sk_buff  *skb;
154	struct scatterlist sg;
155	struct tasklet_struct tasklet;
156	int channel;
157};
158
159#define KS8842_USE_DMA(adapter) (((adapter)->dma_tx.channel != -1) && \
160	 ((adapter)->dma_rx.channel != -1))
161
162struct ks8842_adapter {
163	void __iomem	*hw_addr;
164	int		irq;
165	unsigned long	conf_flags;	/* copy of platform_device config */
166	struct tasklet_struct	tasklet;
167	spinlock_t	lock; /* spinlock to be interrupt safe */
168	struct work_struct timeout_work;
169	struct net_device *netdev;
170	struct device *dev;
171	struct ks8842_tx_dma_ctl	dma_tx;
172	struct ks8842_rx_dma_ctl	dma_rx;
173};
174
175static void ks8842_dma_rx_cb(void *data);
176static void ks8842_dma_tx_cb(void *data);
177
178static inline void ks8842_resume_dma(struct ks8842_adapter *adapter)
179{
180	iowrite32(1, adapter->hw_addr + REQ_TIMB_DMA_RESUME);
181}
182
183static inline void ks8842_select_bank(struct ks8842_adapter *adapter, u16 bank)
184{
185	iowrite16(bank, adapter->hw_addr + REG_SELECT_BANK);
186}
187
188static inline void ks8842_write8(struct ks8842_adapter *adapter, u16 bank,
189	u8 value, int offset)
190{
191	ks8842_select_bank(adapter, bank);
192	iowrite8(value, adapter->hw_addr + offset);
193}
194
195static inline void ks8842_write16(struct ks8842_adapter *adapter, u16 bank,
196	u16 value, int offset)
197{
198	ks8842_select_bank(adapter, bank);
199	iowrite16(value, adapter->hw_addr + offset);
200}
201
202static inline void ks8842_enable_bits(struct ks8842_adapter *adapter, u16 bank,
203	u16 bits, int offset)
204{
205	u16 reg;
206	ks8842_select_bank(adapter, bank);
207	reg = ioread16(adapter->hw_addr + offset);
208	reg |= bits;
209	iowrite16(reg, adapter->hw_addr + offset);
210}
211
212static inline void ks8842_clear_bits(struct ks8842_adapter *adapter, u16 bank,
213	u16 bits, int offset)
214{
215	u16 reg;
216	ks8842_select_bank(adapter, bank);
217	reg = ioread16(adapter->hw_addr + offset);
218	reg &= ~bits;
219	iowrite16(reg, adapter->hw_addr + offset);
220}
221
222static inline void ks8842_write32(struct ks8842_adapter *adapter, u16 bank,
223	u32 value, int offset)
224{
225	ks8842_select_bank(adapter, bank);
226	iowrite32(value, adapter->hw_addr + offset);
227}
228
229static inline u8 ks8842_read8(struct ks8842_adapter *adapter, u16 bank,
230	int offset)
231{
232	ks8842_select_bank(adapter, bank);
233	return ioread8(adapter->hw_addr + offset);
234}
235
236static inline u16 ks8842_read16(struct ks8842_adapter *adapter, u16 bank,
237	int offset)
238{
239	ks8842_select_bank(adapter, bank);
240	return ioread16(adapter->hw_addr + offset);
241}
242
243static inline u32 ks8842_read32(struct ks8842_adapter *adapter, u16 bank,
244	int offset)
245{
246	ks8842_select_bank(adapter, bank);
247	return ioread32(adapter->hw_addr + offset);
248}
249
250static void ks8842_reset(struct ks8842_adapter *adapter)
251{
252	if (adapter->conf_flags & MICREL_KS884X) {
253		ks8842_write16(adapter, 3, 1, REG_GRR);
254		msleep(10);
255		iowrite16(0, adapter->hw_addr + REG_GRR);
256	} else {
257		/* The KS8842 goes haywire when doing softare reset
258		* a work around in the timberdale IP is implemented to
259		* do a hardware reset instead
260		ks8842_write16(adapter, 3, 1, REG_GRR);
261		msleep(10);
262		iowrite16(0, adapter->hw_addr + REG_GRR);
263		*/
264		iowrite32(0x1, adapter->hw_addr + REG_TIMB_RST);
265		msleep(20);
266	}
267}
268
269static void ks8842_update_link_status(struct net_device *netdev,
270	struct ks8842_adapter *adapter)
271{
272	/* check the status of the link */
273	if (ks8842_read16(adapter, 45, REG_P1MBSR) & 0x4) {
274		netif_carrier_on(netdev);
275		netif_wake_queue(netdev);
276	} else {
277		netif_stop_queue(netdev);
278		netif_carrier_off(netdev);
279	}
280}
281
282static void ks8842_enable_tx(struct ks8842_adapter *adapter)
283{
284	ks8842_enable_bits(adapter, 16, 0x01, REG_TXCR);
285}
286
287static void ks8842_disable_tx(struct ks8842_adapter *adapter)
288{
289	ks8842_clear_bits(adapter, 16, 0x01, REG_TXCR);
290}
291
292static void ks8842_enable_rx(struct ks8842_adapter *adapter)
293{
294	ks8842_enable_bits(adapter, 16, 0x01, REG_RXCR);
295}
296
297static void ks8842_disable_rx(struct ks8842_adapter *adapter)
298{
299	ks8842_clear_bits(adapter, 16, 0x01, REG_RXCR);
300}
301
302static void ks8842_reset_hw(struct ks8842_adapter *adapter)
303{
304	/* reset the HW */
305	ks8842_reset(adapter);
306
307	/* Enable QMU Transmit flow control / transmit padding / Transmit CRC */
308	ks8842_write16(adapter, 16, 0x000E, REG_TXCR);
309
310	/* enable the receiver, uni + multi + broadcast + flow ctrl
311		+ crc strip */
312	ks8842_write16(adapter, 16, 0x8 | 0x20 | 0x40 | 0x80 | 0x400,
313		REG_RXCR);
314
315	/* TX frame pointer autoincrement */
316	ks8842_write16(adapter, 17, 0x4000, REG_TXFDPR);
317
318	/* RX frame pointer autoincrement */
319	ks8842_write16(adapter, 17, 0x4000, REG_RXFDPR);
320
321	/* RX 2 kb high watermark */
322	ks8842_write16(adapter, 0, 0x1000, REG_QRFCR);
323
324	/* aggressive back off in half duplex */
325	ks8842_enable_bits(adapter, 32, 1 << 8, REG_SGCR1);
326
327	/* enable no excessive collison drop */
328	ks8842_enable_bits(adapter, 32, 1 << 3, REG_SGCR2);
329
330	/* Enable port 1 force flow control / back pressure / transmit / recv */
331	ks8842_write16(adapter, 48, 0x1E07, REG_P1CR2);
332
333	/* restart port auto-negotiation */
334	ks8842_enable_bits(adapter, 49, 1 << 13, REG_P1CR4);
335
336	/* Enable the transmitter */
337	ks8842_enable_tx(adapter);
338
339	/* Enable the receiver */
340	ks8842_enable_rx(adapter);
341
342	/* clear all interrupts */
343	ks8842_write16(adapter, 18, 0xffff, REG_ISR);
344
345	/* enable interrupts */
346	if (KS8842_USE_DMA(adapter)) {
347		/* When running in DMA Mode the RX interrupt is not enabled in
348		   timberdale because RX data is received by DMA callbacks
349		   it must still be enabled in the KS8842 because it indicates
350		   to timberdale when there is RX data for it's DMA FIFOs */
351		iowrite16(ENABLED_IRQS_DMA_IP, adapter->hw_addr + REG_TIMB_IER);
352		ks8842_write16(adapter, 18, ENABLED_IRQS_DMA, REG_IER);
353	} else {
354		if (!(adapter->conf_flags & MICREL_KS884X))
355			iowrite16(ENABLED_IRQS,
356				adapter->hw_addr + REG_TIMB_IER);
357		ks8842_write16(adapter, 18, ENABLED_IRQS, REG_IER);
358	}
359	/* enable the switch */
360	ks8842_write16(adapter, 32, 0x1, REG_SW_ID_AND_ENABLE);
361}
362
363static void ks8842_read_mac_addr(struct ks8842_adapter *adapter, u8 *dest)
364{
365	int i;
366	u16 mac;
367
368	for (i = 0; i < ETH_ALEN; i++)
369		dest[ETH_ALEN - i - 1] = ks8842_read8(adapter, 2, REG_MARL + i);
370
371	if (adapter->conf_flags & MICREL_KS884X) {
372		/*
373		the sequence of saving mac addr between MAC and Switch is
374		different.
375		*/
376
377		mac = ks8842_read16(adapter, 2, REG_MARL);
378		ks8842_write16(adapter, 39, mac, REG_MACAR3);
379		mac = ks8842_read16(adapter, 2, REG_MARM);
380		ks8842_write16(adapter, 39, mac, REG_MACAR2);
381		mac = ks8842_read16(adapter, 2, REG_MARH);
382		ks8842_write16(adapter, 39, mac, REG_MACAR1);
383	} else {
384
385		/* make sure the switch port uses the same MAC as the QMU */
386		mac = ks8842_read16(adapter, 2, REG_MARL);
387		ks8842_write16(adapter, 39, mac, REG_MACAR1);
388		mac = ks8842_read16(adapter, 2, REG_MARM);
389		ks8842_write16(adapter, 39, mac, REG_MACAR2);
390		mac = ks8842_read16(adapter, 2, REG_MARH);
391		ks8842_write16(adapter, 39, mac, REG_MACAR3);
392	}
393}
394
395static void ks8842_write_mac_addr(struct ks8842_adapter *adapter, u8 *mac)
396{
397	unsigned long flags;
398	unsigned i;
399
400	spin_lock_irqsave(&adapter->lock, flags);
401	for (i = 0; i < ETH_ALEN; i++) {
402		ks8842_write8(adapter, 2, mac[ETH_ALEN - i - 1], REG_MARL + i);
403		if (!(adapter->conf_flags & MICREL_KS884X))
404			ks8842_write8(adapter, 39, mac[ETH_ALEN - i - 1],
405				REG_MACAR1 + i);
406	}
407
408	if (adapter->conf_flags & MICREL_KS884X) {
409		/*
410		the sequence of saving mac addr between MAC and Switch is
411		different.
412		*/
413
414		u16 mac;
415
416		mac = ks8842_read16(adapter, 2, REG_MARL);
417		ks8842_write16(adapter, 39, mac, REG_MACAR3);
418		mac = ks8842_read16(adapter, 2, REG_MARM);
419		ks8842_write16(adapter, 39, mac, REG_MACAR2);
420		mac = ks8842_read16(adapter, 2, REG_MARH);
421		ks8842_write16(adapter, 39, mac, REG_MACAR1);
422	}
423	spin_unlock_irqrestore(&adapter->lock, flags);
424}
425
426static inline u16 ks8842_tx_fifo_space(struct ks8842_adapter *adapter)
427{
428	return ks8842_read16(adapter, 16, REG_TXMIR) & 0x1fff;
429}
430
431static int ks8842_tx_frame_dma(struct sk_buff *skb, struct net_device *netdev)
432{
433	struct ks8842_adapter *adapter = netdev_priv(netdev);
434	struct ks8842_tx_dma_ctl *ctl = &adapter->dma_tx;
435	u8 *buf = ctl->buf;
436
437	if (ctl->adesc) {
438		netdev_dbg(netdev, "%s: TX ongoing\n", __func__);
439		/* transfer ongoing */
440		return NETDEV_TX_BUSY;
441	}
442
443	sg_dma_len(&ctl->sg) = skb->len + sizeof(u32);
444
445	/* copy data to the TX buffer */
446	/* the control word, enable IRQ, port 1 and the length */
447	*buf++ = 0x00;
448	*buf++ = 0x01; /* Port 1 */
449	*buf++ = skb->len & 0xff;
450	*buf++ = (skb->len >> 8) & 0xff;
451	skb_copy_from_linear_data(skb, buf, skb->len);
452
453	dma_sync_single_range_for_device(adapter->dev,
454		sg_dma_address(&ctl->sg), 0, sg_dma_len(&ctl->sg),
455		DMA_TO_DEVICE);
456
457	/* make sure the length is a multiple of 4 */
458	if (sg_dma_len(&ctl->sg) % 4)
459		sg_dma_len(&ctl->sg) += 4 - sg_dma_len(&ctl->sg) % 4;
460
461	ctl->adesc = dmaengine_prep_slave_sg(ctl->chan,
462		&ctl->sg, 1, DMA_MEM_TO_DEV,
463		DMA_PREP_INTERRUPT | DMA_COMPL_SKIP_SRC_UNMAP);
464	if (!ctl->adesc)
465		return NETDEV_TX_BUSY;
466
467	ctl->adesc->callback_param = netdev;
468	ctl->adesc->callback = ks8842_dma_tx_cb;
469	ctl->adesc->tx_submit(ctl->adesc);
470
471	netdev->stats.tx_bytes += skb->len;
472
473	dev_kfree_skb(skb);
474
475	return NETDEV_TX_OK;
476}
477
478static int ks8842_tx_frame(struct sk_buff *skb, struct net_device *netdev)
479{
480	struct ks8842_adapter *adapter = netdev_priv(netdev);
481	int len = skb->len;
482
483	netdev_dbg(netdev, "%s: len %u head %p data %p tail %p end %p\n",
484		__func__, skb->len, skb->head, skb->data,
485		skb_tail_pointer(skb), skb_end_pointer(skb));
486
487	/* check FIFO buffer space, we need space for CRC and command bits */
488	if (ks8842_tx_fifo_space(adapter) < len + 8)
489		return NETDEV_TX_BUSY;
490
491	if (adapter->conf_flags & KS884X_16BIT) {
492		u16 *ptr16 = (u16 *)skb->data;
493		ks8842_write16(adapter, 17, 0x8000 | 0x100, REG_QMU_DATA_LO);
494		ks8842_write16(adapter, 17, (u16)len, REG_QMU_DATA_HI);
495		netdev->stats.tx_bytes += len;
496
497		/* copy buffer */
498		while (len > 0) {
499			iowrite16(*ptr16++, adapter->hw_addr + REG_QMU_DATA_LO);
500			iowrite16(*ptr16++, adapter->hw_addr + REG_QMU_DATA_HI);
501			len -= sizeof(u32);
502		}
503	} else {
504
505		u32 *ptr = (u32 *)skb->data;
506		u32 ctrl;
507		/* the control word, enable IRQ, port 1 and the length */
508		ctrl = 0x8000 | 0x100 | (len << 16);
509		ks8842_write32(adapter, 17, ctrl, REG_QMU_DATA_LO);
510
511		netdev->stats.tx_bytes += len;
512
513		/* copy buffer */
514		while (len > 0) {
515			iowrite32(*ptr, adapter->hw_addr + REG_QMU_DATA_LO);
516			len -= sizeof(u32);
517			ptr++;
518		}
519	}
520
521	/* enqueue packet */
522	ks8842_write16(adapter, 17, 1, REG_TXQCR);
523
524	dev_kfree_skb(skb);
525
526	return NETDEV_TX_OK;
527}
528
529static void ks8842_update_rx_err_counters(struct net_device *netdev, u32 status)
530{
531	netdev_dbg(netdev, "RX error, status: %x\n", status);
532
533	netdev->stats.rx_errors++;
534	if (status & RXSR_TOO_LONG)
535		netdev->stats.rx_length_errors++;
536	if (status & RXSR_CRC_ERROR)
537		netdev->stats.rx_crc_errors++;
538	if (status & RXSR_RUNT)
539		netdev->stats.rx_frame_errors++;
540}
541
542static void ks8842_update_rx_counters(struct net_device *netdev, u32 status,
543	int len)
544{
545	netdev_dbg(netdev, "RX packet, len: %d\n", len);
546
547	netdev->stats.rx_packets++;
548	netdev->stats.rx_bytes += len;
549	if (status & RXSR_MULTICAST)
550		netdev->stats.multicast++;
551}
552
553static int __ks8842_start_new_rx_dma(struct net_device *netdev)
554{
555	struct ks8842_adapter *adapter = netdev_priv(netdev);
556	struct ks8842_rx_dma_ctl *ctl = &adapter->dma_rx;
557	struct scatterlist *sg = &ctl->sg;
558	int err;
559
560	ctl->skb = netdev_alloc_skb(netdev, DMA_BUFFER_SIZE);
561	if (ctl->skb) {
562		sg_init_table(sg, 1);
563		sg_dma_address(sg) = dma_map_single(adapter->dev,
564			ctl->skb->data, DMA_BUFFER_SIZE, DMA_FROM_DEVICE);
565		err = dma_mapping_error(adapter->dev, sg_dma_address(sg));
566		if (unlikely(err)) {
567			sg_dma_address(sg) = 0;
568			goto out;
569		}
570
571		sg_dma_len(sg) = DMA_BUFFER_SIZE;
572
573		ctl->adesc = dmaengine_prep_slave_sg(ctl->chan,
574			sg, 1, DMA_DEV_TO_MEM,
575			DMA_PREP_INTERRUPT | DMA_COMPL_SKIP_SRC_UNMAP);
576
577		if (!ctl->adesc)
578			goto out;
579
580		ctl->adesc->callback_param = netdev;
581		ctl->adesc->callback = ks8842_dma_rx_cb;
582		ctl->adesc->tx_submit(ctl->adesc);
583	} else {
584		err = -ENOMEM;
585		sg_dma_address(sg) = 0;
586		goto out;
587	}
588
589	return err;
590out:
591	if (sg_dma_address(sg))
592		dma_unmap_single(adapter->dev, sg_dma_address(sg),
593			DMA_BUFFER_SIZE, DMA_FROM_DEVICE);
594	sg_dma_address(sg) = 0;
595	if (ctl->skb)
596		dev_kfree_skb(ctl->skb);
597
598	ctl->skb = NULL;
599
600	printk(KERN_ERR DRV_NAME": Failed to start RX DMA: %d\n", err);
601	return err;
602}
603
604static void ks8842_rx_frame_dma_tasklet(unsigned long arg)
605{
606	struct net_device *netdev = (struct net_device *)arg;
607	struct ks8842_adapter *adapter = netdev_priv(netdev);
608	struct ks8842_rx_dma_ctl *ctl = &adapter->dma_rx;
609	struct sk_buff *skb = ctl->skb;
610	dma_addr_t addr = sg_dma_address(&ctl->sg);
611	u32 status;
612
613	ctl->adesc = NULL;
614
615	/* kick next transfer going */
616	__ks8842_start_new_rx_dma(netdev);
617
618	/* now handle the data we got */
619	dma_unmap_single(adapter->dev, addr, DMA_BUFFER_SIZE, DMA_FROM_DEVICE);
620
621	status = *((u32 *)skb->data);
622
623	netdev_dbg(netdev, "%s - rx_data: status: %x\n",
624		__func__, status & 0xffff);
625
626	/* check the status */
627	if ((status & RXSR_VALID) && !(status & RXSR_ERROR)) {
628		int len = (status >> 16) & 0x7ff;
629
630		ks8842_update_rx_counters(netdev, status, len);
631
632		/* reserve 4 bytes which is the status word */
633		skb_reserve(skb, 4);
634		skb_put(skb, len);
635
636		skb->protocol = eth_type_trans(skb, netdev);
637		netif_rx(skb);
638	} else {
639		ks8842_update_rx_err_counters(netdev, status);
640		dev_kfree_skb(skb);
641	}
642}
643
644static void ks8842_rx_frame(struct net_device *netdev,
645	struct ks8842_adapter *adapter)
646{
647	u32 status;
648	int len;
649
650	if (adapter->conf_flags & KS884X_16BIT) {
651		status = ks8842_read16(adapter, 17, REG_QMU_DATA_LO);
652		len = ks8842_read16(adapter, 17, REG_QMU_DATA_HI);
653		netdev_dbg(netdev, "%s - rx_data: status: %x\n",
654			   __func__, status);
655	} else {
656		status = ks8842_read32(adapter, 17, REG_QMU_DATA_LO);
657		len = (status >> 16) & 0x7ff;
658		status &= 0xffff;
659		netdev_dbg(netdev, "%s - rx_data: status: %x\n",
660			   __func__, status);
661	}
662
663	/* check the status */
664	if ((status & RXSR_VALID) && !(status & RXSR_ERROR)) {
665		struct sk_buff *skb = netdev_alloc_skb_ip_align(netdev, len + 3);
666
667		if (skb) {
668
669			ks8842_update_rx_counters(netdev, status, len);
670
671			if (adapter->conf_flags & KS884X_16BIT) {
672				u16 *data16 = (u16 *)skb_put(skb, len);
673				ks8842_select_bank(adapter, 17);
674				while (len > 0) {
675					*data16++ = ioread16(adapter->hw_addr +
676						REG_QMU_DATA_LO);
677					*data16++ = ioread16(adapter->hw_addr +
678						REG_QMU_DATA_HI);
679					len -= sizeof(u32);
680				}
681			} else {
682				u32 *data = (u32 *)skb_put(skb, len);
683
684				ks8842_select_bank(adapter, 17);
685				while (len > 0) {
686					*data++ = ioread32(adapter->hw_addr +
687						REG_QMU_DATA_LO);
688					len -= sizeof(u32);
689				}
690			}
691			skb->protocol = eth_type_trans(skb, netdev);
692			netif_rx(skb);
693		} else
694			netdev->stats.rx_dropped++;
695	} else
696		ks8842_update_rx_err_counters(netdev, status);
697
698	/* set high watermark to 3K */
699	ks8842_clear_bits(adapter, 0, 1 << 12, REG_QRFCR);
700
701	/* release the frame */
702	ks8842_write16(adapter, 17, 0x01, REG_RXQCR);
703
704	/* set high watermark to 2K */
705	ks8842_enable_bits(adapter, 0, 1 << 12, REG_QRFCR);
706}
707
708void ks8842_handle_rx(struct net_device *netdev, struct ks8842_adapter *adapter)
709{
710	u16 rx_data = ks8842_read16(adapter, 16, REG_RXMIR) & 0x1fff;
711	netdev_dbg(netdev, "%s Entry - rx_data: %d\n", __func__, rx_data);
712	while (rx_data) {
713		ks8842_rx_frame(netdev, adapter);
714		rx_data = ks8842_read16(adapter, 16, REG_RXMIR) & 0x1fff;
715	}
716}
717
718void ks8842_handle_tx(struct net_device *netdev, struct ks8842_adapter *adapter)
719{
720	u16 sr = ks8842_read16(adapter, 16, REG_TXSR);
721	netdev_dbg(netdev, "%s - entry, sr: %x\n", __func__, sr);
722	netdev->stats.tx_packets++;
723	if (netif_queue_stopped(netdev))
724		netif_wake_queue(netdev);
725}
726
727void ks8842_handle_rx_overrun(struct net_device *netdev,
728	struct ks8842_adapter *adapter)
729{
730	netdev_dbg(netdev, "%s: entry\n", __func__);
731	netdev->stats.rx_errors++;
732	netdev->stats.rx_fifo_errors++;
733}
734
735void ks8842_tasklet(unsigned long arg)
736{
737	struct net_device *netdev = (struct net_device *)arg;
738	struct ks8842_adapter *adapter = netdev_priv(netdev);
739	u16 isr;
740	unsigned long flags;
741	u16 entry_bank;
742
743	/* read current bank to be able to set it back */
744	spin_lock_irqsave(&adapter->lock, flags);
745	entry_bank = ioread16(adapter->hw_addr + REG_SELECT_BANK);
746	spin_unlock_irqrestore(&adapter->lock, flags);
747
748	isr = ks8842_read16(adapter, 18, REG_ISR);
749	netdev_dbg(netdev, "%s - ISR: 0x%x\n", __func__, isr);
750
751	/* when running in DMA mode, do not ack RX interrupts, it is handled
752	   internally by timberdale, otherwise it's DMA FIFO:s would stop
753	*/
754	if (KS8842_USE_DMA(adapter))
755		isr &= ~IRQ_RX;
756
757	/* Ack */
758	ks8842_write16(adapter, 18, isr, REG_ISR);
759
760	if (!(adapter->conf_flags & MICREL_KS884X))
761		/* Ack in the timberdale IP as well */
762		iowrite32(0x1, adapter->hw_addr + REG_TIMB_IAR);
763
764	if (!netif_running(netdev))
765		return;
766
767	if (isr & IRQ_LINK_CHANGE)
768		ks8842_update_link_status(netdev, adapter);
769
770	/* should not get IRQ_RX when running DMA mode */
771	if (isr & (IRQ_RX | IRQ_RX_ERROR) && !KS8842_USE_DMA(adapter))
772		ks8842_handle_rx(netdev, adapter);
773
774	/* should only happen when in PIO mode */
775	if (isr & IRQ_TX)
776		ks8842_handle_tx(netdev, adapter);
777
778	if (isr & IRQ_RX_OVERRUN)
779		ks8842_handle_rx_overrun(netdev, adapter);
780
781	if (isr & IRQ_TX_STOPPED) {
782		ks8842_disable_tx(adapter);
783		ks8842_enable_tx(adapter);
784	}
785
786	if (isr & IRQ_RX_STOPPED) {
787		ks8842_disable_rx(adapter);
788		ks8842_enable_rx(adapter);
789	}
790
791	/* re-enable interrupts, put back the bank selection register */
792	spin_lock_irqsave(&adapter->lock, flags);
793	if (KS8842_USE_DMA(adapter))
794		ks8842_write16(adapter, 18, ENABLED_IRQS_DMA, REG_IER);
795	else
796		ks8842_write16(adapter, 18, ENABLED_IRQS, REG_IER);
797	iowrite16(entry_bank, adapter->hw_addr + REG_SELECT_BANK);
798
799	/* Make sure timberdale continues DMA operations, they are stopped while
800	   we are handling the ks8842 because we might change bank */
801	if (KS8842_USE_DMA(adapter))
802		ks8842_resume_dma(adapter);
803
804	spin_unlock_irqrestore(&adapter->lock, flags);
805}
806
807static irqreturn_t ks8842_irq(int irq, void *devid)
808{
809	struct net_device *netdev = devid;
810	struct ks8842_adapter *adapter = netdev_priv(netdev);
811	u16 isr;
812	u16 entry_bank = ioread16(adapter->hw_addr + REG_SELECT_BANK);
813	irqreturn_t ret = IRQ_NONE;
814
815	isr = ks8842_read16(adapter, 18, REG_ISR);
816	netdev_dbg(netdev, "%s - ISR: 0x%x\n", __func__, isr);
817
818	if (isr) {
819		if (KS8842_USE_DMA(adapter))
820			/* disable all but RX IRQ, since the FPGA relies on it*/
821			ks8842_write16(adapter, 18, IRQ_RX, REG_IER);
822		else
823			/* disable IRQ */
824			ks8842_write16(adapter, 18, 0x00, REG_IER);
825
826		/* schedule tasklet */
827		tasklet_schedule(&adapter->tasklet);
828
829		ret = IRQ_HANDLED;
830	}
831
832	iowrite16(entry_bank, adapter->hw_addr + REG_SELECT_BANK);
833
834	/* After an interrupt, tell timberdale to continue DMA operations.
835	   DMA is disabled while we are handling the ks8842 because we might
836	   change bank */
837	ks8842_resume_dma(adapter);
838
839	return ret;
840}
841
842static void ks8842_dma_rx_cb(void *data)
843{
844	struct net_device	*netdev = data;
845	struct ks8842_adapter	*adapter = netdev_priv(netdev);
846
847	netdev_dbg(netdev, "RX DMA finished\n");
848	/* schedule tasklet */
849	if (adapter->dma_rx.adesc)
850		tasklet_schedule(&adapter->dma_rx.tasklet);
851}
852
853static void ks8842_dma_tx_cb(void *data)
854{
855	struct net_device		*netdev = data;
856	struct ks8842_adapter		*adapter = netdev_priv(netdev);
857	struct ks8842_tx_dma_ctl	*ctl = &adapter->dma_tx;
858
859	netdev_dbg(netdev, "TX DMA finished\n");
860
861	if (!ctl->adesc)
862		return;
863
864	netdev->stats.tx_packets++;
865	ctl->adesc = NULL;
866
867	if (netif_queue_stopped(netdev))
868		netif_wake_queue(netdev);
869}
870
871static void ks8842_stop_dma(struct ks8842_adapter *adapter)
872{
873	struct ks8842_tx_dma_ctl *tx_ctl = &adapter->dma_tx;
874	struct ks8842_rx_dma_ctl *rx_ctl = &adapter->dma_rx;
875
876	tx_ctl->adesc = NULL;
877	if (tx_ctl->chan)
878		tx_ctl->chan->device->device_control(tx_ctl->chan,
879			DMA_TERMINATE_ALL, 0);
880
881	rx_ctl->adesc = NULL;
882	if (rx_ctl->chan)
883		rx_ctl->chan->device->device_control(rx_ctl->chan,
884			DMA_TERMINATE_ALL, 0);
885
886	if (sg_dma_address(&rx_ctl->sg))
887		dma_unmap_single(adapter->dev, sg_dma_address(&rx_ctl->sg),
888			DMA_BUFFER_SIZE, DMA_FROM_DEVICE);
889	sg_dma_address(&rx_ctl->sg) = 0;
890
891	dev_kfree_skb(rx_ctl->skb);
892	rx_ctl->skb = NULL;
893}
894
895static void ks8842_dealloc_dma_bufs(struct ks8842_adapter *adapter)
896{
897	struct ks8842_tx_dma_ctl *tx_ctl = &adapter->dma_tx;
898	struct ks8842_rx_dma_ctl *rx_ctl = &adapter->dma_rx;
899
900	ks8842_stop_dma(adapter);
901
902	if (tx_ctl->chan)
903		dma_release_channel(tx_ctl->chan);
904	tx_ctl->chan = NULL;
905
906	if (rx_ctl->chan)
907		dma_release_channel(rx_ctl->chan);
908	rx_ctl->chan = NULL;
909
910	tasklet_kill(&rx_ctl->tasklet);
911
912	if (sg_dma_address(&tx_ctl->sg))
913		dma_unmap_single(adapter->dev, sg_dma_address(&tx_ctl->sg),
914			DMA_BUFFER_SIZE, DMA_TO_DEVICE);
915	sg_dma_address(&tx_ctl->sg) = 0;
916
917	kfree(tx_ctl->buf);
918	tx_ctl->buf = NULL;
919}
920
921static bool ks8842_dma_filter_fn(struct dma_chan *chan, void *filter_param)
922{
923	return chan->chan_id == (long)filter_param;
924}
925
926static int ks8842_alloc_dma_bufs(struct net_device *netdev)
927{
928	struct ks8842_adapter *adapter = netdev_priv(netdev);
929	struct ks8842_tx_dma_ctl *tx_ctl = &adapter->dma_tx;
930	struct ks8842_rx_dma_ctl *rx_ctl = &adapter->dma_rx;
931	int err;
932
933	dma_cap_mask_t mask;
934
935	dma_cap_zero(mask);
936	dma_cap_set(DMA_SLAVE, mask);
937	dma_cap_set(DMA_PRIVATE, mask);
938
939	sg_init_table(&tx_ctl->sg, 1);
940
941	tx_ctl->chan = dma_request_channel(mask, ks8842_dma_filter_fn,
942					   (void *)(long)tx_ctl->channel);
943	if (!tx_ctl->chan) {
944		err = -ENODEV;
945		goto err;
946	}
947
948	/* allocate DMA buffer */
949	tx_ctl->buf = kmalloc(DMA_BUFFER_SIZE, GFP_KERNEL);
950	if (!tx_ctl->buf) {
951		err = -ENOMEM;
952		goto err;
953	}
954
955	sg_dma_address(&tx_ctl->sg) = dma_map_single(adapter->dev,
956		tx_ctl->buf, DMA_BUFFER_SIZE, DMA_TO_DEVICE);
957	err = dma_mapping_error(adapter->dev,
958		sg_dma_address(&tx_ctl->sg));
959	if (err) {
960		sg_dma_address(&tx_ctl->sg) = 0;
961		goto err;
962	}
963
964	rx_ctl->chan = dma_request_channel(mask, ks8842_dma_filter_fn,
965					   (void *)(long)rx_ctl->channel);
966	if (!rx_ctl->chan) {
967		err = -ENODEV;
968		goto err;
969	}
970
971	tasklet_init(&rx_ctl->tasklet, ks8842_rx_frame_dma_tasklet,
972		(unsigned long)netdev);
973
974	return 0;
975err:
976	ks8842_dealloc_dma_bufs(adapter);
977	return err;
978}
979
980/* Netdevice operations */
981
982static int ks8842_open(struct net_device *netdev)
983{
984	struct ks8842_adapter *adapter = netdev_priv(netdev);
985	int err;
986
987	netdev_dbg(netdev, "%s - entry\n", __func__);
988
989	if (KS8842_USE_DMA(adapter)) {
990		err = ks8842_alloc_dma_bufs(netdev);
991
992		if (!err) {
993			/* start RX dma */
994			err = __ks8842_start_new_rx_dma(netdev);
995			if (err)
996				ks8842_dealloc_dma_bufs(adapter);
997		}
998
999		if (err) {
1000			printk(KERN_WARNING DRV_NAME
1001				": Failed to initiate DMA, running PIO\n");
1002			ks8842_dealloc_dma_bufs(adapter);
1003			adapter->dma_rx.channel = -1;
1004			adapter->dma_tx.channel = -1;
1005		}
1006	}
1007
1008	/* reset the HW */
1009	ks8842_reset_hw(adapter);
1010
1011	ks8842_write_mac_addr(adapter, netdev->dev_addr);
1012
1013	ks8842_update_link_status(netdev, adapter);
1014
1015	err = request_irq(adapter->irq, ks8842_irq, IRQF_SHARED, DRV_NAME,
1016		netdev);
1017	if (err) {
1018		pr_err("Failed to request IRQ: %d: %d\n", adapter->irq, err);
1019		return err;
1020	}
1021
1022	return 0;
1023}
1024
1025static int ks8842_close(struct net_device *netdev)
1026{
1027	struct ks8842_adapter *adapter = netdev_priv(netdev);
1028
1029	netdev_dbg(netdev, "%s - entry\n", __func__);
1030
1031	cancel_work_sync(&adapter->timeout_work);
1032
1033	if (KS8842_USE_DMA(adapter))
1034		ks8842_dealloc_dma_bufs(adapter);
1035
1036	/* free the irq */
1037	free_irq(adapter->irq, netdev);
1038
1039	/* disable the switch */
1040	ks8842_write16(adapter, 32, 0x0, REG_SW_ID_AND_ENABLE);
1041
1042	return 0;
1043}
1044
1045static netdev_tx_t ks8842_xmit_frame(struct sk_buff *skb,
1046				     struct net_device *netdev)
1047{
1048	int ret;
1049	struct ks8842_adapter *adapter = netdev_priv(netdev);
1050
1051	netdev_dbg(netdev, "%s: entry\n", __func__);
1052
1053	if (KS8842_USE_DMA(adapter)) {
1054		unsigned long flags;
1055		ret = ks8842_tx_frame_dma(skb, netdev);
1056		/* for now only allow one transfer at the time */
1057		spin_lock_irqsave(&adapter->lock, flags);
1058		if (adapter->dma_tx.adesc)
1059			netif_stop_queue(netdev);
1060		spin_unlock_irqrestore(&adapter->lock, flags);
1061		return ret;
1062	}
1063
1064	ret = ks8842_tx_frame(skb, netdev);
1065
1066	if (ks8842_tx_fifo_space(adapter) <  netdev->mtu + 8)
1067		netif_stop_queue(netdev);
1068
1069	return ret;
1070}
1071
1072static int ks8842_set_mac(struct net_device *netdev, void *p)
1073{
1074	struct ks8842_adapter *adapter = netdev_priv(netdev);
1075	struct sockaddr *addr = p;
1076	char *mac = (u8 *)addr->sa_data;
1077
1078	netdev_dbg(netdev, "%s: entry\n", __func__);
1079
1080	if (!is_valid_ether_addr(addr->sa_data))
1081		return -EADDRNOTAVAIL;
1082
1083	netdev->addr_assign_type &= ~NET_ADDR_RANDOM;
1084	memcpy(netdev->dev_addr, mac, netdev->addr_len);
1085
1086	ks8842_write_mac_addr(adapter, mac);
1087	return 0;
1088}
1089
1090static void ks8842_tx_timeout_work(struct work_struct *work)
1091{
1092	struct ks8842_adapter *adapter =
1093		container_of(work, struct ks8842_adapter, timeout_work);
1094	struct net_device *netdev = adapter->netdev;
1095	unsigned long flags;
1096
1097	netdev_dbg(netdev, "%s: entry\n", __func__);
1098
1099	spin_lock_irqsave(&adapter->lock, flags);
1100
1101	if (KS8842_USE_DMA(adapter))
1102		ks8842_stop_dma(adapter);
1103
1104	/* disable interrupts */
1105	ks8842_write16(adapter, 18, 0, REG_IER);
1106	ks8842_write16(adapter, 18, 0xFFFF, REG_ISR);
1107
1108	netif_stop_queue(netdev);
1109
1110	spin_unlock_irqrestore(&adapter->lock, flags);
1111
1112	ks8842_reset_hw(adapter);
1113
1114	ks8842_write_mac_addr(adapter, netdev->dev_addr);
1115
1116	ks8842_update_link_status(netdev, adapter);
1117
1118	if (KS8842_USE_DMA(adapter))
1119		__ks8842_start_new_rx_dma(netdev);
1120}
1121
1122static void ks8842_tx_timeout(struct net_device *netdev)
1123{
1124	struct ks8842_adapter *adapter = netdev_priv(netdev);
1125
1126	netdev_dbg(netdev, "%s: entry\n", __func__);
1127
1128	schedule_work(&adapter->timeout_work);
1129}
1130
1131static const struct net_device_ops ks8842_netdev_ops = {
1132	.ndo_open		= ks8842_open,
1133	.ndo_stop		= ks8842_close,
1134	.ndo_start_xmit		= ks8842_xmit_frame,
1135	.ndo_set_mac_address	= ks8842_set_mac,
1136	.ndo_tx_timeout 	= ks8842_tx_timeout,
1137	.ndo_validate_addr	= eth_validate_addr
1138};
1139
1140static const struct ethtool_ops ks8842_ethtool_ops = {
1141	.get_link		= ethtool_op_get_link,
1142};
1143
1144static int __devinit ks8842_probe(struct platform_device *pdev)
1145{
1146	int err = -ENOMEM;
1147	struct resource *iomem;
1148	struct net_device *netdev;
1149	struct ks8842_adapter *adapter;
1150	struct ks8842_platform_data *pdata = pdev->dev.platform_data;
1151	u16 id;
1152	unsigned i;
1153
1154	iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1155	if (!request_mem_region(iomem->start, resource_size(iomem), DRV_NAME))
1156		goto err_mem_region;
1157
1158	netdev = alloc_etherdev(sizeof(struct ks8842_adapter));
1159	if (!netdev)
1160		goto err_alloc_etherdev;
1161
1162	SET_NETDEV_DEV(netdev, &pdev->dev);
1163
1164	adapter = netdev_priv(netdev);
1165	adapter->netdev = netdev;
1166	INIT_WORK(&adapter->timeout_work, ks8842_tx_timeout_work);
1167	adapter->hw_addr = ioremap(iomem->start, resource_size(iomem));
1168	adapter->conf_flags = iomem->flags;
1169
1170	if (!adapter->hw_addr)
1171		goto err_ioremap;
1172
1173	adapter->irq = platform_get_irq(pdev, 0);
1174	if (adapter->irq < 0) {
1175		err = adapter->irq;
1176		goto err_get_irq;
1177	}
1178
1179	adapter->dev = (pdev->dev.parent) ? pdev->dev.parent : &pdev->dev;
1180
1181	/* DMA is only supported when accessed via timberdale */
1182	if (!(adapter->conf_flags & MICREL_KS884X) && pdata &&
1183		(pdata->tx_dma_channel != -1) &&
1184		(pdata->rx_dma_channel != -1)) {
1185		adapter->dma_rx.channel = pdata->rx_dma_channel;
1186		adapter->dma_tx.channel = pdata->tx_dma_channel;
1187	} else {
1188		adapter->dma_rx.channel = -1;
1189		adapter->dma_tx.channel = -1;
1190	}
1191
1192	tasklet_init(&adapter->tasklet, ks8842_tasklet, (unsigned long)netdev);
1193	spin_lock_init(&adapter->lock);
1194
1195	netdev->netdev_ops = &ks8842_netdev_ops;
1196	netdev->ethtool_ops = &ks8842_ethtool_ops;
1197
1198	/* Check if a mac address was given */
1199	i = netdev->addr_len;
1200	if (pdata) {
1201		for (i = 0; i < netdev->addr_len; i++)
1202			if (pdata->macaddr[i] != 0)
1203				break;
1204
1205		if (i < netdev->addr_len)
1206			/* an address was passed, use it */
1207			memcpy(netdev->dev_addr, pdata->macaddr,
1208				netdev->addr_len);
1209	}
1210
1211	if (i == netdev->addr_len) {
1212		ks8842_read_mac_addr(adapter, netdev->dev_addr);
1213
1214		if (!is_valid_ether_addr(netdev->dev_addr))
1215			eth_hw_addr_random(netdev);
1216	}
1217
1218	id = ks8842_read16(adapter, 32, REG_SW_ID_AND_ENABLE);
1219
1220	strcpy(netdev->name, "eth%d");
1221	err = register_netdev(netdev);
1222	if (err)
1223		goto err_register;
1224
1225	platform_set_drvdata(pdev, netdev);
1226
1227	pr_info("Found chip, family: 0x%x, id: 0x%x, rev: 0x%x\n",
1228		(id >> 8) & 0xff, (id >> 4) & 0xf, (id >> 1) & 0x7);
1229
1230	return 0;
1231
1232err_register:
1233err_get_irq:
1234	iounmap(adapter->hw_addr);
1235err_ioremap:
1236	free_netdev(netdev);
1237err_alloc_etherdev:
1238	release_mem_region(iomem->start, resource_size(iomem));
1239err_mem_region:
1240	return err;
1241}
1242
1243static int __devexit ks8842_remove(struct platform_device *pdev)
1244{
1245	struct net_device *netdev = platform_get_drvdata(pdev);
1246	struct ks8842_adapter *adapter = netdev_priv(netdev);
1247	struct resource *iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1248
1249	unregister_netdev(netdev);
1250	tasklet_kill(&adapter->tasklet);
1251	iounmap(adapter->hw_addr);
1252	free_netdev(netdev);
1253	release_mem_region(iomem->start, resource_size(iomem));
1254	platform_set_drvdata(pdev, NULL);
1255	return 0;
1256}
1257
1258
1259static struct platform_driver ks8842_platform_driver = {
1260	.driver = {
1261		.name	= DRV_NAME,
1262		.owner	= THIS_MODULE,
1263	},
1264	.probe		= ks8842_probe,
1265	.remove		= ks8842_remove,
1266};
1267
1268module_platform_driver(ks8842_platform_driver);
1269
1270MODULE_DESCRIPTION("Timberdale KS8842 ethernet driver");
1271MODULE_AUTHOR("Mocean Laboratories <info@mocean-labs.com>");
1272MODULE_LICENSE("GPL v2");
1273MODULE_ALIAS("platform:ks8842");
1274
1275