1 /*
2  * xtsonic.c
3  *
4  * (C) 2001 - 2007 Tensilica Inc.
5  *	Kevin Chea <kchea@yahoo.com>
6  *	Marc Gauthier <marc@linux-xtensa.org>
7  *	Chris Zankel <chris@zankel.net>
8  *
9  * (C) 1996,1998 by Thomas Bogendoerfer (tsbogend@alpha.franken.de)
10  *
11  * This driver is based on work from Andreas Busse, but most of
12  * the code is rewritten.
13  *
14  * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
15  *
16  * A driver for the onboard Sonic ethernet controller on the XT2000.
17  */
18 
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/fcntl.h>
23 #include <linux/gfp.h>
24 #include <linux/interrupt.h>
25 #include <linux/init.h>
26 #include <linux/ioport.h>
27 #include <linux/in.h>
28 #include <linux/string.h>
29 #include <linux/delay.h>
30 #include <linux/errno.h>
31 #include <linux/netdevice.h>
32 #include <linux/etherdevice.h>
33 #include <linux/skbuff.h>
34 #include <linux/platform_device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/slab.h>
37 
38 #include <asm/io.h>
39 #include <asm/pgtable.h>
40 #include <asm/dma.h>
41 
42 static char xtsonic_string[] = "xtsonic";
43 
44 extern unsigned xtboard_nvram_valid(void);
45 extern void xtboard_get_ether_addr(unsigned char *buf);
46 
47 #include "sonic.h"
48 
49 /*
50  * According to the documentation for the Sonic ethernet controller,
51  * EOBC should be 760 words (1520 bytes) for 32-bit applications, and,
52  * as such, 2 words less than the buffer size. The value for RBSIZE
53  * defined in sonic.h, however is only 1520.
54  *
55  * (Note that in 16-bit configurations, EOBC is 759 words (1518 bytes) and
56  * RBSIZE 1520 bytes)
57  */
58 #undef SONIC_RBSIZE
59 #define SONIC_RBSIZE	1524
60 
61 /*
62  * The chip provides 256 byte register space.
63  */
64 #define SONIC_MEM_SIZE	0x100
65 
66 /*
67  * Macros to access SONIC registers
68  */
69 #define SONIC_READ(reg) \
70 	(0xffff & *((volatile unsigned int *)dev->base_addr+reg))
71 
72 #define SONIC_WRITE(reg,val) \
73 	*((volatile unsigned int *)dev->base_addr+reg) = val
74 
75 
76 /* Use 0 for production, 1 for verification, and >2 for debug */
77 #ifdef SONIC_DEBUG
78 static unsigned int sonic_debug = SONIC_DEBUG;
79 #else
80 static unsigned int sonic_debug = 1;
81 #endif
82 
83 /*
84  * We cannot use station (ethernet) address prefixes to detect the
85  * sonic controller since these are board manufacturer depended.
86  * So we check for known Silicon Revision IDs instead.
87  */
88 static unsigned short known_revisions[] =
89 {
90 	0x101,			/* SONIC 83934 */
91 	0xffff			/* end of list */
92 };
93 
94 static int xtsonic_open(struct net_device *dev)
95 {
96 	int retval;
97 
98 	retval = request_irq(dev->irq, sonic_interrupt, IRQF_DISABLED,
99 				"sonic", dev);
100 	if (retval) {
101 		printk(KERN_ERR "%s: unable to get IRQ %d.\n",
102 		       dev->name, dev->irq);
103 		return -EAGAIN;
104 	}
105 
106 	retval = sonic_open(dev);
107 	if (retval)
108 		free_irq(dev->irq, dev);
109 	return retval;
110 }
111 
112 static int xtsonic_close(struct net_device *dev)
113 {
114 	int err;
115 	err = sonic_close(dev);
116 	free_irq(dev->irq, dev);
117 	return err;
118 }
119 
120 static const struct net_device_ops xtsonic_netdev_ops = {
121 	.ndo_open		= xtsonic_open,
122 	.ndo_stop		= xtsonic_close,
123 	.ndo_start_xmit		= sonic_send_packet,
124 	.ndo_get_stats		= sonic_get_stats,
125 	.ndo_set_rx_mode	= sonic_multicast_list,
126 	.ndo_tx_timeout		= sonic_tx_timeout,
127 	.ndo_validate_addr	= eth_validate_addr,
128 	.ndo_change_mtu		= eth_change_mtu,
129 	.ndo_set_mac_address	= eth_mac_addr,
130 };
131 
132 static int __init sonic_probe1(struct net_device *dev)
133 {
134 	static unsigned version_printed = 0;
135 	unsigned int silicon_revision;
136 	struct sonic_local *lp = netdev_priv(dev);
137 	unsigned int base_addr = dev->base_addr;
138 	int i;
139 	int err = 0;
140 
141 	if (!request_mem_region(base_addr, 0x100, xtsonic_string))
142 		return -EBUSY;
143 
144 	/*
145 	 * get the Silicon Revision ID. If this is one of the known
146 	 * one assume that we found a SONIC ethernet controller at
147 	 * the expected location.
148 	 */
149 	silicon_revision = SONIC_READ(SONIC_SR);
150 	if (sonic_debug > 1)
151 		printk("SONIC Silicon Revision = 0x%04x\n",silicon_revision);
152 
153 	i = 0;
154 	while ((known_revisions[i] != 0xffff) &&
155 			(known_revisions[i] != silicon_revision))
156 		i++;
157 
158 	if (known_revisions[i] == 0xffff) {
159 		printk("SONIC ethernet controller not found (0x%4x)\n",
160 				silicon_revision);
161 		return -ENODEV;
162 	}
163 
164 	if (sonic_debug  &&  version_printed++ == 0)
165 		printk(version);
166 
167 	/*
168 	 * Put the sonic into software reset, then retrieve ethernet address.
169 	 * Note: we are assuming that the boot-loader has initialized the cam.
170 	 */
171 	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
172 	SONIC_WRITE(SONIC_DCR,
173 		    SONIC_DCR_WC0|SONIC_DCR_DW|SONIC_DCR_LBR|SONIC_DCR_SBUS);
174 	SONIC_WRITE(SONIC_CEP,0);
175 	SONIC_WRITE(SONIC_IMR,0);
176 
177 	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
178 	SONIC_WRITE(SONIC_CEP,0);
179 
180 	for (i=0; i<3; i++) {
181 		unsigned int val = SONIC_READ(SONIC_CAP0-i);
182 		dev->dev_addr[i*2] = val;
183 		dev->dev_addr[i*2+1] = val >> 8;
184 	}
185 
186 	/* Initialize the device structure. */
187 
188 	lp->dma_bitmode = SONIC_BITMODE32;
189 
190 	/*
191 	 *  Allocate local private descriptor areas in uncached space.
192 	 *  The entire structure must be located within the same 64kb segment.
193 	 *  A simple way to ensure this is to allocate twice the
194 	 *  size of the structure -- given that the structure is
195 	 *  much less than 64 kB, at least one of the halves of
196 	 *  the allocated area will be contained entirely in 64 kB.
197 	 *  We also allocate extra space for a pointer to allow freeing
198 	 *  this structure later on (in xtsonic_cleanup_module()).
199 	 */
200 	lp->descriptors = dma_alloc_coherent(lp->device,
201 					     SIZEOF_SONIC_DESC *
202 					     SONIC_BUS_SCALE(lp->dma_bitmode),
203 					     &lp->descriptors_laddr,
204 					     GFP_KERNEL);
205 	if (lp->descriptors == NULL) {
206 		err = -ENOMEM;
207 		goto out;
208 	}
209 
210 	lp->cda = lp->descriptors;
211 	lp->tda = lp->cda + (SIZEOF_SONIC_CDA
212 			     * SONIC_BUS_SCALE(lp->dma_bitmode));
213 	lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
214 			     * SONIC_BUS_SCALE(lp->dma_bitmode));
215 	lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
216 			     * SONIC_BUS_SCALE(lp->dma_bitmode));
217 
218 	/* get the virtual dma address */
219 
220 	lp->cda_laddr = lp->descriptors_laddr;
221 	lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
222 				         * SONIC_BUS_SCALE(lp->dma_bitmode));
223 	lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
224 					 * SONIC_BUS_SCALE(lp->dma_bitmode));
225 	lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
226 					 * SONIC_BUS_SCALE(lp->dma_bitmode));
227 
228 	dev->netdev_ops		= &xtsonic_netdev_ops;
229 	dev->watchdog_timeo	= TX_TIMEOUT;
230 
231 	/*
232 	 * clear tally counter
233 	 */
234 	SONIC_WRITE(SONIC_CRCT,0xffff);
235 	SONIC_WRITE(SONIC_FAET,0xffff);
236 	SONIC_WRITE(SONIC_MPT,0xffff);
237 
238 	return 0;
239 out:
240 	release_region(dev->base_addr, SONIC_MEM_SIZE);
241 	return err;
242 }
243 
244 
245 /*
246  * Probe for a SONIC ethernet controller on an XT2000 board.
247  * Actually probing is superfluous but we're paranoid.
248  */
249 
250 int xtsonic_probe(struct platform_device *pdev)
251 {
252 	struct net_device *dev;
253 	struct sonic_local *lp;
254 	struct resource *resmem, *resirq;
255 	int err = 0;
256 
257 	if ((resmem = platform_get_resource(pdev, IORESOURCE_MEM, 0)) == NULL)
258 		return -ENODEV;
259 
260 	if ((resirq = platform_get_resource(pdev, IORESOURCE_IRQ, 0)) == NULL)
261 		return -ENODEV;
262 
263 	if ((dev = alloc_etherdev(sizeof(struct sonic_local))) == NULL)
264 		return -ENOMEM;
265 
266 	lp = netdev_priv(dev);
267 	lp->device = &pdev->dev;
268 	SET_NETDEV_DEV(dev, &pdev->dev);
269 	netdev_boot_setup_check(dev);
270 
271 	dev->base_addr = resmem->start;
272 	dev->irq = resirq->start;
273 
274 	if ((err = sonic_probe1(dev)))
275 		goto out;
276 	if ((err = register_netdev(dev)))
277 		goto out1;
278 
279 	printk("%s: SONIC ethernet @%08lx, MAC %pM, IRQ %d\n", dev->name,
280 	       dev->base_addr, dev->dev_addr, dev->irq);
281 
282 	return 0;
283 
284 out1:
285 	release_region(dev->base_addr, SONIC_MEM_SIZE);
286 out:
287 	free_netdev(dev);
288 
289 	return err;
290 }
291 
292 MODULE_DESCRIPTION("Xtensa XT2000 SONIC ethernet driver");
293 module_param(sonic_debug, int, 0);
294 MODULE_PARM_DESC(sonic_debug, "xtsonic debug level (1-4)");
295 
296 #include "sonic.c"
297 
298 static int xtsonic_device_remove(struct platform_device *pdev)
299 {
300 	struct net_device *dev = platform_get_drvdata(pdev);
301 	struct sonic_local *lp = netdev_priv(dev);
302 
303 	unregister_netdev(dev);
304 	dma_free_coherent(lp->device,
305 			  SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
306 			  lp->descriptors, lp->descriptors_laddr);
307 	release_region (dev->base_addr, SONIC_MEM_SIZE);
308 	free_netdev(dev);
309 
310 	return 0;
311 }
312 
313 static struct platform_driver xtsonic_driver = {
314 	.probe = xtsonic_probe,
315 	.remove = xtsonic_device_remove,
316 	.driver = {
317 		.name = xtsonic_string,
318 	},
319 };
320 
321 module_platform_driver(xtsonic_driver);
322