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>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/netdevice.h>
12 #include <linux/etherdevice.h>
13 #include <linux/platform_device.h>
14 #include <asm/mips-boards/simint.h>
16 #define MIPSNET_VERSION "2007-11-17"
19 * Net status/control block as seen by sw in the core.
23 * Device info for probing, reads as MIPSNET%d where %d is some
29 * read only busy flag.
30 * Set and cleared by the Net Device to indicate that an rx or a tx
36 * Set by the Net Device.
37 * The device will set it once data has been received.
38 * The value is the number of bytes that should be read from
39 * rxDataBuffer. The value will decrease till 0 until all the data
40 * from rxDataBuffer has been read.
42 u32 rxDataCount; /*0x0c */
43 #define MIPSNET_MAX_RXTX_DATACOUNT (1 << 16)
46 * Settable from the MIPS core, cleared by the Net Device.
47 * The core should set the number of bytes it wants to send,
48 * then it should write those bytes of data to txDataBuffer.
49 * The device will clear txDataCount has been processed (not
52 u32 txDataCount; /*0x10 */
57 * Used to clear the interrupted generated by this dev.
58 * Write a 1 to clear the interrupt. (except bit31).
60 * Bit0 is set if it was a tx-done interrupt.
61 * Bit1 is set when new rx-data is available.
62 * Until this bit is cleared there will be no other RXs.
64 * Bit31 is used for testing, it clears after a read.
65 * Writing 1 to this bit will cause an interrupt to be generated.
66 * To clear the test interrupt, write 0 to this register.
68 u32 interruptControl; /*0x14 */
69 #define MIPSNET_INTCTL_TXDONE (1u << 0)
70 #define MIPSNET_INTCTL_RXDONE (1u << 1)
71 #define MIPSNET_INTCTL_TESTBIT (1u << 31)
74 * Readonly core-specific interrupt info for the device to signal
75 * the core. The meaning of the contents of this field might change.
77 /* XXX: the whole memIntf interrupt scheme is messy: the device
78 * should have no control what so ever of what VPE/register set is
80 * The MemIntf should only expose interrupt lines, and something in
81 * the config should be responsible for the line<->core/vpe bindings.
83 u32 interruptInfo; /*0x18 */
86 * This is where the received data is read out.
87 * There is more data to read until rxDataReady is 0.
88 * Only 1 byte at this regs offset is used.
90 u32 rxDataBuffer; /*0x1c */
93 * This is where the data to transmit is written.
94 * Data should be written for the amount specified in the
95 * txDataCount register.
96 * Only 1 byte at this regs offset is used.
98 u32 txDataBuffer; /*0x20 */
101 #define regaddr(dev, field) \
102 (dev->base_addr + offsetof(struct mipsnet_regs, field))
104 static char mipsnet_string[] = "mipsnet";
107 * Copy data from the MIPSNET rx data port
109 static int ioiocpy_frommipsnet(struct net_device *dev, unsigned char *kdata,
112 for (; len > 0; len--, kdata++)
113 *kdata = inb(regaddr(dev, rxDataBuffer));
115 return inl(regaddr(dev, rxDataCount));
118 static inline void mipsnet_put_todevice(struct net_device *dev,
121 int count_to_go = skb->len;
122 char *buf_ptr = skb->data;
124 outl(skb->len, regaddr(dev, txDataCount));
126 for (; count_to_go; buf_ptr++, count_to_go--)
127 outb(*buf_ptr, regaddr(dev, txDataBuffer));
129 dev->stats.tx_packets++;
130 dev->stats.tx_bytes += skb->len;
135 static int mipsnet_xmit(struct sk_buff *skb, struct net_device *dev)
138 * Only one packet at a time. Once TXDONE interrupt is serviced, the
139 * queue will be restarted.
141 netif_stop_queue(dev);
142 mipsnet_put_todevice(dev, skb);
147 static inline ssize_t mipsnet_get_fromdev(struct net_device *dev, size_t len)
154 skb = dev_alloc_skb(len + NET_IP_ALIGN);
156 dev->stats.rx_dropped++;
160 skb_reserve(skb, NET_IP_ALIGN);
161 if (ioiocpy_frommipsnet(dev, skb_put(skb, len), len))
164 skb->protocol = eth_type_trans(skb, dev);
165 skb->ip_summed = CHECKSUM_UNNECESSARY;
169 dev->stats.rx_packets++;
170 dev->stats.rx_bytes += len;
175 static irqreturn_t mipsnet_interrupt(int irq, void *dev_id)
177 struct net_device *dev = dev_id;
179 irqreturn_t ret = IRQ_NONE;
184 /* TESTBIT is cleared on read. */
185 int_flags = inl(regaddr(dev, interruptControl));
186 if (int_flags & MIPSNET_INTCTL_TESTBIT) {
187 /* TESTBIT takes effect after a write with 0. */
188 outl(0, regaddr(dev, interruptControl));
190 } else if (int_flags & MIPSNET_INTCTL_TXDONE) {
191 /* Only one packet at a time, we are done. */
192 dev->stats.tx_packets++;
193 netif_wake_queue(dev);
194 outl(MIPSNET_INTCTL_TXDONE,
195 regaddr(dev, interruptControl));
197 } else if (int_flags & MIPSNET_INTCTL_RXDONE) {
198 mipsnet_get_fromdev(dev, inl(regaddr(dev, rxDataCount)));
199 outl(MIPSNET_INTCTL_RXDONE, regaddr(dev, interruptControl));
205 printk(KERN_INFO "%s: %s(): irq %d for unknown device\n",
206 dev->name, __func__, irq);
210 static int mipsnet_open(struct net_device *dev)
214 err = request_irq(dev->irq, &mipsnet_interrupt,
215 IRQF_SHARED, dev->name, (void *) dev);
217 release_region(dev->base_addr, sizeof(struct mipsnet_regs));
221 netif_start_queue(dev);
223 /* test interrupt handler */
224 outl(MIPSNET_INTCTL_TESTBIT, regaddr(dev, interruptControl));
229 static int mipsnet_close(struct net_device *dev)
231 netif_stop_queue(dev);
232 free_irq(dev->irq, dev);
236 static void mipsnet_set_mclist(struct net_device *dev)
240 static const struct net_device_ops mipsnet_netdev_ops = {
241 .ndo_open = mipsnet_open,
242 .ndo_stop = mipsnet_close,
243 .ndo_start_xmit = mipsnet_xmit,
244 .ndo_set_multicast_list = mipsnet_set_mclist,
245 .ndo_change_mtu = eth_change_mtu,
246 .ndo_validate_addr = eth_validate_addr,
247 .ndo_set_mac_address = eth_mac_addr,
250 static int __init mipsnet_probe(struct platform_device *dev)
252 struct net_device *netdev;
255 netdev = alloc_etherdev(0);
261 platform_set_drvdata(dev, netdev);
263 netdev->netdev_ops = &mipsnet_netdev_ops;
266 * TODO: probe for these or load them from PARAM
268 netdev->base_addr = 0x4200;
269 netdev->irq = MIPS_CPU_IRQ_BASE + MIPSCPU_INT_MB0 +
270 inl(regaddr(netdev, interruptInfo));
272 /* Get the io region now, get irq on open() */
273 if (!request_region(netdev->base_addr, sizeof(struct mipsnet_regs),
276 goto out_free_netdev;
280 * Lacking any better mechanism to allocate a MAC address we use a
283 random_ether_addr(netdev->dev_addr);
285 err = register_netdev(netdev);
287 printk(KERN_ERR "MIPSNet: failed to register netdev.\n");
288 goto out_free_region;
294 release_region(netdev->base_addr, sizeof(struct mipsnet_regs));
303 static int __devexit mipsnet_device_remove(struct platform_device *device)
305 struct net_device *dev = platform_get_drvdata(device);
307 unregister_netdev(dev);
308 release_region(dev->base_addr, sizeof(struct mipsnet_regs));
310 platform_set_drvdata(device, NULL);
315 static struct platform_driver mipsnet_driver = {
317 .name = mipsnet_string,
318 .owner = THIS_MODULE,
320 .probe = mipsnet_probe,
321 .remove = __devexit_p(mipsnet_device_remove),
324 static int __init mipsnet_init_module(void)
328 printk(KERN_INFO "MIPSNet Ethernet driver. Version: %s. "
329 "(c)2005 MIPS Technologies, Inc.\n", MIPSNET_VERSION);
331 err = platform_driver_register(&mipsnet_driver);
333 printk(KERN_ERR "Driver registration failed\n");
338 static void __exit mipsnet_exit_module(void)
340 platform_driver_unregister(&mipsnet_driver);
343 module_init(mipsnet_init_module);
344 module_exit(mipsnet_exit_module);