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
 42static char xtsonic_string[] = "xtsonic";
 43
 44extern unsigned xtboard_nvram_valid(void);
 45extern 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
 78static unsigned int sonic_debug = SONIC_DEBUG;
 79#else
 80static 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 */
 88static unsigned short known_revisions[] =
 89{
 90	0x101,			/* SONIC 83934 */
 91	0xffff			/* end of list */
 92};
 93
 94static int xtsonic_open(struct net_device *dev)
 95{
 96	int retval;
 97
 98	retval = request_irq(dev->irq, sonic_interrupt, 0, "sonic", dev);
 99	if (retval) {
100		printk(KERN_ERR "%s: unable to get IRQ %d.\n",
101		       dev->name, dev->irq);
102		return -EAGAIN;
103	}
104
105	retval = sonic_open(dev);
106	if (retval)
107		free_irq(dev->irq, dev);
108	return retval;
109}
110
111static int xtsonic_close(struct net_device *dev)
112{
113	int err;
114	err = sonic_close(dev);
115	free_irq(dev->irq, dev);
116	return err;
117}
118
119static const struct net_device_ops xtsonic_netdev_ops = {
120	.ndo_open		= xtsonic_open,
121	.ndo_stop		= xtsonic_close,
122	.ndo_start_xmit		= sonic_send_packet,
123	.ndo_get_stats		= sonic_get_stats,
124	.ndo_set_rx_mode	= sonic_multicast_list,
125	.ndo_tx_timeout		= sonic_tx_timeout,
126	.ndo_validate_addr	= eth_validate_addr,
127	.ndo_change_mtu		= eth_change_mtu,
128	.ndo_set_mac_address	= eth_mac_addr,
129};
130
131static int __init sonic_probe1(struct net_device *dev)
132{
133	static unsigned version_printed = 0;
134	unsigned int silicon_revision;
135	struct sonic_local *lp = netdev_priv(dev);
136	unsigned int base_addr = dev->base_addr;
137	int i;
138	int err = 0;
139
140	if (!request_mem_region(base_addr, 0x100, xtsonic_string))
141		return -EBUSY;
142
143	/*
144	 * get the Silicon Revision ID. If this is one of the known
145	 * one assume that we found a SONIC ethernet controller at
146	 * the expected location.
147	 */
148	silicon_revision = SONIC_READ(SONIC_SR);
149	if (sonic_debug > 1)
150		printk("SONIC Silicon Revision = 0x%04x\n",silicon_revision);
151
152	i = 0;
153	while ((known_revisions[i] != 0xffff) &&
154			(known_revisions[i] != silicon_revision))
155		i++;
156
157	if (known_revisions[i] == 0xffff) {
158		printk("SONIC ethernet controller not found (0x%4x)\n",
159				silicon_revision);
160		return -ENODEV;
161	}
162
163	if (sonic_debug  &&  version_printed++ == 0)
164		printk(version);
165
166	/*
167	 * Put the sonic into software reset, then retrieve ethernet address.
168	 * Note: we are assuming that the boot-loader has initialized the cam.
169	 */
170	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
171	SONIC_WRITE(SONIC_DCR,
172		    SONIC_DCR_WC0|SONIC_DCR_DW|SONIC_DCR_LBR|SONIC_DCR_SBUS);
173	SONIC_WRITE(SONIC_CEP,0);
174	SONIC_WRITE(SONIC_IMR,0);
175
176	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
177	SONIC_WRITE(SONIC_CEP,0);
178
179	for (i=0; i<3; i++) {
180		unsigned int val = SONIC_READ(SONIC_CAP0-i);
181		dev->dev_addr[i*2] = val;
182		dev->dev_addr[i*2+1] = val >> 8;
183	}
184
185	/* Initialize the device structure. */
186
187	lp->dma_bitmode = SONIC_BITMODE32;
188
189	/*
190	 *  Allocate local private descriptor areas in uncached space.
191	 *  The entire structure must be located within the same 64kb segment.
192	 *  A simple way to ensure this is to allocate twice the
193	 *  size of the structure -- given that the structure is
194	 *  much less than 64 kB, at least one of the halves of
195	 *  the allocated area will be contained entirely in 64 kB.
196	 *  We also allocate extra space for a pointer to allow freeing
197	 *  this structure later on (in xtsonic_cleanup_module()).
198	 */
199	lp->descriptors = dma_alloc_coherent(lp->device,
200					     SIZEOF_SONIC_DESC *
201					     SONIC_BUS_SCALE(lp->dma_bitmode),
202					     &lp->descriptors_laddr,
203					     GFP_KERNEL);
204	if (lp->descriptors == NULL) {
205		err = -ENOMEM;
206		goto out;
207	}
208
209	lp->cda = lp->descriptors;
210	lp->tda = lp->cda + (SIZEOF_SONIC_CDA
211			     * SONIC_BUS_SCALE(lp->dma_bitmode));
212	lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
213			     * SONIC_BUS_SCALE(lp->dma_bitmode));
214	lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
215			     * SONIC_BUS_SCALE(lp->dma_bitmode));
216
217	/* get the virtual dma address */
218
219	lp->cda_laddr = lp->descriptors_laddr;
220	lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
221				         * SONIC_BUS_SCALE(lp->dma_bitmode));
222	lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
223					 * SONIC_BUS_SCALE(lp->dma_bitmode));
224	lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
225					 * SONIC_BUS_SCALE(lp->dma_bitmode));
226
227	dev->netdev_ops		= &xtsonic_netdev_ops;
228	dev->watchdog_timeo	= TX_TIMEOUT;
229
230	/*
231	 * clear tally counter
232	 */
233	SONIC_WRITE(SONIC_CRCT,0xffff);
234	SONIC_WRITE(SONIC_FAET,0xffff);
235	SONIC_WRITE(SONIC_MPT,0xffff);
236
237	return 0;
238out:
239	release_region(dev->base_addr, SONIC_MEM_SIZE);
240	return err;
241}
242
243
244/*
245 * Probe for a SONIC ethernet controller on an XT2000 board.
246 * Actually probing is superfluous but we're paranoid.
247 */
248
249int xtsonic_probe(struct platform_device *pdev)
250{
251	struct net_device *dev;
252	struct sonic_local *lp;
253	struct resource *resmem, *resirq;
254	int err = 0;
255
256	if ((resmem = platform_get_resource(pdev, IORESOURCE_MEM, 0)) == NULL)
257		return -ENODEV;
258
259	if ((resirq = platform_get_resource(pdev, IORESOURCE_IRQ, 0)) == NULL)
260		return -ENODEV;
261
262	if ((dev = alloc_etherdev(sizeof(struct sonic_local))) == NULL)
263		return -ENOMEM;
264
265	lp = netdev_priv(dev);
266	lp->device = &pdev->dev;
267	platform_set_drvdata(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
284out1:
285	release_region(dev->base_addr, SONIC_MEM_SIZE);
286out:
287	free_netdev(dev);
288
289	return err;
290}
291
292MODULE_DESCRIPTION("Xtensa XT2000 SONIC ethernet driver");
293module_param(sonic_debug, int, 0);
294MODULE_PARM_DESC(sonic_debug, "xtsonic debug level (1-4)");
295
296#include "sonic.c"
297
298static 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
313static struct platform_driver xtsonic_driver = {
314	.probe = xtsonic_probe,
315	.remove = xtsonic_device_remove,
316	.driver = {
317		.name = xtsonic_string,
318	},
319};
320
321module_platform_driver(xtsonic_driver);