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() */
51 #include <linux/mutex.h>
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. */
62 #define KMEM_SAFETYZONE 8
64 #define DEV_TO_SLAVE(dev) (*((struct net_device **)netdev_priv(dev)))
71 * WAN device IOCTL handlers
74 static DEFINE_MUTEX(wanrouter_mutex
);
75 static int wanrouter_device_setup(struct wan_device
*wandev
,
76 wandev_conf_t __user
*u_conf
);
77 static int wanrouter_device_stat(struct wan_device
*wandev
,
78 wandev_stat_t __user
*u_stat
);
79 static int wanrouter_device_shutdown(struct wan_device
*wandev
);
80 static int wanrouter_device_new_if(struct wan_device
*wandev
,
81 wanif_conf_t __user
*u_conf
);
82 static int wanrouter_device_del_if(struct wan_device
*wandev
,
89 static struct wan_device
*wanrouter_find_device(char *name
);
90 static int wanrouter_delete_interface(struct wan_device
*wandev
, char *name
);
91 static void lock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
93 static void unlock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
102 static char wanrouter_fullname
[] = "Sangoma WANPIPE Router";
103 static char wanrouter_copyright
[] = "(c) 1995-2000 Sangoma Technologies Inc.";
104 static char wanrouter_modname
[] = ROUTER_NAME
; /* short module name */
105 struct wan_device
* wanrouter_router_devlist
; /* list of registered devices */
108 * Organize Unique Identifiers for encapsulation/decapsulation
112 static int __init
wanrouter_init(void)
116 printk(KERN_INFO
"%s v%u.%u %s\n",
117 wanrouter_fullname
, ROUTER_VERSION
, ROUTER_RELEASE
,
118 wanrouter_copyright
);
120 err
= wanrouter_proc_init();
122 printk(KERN_INFO
"%s: can't create entry in proc filesystem!\n",
128 static void __exit
wanrouter_cleanup (void)
130 wanrouter_proc_cleanup();
134 * This is just plain dumb. We should move the bugger to drivers/net/wan,
135 * slap it first in directory and make it module_init(). The only reason
136 * for subsys_initcall() here is that net goes after drivers (why, BTW?)
138 subsys_initcall(wanrouter_init
);
139 module_exit(wanrouter_cleanup
);
146 * Register WAN device.
147 * o verify device credentials
148 * o create an entry for the device in the /proc/net/router directory
149 * o initialize internally maintained fields of the wan_device structure
150 * o link device data space to a singly-linked list
151 * o if it's the first device, then start kernel 'thread'
152 * o increment module use count
162 int register_wan_device(struct wan_device
*wandev
)
166 if ((wandev
== NULL
) || (wandev
->magic
!= ROUTER_MAGIC
) ||
167 (wandev
->name
== NULL
))
170 namelen
= strlen(wandev
->name
);
171 if (!namelen
|| (namelen
> WAN_DRVNAME_SZ
))
174 if (wanrouter_find_device(wandev
->name
))
178 printk(KERN_INFO
"%s: registering WAN device %s\n",
179 wanrouter_modname
, wandev
->name
);
183 * Register /proc directory entry
185 err
= wanrouter_proc_add(wandev
);
188 "%s: can't create /proc/net/router/%s entry!\n",
189 wanrouter_modname
, wandev
->name
);
194 * Initialize fields of the wan_device structure maintained by the
195 * router and update local data.
200 wandev
->next
= wanrouter_router_devlist
;
201 wanrouter_router_devlist
= wandev
;
206 * Unregister WAN device.
208 * o unlink device data space from the linked list
209 * o delete device entry in the /proc/net/router directory
210 * o decrement module use count
218 int unregister_wan_device(char *name
)
220 struct wan_device
*wandev
, *prev
;
225 for (wandev
= wanrouter_router_devlist
, prev
= NULL
;
226 wandev
&& strcmp(wandev
->name
, name
);
227 prev
= wandev
, wandev
= wandev
->next
)
233 printk(KERN_INFO
"%s: unregistering WAN device %s\n",
234 wanrouter_modname
, name
);
237 if (wandev
->state
!= WAN_UNCONFIGURED
)
238 wanrouter_device_shutdown(wandev
);
241 prev
->next
= wandev
->next
;
243 wanrouter_router_devlist
= wandev
->next
;
245 wanrouter_proc_delete(wandev
);
252 * o find WAN device associated with this node
253 * o execute requested action or pass command to the device driver
256 long wanrouter_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
258 struct inode
*inode
= file
->f_path
.dentry
->d_inode
;
260 struct proc_dir_entry
*dent
;
261 struct wan_device
*wandev
;
262 void __user
*data
= (void __user
*)arg
;
264 if (!capable(CAP_NET_ADMIN
))
267 if ((cmd
>> 8) != ROUTER_IOCTL
)
271 if ((dent
== NULL
) || (dent
->data
== NULL
))
275 if (wandev
->magic
!= ROUTER_MAGIC
)
278 mutex_lock(&wanrouter_mutex
);
281 err
= wanrouter_device_setup(wandev
, data
);
285 err
= wanrouter_device_shutdown(wandev
);
289 err
= wanrouter_device_stat(wandev
, data
);
293 err
= wanrouter_device_new_if(wandev
, data
);
297 err
= wanrouter_device_del_if(wandev
, data
);
304 if ((cmd
>= ROUTER_USER
) &&
305 (cmd
<= ROUTER_USER_MAX
) &&
307 err
= wandev
->ioctl(wandev
, cmd
, arg
);
310 mutex_unlock(&wanrouter_mutex
);
315 * WAN Driver IOCTL Handlers
319 * Setup WAN link device.
320 * o verify user address space
321 * o allocate kernel memory and copy configuration data to kernel space
322 * o if configuration data includes extension, copy it to kernel space too
323 * o call driver's setup() entry point
326 static int wanrouter_device_setup(struct wan_device
*wandev
,
327 wandev_conf_t __user
*u_conf
)
333 if (wandev
->setup
== NULL
) { /* Nothing to do ? */
334 printk(KERN_INFO
"%s: ERROR, No setup script: wandev->setup()\n",
339 conf
= kmalloc(sizeof(wandev_conf_t
), GFP_KERNEL
);
341 printk(KERN_INFO
"%s: ERROR, Failed to allocate kernel memory !\n",
346 if (copy_from_user(conf
, u_conf
, sizeof(wandev_conf_t
))) {
347 printk(KERN_INFO
"%s: Failed to copy user config data to kernel space!\n",
353 if (conf
->magic
!= ROUTER_MAGIC
) {
355 printk(KERN_INFO
"%s: ERROR, Invalid MAGIC Number\n",
360 if (conf
->data_size
&& conf
->data
) {
361 if (conf
->data_size
> 128000) {
363 "%s: ERROR, Invalid firmware data size %i !\n",
364 wandev
->name
, conf
->data_size
);
369 data
= vmalloc(conf
->data_size
);
372 "%s: ERROR, Faild allocate kernel memory !\n",
377 if (!copy_from_user(data
, conf
->data
, conf
->data_size
)) {
379 err
= wandev
->setup(wandev
, conf
);
382 "%s: ERROR, Faild to copy from user data !\n",
389 "%s: ERROR, No firmware found ! Firmware size = %i !\n",
390 wandev
->name
, conf
->data_size
);
398 * Shutdown WAN device.
399 * o delete all not opened logical channels for this device
400 * o call driver's shutdown() entry point
403 static int wanrouter_device_shutdown(struct wan_device
*wandev
)
405 struct net_device
*dev
;
408 if (wandev
->state
== WAN_UNCONFIGURED
)
411 printk(KERN_INFO
"\n%s: Shutting Down!\n",wandev
->name
);
413 for (dev
= wandev
->dev
; dev
;) {
414 err
= wanrouter_delete_interface(wandev
, dev
->name
);
417 /* The above function deallocates the current dev
418 * structure. Therefore, we cannot use netdev_priv(dev)
419 * as the next element: wandev->dev points to the
425 return -EBUSY
; /* there are opened interfaces */
427 if (wandev
->shutdown
)
428 err
=wandev
->shutdown(wandev
);
434 * Get WAN device status & statistics.
437 static int wanrouter_device_stat(struct wan_device
*wandev
,
438 wandev_stat_t __user
*u_stat
)
442 memset(&stat
, 0, sizeof(stat
));
444 /* Ask device driver to update device statistics */
445 if ((wandev
->state
!= WAN_UNCONFIGURED
) && wandev
->update
)
446 wandev
->update(wandev
);
448 /* Fill out structure */
449 stat
.ndev
= wandev
->ndev
;
450 stat
.state
= wandev
->state
;
452 if (copy_to_user(u_stat
, &stat
, sizeof(stat
)))
459 * Create new WAN interface.
460 * o verify user address space
461 * o copy configuration data to kernel address space
462 * o allocate network interface data space
463 * o call driver's new_if() entry point
464 * o make sure there is no interface name conflict
465 * o register network interface
468 static int wanrouter_device_new_if(struct wan_device
*wandev
,
469 wanif_conf_t __user
*u_conf
)
472 struct net_device
*dev
= NULL
;
475 if ((wandev
->state
== WAN_UNCONFIGURED
) || (wandev
->new_if
== NULL
))
478 cnf
= kmalloc(sizeof(wanif_conf_t
), GFP_KERNEL
);
483 if (copy_from_user(cnf
, u_conf
, sizeof(wanif_conf_t
)))
487 if (cnf
->magic
!= ROUTER_MAGIC
)
490 if (cnf
->config_id
== WANCONFIG_MPPP
) {
491 printk(KERN_INFO
"%s: Wanpipe Mulit-Port PPP support has not been compiled in!\n",
493 err
= -EPROTONOSUPPORT
;
496 err
= wandev
->new_if(wandev
, dev
, cnf
);
500 /* Register network interface. This will invoke init()
501 * function supplied by the driver. If device registered
502 * successfully, add it to the interface list.
505 if (dev
->name
== NULL
) {
510 printk(KERN_INFO
"%s: registering interface %s...\n",
511 wanrouter_modname
, dev
->name
);
514 err
= register_netdev(dev
);
516 struct net_device
*slave
= NULL
;
517 unsigned long smp_flags
=0;
519 lock_adapter_irq(&wandev
->lock
, &smp_flags
);
521 if (wandev
->dev
== NULL
) {
524 for (slave
=wandev
->dev
;
526 slave
= DEV_TO_SLAVE(slave
))
527 DEV_TO_SLAVE(slave
) = dev
;
531 unlock_adapter_irq(&wandev
->lock
, &smp_flags
);
532 err
= 0; /* done !!! */
537 wandev
->del_if(wandev
, dev
);
548 * Delete WAN logical channel.
549 * o verify user address space
550 * o copy configuration data to kernel address space
553 static int wanrouter_device_del_if(struct wan_device
*wandev
, char __user
*u_name
)
555 char name
[WAN_IFNAME_SZ
+ 1];
558 if (wandev
->state
== WAN_UNCONFIGURED
)
561 memset(name
, 0, sizeof(name
));
563 if (copy_from_user(name
, u_name
, WAN_IFNAME_SZ
))
566 err
= wanrouter_delete_interface(wandev
, name
);
570 /* If last interface being deleted, shutdown card
571 * This helps with administration at leaf nodes
572 * (You can tell if the person at the other end of the phone
573 * has an interface configured) and avoids DoS vulnerabilities
574 * in binary driver files - this fixes a problem with the current
575 * Sangoma driver going into strange states when all the network
576 * interfaces are deleted and the link irrecoverably disconnected.
579 if (!wandev
->ndev
&& wandev
->shutdown
)
580 err
= wandev
->shutdown(wandev
);
586 * Miscellaneous Functions
590 * Find WAN device by name.
591 * Return pointer to the WAN device data space or NULL if device not found.
594 static struct wan_device
*wanrouter_find_device(char *name
)
596 struct wan_device
*wandev
;
598 for (wandev
= wanrouter_router_devlist
;
599 wandev
&& strcmp(wandev
->name
, name
);
600 wandev
= wandev
->next
);
605 * Delete WAN logical channel identified by its name.
606 * o find logical channel by its name
607 * o call driver's del_if() entry point
608 * o unregister network interface
609 * o unlink channel data space from linked list of channels
610 * o release channel data space
613 * -ENODEV channel not found.
614 * -EBUSY interface is open
616 * Note: If (force != 0), then device will be destroyed even if interface
617 * associated with it is open. It's caller's responsibility to make
618 * sure that opened interfaces are not removed!
621 static int wanrouter_delete_interface(struct wan_device
*wandev
, char *name
)
623 struct net_device
*dev
= NULL
, *prev
= NULL
;
624 unsigned long smp_flags
=0;
626 lock_adapter_irq(&wandev
->lock
, &smp_flags
);
629 while (dev
&& strcmp(name
, dev
->name
)) {
630 struct net_device
**slave
= netdev_priv(dev
);
634 unlock_adapter_irq(&wandev
->lock
, &smp_flags
);
637 return -ENODEV
; /* interface not found */
639 if (netif_running(dev
))
640 return -EBUSY
; /* interface in use */
643 wandev
->del_if(wandev
, dev
);
645 lock_adapter_irq(&wandev
->lock
, &smp_flags
);
647 struct net_device
**prev_slave
= netdev_priv(prev
);
648 struct net_device
**slave
= netdev_priv(dev
);
650 *prev_slave
= *slave
;
652 struct net_device
**slave
= netdev_priv(dev
);
653 wandev
->dev
= *slave
;
656 unlock_adapter_irq(&wandev
->lock
, &smp_flags
);
658 printk(KERN_INFO
"%s: unregistering '%s'\n", wandev
->name
, dev
->name
);
660 unregister_netdev(dev
);
667 static void lock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
670 spin_lock_irqsave(lock
, *smp_flags
);
674 static void unlock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
677 spin_unlock_irqrestore(lock
, *smp_flags
);
680 EXPORT_SYMBOL(register_wan_device
);
681 EXPORT_SYMBOL(unregister_wan_device
);
683 MODULE_LICENSE("GPL");