2 * Copyright (C) 2001 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
3 * Copyright (C) 2001 Lennert Buytenhek (buytenh@gnu.org) and
4 * James Leu (jleu@mindspring.net).
5 * Copyright (C) 2001 by various other people who didn't put their name here.
6 * Licensed under the GPL.
9 #include <linux/bootmem.h>
10 #include <linux/etherdevice.h>
11 #include <linux/ethtool.h>
12 #include <linux/inetdevice.h>
13 #include <linux/init.h>
14 #include <linux/list.h>
15 #include <linux/netdevice.h>
16 #include <linux/platform_device.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/slab.h>
20 #include <linux/spinlock.h>
24 #include "mconsole_kern.h"
28 #define DRIVER_NAME "uml-netdev"
30 static DEFINE_SPINLOCK(opened_lock);
31 static LIST_HEAD(opened);
34 * The drop_skb is used when we can't allocate an skb. The
35 * packet is read into drop_skb in order to get the data off the
36 * connection to the host.
37 * It is reallocated whenever a maximum packet size is seen which is
38 * larger than any seen before. update_drop_skb is called from
39 * eth_configure when a new interface is added.
41 static DEFINE_SPINLOCK(drop_lock);
42 static struct sk_buff *drop_skb;
45 static int update_drop_skb(int max)
51 spin_lock_irqsave(&drop_lock, flags);
57 new = dev_alloc_skb(max);
68 spin_unlock_irqrestore(&drop_lock, flags);
73 static int uml_net_rx(struct net_device *dev)
75 struct uml_net_private *lp = netdev_priv(dev);
79 /* If we can't allocate memory, try again next round. */
80 skb = dev_alloc_skb(lp->max_packet);
83 /* Read a packet into drop_skb and don't do anything with it. */
84 (*lp->read)(lp->fd, drop_skb, lp);
85 dev->stats.rx_dropped++;
90 skb_put(skb, lp->max_packet);
91 skb_reset_mac_header(skb);
92 pkt_len = (*lp->read)(lp->fd, skb, lp);
95 skb_trim(skb, pkt_len);
96 skb->protocol = (*lp->protocol)(skb);
98 dev->stats.rx_bytes += skb->len;
99 dev->stats.rx_packets++;
108 static void uml_dev_close(struct work_struct *work)
110 struct uml_net_private *lp =
111 container_of(work, struct uml_net_private, work);
115 static irqreturn_t uml_net_interrupt(int irq, void *dev_id)
117 struct net_device *dev = dev_id;
118 struct uml_net_private *lp = netdev_priv(dev);
121 if (!netif_running(dev))
124 spin_lock(&lp->lock);
125 while ((err = uml_net_rx(dev)) > 0) ;
128 "Device '%s' read returned %d, shutting it down\n",
130 /* dev_close can't be called in interrupt context, and takes
132 * And dev_close() can be safely called multiple times on the
133 * same device, since it tests for (dev->flags & IFF_UP). So
134 * there's no harm in delaying the device shutdown.
135 * Furthermore, the workqueue will not re-enqueue an already
136 * enqueued work item. */
137 schedule_work(&lp->work);
140 reactivate_fd(lp->fd, UM_ETH_IRQ);
143 spin_unlock(&lp->lock);
147 static int uml_net_open(struct net_device *dev)
149 struct uml_net_private *lp = netdev_priv(dev);
157 lp->fd = (*lp->open)(&lp->user);
163 err = um_request_irq(dev->irq, lp->fd, IRQ_READ, uml_net_interrupt,
164 IRQF_SHARED, dev->name, dev);
166 printk(KERN_ERR "uml_net_open: failed to get irq(%d)\n", err);
171 lp->tl.data = (unsigned long) &lp->user;
172 netif_start_queue(dev);
174 /* clear buffer - it can happen that the host side of the interface
175 * is full when we get here. In this case, new data is never queued,
176 * SIGIOs never arrive, and the net never works.
178 while ((err = uml_net_rx(dev)) > 0) ;
180 spin_lock(&opened_lock);
181 list_add(&lp->list, &opened);
182 spin_unlock(&opened_lock);
186 if (lp->close != NULL) (*lp->close)(lp->fd, &lp->user);
192 static int uml_net_close(struct net_device *dev)
194 struct uml_net_private *lp = netdev_priv(dev);
196 netif_stop_queue(dev);
198 um_free_irq(dev->irq, dev);
199 if (lp->close != NULL)
200 (*lp->close)(lp->fd, &lp->user);
203 spin_lock(&opened_lock);
205 spin_unlock(&opened_lock);
210 static int uml_net_start_xmit(struct sk_buff *skb, struct net_device *dev)
212 struct uml_net_private *lp = netdev_priv(dev);
216 netif_stop_queue(dev);
218 spin_lock_irqsave(&lp->lock, flags);
220 len = (*lp->write)(lp->fd, skb, lp);
222 if (len == skb->len) {
223 dev->stats.tx_packets++;
224 dev->stats.tx_bytes += skb->len;
225 dev->trans_start = jiffies;
226 netif_start_queue(dev);
228 /* this is normally done in the interrupt when tx finishes */
229 netif_wake_queue(dev);
232 netif_start_queue(dev);
233 dev->stats.tx_dropped++;
236 netif_start_queue(dev);
237 printk(KERN_ERR "uml_net_start_xmit: failed(%d)\n", len);
240 spin_unlock_irqrestore(&lp->lock, flags);
247 static void uml_net_set_multicast_list(struct net_device *dev)
252 static void uml_net_tx_timeout(struct net_device *dev)
254 dev->trans_start = jiffies;
255 netif_wake_queue(dev);
258 static int uml_net_change_mtu(struct net_device *dev, int new_mtu)
265 #ifdef CONFIG_NET_POLL_CONTROLLER
266 static void uml_net_poll_controller(struct net_device *dev)
268 disable_irq(dev->irq);
269 uml_net_interrupt(dev->irq, dev);
270 enable_irq(dev->irq);
274 static void uml_net_get_drvinfo(struct net_device *dev,
275 struct ethtool_drvinfo *info)
277 strcpy(info->driver, DRIVER_NAME);
278 strcpy(info->version, "42");
281 static const struct ethtool_ops uml_net_ethtool_ops = {
282 .get_drvinfo = uml_net_get_drvinfo,
283 .get_link = ethtool_op_get_link,
286 static void uml_net_user_timer_expire(unsigned long _conn)
289 struct connection *conn = (struct connection *)_conn;
291 dprintk(KERN_INFO "uml_net_user_timer_expire [%p]\n", conn);
296 static int setup_etheraddr(char *str, unsigned char *addr, char *name)
304 for (i = 0; i < 6; i++) {
305 addr[i] = simple_strtoul(str, &end, 16);
307 ((*end != ':') && (*end != ',') && (*end != '\0'))) {
309 "setup_etheraddr: failed to parse '%s' "
310 "as an ethernet address\n", str);
315 if (is_multicast_ether_addr(addr)) {
317 "Attempt to assign a multicast ethernet address to a "
318 "device disallowed\n");
321 if (!is_valid_ether_addr(addr)) {
323 "Attempt to assign an invalid ethernet address to a "
324 "device disallowed\n");
327 if (!is_local_ether_addr(addr)) {
329 "Warning: Assigning a globally valid ethernet "
330 "address to a device\n");
331 printk(KERN_WARNING "You should set the 2nd rightmost bit in "
332 "the first byte of the MAC,\n");
333 printk(KERN_WARNING "i.e. %02x:%02x:%02x:%02x:%02x:%02x\n",
334 addr[0] | 0x02, addr[1], addr[2], addr[3], addr[4],
341 "Choosing a random ethernet address for device %s\n", name);
342 eth_random_addr(addr);
346 static DEFINE_SPINLOCK(devices_lock);
347 static LIST_HEAD(devices);
349 static struct platform_driver uml_net_driver = {
355 static void net_device_release(struct device *dev)
357 struct uml_net *device = dev_get_drvdata(dev);
358 struct net_device *netdev = device->dev;
359 struct uml_net_private *lp = netdev_priv(netdev);
361 if (lp->remove != NULL)
362 (*lp->remove)(&lp->user);
363 list_del(&device->list);
368 static const struct net_device_ops uml_netdev_ops = {
369 .ndo_open = uml_net_open,
370 .ndo_stop = uml_net_close,
371 .ndo_start_xmit = uml_net_start_xmit,
372 .ndo_set_rx_mode = uml_net_set_multicast_list,
373 .ndo_tx_timeout = uml_net_tx_timeout,
374 .ndo_set_mac_address = eth_mac_addr,
375 .ndo_change_mtu = uml_net_change_mtu,
376 .ndo_validate_addr = eth_validate_addr,
377 #ifdef CONFIG_NET_POLL_CONTROLLER
378 .ndo_poll_controller = uml_net_poll_controller,
383 * Ensures that platform_driver_register is called only once by
384 * eth_configure. Will be set in an initcall.
386 static int driver_registered;
388 static void eth_configure(int n, void *init, char *mac,
389 struct transport *transport)
391 struct uml_net *device;
392 struct net_device *dev;
393 struct uml_net_private *lp;
397 size = transport->private_size + sizeof(struct uml_net_private);
399 device = kzalloc(sizeof(*device), GFP_KERNEL);
400 if (device == NULL) {
401 printk(KERN_ERR "eth_configure failed to allocate struct "
406 dev = alloc_etherdev(size);
408 printk(KERN_ERR "eth_configure: failed to allocate struct "
409 "net_device for eth%d\n", n);
410 goto out_free_device;
413 INIT_LIST_HEAD(&device->list);
416 /* If this name ends up conflicting with an existing registered
417 * netdevice, that is OK, register_netdev{,ice}() will notice this
420 snprintf(dev->name, sizeof(dev->name), "eth%d", n);
422 random_mac = setup_etheraddr(mac, device->mac, dev->name);
424 printk(KERN_INFO "Netdevice %d (%pM) : ", n, device->mac);
426 lp = netdev_priv(dev);
427 /* This points to the transport private data. It's still clear, but we
428 * must memset it to 0 *now*. Let's help the drivers. */
430 INIT_WORK(&lp->work, uml_dev_close);
433 if (!driver_registered) {
434 platform_driver_register(¨_net_driver);
435 driver_registered = 1;
438 device->pdev.name = DRIVER_NAME;
439 device->pdev.dev.release = net_device_release;
440 dev_set_drvdata(&device->pdev.dev, device);
441 if (platform_device_register(&device->pdev))
442 goto out_free_netdev;
443 SET_NETDEV_DEV(dev,&device->pdev.dev);
448 * These just fill in a data structure, so there's no failure
449 * to be worried about.
451 (*transport->kern->init)(dev, init);
453 *lp = ((struct uml_net_private)
454 { .list = LIST_HEAD_INIT(lp->list),
457 .mac = { 0xfe, 0xfd, 0x0, 0x0, 0x0, 0x0},
458 .max_packet = transport->user->max_packet,
459 .protocol = transport->kern->protocol,
460 .open = transport->user->open,
461 .close = transport->user->close,
462 .remove = transport->user->remove,
463 .read = transport->kern->read,
464 .write = transport->kern->write,
465 .add_address = transport->user->add_address,
466 .delete_address = transport->user->delete_address });
469 spin_lock_init(&lp->lock);
470 lp->tl.function = uml_net_user_timer_expire;
471 memcpy(lp->mac, device->mac, sizeof(lp->mac));
473 if ((transport->user->init != NULL) &&
474 ((*transport->user->init)(&lp->user, dev) != 0))
477 /* don't use eth_mac_addr, it will not work here */
478 memcpy(dev->dev_addr, device->mac, ETH_ALEN);
480 dev->addr_assign_type |= NET_ADDR_RANDOM;
482 dev->mtu = transport->user->mtu;
483 dev->netdev_ops = ¨_netdev_ops;
484 dev->ethtool_ops = ¨_net_ethtool_ops;
485 dev->watchdog_timeo = (HZ >> 1);
486 dev->irq = UM_ETH_IRQ;
488 err = update_drop_skb(lp->max_packet);
490 goto out_undo_user_init;
493 err = register_netdevice(dev);
496 goto out_undo_user_init;
498 spin_lock(&devices_lock);
499 list_add(&device->list, &devices);
500 spin_unlock(&devices_lock);
505 if (transport->user->remove != NULL)
506 (*transport->user->remove)(&lp->user);
508 platform_device_unregister(&device->pdev);
509 return; /* platform_device_unregister frees dev and device */
516 static struct uml_net *find_device(int n)
518 struct uml_net *device;
519 struct list_head *ele;
521 spin_lock(&devices_lock);
522 list_for_each(ele, &devices) {
523 device = list_entry(ele, struct uml_net, list);
524 if (device->index == n)
529 spin_unlock(&devices_lock);
533 static int eth_parse(char *str, int *index_out, char **str_out,
537 int n, err = -EINVAL;
539 n = simple_strtoul(str, &end, 0);
541 *error_out = "Bad device number";
547 *error_out = "Expected '=' after device number";
552 if (find_device(n)) {
553 *error_out = "Device already configured";
563 struct list_head list;
568 static DEFINE_SPINLOCK(transports_lock);
569 static LIST_HEAD(transports);
571 /* Filled in during early boot */
572 static LIST_HEAD(eth_cmd_line);
574 static int check_transport(struct transport *transport, char *eth, int n,
575 void **init_out, char **mac_out)
579 len = strlen(transport->name);
580 if (strncmp(eth, transport->name, len))
586 else if (*eth != '\0')
589 *init_out = kmalloc(transport->setup_size, GFP_KERNEL);
590 if (*init_out == NULL)
593 if (!transport->setup(eth, mac_out, *init_out)) {
600 void register_transport(struct transport *new)
602 struct list_head *ele, *next;
603 struct eth_init *eth;
608 spin_lock(&transports_lock);
609 BUG_ON(!list_empty(&new->list));
610 list_add(&new->list, &transports);
611 spin_unlock(&transports_lock);
613 list_for_each_safe(ele, next, ð_cmd_line) {
614 eth = list_entry(ele, struct eth_init, list);
615 match = check_transport(new, eth->init, eth->index, &init,
619 else if (init != NULL) {
620 eth_configure(eth->index, init, mac, new);
623 list_del(ð->list);
627 static int eth_setup_common(char *str, int index)
629 struct list_head *ele;
630 struct transport *transport;
635 spin_lock(&transports_lock);
636 list_for_each(ele, &transports) {
637 transport = list_entry(ele, struct transport, list);
638 if (!check_transport(transport, str, index, &init, &mac))
641 eth_configure(index, init, mac, transport);
648 spin_unlock(&transports_lock);
652 static int __init eth_setup(char *str)
654 struct eth_init *new;
658 err = eth_parse(str, &n, &str, &error);
660 printk(KERN_ERR "eth_setup - Couldn't parse '%s' : %s\n",
665 new = alloc_bootmem(sizeof(*new));
667 printk(KERN_ERR "eth_init : alloc_bootmem failed\n");
671 INIT_LIST_HEAD(&new->list);
675 list_add_tail(&new->list, ð_cmd_line);
679 __setup("eth", eth_setup);
680 __uml_help(eth_setup,
681 "eth[0-9]+=<transport>,<options>\n"
682 " Configure a network device.\n\n"
685 static int net_config(char *str, char **error_out)
689 err = eth_parse(str, &n, &str, error_out);
693 /* This string is broken up and the pieces used by the underlying
694 * driver. So, it is freed only if eth_setup_common fails.
696 str = kstrdup(str, GFP_KERNEL);
698 *error_out = "net_config failed to strdup string";
701 err = !eth_setup_common(str, n);
707 static int net_id(char **str, int *start_out, int *end_out)
712 n = simple_strtoul(*str, &end, 0);
713 if ((*end != '\0') || (end == *str))
722 static int net_remove(int n, char **error_out)
724 struct uml_net *device;
725 struct net_device *dev;
726 struct uml_net_private *lp;
728 device = find_device(n);
733 lp = netdev_priv(dev);
736 unregister_netdev(dev);
737 platform_device_unregister(&device->pdev);
742 static struct mc_device net_mc = {
743 .list = LIST_HEAD_INIT(net_mc.list),
745 .config = net_config,
748 .remove = net_remove,
752 static int uml_inetaddr_event(struct notifier_block *this, unsigned long event,
755 struct in_ifaddr *ifa = ptr;
756 struct net_device *dev = ifa->ifa_dev->dev;
757 struct uml_net_private *lp;
758 void (*proc)(unsigned char *, unsigned char *, void *);
759 unsigned char addr_buf[4], netmask_buf[4];
761 if (dev->netdev_ops->ndo_open != uml_net_open)
764 lp = netdev_priv(dev);
769 proc = lp->add_address;
772 proc = lp->delete_address;
776 memcpy(addr_buf, &ifa->ifa_address, sizeof(addr_buf));
777 memcpy(netmask_buf, &ifa->ifa_mask, sizeof(netmask_buf));
778 (*proc)(addr_buf, netmask_buf, &lp->user);
783 /* uml_net_init shouldn't be called twice on two CPUs at the same time */
784 static struct notifier_block uml_inetaddr_notifier = {
785 .notifier_call = uml_inetaddr_event,
788 static void inet_register(void)
790 struct list_head *ele;
791 struct uml_net_private *lp;
792 struct in_device *ip;
793 struct in_ifaddr *in;
795 register_inetaddr_notifier(¨_inetaddr_notifier);
797 /* Devices may have been opened already, so the uml_inetaddr_notifier
798 * didn't get a chance to run for them. This fakes it so that
799 * addresses which have already been set up get handled properly.
801 spin_lock(&opened_lock);
802 list_for_each(ele, &opened) {
803 lp = list_entry(ele, struct uml_net_private, list);
804 ip = lp->dev->ip_ptr;
809 uml_inetaddr_event(NULL, NETDEV_UP, in);
813 spin_unlock(&opened_lock);
816 static inline void inet_register(void)
821 static int uml_net_init(void)
823 mconsole_register_dev(&net_mc);
828 __initcall(uml_net_init);
830 static void close_devices(void)
832 struct list_head *ele;
833 struct uml_net_private *lp;
835 spin_lock(&opened_lock);
836 list_for_each(ele, &opened) {
837 lp = list_entry(ele, struct uml_net_private, list);
838 um_free_irq(lp->dev->irq, lp->dev);
839 if ((lp->close != NULL) && (lp->fd >= 0))
840 (*lp->close)(lp->fd, &lp->user);
841 if (lp->remove != NULL)
842 (*lp->remove)(&lp->user);
844 spin_unlock(&opened_lock);
847 __uml_exitcall(close_devices);
849 void iter_addresses(void *d, void (*cb)(unsigned char *, unsigned char *,
853 struct net_device *dev = d;
854 struct in_device *ip = dev->ip_ptr;
855 struct in_ifaddr *in;
856 unsigned char address[4], netmask[4];
858 if (ip == NULL) return;
861 memcpy(address, &in->ifa_address, sizeof(address));
862 memcpy(netmask, &in->ifa_mask, sizeof(netmask));
863 (*cb)(address, netmask, arg);
868 int dev_netmask(void *d, void *m)
870 struct net_device *dev = d;
871 struct in_device *ip = dev->ip_ptr;
872 struct in_ifaddr *in;
873 __be32 *mask_out = m;
882 *mask_out = in->ifa_mask;
886 void *get_output_buffer(int *len_out)
890 ret = (void *) __get_free_pages(GFP_KERNEL, 0);
891 if (ret) *len_out = PAGE_SIZE;
896 void free_output_buffer(void *buffer)
898 free_pages((unsigned long) buffer, 0);
901 int tap_setup_common(char *str, char *type, char **dev_name, char **mac_out,
906 remain = split_if_spec(str, dev_name, mac_out, gate_addr, NULL);
907 if (remain != NULL) {
908 printk(KERN_ERR "tap_setup_common - Extra garbage on "
909 "specification : '%s'\n", remain);
916 unsigned short eth_protocol(struct sk_buff *skb)
918 return eth_type_trans(skb, skb->dev);