1 /*
2  *  Amiga Linux/m68k and Linux/PPC Zorro NS8390 Ethernet Driver
3  *
4  *  (C) Copyright 1998-2000 by some Elitist 680x0 Users(TM)
5  *
6  *  ---------------------------------------------------------------------------
7  *
8  *  This program is based on all the other NE2000 drivers for Linux
9  *
10  *  ---------------------------------------------------------------------------
11  *
12  *  This file is subject to the terms and conditions of the GNU General Public
13  *  License.  See the file COPYING in the main directory of the Linux
14  *  distribution for more details.
15  *
16  *  ---------------------------------------------------------------------------
17  *
18  *  The Ariadne II and X-Surf are Zorro-II boards containing Realtek RTL8019AS
19  *  Ethernet Controllers.
20  */
21 
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/errno.h>
27 #include <linux/init.h>
28 #include <linux/delay.h>
29 #include <linux/netdevice.h>
30 #include <linux/etherdevice.h>
31 #include <linux/zorro.h>
32 #include <linux/jiffies.h>
33 
34 #include <asm/irq.h>
35 #include <asm/amigaints.h>
36 #include <asm/amigahw.h>
37 
38 #define EI_SHIFT(x)		(ei_local->reg_offset[x])
39 #define ei_inb(port)		in_8(port)
40 #define ei_outb(val, port)	out_8(port, val)
41 #define ei_inb_p(port)		in_8(port)
42 #define ei_outb_p(val, port)	out_8(port, val)
43 
44 static const char version[] =
45 	"8390.c:v1.10cvs 9/23/94 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";
46 
47 #include "lib8390.c"
48 
49 #define DRV_NAME	"zorro8390"
50 
51 #define NE_BASE		(dev->base_addr)
52 #define NE_CMD		(0x00 * 2)
53 #define NE_DATAPORT	(0x10 * 2)	/* NatSemi-defined port window offset */
54 #define NE_RESET	(0x1f * 2)	/* Issue a read to reset,
55 					 * a write to clear. */
56 #define NE_IO_EXTENT	(0x20 * 2)
57 
58 #define NE_EN0_ISR	(0x07 * 2)
59 #define NE_EN0_DCFG	(0x0e * 2)
60 
61 #define NE_EN0_RSARLO	(0x08 * 2)
62 #define NE_EN0_RSARHI	(0x09 * 2)
63 #define NE_EN0_RCNTLO	(0x0a * 2)
64 #define NE_EN0_RXCR	(0x0c * 2)
65 #define NE_EN0_TXCR	(0x0d * 2)
66 #define NE_EN0_RCNTHI	(0x0b * 2)
67 #define NE_EN0_IMR	(0x0f * 2)
68 
69 #define NESM_START_PG	0x40	/* First page of TX buffer */
70 #define NESM_STOP_PG	0x80	/* Last page +1 of RX ring */
71 
72 #define WORDSWAP(a)	((((a) >> 8) & 0xff) | ((a) << 8))
73 
74 static struct card_info {
75 	zorro_id id;
76 	const char *name;
77 	unsigned int offset;
78 } cards[] = {
79 	{ ZORRO_PROD_VILLAGE_TRONIC_ARIADNE2, "Ariadne II", 0x0600 },
80 	{ ZORRO_PROD_INDIVIDUAL_COMPUTERS_X_SURF, "X-Surf", 0x8600 },
81 };
82 
83 /* Hard reset the card.  This used to pause for the same period that a
84  * 8390 reset command required, but that shouldn't be necessary.
85  */
86 static void zorro8390_reset_8390(struct net_device *dev)
87 {
88 	unsigned long reset_start_time = jiffies;
89 	struct ei_device *ei_local = netdev_priv(dev);
90 
91 	netif_dbg(ei_local, hw, dev, "resetting - t=%ld...\n", jiffies);
92 
93 	z_writeb(z_readb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
94 
95 	ei_status.txing = 0;
96 	ei_status.dmaing = 0;
97 
98 	/* This check _should_not_ be necessary, omit eventually. */
99 	while ((z_readb(NE_BASE + NE_EN0_ISR) & ENISR_RESET) == 0)
100 		if (time_after(jiffies, reset_start_time + 2 * HZ / 100)) {
101 			netdev_warn(dev, "%s: did not complete\n", __func__);
102 			break;
103 		}
104 	z_writeb(ENISR_RESET, NE_BASE + NE_EN0_ISR);	/* Ack intr */
105 }
106 
107 /* Grab the 8390 specific header. Similar to the block_input routine, but
108  * we don't need to be concerned with ring wrap as the header will be at
109  * the start of a page, so we optimize accordingly.
110  */
111 static void zorro8390_get_8390_hdr(struct net_device *dev,
112 				   struct e8390_pkt_hdr *hdr, int ring_page)
113 {
114 	int nic_base = dev->base_addr;
115 	int cnt;
116 	short *ptrs;
117 
118 	/* This *shouldn't* happen.
119 	 * If it does, it's the last thing you'll see
120 	 */
121 	if (ei_status.dmaing) {
122 		netdev_warn(dev,
123 			    "%s: DMAing conflict [DMAstat:%d][irqlock:%d]\n",
124 			    __func__, ei_status.dmaing, ei_status.irqlock);
125 		return;
126 	}
127 
128 	ei_status.dmaing |= 0x01;
129 	z_writeb(E8390_NODMA + E8390_PAGE0 + E8390_START, nic_base + NE_CMD);
130 	z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
131 	z_writeb(sizeof(struct e8390_pkt_hdr), nic_base + NE_EN0_RCNTLO);
132 	z_writeb(0, nic_base + NE_EN0_RCNTHI);
133 	z_writeb(0, nic_base + NE_EN0_RSARLO);		/* On page boundary */
134 	z_writeb(ring_page, nic_base + NE_EN0_RSARHI);
135 	z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
136 
137 	ptrs = (short *)hdr;
138 	for (cnt = 0; cnt < sizeof(struct e8390_pkt_hdr) >> 1; cnt++)
139 		*ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
140 
141 	z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);	/* Ack intr */
142 
143 	hdr->count = WORDSWAP(hdr->count);
144 
145 	ei_status.dmaing &= ~0x01;
146 }
147 
148 /* Block input and output, similar to the Crynwr packet driver.
149  * If you are porting to a new ethercard, look at the packet driver source
150  * for hints. The NEx000 doesn't share the on-board packet memory --
151  * you have to put the packet out through the "remote DMA" dataport
152  * using z_writeb.
153  */
154 static void zorro8390_block_input(struct net_device *dev, int count,
155 				  struct sk_buff *skb, int ring_offset)
156 {
157 	int nic_base = dev->base_addr;
158 	char *buf = skb->data;
159 	short *ptrs;
160 	int cnt;
161 
162 	/* This *shouldn't* happen.
163 	 * If it does, it's the last thing you'll see
164 	 */
165 	if (ei_status.dmaing) {
166 		netdev_err(dev, "%s: DMAing conflict [DMAstat:%d][irqlock:%d]\n",
167 			   __func__, ei_status.dmaing, ei_status.irqlock);
168 		return;
169 	}
170 	ei_status.dmaing |= 0x01;
171 	z_writeb(E8390_NODMA + E8390_PAGE0 + E8390_START, nic_base + NE_CMD);
172 	z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
173 	z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
174 	z_writeb(count >> 8, nic_base + NE_EN0_RCNTHI);
175 	z_writeb(ring_offset & 0xff, nic_base + NE_EN0_RSARLO);
176 	z_writeb(ring_offset >> 8, nic_base + NE_EN0_RSARHI);
177 	z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
178 	ptrs = (short *)buf;
179 	for (cnt = 0; cnt < count >> 1; cnt++)
180 		*ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
181 	if (count & 0x01)
182 		buf[count - 1] = z_readb(NE_BASE + NE_DATAPORT);
183 
184 	z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);	/* Ack intr */
185 	ei_status.dmaing &= ~0x01;
186 }
187 
188 static void zorro8390_block_output(struct net_device *dev, int count,
189 				   const unsigned char *buf,
190 				   const int start_page)
191 {
192 	int nic_base = NE_BASE;
193 	unsigned long dma_start;
194 	short *ptrs;
195 	int cnt;
196 
197 	/* Round the count up for word writes.  Do we need to do this?
198 	 * What effect will an odd byte count have on the 8390?
199 	 * I should check someday.
200 	 */
201 	if (count & 0x01)
202 		count++;
203 
204 	/* This *shouldn't* happen.
205 	 * If it does, it's the last thing you'll see
206 	 */
207 	if (ei_status.dmaing) {
208 		netdev_err(dev, "%s: DMAing conflict [DMAstat:%d][irqlock:%d]\n",
209 			   __func__, ei_status.dmaing, ei_status.irqlock);
210 		return;
211 	}
212 	ei_status.dmaing |= 0x01;
213 	/* We should already be in page 0, but to be safe... */
214 	z_writeb(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
215 
216 	z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
217 
218 	/* Now the normal output. */
219 	z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
220 	z_writeb(count >> 8,   nic_base + NE_EN0_RCNTHI);
221 	z_writeb(0x00, nic_base + NE_EN0_RSARLO);
222 	z_writeb(start_page, nic_base + NE_EN0_RSARHI);
223 
224 	z_writeb(E8390_RWRITE + E8390_START, nic_base + NE_CMD);
225 	ptrs = (short *)buf;
226 	for (cnt = 0; cnt < count >> 1; cnt++)
227 		z_writew(*ptrs++, NE_BASE + NE_DATAPORT);
228 
229 	dma_start = jiffies;
230 
231 	while ((z_readb(NE_BASE + NE_EN0_ISR) & ENISR_RDC) == 0)
232 		if (time_after(jiffies, dma_start + 2 * HZ / 100)) {
233 					/* 20ms */
234 			netdev_warn(dev, "timeout waiting for Tx RDC\n");
235 			zorro8390_reset_8390(dev);
236 			__NS8390_init(dev, 1);
237 			break;
238 		}
239 
240 	z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);	/* Ack intr */
241 	ei_status.dmaing &= ~0x01;
242 }
243 
244 static int zorro8390_open(struct net_device *dev)
245 {
246 	__ei_open(dev);
247 	return 0;
248 }
249 
250 static int zorro8390_close(struct net_device *dev)
251 {
252 	struct ei_device *ei_local = netdev_priv(dev);
253 
254 	netif_dbg(ei_local, ifdown, dev, "Shutting down ethercard\n");
255 	__ei_close(dev);
256 	return 0;
257 }
258 
259 static void zorro8390_remove_one(struct zorro_dev *z)
260 {
261 	struct net_device *dev = zorro_get_drvdata(z);
262 
263 	unregister_netdev(dev);
264 	free_irq(IRQ_AMIGA_PORTS, dev);
265 	release_mem_region(ZTWO_PADDR(dev->base_addr), NE_IO_EXTENT * 2);
266 	free_netdev(dev);
267 }
268 
269 static struct zorro_device_id zorro8390_zorro_tbl[] = {
270 	{ ZORRO_PROD_VILLAGE_TRONIC_ARIADNE2, },
271 	{ ZORRO_PROD_INDIVIDUAL_COMPUTERS_X_SURF, },
272 	{ 0 }
273 };
274 MODULE_DEVICE_TABLE(zorro, zorro8390_zorro_tbl);
275 
276 static const struct net_device_ops zorro8390_netdev_ops = {
277 	.ndo_open		= zorro8390_open,
278 	.ndo_stop		= zorro8390_close,
279 	.ndo_start_xmit		= __ei_start_xmit,
280 	.ndo_tx_timeout		= __ei_tx_timeout,
281 	.ndo_get_stats		= __ei_get_stats,
282 	.ndo_set_rx_mode	= __ei_set_multicast_list,
283 	.ndo_validate_addr	= eth_validate_addr,
284 	.ndo_set_mac_address	= eth_mac_addr,
285 #ifdef CONFIG_NET_POLL_CONTROLLER
286 	.ndo_poll_controller	= __ei_poll,
287 #endif
288 };
289 
290 static int zorro8390_init(struct net_device *dev, unsigned long board,
291 			  const char *name, void __iomem *ioaddr)
292 {
293 	int i;
294 	int err;
295 	unsigned char SA_prom[32];
296 	int start_page, stop_page;
297 	static u32 zorro8390_offsets[16] = {
298 		0x00, 0x02, 0x04, 0x06, 0x08, 0x0a, 0x0c, 0x0e,
299 		0x10, 0x12, 0x14, 0x16, 0x18, 0x1a, 0x1c, 0x1e,
300 	};
301 
302 	/* Reset card. Who knows what dain-bramaged state it was left in. */
303 	{
304 		unsigned long reset_start_time = jiffies;
305 
306 		z_writeb(z_readb(ioaddr + NE_RESET), ioaddr + NE_RESET);
307 
308 		while ((z_readb(ioaddr + NE_EN0_ISR) & ENISR_RESET) == 0)
309 			if (time_after(jiffies,
310 				       reset_start_time + 2 * HZ / 100)) {
311 				netdev_warn(dev, "not found (no reset ack)\n");
312 				return -ENODEV;
313 			}
314 
315 		z_writeb(0xff, ioaddr + NE_EN0_ISR);	/* Ack all intr. */
316 	}
317 
318 	/* Read the 16 bytes of station address PROM.
319 	 * We must first initialize registers,
320 	 * similar to NS8390_init(eifdev, 0).
321 	 * We can't reliably read the SAPROM address without this.
322 	 * (I learned the hard way!).
323 	 */
324 	{
325 		static const struct {
326 			u32 value;
327 			u32 offset;
328 		} program_seq[] = {
329 			{E8390_NODMA + E8390_PAGE0 + E8390_STOP, NE_CMD},
330 						/* Select page 0 */
331 			{0x48,	NE_EN0_DCFG},	/* 0x48: Set byte-wide access */
332 			{0x00,	NE_EN0_RCNTLO},	/* Clear the count regs */
333 			{0x00,	NE_EN0_RCNTHI},
334 			{0x00,	NE_EN0_IMR},	/* Mask completion irq */
335 			{0xFF,	NE_EN0_ISR},
336 			{E8390_RXOFF, NE_EN0_RXCR}, /* 0x20 Set to monitor */
337 			{E8390_TXOFF, NE_EN0_TXCR}, /* 0x02 and loopback mode */
338 			{32,	NE_EN0_RCNTLO},
339 			{0x00,	NE_EN0_RCNTHI},
340 			{0x00,	NE_EN0_RSARLO},	/* DMA starting at 0x0000 */
341 			{0x00,	NE_EN0_RSARHI},
342 			{E8390_RREAD + E8390_START, NE_CMD},
343 		};
344 		for (i = 0; i < ARRAY_SIZE(program_seq); i++)
345 			z_writeb(program_seq[i].value,
346 				 ioaddr + program_seq[i].offset);
347 	}
348 	for (i = 0; i < 16; i++) {
349 		SA_prom[i] = z_readb(ioaddr + NE_DATAPORT);
350 		(void)z_readb(ioaddr + NE_DATAPORT);
351 	}
352 
353 	/* We must set the 8390 for word mode. */
354 	z_writeb(0x49, ioaddr + NE_EN0_DCFG);
355 	start_page = NESM_START_PG;
356 	stop_page = NESM_STOP_PG;
357 
358 	dev->base_addr = (unsigned long)ioaddr;
359 	dev->irq = IRQ_AMIGA_PORTS;
360 
361 	/* Install the Interrupt handler */
362 	i = request_irq(IRQ_AMIGA_PORTS, __ei_interrupt,
363 			IRQF_SHARED, DRV_NAME, dev);
364 	if (i)
365 		return i;
366 
367 	eth_hw_addr_set(dev, SA_prom);
368 
369 	pr_debug("Found ethernet address: %pM\n", dev->dev_addr);
370 
371 	ei_status.name = name;
372 	ei_status.tx_start_page = start_page;
373 	ei_status.stop_page = stop_page;
374 	ei_status.word16 = 1;
375 
376 	ei_status.rx_start_page = start_page + TX_PAGES;
377 
378 	ei_status.reset_8390 = zorro8390_reset_8390;
379 	ei_status.block_input = zorro8390_block_input;
380 	ei_status.block_output = zorro8390_block_output;
381 	ei_status.get_8390_hdr = zorro8390_get_8390_hdr;
382 	ei_status.reg_offset = zorro8390_offsets;
383 
384 	dev->netdev_ops = &zorro8390_netdev_ops;
385 	__NS8390_init(dev, 0);
386 
387 	err = register_netdev(dev);
388 	if (err) {
389 		free_irq(IRQ_AMIGA_PORTS, dev);
390 		return err;
391 	}
392 
393 	netdev_info(dev, "%s at 0x%08lx, Ethernet Address %pM\n",
394 		    name, board, dev->dev_addr);
395 
396 	return 0;
397 }
398 
399 static int zorro8390_init_one(struct zorro_dev *z,
400 			      const struct zorro_device_id *ent)
401 {
402 	struct net_device *dev;
403 	unsigned long board, ioaddr;
404 	int err, i;
405 
406 	for (i = ARRAY_SIZE(cards) - 1; i >= 0; i--)
407 		if (z->id == cards[i].id)
408 			break;
409 	if (i < 0)
410 		return -ENODEV;
411 
412 	board = z->resource.start;
413 	ioaddr = board + cards[i].offset;
414 	dev = ____alloc_ei_netdev(0);
415 	if (!dev)
416 		return -ENOMEM;
417 	if (!request_mem_region(ioaddr, NE_IO_EXTENT * 2, DRV_NAME)) {
418 		free_netdev(dev);
419 		return -EBUSY;
420 	}
421 	err = zorro8390_init(dev, board, cards[i].name, ZTWO_VADDR(ioaddr));
422 	if (err) {
423 		release_mem_region(ioaddr, NE_IO_EXTENT * 2);
424 		free_netdev(dev);
425 		return err;
426 	}
427 	zorro_set_drvdata(z, dev);
428 	return 0;
429 }
430 
431 static struct zorro_driver zorro8390_driver = {
432 	.name		= "zorro8390",
433 	.id_table	= zorro8390_zorro_tbl,
434 	.probe		= zorro8390_init_one,
435 	.remove		= zorro8390_remove_one,
436 };
437 
438 static int __init zorro8390_init_module(void)
439 {
440 	return zorro_register_driver(&zorro8390_driver);
441 }
442 
443 static void __exit zorro8390_cleanup_module(void)
444 {
445 	zorro_unregister_driver(&zorro8390_driver);
446 }
447 
448 module_init(zorro8390_init_module);
449 module_exit(zorro8390_cleanup_module);
450 
451 MODULE_LICENSE("GPL");
452