2 * This program is free software; you can distribute it and/or modify it
3 * under the terms of the GNU General Public License (Version 2) as
4 * published by the Free Software Foundation.
6 * This program is distributed in the hope it will be useful, but WITHOUT
7 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
8 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11 * You should have received a copy of the GNU General Public License along
12 * with this program; if not, write to the Free Software Foundation, Inc.,
13 * 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
15 * Copyright (C) Hans Alblas PE1AYX <hans@esrac.ele.tue.nl>
16 * Copyright (C) 2004, 05 Ralf Baechle DL5RB <ralf@linux-mips.org>
19 #include <linux/config.h>
20 #include <linux/module.h>
21 #include <asm/system.h>
22 #include <linux/bitops.h>
23 #include <asm/uaccess.h>
24 #include <linux/string.h>
26 #include <linux/interrupt.h>
28 #include <linux/inet.h>
29 #include <linux/tty.h>
30 #include <linux/errno.h>
31 #include <linux/netdevice.h>
32 #include <linux/major.h>
33 #include <linux/init.h>
34 #include <linux/rtnetlink.h>
35 #include <linux/etherdevice.h>
36 #include <linux/skbuff.h>
37 #include <linux/if_arp.h>
38 #include <linux/jiffies.h>
44 #include <linux/tcp.h>
49 /* SLIP/KISS protocol characters. */
50 #define END 0300 /* indicates end of frame */
51 #define ESC 0333 /* indicates byte stuffing */
52 #define ESC_END 0334 /* ESC ESC_END means END 'data' */
53 #define ESC_ESC 0335 /* ESC ESC_ESC means ESC 'data' */
56 struct tty_struct *tty; /* ptr to TTY structure */
57 struct net_device *dev; /* easy for intr handling */
59 /* These are pointers to the malloc()ed frame buffers. */
60 spinlock_t buflock;/* lock for rbuf and xbuf */
61 unsigned char *rbuff; /* receiver buffer */
62 int rcount; /* received chars counter */
63 unsigned char *xbuff; /* transmitter buffer */
64 unsigned char *xhead; /* pointer to next byte to XMIT */
65 int xleft; /* bytes left in XMIT queue */
67 struct net_device_stats stats;
69 /* Detailed SLIP statistics. */
70 int mtu; /* Our mtu (to spot changes!) */
71 int buffsize; /* Max buffers sizes */
73 unsigned long flags; /* Flag values/ mode etc */
74 /* long req'd: used by set_bit --RR */
75 #define AXF_INUSE 0 /* Channel in use */
76 #define AXF_ESCAPE 1 /* ESC received */
77 #define AXF_ERROR 2 /* Parity, etc. error */
78 #define AXF_KEEPTEST 3 /* Keepalive test flag */
79 #define AXF_OUTWAIT 4 /* is outpacket was flag */
82 int crcmode; /* MW: for FlexNet, SMACK etc. */
83 #define CRC_MODE_NONE 0
84 #define CRC_MODE_FLEX 1
85 #define CRC_MODE_SMACK 2
88 struct semaphore dead_sem;
91 /*---------------------------------------------------------------------------*/
93 static const unsigned short crc_flex_table[] = {
94 0x0f87, 0x1e0e, 0x2c95, 0x3d1c, 0x49a3, 0x582a, 0x6ab1, 0x7b38,
95 0x83cf, 0x9246, 0xa0dd, 0xb154, 0xc5eb, 0xd462, 0xe6f9, 0xf770,
96 0x1f06, 0x0e8f, 0x3c14, 0x2d9d, 0x5922, 0x48ab, 0x7a30, 0x6bb9,
97 0x934e, 0x82c7, 0xb05c, 0xa1d5, 0xd56a, 0xc4e3, 0xf678, 0xe7f1,
98 0x2e85, 0x3f0c, 0x0d97, 0x1c1e, 0x68a1, 0x7928, 0x4bb3, 0x5a3a,
99 0xa2cd, 0xb344, 0x81df, 0x9056, 0xe4e9, 0xf560, 0xc7fb, 0xd672,
100 0x3e04, 0x2f8d, 0x1d16, 0x0c9f, 0x7820, 0x69a9, 0x5b32, 0x4abb,
101 0xb24c, 0xa3c5, 0x915e, 0x80d7, 0xf468, 0xe5e1, 0xd77a, 0xc6f3,
102 0x4d83, 0x5c0a, 0x6e91, 0x7f18, 0x0ba7, 0x1a2e, 0x28b5, 0x393c,
103 0xc1cb, 0xd042, 0xe2d9, 0xf350, 0x87ef, 0x9666, 0xa4fd, 0xb574,
104 0x5d02, 0x4c8b, 0x7e10, 0x6f99, 0x1b26, 0x0aaf, 0x3834, 0x29bd,
105 0xd14a, 0xc0c3, 0xf258, 0xe3d1, 0x976e, 0x86e7, 0xb47c, 0xa5f5,
106 0x6c81, 0x7d08, 0x4f93, 0x5e1a, 0x2aa5, 0x3b2c, 0x09b7, 0x183e,
107 0xe0c9, 0xf140, 0xc3db, 0xd252, 0xa6ed, 0xb764, 0x85ff, 0x9476,
108 0x7c00, 0x6d89, 0x5f12, 0x4e9b, 0x3a24, 0x2bad, 0x1936, 0x08bf,
109 0xf048, 0xe1c1, 0xd35a, 0xc2d3, 0xb66c, 0xa7e5, 0x957e, 0x84f7,
110 0x8b8f, 0x9a06, 0xa89d, 0xb914, 0xcdab, 0xdc22, 0xeeb9, 0xff30,
111 0x07c7, 0x164e, 0x24d5, 0x355c, 0x41e3, 0x506a, 0x62f1, 0x7378,
112 0x9b0e, 0x8a87, 0xb81c, 0xa995, 0xdd2a, 0xcca3, 0xfe38, 0xefb1,
113 0x1746, 0x06cf, 0x3454, 0x25dd, 0x5162, 0x40eb, 0x7270, 0x63f9,
114 0xaa8d, 0xbb04, 0x899f, 0x9816, 0xeca9, 0xfd20, 0xcfbb, 0xde32,
115 0x26c5, 0x374c, 0x05d7, 0x145e, 0x60e1, 0x7168, 0x43f3, 0x527a,
116 0xba0c, 0xab85, 0x991e, 0x8897, 0xfc28, 0xeda1, 0xdf3a, 0xceb3,
117 0x3644, 0x27cd, 0x1556, 0x04df, 0x7060, 0x61e9, 0x5372, 0x42fb,
118 0xc98b, 0xd802, 0xea99, 0xfb10, 0x8faf, 0x9e26, 0xacbd, 0xbd34,
119 0x45c3, 0x544a, 0x66d1, 0x7758, 0x03e7, 0x126e, 0x20f5, 0x317c,
120 0xd90a, 0xc883, 0xfa18, 0xeb91, 0x9f2e, 0x8ea7, 0xbc3c, 0xadb5,
121 0x5542, 0x44cb, 0x7650, 0x67d9, 0x1366, 0x02ef, 0x3074, 0x21fd,
122 0xe889, 0xf900, 0xcb9b, 0xda12, 0xaead, 0xbf24, 0x8dbf, 0x9c36,
123 0x64c1, 0x7548, 0x47d3, 0x565a, 0x22e5, 0x336c, 0x01f7, 0x107e,
124 0xf808, 0xe981, 0xdb1a, 0xca93, 0xbe2c, 0xafa5, 0x9d3e, 0x8cb7,
125 0x7440, 0x65c9, 0x5752, 0x46db, 0x3264, 0x23ed, 0x1176, 0x00ff
128 static unsigned short calc_crc_flex(unsigned char *cp, int size)
130 unsigned short crc = 0xffff;
133 crc = (crc << 8) ^ crc_flex_table[((crc >> 8) ^ *cp++) & 0xff];
138 static int check_crc_flex(unsigned char *cp, int size)
140 unsigned short crc = 0xffff;
146 crc = (crc << 8) ^ crc_flex_table[((crc >> 8) ^ *cp++) & 0xff];
148 if ((crc & 0xffff) != 0x7070)
155 * Standard encapsulation
158 static int kiss_esc(unsigned char *s, unsigned char *d, int len)
160 unsigned char *ptr = d;
164 * Send an initial END character to flush out any data that may have
165 * accumulated in the receiver due to line noise.
193 * OK its ugly, but tell me a better solution without copying the
194 * packet to a temporary buffer :-)
196 static int kiss_esc_crc(unsigned char *s, unsigned char *d, unsigned short crc,
199 unsigned char *ptr = d;
232 /* Send one completely decapsulated AX.25 packet to the AX.25 layer. */
233 static void ax_bump(struct mkiss *ax)
238 spin_lock_bh(&ax->buflock);
239 if (ax->rbuff[0] > 0x0f) {
240 if (ax->rbuff[0] & 0x20) {
241 ax->crcmode = CRC_MODE_FLEX;
242 if (check_crc_flex(ax->rbuff, ax->rcount) < 0) {
243 ax->stats.rx_errors++;
247 /* dl9sau bugfix: the trailling two bytes flexnet crc
248 * will not be passed to the kernel. thus we have
249 * to correct the kissparm signature, because it
250 * indicates a crc but there's none
255 spin_unlock_bh(&ax->buflock);
259 if ((skb = dev_alloc_skb(count)) == NULL) {
260 printk(KERN_ERR "mkiss: %s: memory squeeze, dropping packet.\n",
262 ax->stats.rx_dropped++;
266 spin_lock_bh(&ax->buflock);
267 memcpy(skb_put(skb,count), ax->rbuff, count);
268 spin_unlock_bh(&ax->buflock);
269 skb->protocol = ax25_type_trans(skb, ax->dev);
271 ax->dev->last_rx = jiffies;
272 ax->stats.rx_packets++;
273 ax->stats.rx_bytes += count;
276 static void kiss_unesc(struct mkiss *ax, unsigned char s)
280 /* drop keeptest bit = VSV */
281 if (test_bit(AXF_KEEPTEST, &ax->flags))
282 clear_bit(AXF_KEEPTEST, &ax->flags);
284 if (!test_and_clear_bit(AXF_ERROR, &ax->flags) && (ax->rcount > 2))
287 clear_bit(AXF_ESCAPE, &ax->flags);
292 set_bit(AXF_ESCAPE, &ax->flags);
295 if (test_and_clear_bit(AXF_ESCAPE, &ax->flags))
299 if (test_and_clear_bit(AXF_ESCAPE, &ax->flags))
304 spin_lock_bh(&ax->buflock);
305 if (!test_bit(AXF_ERROR, &ax->flags)) {
306 if (ax->rcount < ax->buffsize) {
307 ax->rbuff[ax->rcount++] = s;
308 spin_unlock_bh(&ax->buflock);
312 ax->stats.rx_over_errors++;
313 set_bit(AXF_ERROR, &ax->flags);
315 spin_unlock_bh(&ax->buflock);
318 static int ax_set_mac_address(struct net_device *dev, void *addr)
320 struct sockaddr_ax25 *sa = addr;
322 spin_lock_irq(&dev->xmit_lock);
323 memcpy(dev->dev_addr, &sa->sax25_call, AX25_ADDR_LEN);
324 spin_unlock_irq(&dev->xmit_lock);
329 /*---------------------------------------------------------------------------*/
331 static void ax_changedmtu(struct mkiss *ax)
333 struct net_device *dev = ax->dev;
334 unsigned char *xbuff, *rbuff, *oxbuff, *orbuff;
340 * allow for arrival of larger UDP packets, even if we say not to
341 * also fixes a bug in which SunOS sends 512-byte packets even with
347 xbuff = kmalloc(len + 4, GFP_ATOMIC);
348 rbuff = kmalloc(len + 4, GFP_ATOMIC);
350 if (xbuff == NULL || rbuff == NULL) {
351 printk(KERN_ERR "mkiss: %s: unable to grow ax25 buffers, "
352 "MTU change cancelled.\n",
362 spin_lock_bh(&ax->buflock);
370 if (ax->xleft <= len) {
371 memcpy(ax->xbuff, ax->xhead, ax->xleft);
374 ax->stats.tx_dropped++;
378 ax->xhead = ax->xbuff;
381 if (ax->rcount <= len) {
382 memcpy(ax->rbuff, orbuff, ax->rcount);
385 ax->stats.rx_over_errors++;
386 set_bit(AXF_ERROR, &ax->flags);
390 ax->mtu = dev->mtu + 73;
393 spin_unlock_bh(&ax->buflock);
399 /* Encapsulate one AX.25 packet and stuff into a TTY queue. */
400 static void ax_encaps(struct net_device *dev, unsigned char *icp, int len)
402 struct mkiss *ax = netdev_priv(dev);
406 if (ax->mtu != ax->dev->mtu + 73) /* Someone has been ifconfigging */
409 if (len > ax->mtu) { /* Sigh, shouldn't occur BUT ... */
411 printk(KERN_ERR "mkiss: %s: truncating oversized transmit packet!\n", ax->dev->name);
412 ax->stats.tx_dropped++;
413 netif_start_queue(dev);
419 spin_lock_bh(&ax->buflock);
420 switch (ax->crcmode) {
425 crc = calc_crc_flex(p, len);
426 count = kiss_esc_crc(p, (unsigned char *)ax->xbuff, crc, len+2);
430 count = kiss_esc(p, (unsigned char *)ax->xbuff, len);
434 set_bit(TTY_DO_WRITE_WAKEUP, &ax->tty->flags);
435 actual = ax->tty->driver->write(ax->tty, ax->xbuff, count);
436 ax->stats.tx_packets++;
437 ax->stats.tx_bytes += actual;
439 ax->dev->trans_start = jiffies;
440 ax->xleft = count - actual;
441 ax->xhead = ax->xbuff + actual;
443 spin_unlock_bh(&ax->buflock);
446 /* Encapsulate an AX.25 packet and kick it into a TTY queue. */
447 static int ax_xmit(struct sk_buff *skb, struct net_device *dev)
449 struct mkiss *ax = netdev_priv(dev);
451 if (!netif_running(dev)) {
452 printk(KERN_ERR "mkiss: %s: xmit call when iface is down\n", dev->name);
456 if (netif_queue_stopped(dev)) {
458 * May be we must check transmitter timeout here ?
459 * 14 Oct 1994 Dmitry Gorodchanin.
461 if (time_before(jiffies, dev->trans_start + 20 * HZ)) {
462 /* 20 sec timeout not reached */
466 printk(KERN_ERR "mkiss: %s: transmit timed out, %s?\n", dev->name,
467 (ax->tty->driver->chars_in_buffer(ax->tty) || ax->xleft) ?
468 "bad line quality" : "driver error");
471 clear_bit(TTY_DO_WRITE_WAKEUP, &ax->tty->flags);
472 netif_start_queue(dev);
475 /* We were not busy, so we are now... :-) */
477 netif_stop_queue(dev);
478 ax_encaps(dev, skb->data, skb->len);
485 static int ax_open_dev(struct net_device *dev)
487 struct mkiss *ax = netdev_priv(dev);
495 #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
497 /* Return the frame type ID */
498 static int ax_header(struct sk_buff *skb, struct net_device *dev, unsigned short type,
499 void *daddr, void *saddr, unsigned len)
502 if (type != htons(ETH_P_AX25))
503 return ax25_hard_header(skb, dev, type, daddr, saddr, len);
509 static int ax_rebuild_header(struct sk_buff *skb)
512 return ax25_rebuild_header(skb);
518 #endif /* CONFIG_{AX25,AX25_MODULE} */
520 /* Open the low-level part of the AX25 channel. Easy! */
521 static int ax_open(struct net_device *dev)
523 struct mkiss *ax = netdev_priv(dev);
530 * Allocate the frame buffers:
532 * rbuff Receive buffer.
533 * xbuff Transmit buffer.
538 * allow for arrival of larger UDP packets, even if we say not to
539 * also fixes a bug in which SunOS sends 512-byte packets even with
545 if ((ax->rbuff = kmalloc(len + 4, GFP_KERNEL)) == NULL)
548 if ((ax->xbuff = kmalloc(len + 4, GFP_KERNEL)) == NULL)
551 ax->mtu = dev->mtu + 73;
556 ax->flags &= (1 << AXF_INUSE); /* Clear ESCAPE & ERROR flags */
558 spin_lock_init(&ax->buflock);
570 /* Close the low-level part of the AX25 channel. Easy! */
571 static int ax_close(struct net_device *dev)
573 struct mkiss *ax = netdev_priv(dev);
576 clear_bit(TTY_DO_WRITE_WAKEUP, &ax->tty->flags);
578 netif_stop_queue(dev);
583 static struct net_device_stats *ax_get_stats(struct net_device *dev)
585 struct mkiss *ax = netdev_priv(dev);
590 static void ax_setup(struct net_device *dev)
592 static char ax25_bcast[AX25_ADDR_LEN] =
593 {'Q'<<1,'S'<<1,'T'<<1,' '<<1,' '<<1,' '<<1,'0'<<1};
594 static char ax25_test[AX25_ADDR_LEN] =
595 {'L'<<1,'I'<<1,'N'<<1,'U'<<1,'X'<<1,' '<<1,'1'<<1};
597 /* Finish setting up the DEVICE info. */
599 dev->hard_start_xmit = ax_xmit;
600 dev->open = ax_open_dev;
601 dev->stop = ax_close;
602 dev->get_stats = ax_get_stats;
603 dev->set_mac_address = ax_set_mac_address;
604 dev->hard_header_len = 0;
606 dev->type = ARPHRD_AX25;
607 dev->tx_queue_len = 10;
608 dev->hard_header = ax_header;
609 dev->rebuild_header = ax_rebuild_header;
611 memcpy(dev->broadcast, ax25_bcast, AX25_ADDR_LEN);
612 memcpy(dev->dev_addr, ax25_test, AX25_ADDR_LEN);
614 dev->flags = IFF_BROADCAST | IFF_MULTICAST;
618 * We have a potential race on dereferencing tty->disc_data, because the tty
619 * layer provides no locking at all - thus one cpu could be running
620 * sixpack_receive_buf while another calls sixpack_close, which zeroes
621 * tty->disc_data and frees the memory that sixpack_receive_buf is using. The
622 * best way to fix this is to use a rwlock in the tty struct, but for now we
623 * use a single global rwlock for all ttys in ppp line discipline.
625 static rwlock_t disc_data_lock = RW_LOCK_UNLOCKED;
627 static struct mkiss *mkiss_get(struct tty_struct *tty)
631 read_lock(&disc_data_lock);
634 atomic_inc(&ax->refcnt);
635 read_unlock(&disc_data_lock);
640 static void mkiss_put(struct mkiss *ax)
642 if (atomic_dec_and_test(&ax->refcnt))
646 static int mkiss_open(struct tty_struct *tty)
648 struct net_device *dev;
652 if (!capable(CAP_NET_ADMIN))
655 dev = alloc_netdev(sizeof(struct mkiss), "ax%d", ax_setup);
661 ax = netdev_priv(dev);
664 spin_lock_init(&ax->buflock);
665 atomic_set(&ax->refcnt, 1);
666 init_MUTEX_LOCKED(&ax->dead_sem);
671 if (tty->driver->flush_buffer)
672 tty->driver->flush_buffer(tty);
674 /* Restore default settings */
675 dev->type = ARPHRD_AX25;
677 /* Perform the low-level AX25 initialization. */
678 if ((err = ax_open(ax->dev))) {
679 goto out_free_netdev;
682 if (register_netdev(dev))
683 goto out_free_buffers;
685 netif_start_queue(dev);
687 /* Done. We have linked the TTY line to a channel. */
701 static void mkiss_close(struct tty_struct *tty)
705 write_lock(&disc_data_lock);
707 tty->disc_data = NULL;
708 write_unlock(&disc_data_lock);
714 * We have now ensured that nobody can start using ap from now on, but
715 * we have to wait for all existing users to finish.
717 if (!atomic_dec_and_test(&ax->refcnt))
720 unregister_netdev(ax->dev);
722 /* Free all AX25 frame buffers. */
729 /* Perform I/O control on an active ax25 channel. */
730 static int mkiss_ioctl(struct tty_struct *tty, struct file *file,
731 unsigned int cmd, unsigned long arg)
733 struct mkiss *ax = mkiss_get(tty);
734 struct net_device *dev = ax->dev;
735 unsigned int tmp, err;
737 /* First make sure we're connected. */
743 err = copy_to_user((void __user *) arg, ax->dev->name,
744 strlen(ax->dev->name) + 1) ? -EFAULT : 0;
748 err = put_user(4, (int __user *) arg);
752 if (get_user(tmp, (int __user *) arg)) {
758 dev->addr_len = AX25_ADDR_LEN;
759 dev->hard_header_len = AX25_KISS_HEADER_LEN +
760 AX25_MAX_HEADER_LEN + 3;
761 dev->type = ARPHRD_AX25;
766 case SIOCSIFHWADDR: {
767 char addr[AX25_ADDR_LEN];
768 printk(KERN_INFO "In SIOCSIFHWADDR");
770 if (copy_from_user(&addr,
771 (void __user *) arg, AX25_ADDR_LEN)) {
776 spin_lock_irq(&dev->xmit_lock);
777 memcpy(dev->dev_addr, addr, AX25_ADDR_LEN);
778 spin_unlock_irq(&dev->xmit_lock);
793 * Handle the 'receiver data ready' interrupt.
794 * This function is called by the 'tty_io' module in the kernel when
795 * a block of data has been received, which can now be decapsulated
796 * and sent on to the AX.25 layer for further processing.
798 static void mkiss_receive_buf(struct tty_struct *tty, const unsigned char *cp,
801 struct mkiss *ax = mkiss_get(tty);
807 * Argh! mtu change time! - costs us the packet part received
810 if (ax->mtu != ax->dev->mtu + 73)
813 /* Read the characters out of the buffer */
815 if (fp != NULL && *fp++) {
816 if (!test_and_set_bit(AXF_ERROR, &ax->flags))
817 ax->stats.rx_errors++;
822 kiss_unesc(ax, *cp++);
826 if (test_and_clear_bit(TTY_THROTTLED, &tty->flags)
827 && tty->driver->unthrottle)
828 tty->driver->unthrottle(tty);
831 static int mkiss_receive_room(struct tty_struct *tty)
833 return 65536; /* We can handle an infinite amount of data. :-) */
837 * Called by the driver when there's room for more data. If we have
838 * more packets to send, we send them here.
840 static void mkiss_write_wakeup(struct tty_struct *tty)
842 struct mkiss *ax = mkiss_get(tty);
848 if (ax->xleft <= 0) {
849 /* Now serial buffer is almost free & we can start
850 * transmission of another packet
852 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
854 netif_wake_queue(ax->dev);
858 actual = tty->driver->write(tty, ax->xhead, ax->xleft);
866 static struct tty_ldisc ax_ldisc = {
867 .magic = TTY_LDISC_MAGIC,
870 .close = mkiss_close,
871 .ioctl = mkiss_ioctl,
872 .receive_buf = mkiss_receive_buf,
873 .receive_room = mkiss_receive_room,
874 .write_wakeup = mkiss_write_wakeup
877 static char banner[] __initdata = KERN_INFO \
878 "mkiss: AX.25 Multikiss, Hans Albas PE1AYX\n";
879 static char msg_regfail[] __initdata = KERN_ERR \
880 "mkiss: can't register line discipline (err = %d)\n";
882 static int __init mkiss_init_driver(void)
888 if ((status = tty_register_ldisc(N_AX25, &ax_ldisc)) != 0)
894 static const char msg_unregfail[] __exitdata = KERN_ERR \
895 "mkiss: can't unregister line discipline (err = %d)\n";
897 static void __exit mkiss_exit_driver(void)
901 if ((ret = tty_unregister_ldisc(N_AX25)))
902 printk(msg_unregfail, ret);
905 MODULE_AUTHOR("Ralf Baechle DL5RB <ralf@linux-mips.org>");
906 MODULE_DESCRIPTION("KISS driver for AX.25 over TTYs");
907 MODULE_LICENSE("GPL");
908 MODULE_ALIAS_LDISC(N_AX25);
910 module_init(mkiss_init_driver);
911 module_exit(mkiss_exit_driver);