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 managenment (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/config.h>
46 #include <linux/stddef.h> /* offsetof(), etc. */
47 #include <linux/errno.h> /* return codes */
48 #include <linux/kernel.h>
49 #include <linux/init.h>
50 #include <linux/module.h> /* support for loadable modules */
51 #include <linux/slab.h> /* kmalloc(), kfree() */
53 #include <linux/string.h> /* inline mem*, str* functions */
55 #include <asm/byteorder.h> /* htons(), etc. */
56 #include <linux/wanrouter.h> /* WAN router API definitions */
58 #include <linux/vmalloc.h> /* vmalloc, vfree */
59 #include <asm/uaccess.h> /* copy_to/from_user */
60 #include <linux/init.h> /* __initfunc et al. */
61 #include <net/syncppp.h>
63 #define KMEM_SAFETYZONE 8
65 /***********FOR DEBUGGING PURPOSES*********************************************
66 static void * dbg_kmalloc(unsigned int size, int prio, int line) {
68 void * v = kmalloc(size+sizeof(unsigned int)+2*KMEM_SAFETYZONE*8,prio);
70 c1 += sizeof(unsigned int);
71 *((unsigned int *)v) = size;
73 for (i = 0; i < KMEM_SAFETYZONE; i++) {
74 c1[0] = 'D'; c1[1] = 'E'; c1[2] = 'A'; c1[3] = 'D';
75 c1[4] = 'B'; c1[5] = 'E'; c1[6] = 'E'; c1[7] = 'F';
79 for (i = 0; i < KMEM_SAFETYZONE; i++) {
80 c1[0] = 'M'; c1[1] = 'U'; c1[2] = 'N'; c1[3] = 'G';
81 c1[4] = 'W'; c1[5] = 'A'; c1[6] = 'L'; c1[7] = 'L';
84 v = ((char *)v) + sizeof(unsigned int) + KMEM_SAFETYZONE*8;
85 printk(KERN_INFO "line %d kmalloc(%d,%d) = %p\n",line,size,prio,v);
88 static void dbg_kfree(void * v, int line) {
89 unsigned int * sp = (unsigned int *)(((char *)v) - (sizeof(unsigned int) + KMEM_SAFETYZONE*8));
90 unsigned int size = *sp;
91 char * c1 = ((char *)v) - KMEM_SAFETYZONE*8;
93 for (i = 0; i < KMEM_SAFETYZONE; i++) {
94 if ( c1[0] != 'D' || c1[1] != 'E' || c1[2] != 'A' || c1[3] != 'D'
95 || c1[4] != 'B' || c1[5] != 'E' || c1[6] != 'E' || c1[7] != 'F') {
96 printk(KERN_INFO "kmalloced block at %p has been corrupted (underrun)!\n",v);
97 printk(KERN_INFO " %4x: %2x %2x %2x %2x %2x %2x %2x %2x\n", i*8,
98 c1[0],c1[1],c1[2],c1[3],c1[4],c1[5],c1[6],c1[7] );
103 for (i = 0; i < KMEM_SAFETYZONE; i++) {
104 if ( c1[0] != 'M' || c1[1] != 'U' || c1[2] != 'N' || c1[3] != 'G'
105 || c1[4] != 'W' || c1[5] != 'A' || c1[6] != 'L' || c1[7] != 'L'
107 printk(KERN_INFO "kmalloced block at %p has been corrupted (overrun):\n",v);
108 printk(KERN_INFO " %4x: %2x %2x %2x %2x %2x %2x %2x %2x\n", i*8,
109 c1[0],c1[1],c1[2],c1[3],c1[4],c1[5],c1[6],c1[7] );
113 printk(KERN_INFO "line %d kfree(%p)\n",line,v);
114 v = ((char *)v) - (sizeof(unsigned int) + KMEM_SAFETYZONE*8);
118 #define kmalloc(x,y) dbg_kmalloc(x,y,__LINE__)
119 #define kfree(x) dbg_kfree(x,__LINE__)
120 *****************************************************************************/
123 * Function Prototypes
127 * WAN device IOCTL handlers
130 static int wanrouter_device_setup(struct wan_device *wandev,
131 wandev_conf_t __user *u_conf);
132 static int wanrouter_device_stat(struct wan_device *wandev,
133 wandev_stat_t __user *u_stat);
134 static int wanrouter_device_shutdown(struct wan_device *wandev);
135 static int wanrouter_device_new_if(struct wan_device *wandev,
136 wanif_conf_t __user *u_conf);
137 static int wanrouter_device_del_if(struct wan_device *wandev,
138 char __user *u_name);
144 static struct wan_device *wanrouter_find_device(char *name);
145 static int wanrouter_delete_interface(struct wan_device *wandev, char *name);
146 void lock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags);
147 void unlock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags);
155 static char wanrouter_fullname[] = "Sangoma WANPIPE Router";
156 static char wanrouter_copyright[] = "(c) 1995-2000 Sangoma Technologies Inc.";
157 static char wanrouter_modname[] = ROUTER_NAME; /* short module name */
158 struct wan_device* wanrouter_router_devlist; /* list of registered devices */
161 * Organize Unique Identifiers for encapsulation/decapsulation
164 static unsigned char wanrouter_oui_ether[] = { 0x00, 0x00, 0x00 };
166 static unsigned char wanrouter_oui_802_2[] = { 0x00, 0x80, 0xC2 };
169 static int __init wanrouter_init(void)
173 printk(KERN_INFO "%s v%u.%u %s\n",
174 wanrouter_fullname, ROUTER_VERSION, ROUTER_RELEASE,
175 wanrouter_copyright);
177 err = wanrouter_proc_init();
179 printk(KERN_INFO "%s: can't create entry in proc filesystem!\n",
185 static void __exit wanrouter_cleanup (void)
187 wanrouter_proc_cleanup();
191 * This is just plain dumb. We should move the bugger to drivers/net/wan,
192 * slap it first in directory and make it module_init(). The only reason
193 * for subsys_initcall() here is that net goes after drivers (why, BTW?)
195 subsys_initcall(wanrouter_init);
196 module_exit(wanrouter_cleanup);
203 * Register WAN device.
204 * o verify device credentials
205 * o create an entry for the device in the /proc/net/router directory
206 * o initialize internally maintained fields of the wan_device structure
207 * o link device data space to a singly-linked list
208 * o if it's the first device, then start kernel 'thread'
209 * o increment module use count
219 int register_wan_device(struct wan_device *wandev)
223 if ((wandev == NULL) || (wandev->magic != ROUTER_MAGIC) ||
224 (wandev->name == NULL))
227 namelen = strlen(wandev->name);
228 if (!namelen || (namelen > WAN_DRVNAME_SZ))
231 if (wanrouter_find_device(wandev->name))
235 printk(KERN_INFO "%s: registering WAN device %s\n",
236 wanrouter_modname, wandev->name);
240 * Register /proc directory entry
242 err = wanrouter_proc_add(wandev);
245 "%s: can't create /proc/net/router/%s entry!\n",
246 wanrouter_modname, wandev->name);
251 * Initialize fields of the wan_device structure maintained by the
252 * router and update local data.
257 wandev->next = wanrouter_router_devlist;
258 wanrouter_router_devlist = wandev;
263 * Unregister WAN device.
265 * o unlink device data space from the linked list
266 * o delete device entry in the /proc/net/router directory
267 * o decrement module use count
275 int unregister_wan_device(char *name)
277 struct wan_device *wandev, *prev;
282 for (wandev = wanrouter_router_devlist, prev = NULL;
283 wandev && strcmp(wandev->name, name);
284 prev = wandev, wandev = wandev->next)
290 printk(KERN_INFO "%s: unregistering WAN device %s\n",
291 wanrouter_modname, name);
294 if (wandev->state != WAN_UNCONFIGURED)
295 wanrouter_device_shutdown(wandev);
298 prev->next = wandev->next;
300 wanrouter_router_devlist = wandev->next;
302 wanrouter_proc_delete(wandev);
307 * Encapsulate packet.
309 * Return: encapsulation header size
310 * < 0 - unsupported Ethertype
313 * 1. This function may be called on interrupt context.
317 int wanrouter_encapsulate(struct sk_buff *skb, struct net_device *dev,
323 case ETH_P_IP: /* IP datagram encapsulation */
326 skb->data[0] = NLPID_IP;
329 case ETH_P_IPX: /* SNAP encapsulation */
334 skb->data[1] = NLPID_SNAP;
335 memcpy(&skb->data[2], wanrouter_oui_ether,
336 sizeof(wanrouter_oui_ether));
337 *((unsigned short*)&skb->data[5]) = htons(type);
340 default: /* Unknown packet type */
342 "%s: unsupported Ethertype 0x%04X on interface %s!\n",
343 wanrouter_modname, type, dev->name);
351 * Decapsulate packet.
353 * Return: Ethertype (in network order)
354 * 0 unknown encapsulation
357 * 1. This function may be called on interrupt context.
361 unsigned short wanrouter_type_trans(struct sk_buff *skb, struct net_device *dev)
363 int cnt = skb->data[0] ? 0 : 1; /* there may be a pad present */
364 unsigned short ethertype;
366 switch (skb->data[cnt]) {
367 case NLPID_IP: /* IP datagramm */
368 ethertype = htons(ETH_P_IP);
372 case NLPID_SNAP: /* SNAP encapsulation */
373 if (memcmp(&skb->data[cnt + 1], wanrouter_oui_ether,
374 sizeof(wanrouter_oui_ether))){
376 "%s: unsupported SNAP OUI %02X-%02X-%02X "
377 "on interface %s!\n", wanrouter_modname,
378 skb->data[cnt+1], skb->data[cnt+2],
379 skb->data[cnt+3], dev->name);
382 ethertype = *((unsigned short*)&skb->data[cnt+4]);
386 /* add other protocols, e.g. CLNP, ESIS, ISIS, if needed */
390 "%s: unsupported NLPID 0x%02X on interface %s!\n",
391 wanrouter_modname, skb->data[cnt], dev->name);
394 skb->protocol = ethertype;
395 skb->pkt_type = PACKET_HOST; /* Physically point to point */
397 skb->mac.raw = skb->data;
404 * o find WAN device associated with this node
405 * o execute requested action or pass command to the device driver
408 int wanrouter_ioctl(struct inode *inode, struct file *file,
409 unsigned int cmd, unsigned long arg)
412 struct proc_dir_entry *dent;
413 struct wan_device *wandev;
414 void __user *data = (void __user *)arg;
416 if (!capable(CAP_NET_ADMIN))
419 if ((cmd >> 8) != ROUTER_IOCTL)
423 if ((dent == NULL) || (dent->data == NULL))
427 if (wandev->magic != ROUTER_MAGIC)
432 err = wanrouter_device_setup(wandev, data);
436 err = wanrouter_device_shutdown(wandev);
440 err = wanrouter_device_stat(wandev, data);
444 err = wanrouter_device_new_if(wandev, data);
448 err = wanrouter_device_del_if(wandev, data);
455 if ((cmd >= ROUTER_USER) &&
456 (cmd <= ROUTER_USER_MAX) &&
458 err = wandev->ioctl(wandev, cmd, arg);
465 * WAN Driver IOCTL Handlers
469 * Setup WAN link device.
470 * o verify user address space
471 * o allocate kernel memory and copy configuration data to kernel space
472 * o if configuration data includes extension, copy it to kernel space too
473 * o call driver's setup() entry point
476 static int wanrouter_device_setup(struct wan_device *wandev,
477 wandev_conf_t __user *u_conf)
483 if (wandev->setup == NULL) { /* Nothing to do ? */
484 printk(KERN_INFO "%s: ERROR, No setup script: wandev->setup()\n",
489 conf = kmalloc(sizeof(wandev_conf_t), GFP_KERNEL);
491 printk(KERN_INFO "%s: ERROR, Failed to allocate kernel memory !\n",
496 if (copy_from_user(conf, u_conf, sizeof(wandev_conf_t))) {
497 printk(KERN_INFO "%s: Failed to copy user config data to kernel space!\n",
503 if (conf->magic != ROUTER_MAGIC) {
505 printk(KERN_INFO "%s: ERROR, Invalid MAGIC Number\n",
510 if (conf->data_size && conf->data) {
511 if (conf->data_size > 128000 || conf->data_size < 0) {
513 "%s: ERROR, Invalid firmware data size %i !\n",
514 wandev->name, conf->data_size);
519 data = vmalloc(conf->data_size);
522 "%s: ERROR, Faild allocate kernel memory !\n",
527 if (!copy_from_user(data, conf->data, conf->data_size)) {
529 err = wandev->setup(wandev, conf);
532 "%s: ERROR, Faild to copy from user data !\n",
539 "%s: ERROR, No firmware found ! Firmware size = %i !\n",
540 wandev->name, conf->data_size);
548 * Shutdown WAN device.
549 * o delete all not opened logical channels for this device
550 * o call driver's shutdown() entry point
553 static int wanrouter_device_shutdown(struct wan_device *wandev)
555 struct net_device *dev;
558 if (wandev->state == WAN_UNCONFIGURED)
561 printk(KERN_INFO "\n%s: Shutting Down!\n",wandev->name);
563 for (dev = wandev->dev; dev;) {
564 err = wanrouter_delete_interface(wandev, dev->name);
567 /* The above function deallocates the current dev
568 * structure. Therefore, we cannot use dev->priv
569 * as the next element: wandev->dev points to the
575 return -EBUSY; /* there are opened interfaces */
577 if (wandev->shutdown)
578 err=wandev->shutdown(wandev);
584 * Get WAN device status & statistics.
587 static int wanrouter_device_stat(struct wan_device *wandev,
588 wandev_stat_t __user *u_stat)
592 memset(&stat, 0, sizeof(stat));
594 /* Ask device driver to update device statistics */
595 if ((wandev->state != WAN_UNCONFIGURED) && wandev->update)
596 wandev->update(wandev);
598 /* Fill out structure */
599 stat.ndev = wandev->ndev;
600 stat.state = wandev->state;
602 if (copy_to_user(u_stat, &stat, sizeof(stat)))
609 * Create new WAN interface.
610 * o verify user address space
611 * o copy configuration data to kernel address space
612 * o allocate network interface data space
613 * o call driver's new_if() entry point
614 * o make sure there is no interface name conflict
615 * o register network interface
618 static int wanrouter_device_new_if(struct wan_device *wandev,
619 wanif_conf_t __user *u_conf)
622 struct net_device *dev = NULL;
623 #ifdef CONFIG_WANPIPE_MULTPPP
624 struct ppp_device *pppdev=NULL;
628 if ((wandev->state == WAN_UNCONFIGURED) || (wandev->new_if == NULL))
631 cnf = kmalloc(sizeof(wanif_conf_t), GFP_KERNEL);
636 if (copy_from_user(cnf, u_conf, sizeof(wanif_conf_t)))
640 if (cnf->magic != ROUTER_MAGIC)
643 if (cnf->config_id == WANCONFIG_MPPP) {
644 #ifdef CONFIG_WANPIPE_MULTPPP
645 pppdev = kmalloc(sizeof(struct ppp_device), GFP_KERNEL);
649 memset(pppdev, 0, sizeof(struct ppp_device));
650 pppdev->dev = kmalloc(sizeof(struct net_device), GFP_KERNEL);
651 if (pppdev->dev == NULL) {
656 memset(pppdev->dev, 0, sizeof(struct net_device));
657 err = wandev->new_if(wandev, (struct net_device *)pppdev, cnf);
660 printk(KERN_INFO "%s: Wanpipe Mulit-Port PPP support has not been compiled in!\n",
662 err = -EPROTONOSUPPORT;
666 dev = kmalloc(sizeof(struct net_device), GFP_KERNEL);
670 memset(dev, 0, sizeof(struct net_device));
671 err = wandev->new_if(wandev, dev, cnf);
675 /* Register network interface. This will invoke init()
676 * function supplied by the driver. If device registered
677 * successfully, add it to the interface list.
680 if (dev->name == NULL) {
685 printk(KERN_INFO "%s: registering interface %s...\n",
686 wanrouter_modname, dev->name);
689 err = register_netdev(dev);
691 struct net_device *slave = NULL;
692 unsigned long smp_flags=0;
694 lock_adapter_irq(&wandev->lock, &smp_flags);
696 if (wandev->dev == NULL) {
699 for (slave=wandev->dev;
700 *((struct net_device **)slave->priv);
701 slave = *((struct net_device **)slave->priv));
703 *((struct net_device **)slave->priv) = dev;
707 unlock_adapter_irq(&wandev->lock, &smp_flags);
708 err = 0; /* done !!! */
713 wandev->del_if(wandev, dev);
716 /* This code has moved from del_if() function */
722 #ifdef CONFIG_WANPIPE_MULTPPP
723 if (cnf->config_id == WANCONFIG_MPPP)
728 /* Sync PPP is disabled */
729 if (cnf->config_id != WANCONFIG_MPPP)
740 * Delete WAN logical channel.
741 * o verify user address space
742 * o copy configuration data to kernel address space
745 static int wanrouter_device_del_if(struct wan_device *wandev, char __user *u_name)
747 char name[WAN_IFNAME_SZ + 1];
750 if (wandev->state == WAN_UNCONFIGURED)
753 memset(name, 0, sizeof(name));
755 if (copy_from_user(name, u_name, WAN_IFNAME_SZ))
758 err = wanrouter_delete_interface(wandev, name);
762 /* If last interface being deleted, shutdown card
763 * This helps with administration at leaf nodes
764 * (You can tell if the person at the other end of the phone
765 * has an interface configured) and avoids DoS vulnerabilities
766 * in binary driver files - this fixes a problem with the current
767 * Sangoma driver going into strange states when all the network
768 * interfaces are deleted and the link irrecoverably disconnected.
771 if (!wandev->ndev && wandev->shutdown)
772 err = wandev->shutdown(wandev);
778 * Miscellaneous Functions
782 * Find WAN device by name.
783 * Return pointer to the WAN device data space or NULL if device not found.
786 static struct wan_device *wanrouter_find_device(char *name)
788 struct wan_device *wandev;
790 for (wandev = wanrouter_router_devlist;
791 wandev && strcmp(wandev->name, name);
792 wandev = wandev->next);
797 * Delete WAN logical channel identified by its name.
798 * o find logical channel by its name
799 * o call driver's del_if() entry point
800 * o unregister network interface
801 * o unlink channel data space from linked list of channels
802 * o release channel data space
805 * -ENODEV channel not found.
806 * -EBUSY interface is open
808 * Note: If (force != 0), then device will be destroyed even if interface
809 * associated with it is open. It's caller's responsibility to make
810 * sure that opened interfaces are not removed!
813 static int wanrouter_delete_interface(struct wan_device *wandev, char *name)
815 struct net_device *dev = NULL, *prev = NULL;
816 unsigned long smp_flags=0;
818 lock_adapter_irq(&wandev->lock, &smp_flags);
821 while (dev && strcmp(name, dev->name)) {
822 struct net_device **slave = dev->priv;
826 unlock_adapter_irq(&wandev->lock, &smp_flags);
829 return -ENODEV; /* interface not found */
831 if (netif_running(dev))
832 return -EBUSY; /* interface in use */
835 wandev->del_if(wandev, dev);
837 lock_adapter_irq(&wandev->lock, &smp_flags);
839 struct net_device **prev_slave = prev->priv;
840 struct net_device **slave = dev->priv;
842 *prev_slave = *slave;
844 struct net_device **slave = dev->priv;
845 wandev->dev = *slave;
848 unlock_adapter_irq(&wandev->lock, &smp_flags);
850 printk(KERN_INFO "%s: unregistering '%s'\n", wandev->name, dev->name);
852 /* Due to new interface linking method using dev->priv,
853 * this code has moved from del_if() function.*/
859 unregister_netdev(dev);
866 void lock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags)
868 spin_lock_irqsave(lock, *smp_flags);
872 void unlock_adapter_irq(spinlock_t *lock, unsigned long *smp_flags)
874 spin_unlock_irqrestore(lock, *smp_flags);
877 EXPORT_SYMBOL(register_wan_device);
878 EXPORT_SYMBOL(unregister_wan_device);
879 EXPORT_SYMBOL(wanrouter_encapsulate);
880 EXPORT_SYMBOL(wanrouter_type_trans);
881 EXPORT_SYMBOL(lock_adapter_irq);
882 EXPORT_SYMBOL(unlock_adapter_irq);
884 MODULE_LICENSE("GPL");