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
7 #include <linux/init.h>
8 #include <linux/interrupt.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/netdevice.h>
13 #include <linux/etherdevice.h>
14 #include <linux/platform_device.h>
15 #include <asm/mips-boards/simint.h>
17 #define MIPSNET_VERSION "2007-11-17"
20 * Net status/control block as seen by sw in the core.
24 * Device info for probing, reads as MIPSNET%d where %d is some
30 * read only busy flag.
31 * Set and cleared by the Net Device to indicate that an rx or a tx
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.
43 u32 rxDataCount; /*0x0c */
44 #define MIPSNET_MAX_RXTX_DATACOUNT (1 << 16)
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
53 u32 txDataCount; /*0x10 */
58 * Used to clear the interrupted generated by this dev.
59 * Write a 1 to clear the interrupt. (except bit31).
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.
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.
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)
75 * Readonly core-specific interrupt info for the device to signal
76 * the core. The meaning of the contents of this field might change.
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
81 * The MemIntf should only expose interrupt lines, and something in
82 * the config should be responsible for the line<->core/vpe bindings.
84 u32 interruptInfo; /*0x18 */
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.
91 u32 rxDataBuffer; /*0x1c */
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.
99 u32 txDataBuffer; /*0x20 */
102 #define regaddr(dev, field) \
103 (dev->base_addr + offsetof(struct mipsnet_regs, field))
105 static char mipsnet_string[] = "mipsnet";
108 * Copy data from the MIPSNET rx data port
110 static int ioiocpy_frommipsnet(struct net_device *dev, unsigned char *kdata,
113 for (; len > 0; len--, kdata++)
114 *kdata = inb(regaddr(dev, rxDataBuffer));
116 return inl(regaddr(dev, rxDataCount));
119 static inline void mipsnet_put_todevice(struct net_device *dev,
122 int count_to_go = skb->len;
123 char *buf_ptr = skb->data;
125 outl(skb->len, regaddr(dev, txDataCount));
127 for (; count_to_go; buf_ptr++, count_to_go--)
128 outb(*buf_ptr, regaddr(dev, txDataBuffer));
130 dev->stats.tx_packets++;
131 dev->stats.tx_bytes += skb->len;
136 static int mipsnet_xmit(struct sk_buff *skb, struct net_device *dev)
139 * Only one packet at a time. Once TXDONE interrupt is serviced, the
140 * queue will be restarted.
142 netif_stop_queue(dev);
143 mipsnet_put_todevice(dev, skb);
148 static inline ssize_t mipsnet_get_fromdev(struct net_device *dev, size_t len)
155 skb = netdev_alloc_skb(dev, len + NET_IP_ALIGN);
157 dev->stats.rx_dropped++;
161 skb_reserve(skb, NET_IP_ALIGN);
162 if (ioiocpy_frommipsnet(dev, skb_put(skb, len), len))
165 skb->protocol = eth_type_trans(skb, dev);
166 skb->ip_summed = CHECKSUM_UNNECESSARY;
170 dev->stats.rx_packets++;
171 dev->stats.rx_bytes += len;
176 static irqreturn_t mipsnet_interrupt(int irq, void *dev_id)
178 struct net_device *dev = dev_id;
180 irqreturn_t ret = IRQ_NONE;
185 /* 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));
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));
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));
206 printk(KERN_INFO "%s: %s(): irq %d for unknown device\n",
207 dev->name, __func__, irq);
211 static int mipsnet_open(struct net_device *dev)
215 err = request_irq(dev->irq, mipsnet_interrupt,
216 IRQF_SHARED, dev->name, (void *) dev);
218 release_region(dev->base_addr, sizeof(struct mipsnet_regs));
222 netif_start_queue(dev);
224 /* test interrupt handler */
225 outl(MIPSNET_INTCTL_TESTBIT, regaddr(dev, interruptControl));
230 static int mipsnet_close(struct net_device *dev)
232 netif_stop_queue(dev);
233 free_irq(dev->irq, dev);
237 static void mipsnet_set_mclist(struct net_device *dev)
241 static const struct net_device_ops mipsnet_netdev_ops = {
242 .ndo_open = mipsnet_open,
243 .ndo_stop = mipsnet_close,
244 .ndo_start_xmit = mipsnet_xmit,
245 .ndo_set_rx_mode = mipsnet_set_mclist,
246 .ndo_change_mtu = eth_change_mtu,
247 .ndo_validate_addr = eth_validate_addr,
248 .ndo_set_mac_address = eth_mac_addr,
251 static int __devinit mipsnet_probe(struct platform_device *dev)
253 struct net_device *netdev;
256 netdev = alloc_etherdev(0);
262 platform_set_drvdata(dev, netdev);
264 netdev->netdev_ops = &mipsnet_netdev_ops;
267 * TODO: probe for these or load them from PARAM
269 netdev->base_addr = 0x4200;
270 netdev->irq = MIPS_CPU_IRQ_BASE + MIPSCPU_INT_MB0 +
271 inl(regaddr(netdev, interruptInfo));
273 /* Get the io region now, get irq on open() */
274 if (!request_region(netdev->base_addr, sizeof(struct mipsnet_regs),
277 goto out_free_netdev;
281 * Lacking any better mechanism to allocate a MAC address we use a
284 random_ether_addr(netdev->dev_addr);
286 err = register_netdev(netdev);
288 printk(KERN_ERR "MIPSNet: failed to register netdev.\n");
289 goto out_free_region;
295 release_region(netdev->base_addr, sizeof(struct mipsnet_regs));
304 static int __devexit mipsnet_device_remove(struct platform_device *device)
306 struct net_device *dev = platform_get_drvdata(device);
308 unregister_netdev(dev);
309 release_region(dev->base_addr, sizeof(struct mipsnet_regs));
311 platform_set_drvdata(device, NULL);
316 static struct platform_driver mipsnet_driver = {
318 .name = mipsnet_string,
319 .owner = THIS_MODULE,
321 .probe = mipsnet_probe,
322 .remove = __devexit_p(mipsnet_device_remove),
325 static int __init mipsnet_init_module(void)
329 printk(KERN_INFO "MIPSNet Ethernet driver. Version: %s. "
330 "(c)2005 MIPS Technologies, Inc.\n", MIPSNET_VERSION);
332 err = platform_driver_register(&mipsnet_driver);
334 printk(KERN_ERR "Driver registration failed\n");
339 static void __exit mipsnet_exit_module(void)
341 platform_driver_unregister(&mipsnet_driver);
344 module_init(mipsnet_init_module);
345 module_exit(mipsnet_exit_module);