blob: db5285befe2aedade24836402909f411ba369ca3 [file] [log] [blame]
Ralf Baechledcbf8472005-10-10 14:51:27 +01001/*
2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
4 * for more details.
5 */
6
Ralf Baechledcbf8472005-10-10 14:51:27 +01007#include <linux/init.h>
Alexey Dobriyan539d3ee2011-06-10 03:36:43 +00008#include <linux/interrupt.h>
Ralf Baechlec2af68e2007-10-12 14:59:56 +01009#include <linux/io.h>
Ralf Baechledcbf8472005-10-10 14:51:27 +010010#include <linux/kernel.h>
11#include <linux/module.h>
12#include <linux/netdevice.h>
Ralf Baechledcbf8472005-10-10 14:51:27 +010013#include <linux/etherdevice.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010014#include <linux/platform_device.h>
Ralf Baechledcbf8472005-10-10 14:51:27 +010015#include <asm/mips-boards/simint.h>
16
Ralf Baechlec800c5c2008-01-11 17:28:00 +000017#define MIPSNET_VERSION "2007-11-17"
Ralf Baechledcbf8472005-10-10 14:51:27 +010018
Ralf Baechlec800c5c2008-01-11 17:28:00 +000019/*
20 * Net status/control block as seen by sw in the core.
21 */
22struct mipsnet_regs {
23 /*
24 * Device info for probing, reads as MIPSNET%d where %d is some
25 * form of version.
26 */
27 u64 devId; /*0x00 */
Ralf Baechledcbf8472005-10-10 14:51:27 +010028
Ralf Baechlec800c5c2008-01-11 17:28:00 +000029 /*
30 * read only busy flag.
31 * Set and cleared by the Net Device to indicate that an rx or a tx
32 * is in progress.
33 */
34 u32 busy; /*0x08 */
35
36 /*
37 * Set by the Net Device.
38 * The device will set it once data has been received.
39 * The value is the number of bytes that should be read from
40 * rxDataBuffer. The value will decrease till 0 until all the data
41 * from rxDataBuffer has been read.
42 */
43 u32 rxDataCount; /*0x0c */
44#define MIPSNET_MAX_RXTX_DATACOUNT (1 << 16)
45
46 /*
47 * Settable from the MIPS core, cleared by the Net Device.
48 * The core should set the number of bytes it wants to send,
49 * then it should write those bytes of data to txDataBuffer.
50 * The device will clear txDataCount has been processed (not
51 * necessarily sent).
52 */
53 u32 txDataCount; /*0x10 */
54
55 /*
56 * Interrupt control
57 *
58 * Used to clear the interrupted generated by this dev.
59 * Write a 1 to clear the interrupt. (except bit31).
60 *
61 * Bit0 is set if it was a tx-done interrupt.
62 * Bit1 is set when new rx-data is available.
63 * Until this bit is cleared there will be no other RXs.
64 *
65 * Bit31 is used for testing, it clears after a read.
66 * Writing 1 to this bit will cause an interrupt to be generated.
67 * To clear the test interrupt, write 0 to this register.
68 */
69 u32 interruptControl; /*0x14 */
70#define MIPSNET_INTCTL_TXDONE (1u << 0)
71#define MIPSNET_INTCTL_RXDONE (1u << 1)
72#define MIPSNET_INTCTL_TESTBIT (1u << 31)
73
74 /*
75 * Readonly core-specific interrupt info for the device to signal
76 * the core. The meaning of the contents of this field might change.
77 */
78 /* XXX: the whole memIntf interrupt scheme is messy: the device
79 * should have no control what so ever of what VPE/register set is
80 * being used.
81 * The MemIntf should only expose interrupt lines, and something in
82 * the config should be responsible for the line<->core/vpe bindings.
83 */
84 u32 interruptInfo; /*0x18 */
85
86 /*
87 * This is where the received data is read out.
88 * There is more data to read until rxDataReady is 0.
89 * Only 1 byte at this regs offset is used.
90 */
91 u32 rxDataBuffer; /*0x1c */
92
93 /*
94 * This is where the data to transmit is written.
95 * Data should be written for the amount specified in the
96 * txDataCount register.
97 * Only 1 byte at this regs offset is used.
98 */
99 u32 txDataBuffer; /*0x20 */
100};
101
102#define regaddr(dev, field) \
103 (dev->base_addr + offsetof(struct mipsnet_regs, field))
Ralf Baechledcbf8472005-10-10 14:51:27 +0100104
Ralf Baechledcbf8472005-10-10 14:51:27 +0100105static char mipsnet_string[] = "mipsnet";
106
107/*
108 * Copy data from the MIPSNET rx data port
109 */
110static int ioiocpy_frommipsnet(struct net_device *dev, unsigned char *kdata,
111 int len)
112{
Ralf Baechlec2af68e2007-10-12 14:59:56 +0100113 for (; len > 0; len--, kdata++)
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000114 *kdata = inb(regaddr(dev, rxDataBuffer));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100115
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000116 return inl(regaddr(dev, rxDataCount));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100117}
118
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000119static inline void mipsnet_put_todevice(struct net_device *dev,
Ralf Baechledcbf8472005-10-10 14:51:27 +0100120 struct sk_buff *skb)
121{
122 int count_to_go = skb->len;
123 char *buf_ptr = skb->data;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100124
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000125 outl(skb->len, regaddr(dev, txDataCount));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100126
Ralf Baechlec2af68e2007-10-12 14:59:56 +0100127 for (; count_to_go; buf_ptr++, count_to_go--)
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000128 outb(*buf_ptr, regaddr(dev, txDataBuffer));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100129
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700130 dev->stats.tx_packets++;
131 dev->stats.tx_bytes += skb->len;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100132
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000133 dev_kfree_skb(skb);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100134}
135
136static int mipsnet_xmit(struct sk_buff *skb, struct net_device *dev)
137{
Ralf Baechlef5e42fb2007-10-23 00:35:26 +0100138 /*
139 * Only one packet at a time. Once TXDONE interrupt is serviced, the
Ralf Baechledcbf8472005-10-10 14:51:27 +0100140 * queue will be restarted.
141 */
142 netif_stop_queue(dev);
143 mipsnet_put_todevice(dev, skb);
144
Patrick McHardy6ed10652009-06-23 06:03:08 +0000145 return NETDEV_TX_OK;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100146}
147
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000148static inline ssize_t mipsnet_get_fromdev(struct net_device *dev, size_t len)
Ralf Baechledcbf8472005-10-10 14:51:27 +0100149{
150 struct sk_buff *skb;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100151
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000152 if (!len)
153 return len;
154
Pradeep A Dalvic056b732012-02-05 02:50:38 +0000155 skb = netdev_alloc_skb(dev, len + NET_IP_ALIGN);
Ralf Baechlec2af68e2007-10-12 14:59:56 +0100156 if (!skb) {
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700157 dev->stats.rx_dropped++;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100158 return -ENOMEM;
159 }
160
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000161 skb_reserve(skb, NET_IP_ALIGN);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100162 if (ioiocpy_frommipsnet(dev, skb_put(skb, len), len))
163 return -EFAULT;
164
Ralf Baechledcbf8472005-10-10 14:51:27 +0100165 skb->protocol = eth_type_trans(skb, dev);
166 skb->ip_summed = CHECKSUM_UNNECESSARY;
167
Ralf Baechledcbf8472005-10-10 14:51:27 +0100168 netif_rx(skb);
169
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700170 dev->stats.rx_packets++;
171 dev->stats.rx_bytes += len;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100172
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000173 return len;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100174}
175
David Howells7d12e782006-10-05 14:55:46 +0100176static irqreturn_t mipsnet_interrupt(int irq, void *dev_id)
Ralf Baechledcbf8472005-10-10 14:51:27 +0100177{
178 struct net_device *dev = dev_id;
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000179 u32 int_flags;
180 irqreturn_t ret = IRQ_NONE;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100181
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000182 if (irq != dev->irq)
183 goto out_badirq;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100184
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000185 /* TESTBIT is cleared on read. */
186 int_flags = inl(regaddr(dev, interruptControl));
187 if (int_flags & MIPSNET_INTCTL_TESTBIT) {
188 /* TESTBIT takes effect after a write with 0. */
189 outl(0, regaddr(dev, interruptControl));
190 ret = IRQ_HANDLED;
191 } else if (int_flags & MIPSNET_INTCTL_TXDONE) {
192 /* Only one packet at a time, we are done. */
193 dev->stats.tx_packets++;
194 netif_wake_queue(dev);
195 outl(MIPSNET_INTCTL_TXDONE,
196 regaddr(dev, interruptControl));
197 ret = IRQ_HANDLED;
198 } else if (int_flags & MIPSNET_INTCTL_RXDONE) {
199 mipsnet_get_fromdev(dev, inl(regaddr(dev, rxDataCount)));
200 outl(MIPSNET_INTCTL_RXDONE, regaddr(dev, interruptControl));
201 ret = IRQ_HANDLED;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100202 }
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000203 return ret;
204
205out_badirq:
206 printk(KERN_INFO "%s: %s(): irq %d for unknown device\n",
Harvey Harrisonb39d66a2008-08-20 16:52:04 -0700207 dev->name, __func__, irq);
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000208 return ret;
Ralf Baechlec2af68e2007-10-12 14:59:56 +0100209}
Ralf Baechledcbf8472005-10-10 14:51:27 +0100210
211static int mipsnet_open(struct net_device *dev)
212{
213 int err;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100214
Joe Perchesa0607fd2009-11-18 23:29:17 -0800215 err = request_irq(dev->irq, mipsnet_interrupt,
Thomas Gleixner1fb9df52006-07-01 19:29:39 -0700216 IRQF_SHARED, dev->name, (void *) dev);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100217 if (err) {
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000218 release_region(dev->base_addr, sizeof(struct mipsnet_regs));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100219 return err;
220 }
221
Ralf Baechledcbf8472005-10-10 14:51:27 +0100222 netif_start_queue(dev);
223
Ralf Baechlec2af68e2007-10-12 14:59:56 +0100224 /* test interrupt handler */
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000225 outl(MIPSNET_INTCTL_TESTBIT, regaddr(dev, interruptControl));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100226
227 return 0;
228}
229
230static int mipsnet_close(struct net_device *dev)
231{
Ralf Baechledcbf8472005-10-10 14:51:27 +0100232 netif_stop_queue(dev);
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000233 free_irq(dev->irq, dev);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100234 return 0;
235}
236
Ralf Baechledcbf8472005-10-10 14:51:27 +0100237static void mipsnet_set_mclist(struct net_device *dev)
238{
Ralf Baechledcbf8472005-10-10 14:51:27 +0100239}
240
Alexander Beregalovd6771e02009-04-15 12:52:51 +0000241static const struct net_device_ops mipsnet_netdev_ops = {
242 .ndo_open = mipsnet_open,
243 .ndo_stop = mipsnet_close,
244 .ndo_start_xmit = mipsnet_xmit,
Jiri Pirkoafc4b132011-08-16 06:29:01 +0000245 .ndo_set_rx_mode = mipsnet_set_mclist,
Alexander Beregalovd6771e02009-04-15 12:52:51 +0000246 .ndo_change_mtu = eth_change_mtu,
247 .ndo_validate_addr = eth_validate_addr,
248 .ndo_set_mac_address = eth_mac_addr,
249};
250
Ralf Baechleade2d3d2010-06-21 03:44:50 +0000251static int __devinit mipsnet_probe(struct platform_device *dev)
Ralf Baechledcbf8472005-10-10 14:51:27 +0100252{
253 struct net_device *netdev;
254 int err;
255
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700256 netdev = alloc_etherdev(0);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100257 if (!netdev) {
258 err = -ENOMEM;
259 goto out;
260 }
261
Ming Lei7a192ec2009-02-06 23:40:12 +0800262 platform_set_drvdata(dev, netdev);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100263
Alexander Beregalovd6771e02009-04-15 12:52:51 +0000264 netdev->netdev_ops = &mipsnet_netdev_ops;
Ralf Baechledcbf8472005-10-10 14:51:27 +0100265
266 /*
267 * TODO: probe for these or load them from PARAM
268 */
269 netdev->base_addr = 0x4200;
Ralf Baechle3b1d4ed2007-06-20 22:27:10 +0100270 netdev->irq = MIPS_CPU_IRQ_BASE + MIPSCPU_INT_MB0 +
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000271 inl(regaddr(netdev, interruptInfo));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100272
Ralf Baechlec2af68e2007-10-12 14:59:56 +0100273 /* Get the io region now, get irq on open() */
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000274 if (!request_region(netdev->base_addr, sizeof(struct mipsnet_regs),
275 "mipsnet")) {
Ralf Baechledcbf8472005-10-10 14:51:27 +0100276 err = -EBUSY;
277 goto out_free_netdev;
278 }
279
280 /*
281 * Lacking any better mechanism to allocate a MAC address we use a
282 * random one ...
283 */
Danny Kukawkaf2cedb62012-02-15 06:45:39 +0000284 eth_hw_addr_random(netdev);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100285
286 err = register_netdev(netdev);
287 if (err) {
288 printk(KERN_ERR "MIPSNet: failed to register netdev.\n");
289 goto out_free_region;
290 }
291
292 return 0;
293
294out_free_region:
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000295 release_region(netdev->base_addr, sizeof(struct mipsnet_regs));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100296
297out_free_netdev:
298 free_netdev(netdev);
299
300out:
301 return err;
302}
303
Ming Lei7a192ec2009-02-06 23:40:12 +0800304static int __devexit mipsnet_device_remove(struct platform_device *device)
Ralf Baechledcbf8472005-10-10 14:51:27 +0100305{
Ming Lei7a192ec2009-02-06 23:40:12 +0800306 struct net_device *dev = platform_get_drvdata(device);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100307
308 unregister_netdev(dev);
Ralf Baechlec800c5c2008-01-11 17:28:00 +0000309 release_region(dev->base_addr, sizeof(struct mipsnet_regs));
Ralf Baechledcbf8472005-10-10 14:51:27 +0100310 free_netdev(dev);
Ming Lei7a192ec2009-02-06 23:40:12 +0800311 platform_set_drvdata(device, NULL);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100312
313 return 0;
314}
315
Ming Lei7a192ec2009-02-06 23:40:12 +0800316static struct platform_driver mipsnet_driver = {
317 .driver = {
318 .name = mipsnet_string,
319 .owner = THIS_MODULE,
320 },
321 .probe = mipsnet_probe,
322 .remove = __devexit_p(mipsnet_device_remove),
Ralf Baechledcbf8472005-10-10 14:51:27 +0100323};
324
Ralf Baechledcbf8472005-10-10 14:51:27 +0100325static int __init mipsnet_init_module(void)
326{
Ralf Baechledcbf8472005-10-10 14:51:27 +0100327 int err;
328
329 printk(KERN_INFO "MIPSNet Ethernet driver. Version: %s. "
330 "(c)2005 MIPS Technologies, Inc.\n", MIPSNET_VERSION);
331
Ming Lei7a192ec2009-02-06 23:40:12 +0800332 err = platform_driver_register(&mipsnet_driver);
Ralf Baechle1e2b9802007-03-18 23:21:22 +0000333 if (err)
Ralf Baechledcbf8472005-10-10 14:51:27 +0100334 printk(KERN_ERR "Driver registration failed\n");
Ralf Baechledcbf8472005-10-10 14:51:27 +0100335
Ralf Baechledcbf8472005-10-10 14:51:27 +0100336 return err;
337}
338
339static void __exit mipsnet_exit_module(void)
340{
Ming Lei7a192ec2009-02-06 23:40:12 +0800341 platform_driver_unregister(&mipsnet_driver);
Ralf Baechledcbf8472005-10-10 14:51:27 +0100342}
343
344module_init(mipsnet_init_module);
345module_exit(mipsnet_exit_module);