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 DEV_TO_SLAVE(dev) (*((struct net_device **)netdev_priv(dev)))
69 * WAN device IOCTL handlers
72 static DEFINE_MUTEX(wanrouter_mutex
);
73 static int wanrouter_device_setup(struct wan_device
*wandev
,
74 wandev_conf_t __user
*u_conf
);
75 static int wanrouter_device_stat(struct wan_device
*wandev
,
76 wandev_stat_t __user
*u_stat
);
77 static int wanrouter_device_shutdown(struct wan_device
*wandev
);
78 static int wanrouter_device_new_if(struct wan_device
*wandev
,
79 wanif_conf_t __user
*u_conf
);
80 static int wanrouter_device_del_if(struct wan_device
*wandev
,
87 static struct wan_device
*wanrouter_find_device(char *name
);
88 static int wanrouter_delete_interface(struct wan_device
*wandev
, char *name
);
89 static void lock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
91 static void unlock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
100 static char wanrouter_fullname
[] = "Sangoma WANPIPE Router";
101 static char wanrouter_copyright
[] = "(c) 1995-2000 Sangoma Technologies Inc.";
102 static char wanrouter_modname
[] = ROUTER_NAME
; /* short module name */
103 struct wan_device
* wanrouter_router_devlist
; /* list of registered devices */
106 * Organize Unique Identifiers for encapsulation/decapsulation
110 static unsigned char wanrouter_oui_ether
[] = { 0x00, 0x00, 0x00 };
111 static unsigned char wanrouter_oui_802_2
[] = { 0x00, 0x80, 0xC2 };
114 static int __init
wanrouter_init(void)
118 printk(KERN_INFO
"%s v%u.%u %s\n",
119 wanrouter_fullname
, ROUTER_VERSION
, ROUTER_RELEASE
,
120 wanrouter_copyright
);
122 err
= wanrouter_proc_init();
124 printk(KERN_INFO
"%s: can't create entry in proc filesystem!\n",
130 static void __exit
wanrouter_cleanup (void)
132 wanrouter_proc_cleanup();
136 * This is just plain dumb. We should move the bugger to drivers/net/wan,
137 * slap it first in directory and make it module_init(). The only reason
138 * for subsys_initcall() here is that net goes after drivers (why, BTW?)
140 subsys_initcall(wanrouter_init
);
141 module_exit(wanrouter_cleanup
);
148 * Register WAN device.
149 * o verify device credentials
150 * o create an entry for the device in the /proc/net/router directory
151 * o initialize internally maintained fields of the wan_device structure
152 * o link device data space to a singly-linked list
153 * o if it's the first device, then start kernel 'thread'
154 * o increment module use count
164 int register_wan_device(struct wan_device
*wandev
)
168 if ((wandev
== NULL
) || (wandev
->magic
!= ROUTER_MAGIC
) ||
169 (wandev
->name
== NULL
))
172 namelen
= strlen(wandev
->name
);
173 if (!namelen
|| (namelen
> WAN_DRVNAME_SZ
))
176 if (wanrouter_find_device(wandev
->name
))
180 printk(KERN_INFO
"%s: registering WAN device %s\n",
181 wanrouter_modname
, wandev
->name
);
185 * Register /proc directory entry
187 err
= wanrouter_proc_add(wandev
);
190 "%s: can't create /proc/net/router/%s entry!\n",
191 wanrouter_modname
, wandev
->name
);
196 * Initialize fields of the wan_device structure maintained by the
197 * router and update local data.
202 wandev
->next
= wanrouter_router_devlist
;
203 wanrouter_router_devlist
= wandev
;
208 * Unregister WAN device.
210 * o unlink device data space from the linked list
211 * o delete device entry in the /proc/net/router directory
212 * o decrement module use count
220 int unregister_wan_device(char *name
)
222 struct wan_device
*wandev
, *prev
;
227 for (wandev
= wanrouter_router_devlist
, prev
= NULL
;
228 wandev
&& strcmp(wandev
->name
, name
);
229 prev
= wandev
, wandev
= wandev
->next
)
235 printk(KERN_INFO
"%s: unregistering WAN device %s\n",
236 wanrouter_modname
, name
);
239 if (wandev
->state
!= WAN_UNCONFIGURED
)
240 wanrouter_device_shutdown(wandev
);
243 prev
->next
= wandev
->next
;
245 wanrouter_router_devlist
= wandev
->next
;
247 wanrouter_proc_delete(wandev
);
254 * Encapsulate packet.
256 * Return: encapsulation header size
257 * < 0 - unsupported Ethertype
260 * 1. This function may be called on interrupt context.
264 int wanrouter_encapsulate(struct sk_buff
*skb
, struct net_device
*dev
,
270 case ETH_P_IP
: /* IP datagram encapsulation */
273 skb
->data
[0] = NLPID_IP
;
276 case ETH_P_IPX
: /* SNAP encapsulation */
281 skb
->data
[1] = NLPID_SNAP
;
282 skb_copy_to_linear_data_offset(skb
, 2, wanrouter_oui_ether
,
283 sizeof(wanrouter_oui_ether
));
284 *((unsigned short*)&skb
->data
[5]) = htons(type
);
287 default: /* Unknown packet type */
289 "%s: unsupported Ethertype 0x%04X on interface %s!\n",
290 wanrouter_modname
, type
, dev
->name
);
298 * Decapsulate packet.
300 * Return: Ethertype (in network order)
301 * 0 unknown encapsulation
304 * 1. This function may be called on interrupt context.
308 __be16
wanrouter_type_trans(struct sk_buff
*skb
, struct net_device
*dev
)
310 int cnt
= skb
->data
[0] ? 0 : 1; /* there may be a pad present */
313 switch (skb
->data
[cnt
]) {
314 case NLPID_IP
: /* IP datagramm */
315 ethertype
= htons(ETH_P_IP
);
319 case NLPID_SNAP
: /* SNAP encapsulation */
320 if (memcmp(&skb
->data
[cnt
+ 1], wanrouter_oui_ether
,
321 sizeof(wanrouter_oui_ether
))){
323 "%s: unsupported SNAP OUI %02X-%02X-%02X "
324 "on interface %s!\n", wanrouter_modname
,
325 skb
->data
[cnt
+1], skb
->data
[cnt
+2],
326 skb
->data
[cnt
+3], dev
->name
);
329 ethertype
= *((__be16
*)&skb
->data
[cnt
+4]);
333 /* add other protocols, e.g. CLNP, ESIS, ISIS, if needed */
337 "%s: unsupported NLPID 0x%02X on interface %s!\n",
338 wanrouter_modname
, skb
->data
[cnt
], dev
->name
);
341 skb
->protocol
= ethertype
;
342 skb
->pkt_type
= PACKET_HOST
; /* Physically point to point */
344 skb_reset_mac_header(skb
);
352 * o find WAN device associated with this node
353 * o execute requested action or pass command to the device driver
356 long wanrouter_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
358 struct inode
*inode
= file
->f_path
.dentry
->d_inode
;
360 struct proc_dir_entry
*dent
;
361 struct wan_device
*wandev
;
362 void __user
*data
= (void __user
*)arg
;
364 if (!capable(CAP_NET_ADMIN
))
367 if ((cmd
>> 8) != ROUTER_IOCTL
)
371 if ((dent
== NULL
) || (dent
->data
== NULL
))
375 if (wandev
->magic
!= ROUTER_MAGIC
)
378 mutex_lock(&wanrouter_mutex
);
381 err
= wanrouter_device_setup(wandev
, data
);
385 err
= wanrouter_device_shutdown(wandev
);
389 err
= wanrouter_device_stat(wandev
, data
);
393 err
= wanrouter_device_new_if(wandev
, data
);
397 err
= wanrouter_device_del_if(wandev
, data
);
404 if ((cmd
>= ROUTER_USER
) &&
405 (cmd
<= ROUTER_USER_MAX
) &&
407 err
= wandev
->ioctl(wandev
, cmd
, arg
);
410 mutex_unlock(&wanrouter_mutex
);
415 * WAN Driver IOCTL Handlers
419 * Setup WAN link device.
420 * o verify user address space
421 * o allocate kernel memory and copy configuration data to kernel space
422 * o if configuration data includes extension, copy it to kernel space too
423 * o call driver's setup() entry point
426 static int wanrouter_device_setup(struct wan_device
*wandev
,
427 wandev_conf_t __user
*u_conf
)
433 if (wandev
->setup
== NULL
) { /* Nothing to do ? */
434 printk(KERN_INFO
"%s: ERROR, No setup script: wandev->setup()\n",
439 conf
= kmalloc(sizeof(wandev_conf_t
), GFP_KERNEL
);
441 printk(KERN_INFO
"%s: ERROR, Failed to allocate kernel memory !\n",
446 if (copy_from_user(conf
, u_conf
, sizeof(wandev_conf_t
))) {
447 printk(KERN_INFO
"%s: Failed to copy user config data to kernel space!\n",
453 if (conf
->magic
!= ROUTER_MAGIC
) {
455 printk(KERN_INFO
"%s: ERROR, Invalid MAGIC Number\n",
460 if (conf
->data_size
&& conf
->data
) {
461 if (conf
->data_size
> 128000) {
463 "%s: ERROR, Invalid firmware data size %i !\n",
464 wandev
->name
, conf
->data_size
);
469 data
= vmalloc(conf
->data_size
);
472 "%s: ERROR, Failed allocate kernel memory !\n",
477 if (!copy_from_user(data
, conf
->data
, conf
->data_size
)) {
479 err
= wandev
->setup(wandev
, conf
);
482 "%s: ERROR, Failed to copy from user data !\n",
489 "%s: ERROR, No firmware found ! Firmware size = %i !\n",
490 wandev
->name
, conf
->data_size
);
498 * Shutdown WAN device.
499 * o delete all not opened logical channels for this device
500 * o call driver's shutdown() entry point
503 static int wanrouter_device_shutdown(struct wan_device
*wandev
)
505 struct net_device
*dev
;
508 if (wandev
->state
== WAN_UNCONFIGURED
)
511 printk(KERN_INFO
"\n%s: Shutting Down!\n",wandev
->name
);
513 for (dev
= wandev
->dev
; dev
;) {
514 err
= wanrouter_delete_interface(wandev
, dev
->name
);
517 /* The above function deallocates the current dev
518 * structure. Therefore, we cannot use netdev_priv(dev)
519 * as the next element: wandev->dev points to the
525 return -EBUSY
; /* there are opened interfaces */
527 if (wandev
->shutdown
)
528 err
=wandev
->shutdown(wandev
);
534 * Get WAN device status & statistics.
537 static int wanrouter_device_stat(struct wan_device
*wandev
,
538 wandev_stat_t __user
*u_stat
)
542 memset(&stat
, 0, sizeof(stat
));
544 /* Ask device driver to update device statistics */
545 if ((wandev
->state
!= WAN_UNCONFIGURED
) && wandev
->update
)
546 wandev
->update(wandev
);
548 /* Fill out structure */
549 stat
.ndev
= wandev
->ndev
;
550 stat
.state
= wandev
->state
;
552 if (copy_to_user(u_stat
, &stat
, sizeof(stat
)))
559 * Create new WAN interface.
560 * o verify user address space
561 * o copy configuration data to kernel address space
562 * o allocate network interface data space
563 * o call driver's new_if() entry point
564 * o make sure there is no interface name conflict
565 * o register network interface
568 static int wanrouter_device_new_if(struct wan_device
*wandev
,
569 wanif_conf_t __user
*u_conf
)
572 struct net_device
*dev
= 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 printk(KERN_INFO
"%s: Wanpipe Mulit-Port PPP support has not been compiled in!\n",
593 err
= -EPROTONOSUPPORT
;
596 err
= wandev
->new_if(wandev
, dev
, cnf
);
600 /* Register network interface. This will invoke init()
601 * function supplied by the driver. If device registered
602 * successfully, add it to the interface list.
606 printk(KERN_INFO
"%s: registering interface %s...\n",
607 wanrouter_modname
, dev
->name
);
610 err
= register_netdev(dev
);
612 struct net_device
*slave
= NULL
;
613 unsigned long smp_flags
=0;
615 lock_adapter_irq(&wandev
->lock
, &smp_flags
);
617 if (wandev
->dev
== NULL
) {
620 for (slave
=wandev
->dev
;
622 slave
= DEV_TO_SLAVE(slave
))
623 DEV_TO_SLAVE(slave
) = dev
;
627 unlock_adapter_irq(&wandev
->lock
, &smp_flags
);
628 err
= 0; /* done !!! */
632 wandev
->del_if(wandev
, dev
);
643 * Delete WAN logical channel.
644 * o verify user address space
645 * o copy configuration data to kernel address space
648 static int wanrouter_device_del_if(struct wan_device
*wandev
, char __user
*u_name
)
650 char name
[WAN_IFNAME_SZ
+ 1];
653 if (wandev
->state
== WAN_UNCONFIGURED
)
656 memset(name
, 0, sizeof(name
));
658 if (copy_from_user(name
, u_name
, WAN_IFNAME_SZ
))
661 err
= wanrouter_delete_interface(wandev
, name
);
665 /* If last interface being deleted, shutdown card
666 * This helps with administration at leaf nodes
667 * (You can tell if the person at the other end of the phone
668 * has an interface configured) and avoids DoS vulnerabilities
669 * in binary driver files - this fixes a problem with the current
670 * Sangoma driver going into strange states when all the network
671 * interfaces are deleted and the link irrecoverably disconnected.
674 if (!wandev
->ndev
&& wandev
->shutdown
)
675 err
= wandev
->shutdown(wandev
);
681 * Miscellaneous Functions
685 * Find WAN device by name.
686 * Return pointer to the WAN device data space or NULL if device not found.
689 static struct wan_device
*wanrouter_find_device(char *name
)
691 struct wan_device
*wandev
;
693 for (wandev
= wanrouter_router_devlist
;
694 wandev
&& strcmp(wandev
->name
, name
);
695 wandev
= wandev
->next
);
700 * Delete WAN logical channel identified by its name.
701 * o find logical channel by its name
702 * o call driver's del_if() entry point
703 * o unregister network interface
704 * o unlink channel data space from linked list of channels
705 * o release channel data space
708 * -ENODEV channel not found.
709 * -EBUSY interface is open
711 * Note: If (force != 0), then device will be destroyed even if interface
712 * associated with it is open. It's caller's responsibility to make
713 * sure that opened interfaces are not removed!
716 static int wanrouter_delete_interface(struct wan_device
*wandev
, char *name
)
718 struct net_device
*dev
= NULL
, *prev
= NULL
;
719 unsigned long smp_flags
=0;
721 lock_adapter_irq(&wandev
->lock
, &smp_flags
);
724 while (dev
&& strcmp(name
, dev
->name
)) {
725 struct net_device
**slave
= netdev_priv(dev
);
729 unlock_adapter_irq(&wandev
->lock
, &smp_flags
);
732 return -ENODEV
; /* interface not found */
734 if (netif_running(dev
))
735 return -EBUSY
; /* interface in use */
738 wandev
->del_if(wandev
, dev
);
740 lock_adapter_irq(&wandev
->lock
, &smp_flags
);
742 struct net_device
**prev_slave
= netdev_priv(prev
);
743 struct net_device
**slave
= netdev_priv(dev
);
745 *prev_slave
= *slave
;
747 struct net_device
**slave
= netdev_priv(dev
);
748 wandev
->dev
= *slave
;
751 unlock_adapter_irq(&wandev
->lock
, &smp_flags
);
753 printk(KERN_INFO
"%s: unregistering '%s'\n", wandev
->name
, dev
->name
);
755 unregister_netdev(dev
);
762 static void lock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
765 spin_lock_irqsave(lock
, *smp_flags
);
769 static void unlock_adapter_irq(spinlock_t
*lock
, unsigned long *smp_flags
)
772 spin_unlock_irqrestore(lock
, *smp_flags
);
775 EXPORT_SYMBOL(register_wan_device
);
776 EXPORT_SYMBOL(unregister_wan_device
);
778 MODULE_LICENSE("GPL");