blob: 3e6aaf9e5ce7c4060b1bc042cf4d46608549297a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Finn Thainefcce832005-08-20 15:53:22 +10002 * jazzsonic.c
3 *
4 * (C) 2005 Finn Thain
5 *
6 * Converted to DMA API, and (from the mac68k project) introduced
7 * dhd's support for 16-bit cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * (C) 1996,1998 by Thomas Bogendoerfer (tsbogend@alpha.franken.de)
Jeff Garzik6aa20a22006-09-13 13:24:59 -040010 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * This driver is based on work from Andreas Busse, but most of
12 * the code is rewritten.
Jeff Garzik6aa20a22006-09-13 13:24:59 -040013 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
15 *
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)
19 */
20
21#include <linux/kernel.h>
22#include <linux/module.h>
23#include <linux/types.h>
24#include <linux/fcntl.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/interrupt.h>
27#include <linux/init.h>
28#include <linux/ioport.h>
29#include <linux/in.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#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>
Russell Kingd052d1b2005-10-29 19:07:23 +010036#include <linux/platform_device.h>
Finn Thainefcce832005-08-20 15:53:22 +100037#include <linux/dma-mapping.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090038#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#include <asm/bootinfo.h>
41#include <asm/system.h>
42#include <asm/pgtable.h>
43#include <asm/io.h>
44#include <asm/dma.h>
45#include <asm/jazz.h>
46#include <asm/jazzdma.h>
47
48static char jazz_sonic_string[] = "jazzsonic";
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50#define SONIC_MEM_SIZE 0x100
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include "sonic.h"
53
54/*
55 * Macros to access SONIC registers
56 */
Finn Thainefcce832005-08-20 15:53:22 +100057#define SONIC_READ(reg) (*((volatile unsigned int *)dev->base_addr+reg))
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59#define SONIC_WRITE(reg,val) \
60do { \
Finn Thainefcce832005-08-20 15:53:22 +100061 *((volatile unsigned int *)dev->base_addr+(reg)) = (val); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070062} while (0)
63
64
Finn Thainefcce832005-08-20 15:53:22 +100065/* use 0 for production, 1 for verification, >1 for debug */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#ifdef SONIC_DEBUG
67static unsigned int sonic_debug = SONIC_DEBUG;
Jeff Garzik6aa20a22006-09-13 13:24:59 -040068#else
Linus Torvalds1da177e2005-04-16 15:20:36 -070069static unsigned int sonic_debug = 1;
70#endif
71
72/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * We cannot use station (ethernet) address prefixes to detect the
74 * sonic controller since these are board manufacturer depended.
Jeff Garzik6aa20a22006-09-13 13:24:59 -040075 * So we check for known Silicon Revision IDs instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 */
77static unsigned short known_revisions[] =
78{
79 0x04, /* Mips Magnum 4000 */
80 0xffff /* end of list */
81};
82
Finn Thainf4d86752007-05-02 12:55:56 +100083static int jazzsonic_open(struct net_device* dev)
84{
Joe Perchesa0607fd2009-11-18 23:29:17 -080085 if (request_irq(dev->irq, sonic_interrupt, IRQF_DISABLED, "sonic", dev)) {
Finn Thainf4d86752007-05-02 12:55:56 +100086 printk(KERN_ERR "%s: unable to get IRQ %d.\n", dev->name, dev->irq);
87 return -EAGAIN;
88 }
89 return sonic_open(dev);
90}
91
92static int jazzsonic_close(struct net_device* dev)
93{
94 int err;
95 err = sonic_close(dev);
96 free_irq(dev->irq, dev);
97 return err;
98}
99
Alexander Beregalov502a3262009-04-15 12:52:45 +0000100static const struct net_device_ops sonic_netdev_ops = {
101 .ndo_open = jazzsonic_open,
102 .ndo_stop = jazzsonic_close,
103 .ndo_start_xmit = sonic_send_packet,
104 .ndo_get_stats = sonic_get_stats,
105 .ndo_set_multicast_list = sonic_multicast_list,
106 .ndo_tx_timeout = sonic_tx_timeout,
107 .ndo_change_mtu = eth_change_mtu,
108 .ndo_validate_addr = eth_validate_addr,
109 .ndo_set_mac_address = eth_mac_addr,
110};
111
Uwe Kleine-König2e76bae2009-07-21 11:25:22 +0000112static int __devinit sonic_probe1(struct net_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 static unsigned version_printed;
115 unsigned int silicon_revision;
116 unsigned int val;
Finn Thainefcce832005-08-20 15:53:22 +1000117 struct sonic_local *lp = netdev_priv(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 int err = -ENODEV;
119 int i;
120
Finn Thainefcce832005-08-20 15:53:22 +1000121 if (!request_mem_region(dev->base_addr, SONIC_MEM_SIZE, jazz_sonic_string))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 return -EBUSY;
Finn Thainefcce832005-08-20 15:53:22 +1000123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 /*
125 * get the Silicon Revision ID. If this is one of the known
126 * one assume that we found a SONIC ethernet controller at
127 * the expected location.
128 */
129 silicon_revision = SONIC_READ(SONIC_SR);
130 if (sonic_debug > 1)
131 printk("SONIC Silicon Revision = 0x%04x\n",silicon_revision);
132
133 i = 0;
Joe Perches8e95a202009-12-03 07:58:21 +0000134 while (known_revisions[i] != 0xffff &&
135 known_revisions[i] != silicon_revision)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 i++;
137
138 if (known_revisions[i] == 0xffff) {
139 printk("SONIC ethernet controller not found (0x%4x)\n",
140 silicon_revision);
141 goto out;
142 }
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 if (sonic_debug && version_printed++ == 0)
145 printk(version);
146
Kay Sieversc2313552009-03-24 16:38:22 -0700147 printk(KERN_INFO "%s: Sonic ethernet found at 0x%08lx, ",
148 dev_name(lp->device), dev->base_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 /*
151 * Put the sonic into software reset, then
152 * retrieve and print the ethernet address.
153 */
154 SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
155 SONIC_WRITE(SONIC_CEP,0);
156 for (i=0; i<3; i++) {
157 val = SONIC_READ(SONIC_CAP0-i);
158 dev->dev_addr[i*2] = val;
159 dev->dev_addr[i*2+1] = val >> 8;
160 }
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 err = -ENOMEM;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 /* Initialize the device structure. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Finn Thainefcce832005-08-20 15:53:22 +1000166 lp->dma_bitmode = SONIC_BITMODE32;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Finn Thainefcce832005-08-20 15:53:22 +1000168 /* Allocate the entire chunk of memory for the descriptors.
169 Note that this cannot cross a 64K boundary. */
170 if ((lp->descriptors = dma_alloc_coherent(lp->device,
171 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
172 &lp->descriptors_laddr, GFP_KERNEL)) == NULL) {
Kay Sieversc2313552009-03-24 16:38:22 -0700173 printk(KERN_ERR "%s: couldn't alloc DMA memory for descriptors.\n",
174 dev_name(lp->device));
Finn Thainefcce832005-08-20 15:53:22 +1000175 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 }
177
Finn Thainefcce832005-08-20 15:53:22 +1000178 /* Now set up the pointers to point to the appropriate places */
179 lp->cda = lp->descriptors;
180 lp->tda = lp->cda + (SIZEOF_SONIC_CDA
181 * SONIC_BUS_SCALE(lp->dma_bitmode));
182 lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
183 * SONIC_BUS_SCALE(lp->dma_bitmode));
184 lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
185 * SONIC_BUS_SCALE(lp->dma_bitmode));
186
187 lp->cda_laddr = lp->descriptors_laddr;
188 lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
189 * SONIC_BUS_SCALE(lp->dma_bitmode));
190 lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
191 * SONIC_BUS_SCALE(lp->dma_bitmode));
192 lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
193 * SONIC_BUS_SCALE(lp->dma_bitmode));
194
Alexander Beregalov502a3262009-04-15 12:52:45 +0000195 dev->netdev_ops = &sonic_netdev_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 dev->watchdog_timeo = TX_TIMEOUT;
197
198 /*
199 * clear tally counter
200 */
201 SONIC_WRITE(SONIC_CRCT,0xffff);
202 SONIC_WRITE(SONIC_FAET,0xffff);
203 SONIC_WRITE(SONIC_MPT,0xffff);
204
205 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206out:
Julia Lawallc9145a22009-08-08 21:43:42 +0000207 release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 return err;
209}
210
211/*
212 * Probe for a SONIC ethernet controller on a Mips Jazz board.
213 * Actually probing is superfluous but we're paranoid.
214 */
Uwe Kleine-König2e76bae2009-07-21 11:25:22 +0000215static int __devinit jazz_sonic_probe(struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
217 struct net_device *dev;
218 struct sonic_local *lp;
Thomas Bogendoerfered9f0e02007-09-08 21:46:49 +0200219 struct resource *res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Thomas Bogendoerfered9f0e02007-09-08 21:46:49 +0200222 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
223 if (!res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 return -ENODEV;
225
Finn Thainefcce832005-08-20 15:53:22 +1000226 dev = alloc_etherdev(sizeof(struct sonic_local));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 if (!dev)
228 return -ENOMEM;
229
Finn Thainefcce832005-08-20 15:53:22 +1000230 lp = netdev_priv(dev);
Russell King3ae5eae2005-11-09 22:32:44 +0000231 lp->device = &pdev->dev;
232 SET_NETDEV_DEV(dev, &pdev->dev);
Finn Thain4564cba2009-07-21 12:21:49 -0700233 platform_set_drvdata(pdev, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Finn Thainefcce832005-08-20 15:53:22 +1000235 netdev_boot_setup_check(dev);
236
Thomas Bogendoerfered9f0e02007-09-08 21:46:49 +0200237 dev->base_addr = res->start;
238 dev->irq = platform_get_irq(pdev, 0);
239 err = sonic_probe1(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 if (err)
241 goto out;
242 err = register_netdev(dev);
243 if (err)
244 goto out1;
245
Johannes Berge1749612008-10-27 15:59:26 -0700246 printk("%s: MAC %pM IRQ %d\n", dev->name, dev->dev_addr, dev->irq);
Finn Thainefcce832005-08-20 15:53:22 +1000247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 return 0;
249
250out1:
Julia Lawallc9145a22009-08-08 21:43:42 +0000251 release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252out:
253 free_netdev(dev);
254
255 return err;
256}
257
Finn Thainefcce832005-08-20 15:53:22 +1000258MODULE_DESCRIPTION("Jazz SONIC ethernet driver");
259module_param(sonic_debug, int, 0);
260MODULE_PARM_DESC(sonic_debug, "jazzsonic debug level (1-4)");
Kay Sievers72abb462008-04-18 13:50:44 -0700261MODULE_ALIAS("platform:jazzsonic");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#include "sonic.c"
264
Russell King3ae5eae2005-11-09 22:32:44 +0000265static int __devexit jazz_sonic_device_remove (struct platform_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266{
Russell King3ae5eae2005-11-09 22:32:44 +0000267 struct net_device *dev = platform_get_drvdata(pdev);
Finn Thainefcce832005-08-20 15:53:22 +1000268 struct sonic_local* lp = netdev_priv(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Finn Thaind74472f2007-05-01 22:33:02 +0200270 unregister_netdev(dev);
Finn Thainefcce832005-08-20 15:53:22 +1000271 dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
272 lp->descriptors, lp->descriptors_laddr);
Julia Lawallc9145a22009-08-08 21:43:42 +0000273 release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
Finn Thaind74472f2007-05-01 22:33:02 +0200274 free_netdev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276 return 0;
277}
278
Russell King3ae5eae2005-11-09 22:32:44 +0000279static struct platform_driver jazz_sonic_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 .probe = jazz_sonic_probe,
281 .remove = __devexit_p(jazz_sonic_device_remove),
Russell King3ae5eae2005-11-09 22:32:44 +0000282 .driver = {
283 .name = jazz_sonic_string,
Kay Sievers72abb462008-04-18 13:50:44 -0700284 .owner = THIS_MODULE,
Russell King3ae5eae2005-11-09 22:32:44 +0000285 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286};
Finn Thainefcce832005-08-20 15:53:22 +1000287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288static int __init jazz_sonic_init_module(void)
289{
Thomas Bogendoerfered9f0e02007-09-08 21:46:49 +0200290 return platform_driver_register(&jazz_sonic_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291}
292
293static void __exit jazz_sonic_cleanup_module(void)
294{
Russell King3ae5eae2005-11-09 22:32:44 +0000295 platform_driver_unregister(&jazz_sonic_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
298module_init(jazz_sonic_init_module);
299module_exit(jazz_sonic_cleanup_module);