6 * Converted to DMA API, and (from the mac68k project) introduced
7 * dhd's support for 16-bit cards.
9 * (C) 1996,1998 by Thomas Bogendoerfer (tsbogend@alpha.franken.de)
11 * This driver is based on work from Andreas Busse, but most of
12 * the code is rewritten.
14 * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
16 * A driver for the onboard Sonic ethernet controller on Mips Jazz
17 * systems (Acer Pica-61, Mips Magnum 4000, Olivetti M700 and
18 * perhaps others, too)
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/fcntl.h>
25 #include <linux/interrupt.h>
26 #include <linux/init.h>
27 #include <linux/ioport.h>
29 #include <linux/slab.h>
30 #include <linux/string.h>
31 #include <linux/delay.h>
32 #include <linux/errno.h>
33 #include <linux/netdevice.h>
34 #include <linux/etherdevice.h>
35 #include <linux/skbuff.h>
36 #include <linux/device.h>
37 #include <linux/dma-mapping.h>
39 #include <asm/bootinfo.h>
40 #include <asm/system.h>
41 #include <asm/pgtable.h>
45 #include <asm/jazzdma.h>
47 static char jazz_sonic_string[] = "jazzsonic";
48 static struct platform_device *jazz_sonic_device;
50 #define SONIC_MEM_SIZE 0x100
55 * Macros to access SONIC registers
57 #define SONIC_READ(reg) (*((volatile unsigned int *)dev->base_addr+reg))
59 #define SONIC_WRITE(reg,val) \
61 *((volatile unsigned int *)dev->base_addr+(reg)) = (val); \
65 /* use 0 for production, 1 for verification, >1 for debug */
67 static unsigned int sonic_debug = SONIC_DEBUG;
69 static unsigned int sonic_debug = 1;
73 * Base address and interrupt of the SONIC controller on JAZZ boards
78 } sonic_portlist[] = { {JAZZ_ETHERNET_BASE, JAZZ_ETHERNET_IRQ}, {0, 0}};
81 * We cannot use station (ethernet) address prefixes to detect the
82 * sonic controller since these are board manufacturer depended.
83 * So we check for known Silicon Revision IDs instead.
85 static unsigned short known_revisions[] =
87 0x04, /* Mips Magnum 4000 */
88 0xffff /* end of list */
91 static int __init sonic_probe1(struct net_device *dev)
93 static unsigned version_printed;
94 unsigned int silicon_revision;
96 struct sonic_local *lp = netdev_priv(dev);
100 if (!request_mem_region(dev->base_addr, SONIC_MEM_SIZE, jazz_sonic_string))
104 * get the Silicon Revision ID. If this is one of the known
105 * one assume that we found a SONIC ethernet controller at
106 * the expected location.
108 silicon_revision = SONIC_READ(SONIC_SR);
110 printk("SONIC Silicon Revision = 0x%04x\n",silicon_revision);
113 while (known_revisions[i] != 0xffff
114 && known_revisions[i] != silicon_revision)
117 if (known_revisions[i] == 0xffff) {
118 printk("SONIC ethernet controller not found (0x%4x)\n",
123 if (sonic_debug && version_printed++ == 0)
126 printk(KERN_INFO "%s: Sonic ethernet found at 0x%08lx, ", lp->device->bus_id, dev->base_addr);
129 * Put the sonic into software reset, then
130 * retrieve and print the ethernet address.
132 SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
133 SONIC_WRITE(SONIC_CEP,0);
134 for (i=0; i<3; i++) {
135 val = SONIC_READ(SONIC_CAP0-i);
136 dev->dev_addr[i*2] = val;
137 dev->dev_addr[i*2+1] = val >> 8;
142 /* Initialize the device structure. */
144 lp->dma_bitmode = SONIC_BITMODE32;
146 /* Allocate the entire chunk of memory for the descriptors.
147 Note that this cannot cross a 64K boundary. */
148 if ((lp->descriptors = dma_alloc_coherent(lp->device,
149 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
150 &lp->descriptors_laddr, GFP_KERNEL)) == NULL) {
151 printk(KERN_ERR "%s: couldn't alloc DMA memory for descriptors.\n", lp->device->bus_id);
155 /* Now set up the pointers to point to the appropriate places */
156 lp->cda = lp->descriptors;
157 lp->tda = lp->cda + (SIZEOF_SONIC_CDA
158 * SONIC_BUS_SCALE(lp->dma_bitmode));
159 lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
160 * SONIC_BUS_SCALE(lp->dma_bitmode));
161 lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
162 * SONIC_BUS_SCALE(lp->dma_bitmode));
164 lp->cda_laddr = lp->descriptors_laddr;
165 lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
166 * SONIC_BUS_SCALE(lp->dma_bitmode));
167 lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
168 * SONIC_BUS_SCALE(lp->dma_bitmode));
169 lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
170 * SONIC_BUS_SCALE(lp->dma_bitmode));
172 dev->open = sonic_open;
173 dev->stop = sonic_close;
174 dev->hard_start_xmit = sonic_send_packet;
175 dev->get_stats = sonic_get_stats;
176 dev->set_multicast_list = &sonic_multicast_list;
177 dev->tx_timeout = sonic_tx_timeout;
178 dev->watchdog_timeo = TX_TIMEOUT;
181 * clear tally counter
183 SONIC_WRITE(SONIC_CRCT,0xffff);
184 SONIC_WRITE(SONIC_FAET,0xffff);
185 SONIC_WRITE(SONIC_MPT,0xffff);
189 release_region(dev->base_addr, SONIC_MEM_SIZE);
194 * Probe for a SONIC ethernet controller on a Mips Jazz board.
195 * Actually probing is superfluous but we're paranoid.
197 static int __init jazz_sonic_probe(struct device *device)
199 struct net_device *dev;
200 struct sonic_local *lp;
205 * Don't probe if we're not running on a Jazz board.
207 if (mips_machgroup != MACH_GROUP_JAZZ)
210 dev = alloc_etherdev(sizeof(struct sonic_local));
214 lp = netdev_priv(dev);
216 SET_NETDEV_DEV(dev, device);
217 SET_MODULE_OWNER(dev);
219 netdev_boot_setup_check(dev);
221 if (dev->base_addr >= KSEG0) { /* Check a single specified location. */
222 err = sonic_probe1(dev);
223 } else if (dev->base_addr != 0) { /* Don't probe at all. */
226 for (i = 0; sonic_portlist[i].port; i++) {
227 dev->base_addr = sonic_portlist[i].port;
228 dev->irq = sonic_portlist[i].irq;
229 if (sonic_probe1(dev) == 0)
232 if (!sonic_portlist[i].port)
237 err = register_netdev(dev);
241 printk("%s: MAC ", dev->name);
242 for (i = 0; i < 6; i++) {
243 printk("%2.2x", dev->dev_addr[i]);
247 printk(" IRQ %d\n", dev->irq);
252 release_region(dev->base_addr, SONIC_MEM_SIZE);
259 MODULE_DESCRIPTION("Jazz SONIC ethernet driver");
260 module_param(sonic_debug, int, 0);
261 MODULE_PARM_DESC(sonic_debug, "jazzsonic debug level (1-4)");
263 #define SONIC_IRQ_FLAG SA_INTERRUPT
267 static int __devexit jazz_sonic_device_remove (struct device *device)
269 struct net_device *dev = device->driver_data;
270 struct sonic_local* lp = netdev_priv(dev);
272 unregister_netdev (dev);
273 dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
274 lp->descriptors, lp->descriptors_laddr);
275 release_region (dev->base_addr, SONIC_MEM_SIZE);
281 static struct device_driver jazz_sonic_driver = {
282 .name = jazz_sonic_string,
283 .bus = &platform_bus_type,
284 .probe = jazz_sonic_probe,
285 .remove = __devexit_p(jazz_sonic_device_remove),
288 static void jazz_sonic_platform_release (struct device *device)
290 struct platform_device *pldev;
293 pldev = to_platform_device (device);
297 static int __init jazz_sonic_init_module(void)
299 struct platform_device *pldev;
302 if ((err = driver_register(&jazz_sonic_driver))) {
303 printk(KERN_ERR "Driver registration failed\n");
307 jazz_sonic_device = NULL;
309 if (!(pldev = kmalloc (sizeof (*pldev), GFP_KERNEL))) {
313 memset(pldev, 0, sizeof (*pldev));
314 pldev->name = jazz_sonic_string;
316 pldev->dev.release = jazz_sonic_platform_release;
317 jazz_sonic_device = pldev;
319 if (platform_device_register (pldev)) {
321 jazz_sonic_device = NULL;
327 platform_device_unregister(pldev);
332 static void __exit jazz_sonic_cleanup_module(void)
334 driver_unregister(&jazz_sonic_driver);
336 if (jazz_sonic_device) {
337 platform_device_unregister(jazz_sonic_device);
338 jazz_sonic_device = NULL;
342 module_init(jazz_sonic_init_module);
343 module_exit(jazz_sonic_cleanup_module);