1 /*****************************************************************************
2 * wanmain.c WAN Multiprotocol Router Module. Main code.
4 * This module is completely hardware-independent and provides
5 * the following common services for the WAN Link Drivers:
6 * o WAN device management (registering, unregistering)
7 * o Network interface management
8 * o Physical connection management (dial-up, incoming calls)
9 * o Logical connection management (switched virtual circuits)
10 * o Protocol encapsulation/decapsulation
14 * Copyright: (c) 1995-1999 Sangoma Technologies Inc.
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License
18 * as published by the Free Software Foundation; either version
19 * 2 of the License, or (at your option) any later version.
20 * ============================================================================
21 * Nov 24, 2000 Nenad Corbic Updated for 2.4.X kernels
22 * Nov 07, 2000 Nenad Corbic Fixed the Mulit-Port PPP for kernels 2.2.16 and
24 * Aug 2, 2000 Nenad Corbic Block the Multi-Port PPP from running on
25 * kernels 2.2.16 or greater. The SyncPPP
27 * Jul 13, 2000 Nenad Corbic Added SyncPPP support
28 * Added extra debugging in device_setup().
29 * Oct 01, 1999 Gideon Hack Update for s514 PCI card
30 * Dec 27, 1996 Gene Kozin Initial version (based on Sangoma's WANPIPE)
31 * Jan 16, 1997 Gene Kozin router_devlist made public
32 * Jan 31, 1997 Alan Cox Hacked it about a bit for 2.1
33 * Jun 27, 1997 Alan Cox realigned with vendor code
34 * Oct 15, 1997 Farhan Thawar changed wan_encapsulate to add a pad byte of 0
35 * Apr 20, 1998 Alan Cox Fixed 2.1 symbols
36 * May 17, 1998 K. Baranowski Fixed SNAP encapsulation in wan_encapsulate
37 * Dec 15, 1998 Arnaldo Melo support for firmwares of up to 128000 bytes
38 * check wandev->setup return value
39 * Dec 22, 1998 Arnaldo Melo vmalloc/vfree used in device_setup to allocate
40 * kernel memory and copy configuration data to
41 * kernel space (for big firmwares)
42 * Jun 02, 1999 Gideon Hack Updates for Linux 2.0.X and 2.2.X kernels.
43 *****************************************************************************/
45 #include <linux/stddef.h> /* offsetof(), etc. */
46 #include <linux/capability.h>
47 #include <linux/errno.h> /* return codes */
48 #include <linux/kernel.h>
49 #include <linux/module.h> /* support for loadable modules */
50 #include <linux/slab.h> /* kmalloc(), kfree() */
52 #include <linux/string.h> /* inline mem*, str* functions */
54 #include <asm/byteorder.h> /* htons(), etc. */
55 #include <linux/wanrouter.h> /* WAN router API definitions */
57 #include <linux/vmalloc.h> /* vmalloc, vfree */
58 #include <asm/uaccess.h> /* copy_to/from_user */
59 #include <linux/init.h> /* __initfunc et al. */
60 #include <net/syncppp.h>
62 #define KMEM_SAFETYZONE 8
69 * WAN device IOCTL handlers
72 static int wanrouter_device_setup(struct wan_device *wandev,
73 wandev_conf_t __user *u_conf);
74 static int wanrouter_device_stat(struct wan_device *wandev,
75 wandev_stat_t __user *u_stat);
76 static int wanrouter_device_shutdown(struct wan_device *wandev);
77 static int wanrouter_device_new_if(struct wan_device *wandev,
78 wanif_conf_t __user *u_conf);
79 static int wanrouter_device_del_if(struct wan_device *wandev,
86 static struct wan_device *wanrouter_find_device(char *name);
87 static int wanrouter_delete_interface(struct wan_device *wandev, char *name);
88 static void lock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags);
89 static void unlock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags);
97 static char wanrouter_fullname[] = "Sangoma WANPIPE Router";
98 static char wanrouter_copyright[] = "(c) 1995-2000 Sangoma Technologies Inc.";
99 static char wanrouter_modname[] = ROUTER_NAME; /* short module name */
100 struct wan_device* wanrouter_router_devlist; /* list of registered devices */
103 * Organize Unique Identifiers for encapsulation/decapsulation
107 static unsigned char wanrouter_oui_ether[] = { 0x00, 0x00, 0x00 };
108 static unsigned char wanrouter_oui_802_2[] = { 0x00, 0x80, 0xC2 };
111 static int __init wanrouter_init(void)
115 printk(KERN_INFO "%s v%u.%u %s\n",
116 wanrouter_fullname, ROUTER_VERSION, ROUTER_RELEASE,
117 wanrouter_copyright);
119 err = wanrouter_proc_init();
121 printk(KERN_INFO "%s: can't create entry in proc filesystem!\n",
127 static void __exit wanrouter_cleanup (void)
129 wanrouter_proc_cleanup();
133 * This is just plain dumb. We should move the bugger to drivers/net/wan,
134 * slap it first in directory and make it module_init(). The only reason
135 * for subsys_initcall() here is that net goes after drivers (why, BTW?)
137 subsys_initcall(wanrouter_init);
138 module_exit(wanrouter_cleanup);
145 * Register WAN device.
146 * o verify device credentials
147 * o create an entry for the device in the /proc/net/router directory
148 * o initialize internally maintained fields of the wan_device structure
149 * o link device data space to a singly-linked list
150 * o if it's the first device, then start kernel 'thread'
151 * o increment module use count
161 int register_wan_device(struct wan_device *wandev)
165 if ((wandev == NULL) || (wandev->magic != ROUTER_MAGIC) ||
166 (wandev->name == NULL))
169 namelen = strlen(wandev->name);
170 if (!namelen || (namelen > WAN_DRVNAME_SZ))
173 if (wanrouter_find_device(wandev->name))
177 printk(KERN_INFO "%s: registering WAN device %s\n",
178 wanrouter_modname, wandev->name);
182 * Register /proc directory entry
184 err = wanrouter_proc_add(wandev);
187 "%s: can't create /proc/net/router/%s entry!\n",
188 wanrouter_modname, wandev->name);
193 * Initialize fields of the wan_device structure maintained by the
194 * router and update local data.
199 wandev->next = wanrouter_router_devlist;
200 wanrouter_router_devlist = wandev;
205 * Unregister WAN device.
207 * o unlink device data space from the linked list
208 * o delete device entry in the /proc/net/router directory
209 * o decrement module use count
217 int unregister_wan_device(char *name)
219 struct wan_device *wandev, *prev;
224 for (wandev = wanrouter_router_devlist, prev = NULL;
225 wandev && strcmp(wandev->name, name);
226 prev = wandev, wandev = wandev->next)
232 printk(KERN_INFO "%s: unregistering WAN device %s\n",
233 wanrouter_modname, name);
236 if (wandev->state != WAN_UNCONFIGURED)
237 wanrouter_device_shutdown(wandev);
240 prev->next = wandev->next;
242 wanrouter_router_devlist = wandev->next;
244 wanrouter_proc_delete(wandev);
251 * Encapsulate packet.
253 * Return: encapsulation header size
254 * < 0 - unsupported Ethertype
257 * 1. This function may be called on interrupt context.
261 int wanrouter_encapsulate(struct sk_buff *skb, struct net_device *dev,
267 case ETH_P_IP: /* IP datagram encapsulation */
270 skb->data[0] = NLPID_IP;
273 case ETH_P_IPX: /* SNAP encapsulation */
278 skb->data[1] = NLPID_SNAP;
279 skb_copy_to_linear_data_offset(skb, 2, wanrouter_oui_ether,
280 sizeof(wanrouter_oui_ether));
281 *((unsigned short*)&skb->data[5]) = htons(type);
284 default: /* Unknown packet type */
286 "%s: unsupported Ethertype 0x%04X on interface %s!\n",
287 wanrouter_modname, type, dev->name);
295 * Decapsulate packet.
297 * Return: Ethertype (in network order)
298 * 0 unknown encapsulation
301 * 1. This function may be called on interrupt context.
305 __be16 wanrouter_type_trans(struct sk_buff *skb, struct net_device *dev)
307 int cnt = skb->data[0] ? 0 : 1; /* there may be a pad present */
310 switch (skb->data[cnt]) {
311 case NLPID_IP: /* IP datagramm */
312 ethertype = htons(ETH_P_IP);
316 case NLPID_SNAP: /* SNAP encapsulation */
317 if (memcmp(&skb->data[cnt + 1], wanrouter_oui_ether,
318 sizeof(wanrouter_oui_ether))){
320 "%s: unsupported SNAP OUI %02X-%02X-%02X "
321 "on interface %s!\n", wanrouter_modname,
322 skb->data[cnt+1], skb->data[cnt+2],
323 skb->data[cnt+3], dev->name);
326 ethertype = *((__be16*)&skb->data[cnt+4]);
330 /* add other protocols, e.g. CLNP, ESIS, ISIS, if needed */
334 "%s: unsupported NLPID 0x%02X on interface %s!\n",
335 wanrouter_modname, skb->data[cnt], dev->name);
338 skb->protocol = ethertype;
339 skb->pkt_type = PACKET_HOST; /* Physically point to point */
341 skb_reset_mac_header(skb);
349 * o find WAN device associated with this node
350 * o execute requested action or pass command to the device driver
353 long wanrouter_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
355 struct inode *inode = file->f_path.dentry->d_inode;
357 struct proc_dir_entry *dent;
358 struct wan_device *wandev;
359 void __user *data = (void __user *)arg;
361 if (!capable(CAP_NET_ADMIN))
364 if ((cmd >> 8) != ROUTER_IOCTL)
368 if ((dent == NULL) || (dent->data == NULL))
372 if (wandev->magic != ROUTER_MAGIC)
378 err = wanrouter_device_setup(wandev, data);
382 err = wanrouter_device_shutdown(wandev);
386 err = wanrouter_device_stat(wandev, data);
390 err = wanrouter_device_new_if(wandev, data);
394 err = wanrouter_device_del_if(wandev, data);
401 if ((cmd >= ROUTER_USER) &&
402 (cmd <= ROUTER_USER_MAX) &&
404 err = wandev->ioctl(wandev, cmd, arg);
412 * WAN Driver IOCTL Handlers
416 * Setup WAN link device.
417 * o verify user address space
418 * o allocate kernel memory and copy configuration data to kernel space
419 * o if configuration data includes extension, copy it to kernel space too
420 * o call driver's setup() entry point
423 static int wanrouter_device_setup(struct wan_device *wandev,
424 wandev_conf_t __user *u_conf)
430 if (wandev->setup == NULL) { /* Nothing to do ? */
431 printk(KERN_INFO "%s: ERROR, No setup script: wandev->setup()\n",
436 conf = kmalloc(sizeof(wandev_conf_t), GFP_KERNEL);
438 printk(KERN_INFO "%s: ERROR, Failed to allocate kernel memory !\n",
443 if (copy_from_user(conf, u_conf, sizeof(wandev_conf_t))) {
444 printk(KERN_INFO "%s: Failed to copy user config data to kernel space!\n",
450 if (conf->magic != ROUTER_MAGIC) {
452 printk(KERN_INFO "%s: ERROR, Invalid MAGIC Number\n",
457 if (conf->data_size && conf->data) {
458 if (conf->data_size > 128000) {
460 "%s: ERROR, Invalid firmware data size %i !\n",
461 wandev->name, conf->data_size);
466 data = vmalloc(conf->data_size);
469 "%s: ERROR, Faild allocate kernel memory !\n",
474 if (!copy_from_user(data, conf->data, conf->data_size)) {
476 err = wandev->setup(wandev, conf);
479 "%s: ERROR, Faild to copy from user data !\n",
486 "%s: ERROR, No firmware found ! Firmware size = %i !\n",
487 wandev->name, conf->data_size);
495 * Shutdown WAN device.
496 * o delete all not opened logical channels for this device
497 * o call driver's shutdown() entry point
500 static int wanrouter_device_shutdown(struct wan_device *wandev)
502 struct net_device *dev;
505 if (wandev->state == WAN_UNCONFIGURED)
508 printk(KERN_INFO "\n%s: Shutting Down!\n",wandev->name);
510 for (dev = wandev->dev; dev;) {
511 err = wanrouter_delete_interface(wandev, dev->name);
514 /* The above function deallocates the current dev
515 * structure. Therefore, we cannot use dev->priv
516 * as the next element: wandev->dev points to the
522 return -EBUSY; /* there are opened interfaces */
524 if (wandev->shutdown)
525 err=wandev->shutdown(wandev);
531 * Get WAN device status & statistics.
534 static int wanrouter_device_stat(struct wan_device *wandev,
535 wandev_stat_t __user *u_stat)
539 memset(&stat, 0, sizeof(stat));
541 /* Ask device driver to update device statistics */
542 if ((wandev->state != WAN_UNCONFIGURED) && wandev->update)
543 wandev->update(wandev);
545 /* Fill out structure */
546 stat.ndev = wandev->ndev;
547 stat.state = wandev->state;
549 if (copy_to_user(u_stat, &stat, sizeof(stat)))
556 * Create new WAN interface.
557 * o verify user address space
558 * o copy configuration data to kernel address space
559 * o allocate network interface data space
560 * o call driver's new_if() entry point
561 * o make sure there is no interface name conflict
562 * o register network interface
565 static int wanrouter_device_new_if(struct wan_device *wandev,
566 wanif_conf_t __user *u_conf)
569 struct net_device *dev = NULL;
570 #ifdef CONFIG_WANPIPE_MULTPPP
571 struct ppp_device *pppdev=NULL;
575 if ((wandev->state == WAN_UNCONFIGURED) || (wandev->new_if == NULL))
578 cnf = kmalloc(sizeof(wanif_conf_t), GFP_KERNEL);
583 if (copy_from_user(cnf, u_conf, sizeof(wanif_conf_t)))
587 if (cnf->magic != ROUTER_MAGIC)
590 if (cnf->config_id == WANCONFIG_MPPP) {
591 #ifdef CONFIG_WANPIPE_MULTPPP
592 pppdev = kzalloc(sizeof(struct ppp_device), GFP_KERNEL);
596 pppdev->dev = kzalloc(sizeof(struct net_device), GFP_KERNEL);
597 if (pppdev->dev == NULL) {
602 err = wandev->new_if(wandev, (struct net_device *)pppdev, cnf);
605 printk(KERN_INFO "%s: Wanpipe Mulit-Port PPP support has not been compiled in!\n",
607 err = -EPROTONOSUPPORT;
611 dev = kzalloc(sizeof(struct net_device), GFP_KERNEL);
615 err = wandev->new_if(wandev, dev, cnf);
619 /* Register network interface. This will invoke init()
620 * function supplied by the driver. If device registered
621 * successfully, add it to the interface list.
624 if (dev->name == NULL) {
629 printk(KERN_INFO "%s: registering interface %s...\n",
630 wanrouter_modname, dev->name);
633 err = register_netdev(dev);
635 struct net_device *slave = NULL;
636 unsigned long smp_flags=0;
638 lock_adapter_irq(&wandev->lock, &smp_flags);
640 if (wandev->dev == NULL) {
643 for (slave=wandev->dev;
644 *((struct net_device **)slave->priv);
645 slave = *((struct net_device **)slave->priv));
647 *((struct net_device **)slave->priv) = dev;
651 unlock_adapter_irq(&wandev->lock, &smp_flags);
652 err = 0; /* done !!! */
657 wandev->del_if(wandev, dev);
660 /* This code has moved from del_if() function */
664 #ifdef CONFIG_WANPIPE_MULTPPP
665 if (cnf->config_id == WANCONFIG_MPPP)
670 /* Sync PPP is disabled */
671 if (cnf->config_id != WANCONFIG_MPPP)
682 * Delete WAN logical channel.
683 * o verify user address space
684 * o copy configuration data to kernel address space
687 static int wanrouter_device_del_if(struct wan_device *wandev, char __user *u_name)
689 char name[WAN_IFNAME_SZ + 1];
692 if (wandev->state == WAN_UNCONFIGURED)
695 memset(name, 0, sizeof(name));
697 if (copy_from_user(name, u_name, WAN_IFNAME_SZ))
700 err = wanrouter_delete_interface(wandev, name);
704 /* If last interface being deleted, shutdown card
705 * This helps with administration at leaf nodes
706 * (You can tell if the person at the other end of the phone
707 * has an interface configured) and avoids DoS vulnerabilities
708 * in binary driver files - this fixes a problem with the current
709 * Sangoma driver going into strange states when all the network
710 * interfaces are deleted and the link irrecoverably disconnected.
713 if (!wandev->ndev && wandev->shutdown)
714 err = wandev->shutdown(wandev);
720 * Miscellaneous Functions
724 * Find WAN device by name.
725 * Return pointer to the WAN device data space or NULL if device not found.
728 static struct wan_device *wanrouter_find_device(char *name)
730 struct wan_device *wandev;
732 for (wandev = wanrouter_router_devlist;
733 wandev && strcmp(wandev->name, name);
734 wandev = wandev->next);
739 * Delete WAN logical channel identified by its name.
740 * o find logical channel by its name
741 * o call driver's del_if() entry point
742 * o unregister network interface
743 * o unlink channel data space from linked list of channels
744 * o release channel data space
747 * -ENODEV channel not found.
748 * -EBUSY interface is open
750 * Note: If (force != 0), then device will be destroyed even if interface
751 * associated with it is open. It's caller's responsibility to make
752 * sure that opened interfaces are not removed!
755 static int wanrouter_delete_interface(struct wan_device *wandev, char *name)
757 struct net_device *dev = NULL, *prev = NULL;
758 unsigned long smp_flags=0;
760 lock_adapter_irq(&wandev->lock, &smp_flags);
763 while (dev && strcmp(name, dev->name)) {
764 struct net_device **slave = dev->priv;
768 unlock_adapter_irq(&wandev->lock, &smp_flags);
771 return -ENODEV; /* interface not found */
773 if (netif_running(dev))
774 return -EBUSY; /* interface in use */
777 wandev->del_if(wandev, dev);
779 lock_adapter_irq(&wandev->lock, &smp_flags);
781 struct net_device **prev_slave = prev->priv;
782 struct net_device **slave = dev->priv;
784 *prev_slave = *slave;
786 struct net_device **slave = dev->priv;
787 wandev->dev = *slave;
790 unlock_adapter_irq(&wandev->lock, &smp_flags);
792 printk(KERN_INFO "%s: unregistering '%s'\n", wandev->name, dev->name);
794 /* Due to new interface linking method using dev->priv,
795 * this code has moved from del_if() function.*/
799 unregister_netdev(dev);
806 static void lock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags)
808 spin_lock_irqsave(lock, *smp_flags);
812 static void unlock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags)
814 spin_unlock_irqrestore(lock, *smp_flags);
817 EXPORT_SYMBOL(register_wan_device);
818 EXPORT_SYMBOL(unregister_wan_device);
820 MODULE_LICENSE("GPL");