Linux Audio

Check our new training course

Loading...
Note: File does not exist in v5.4.
  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, 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
112static 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
120static 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_multicast_list	= 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
132static 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 =
201		dma_alloc_coherent(lp->device,
202			SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
203			&lp->descriptors_laddr, GFP_KERNEL);
204
205	if (lp->descriptors == NULL) {
206		printk(KERN_ERR "%s: couldn't alloc DMA memory for "
207				" descriptors.\n", dev_name(lp->device));
208		goto out;
209	}
210
211	lp->cda = lp->descriptors;
212	lp->tda = lp->cda + (SIZEOF_SONIC_CDA
213			     * SONIC_BUS_SCALE(lp->dma_bitmode));
214	lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
215			     * SONIC_BUS_SCALE(lp->dma_bitmode));
216	lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
217			     * SONIC_BUS_SCALE(lp->dma_bitmode));
218
219	/* get the virtual dma address */
220
221	lp->cda_laddr = lp->descriptors_laddr;
222	lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
223				         * SONIC_BUS_SCALE(lp->dma_bitmode));
224	lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
225					 * SONIC_BUS_SCALE(lp->dma_bitmode));
226	lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
227					 * SONIC_BUS_SCALE(lp->dma_bitmode));
228
229	dev->netdev_ops		= &xtsonic_netdev_ops;
230	dev->watchdog_timeo	= TX_TIMEOUT;
231
232	/*
233	 * clear tally counter
234	 */
235	SONIC_WRITE(SONIC_CRCT,0xffff);
236	SONIC_WRITE(SONIC_FAET,0xffff);
237	SONIC_WRITE(SONIC_MPT,0xffff);
238
239	return 0;
240out:
241	release_region(dev->base_addr, SONIC_MEM_SIZE);
242	return err;
243}
244
245
246/*
247 * Probe for a SONIC ethernet controller on an XT2000 board.
248 * Actually probing is superfluous but we're paranoid.
249 */
250
251int __devinit xtsonic_probe(struct platform_device *pdev)
252{
253	struct net_device *dev;
254	struct sonic_local *lp;
255	struct resource *resmem, *resirq;
256	int err = 0;
257
258	if ((resmem = platform_get_resource(pdev, IORESOURCE_MEM, 0)) == NULL)
259		return -ENODEV;
260
261	if ((resirq = platform_get_resource(pdev, IORESOURCE_IRQ, 0)) == NULL)
262		return -ENODEV;
263
264	if ((dev = alloc_etherdev(sizeof(struct sonic_local))) == NULL)
265		return -ENOMEM;
266
267	lp = netdev_priv(dev);
268	lp->device = &pdev->dev;
269	SET_NETDEV_DEV(dev, &pdev->dev);
270	netdev_boot_setup_check(dev);
271
272	dev->base_addr = resmem->start;
273	dev->irq = resirq->start;
274
275	if ((err = sonic_probe1(dev)))
276		goto out;
277	if ((err = register_netdev(dev)))
278		goto out1;
279
280	printk("%s: SONIC ethernet @%08lx, MAC %pM, IRQ %d\n", dev->name,
281	       dev->base_addr, dev->dev_addr, dev->irq);
282
283	return 0;
284
285out1:
286	release_region(dev->base_addr, SONIC_MEM_SIZE);
287out:
288	free_netdev(dev);
289
290	return err;
291}
292
293MODULE_DESCRIPTION("Xtensa XT2000 SONIC ethernet driver");
294module_param(sonic_debug, int, 0);
295MODULE_PARM_DESC(sonic_debug, "xtsonic debug level (1-4)");
296
297#include "sonic.c"
298
299static int __devexit xtsonic_device_remove (struct platform_device *pdev)
300{
301	struct net_device *dev = platform_get_drvdata(pdev);
302	struct sonic_local *lp = netdev_priv(dev);
303
304	unregister_netdev(dev);
305	dma_free_coherent(lp->device,
306			  SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
307			  lp->descriptors, lp->descriptors_laddr);
308	release_region (dev->base_addr, SONIC_MEM_SIZE);
309	free_netdev(dev);
310
311	return 0;
312}
313
314static struct platform_driver xtsonic_driver = {
315	.probe = xtsonic_probe,
316	.remove = __devexit_p(xtsonic_device_remove),
317	.driver = {
318		.name = xtsonic_string,
319	},
320};
321
322static int __init xtsonic_init(void)
323{
324	return platform_driver_register(&xtsonic_driver);
325}
326
327static void __exit xtsonic_cleanup(void)
328{
329	platform_driver_unregister(&xtsonic_driver);
330}
331
332module_init(xtsonic_init);
333module_exit(xtsonic_cleanup);