5 * o allow users to set the parameters
6 * o sync/async switching ?
8 * Note: This does _not_ implement CCITT X.25 asynchronous framing
9 * recommendations. Its primarily for testing purposes. If you wanted
10 * to do CCITT then in theory all you need is to nick the HDLC async
11 * checksum routines from ppp.c
14 * 2000-10-29 Henner Eisen lapb_data_indication() return status.
17 #include <linux/module.h>
19 #include <asm/system.h>
20 #include <linux/uaccess.h>
21 #include <linux/bitops.h>
22 #include <linux/string.h>
24 #include <linux/interrupt.h>
26 #include <linux/tty.h>
27 #include <linux/errno.h>
28 #include <linux/netdevice.h>
29 #include <linux/etherdevice.h>
30 #include <linux/skbuff.h>
31 #include <linux/if_arp.h>
32 #include <linux/x25.h>
33 #include <linux/lapb.h>
34 #include <linux/init.h>
37 #include <net/x25device.h>
39 static struct net_device **x25_asy_devs;
40 static int x25_asy_maxdev = SL_NRUNIT;
42 module_param(x25_asy_maxdev, int, 0);
43 MODULE_LICENSE("GPL");
45 static int x25_asy_esc(unsigned char *p, unsigned char *d, int len);
46 static void x25_asy_unesc(struct x25_asy *sl, unsigned char c);
47 static void x25_asy_setup(struct net_device *dev);
49 /* Find a free X.25 channel, and link in this `tty' line. */
50 static struct x25_asy *x25_asy_alloc(void)
52 struct net_device *dev = NULL;
56 if (x25_asy_devs == NULL)
57 return NULL; /* Master array missing ! */
59 for (i = 0; i < x25_asy_maxdev; i++) {
60 dev = x25_asy_devs[i];
68 if (!test_and_set_bit(SLF_INUSE, &sl->flags))
73 /* Sorry, too many, all slots in use */
74 if (i >= x25_asy_maxdev)
77 /* If no channels are available, allocate one */
80 sprintf(name, "x25asy%d", i);
82 dev = alloc_netdev(sizeof(struct x25_asy),
87 /* Initialize channel control data */
91 /* register device so that it can be ifconfig'ed */
92 if (register_netdev(dev) == 0) {
93 /* (Re-)Set the INUSE bit. Very Important! */
94 set_bit(SLF_INUSE, &sl->flags);
95 x25_asy_devs[i] = dev;
98 printk(KERN_WARNING "x25_asy_alloc() - register_netdev() failure.\n");
106 /* Free an X.25 channel. */
107 static void x25_asy_free(struct x25_asy *sl)
109 /* Free all X.25 frame buffers. */
115 if (!test_and_clear_bit(SLF_INUSE, &sl->flags))
116 printk(KERN_ERR "%s: x25_asy_free for already free unit.\n",
120 static int x25_asy_change_mtu(struct net_device *dev, int newmtu)
122 struct x25_asy *sl = dev->priv;
123 unsigned char *xbuff, *rbuff;
124 int len = 2 * newmtu;
126 xbuff = kmalloc(len + 4, GFP_ATOMIC);
127 rbuff = kmalloc(len + 4, GFP_ATOMIC);
129 if (xbuff == NULL || rbuff == NULL) {
130 printk(KERN_WARNING "%s: unable to grow X.25 buffers, MTU change cancelled.\n",
137 spin_lock_bh(&sl->lock);
138 xbuff = xchg(&sl->xbuff, xbuff);
140 if (sl->xleft <= len) {
141 memcpy(sl->xbuff, sl->xhead, sl->xleft);
144 sl->stats.tx_dropped++;
147 sl->xhead = sl->xbuff;
149 rbuff = xchg(&sl->rbuff, rbuff);
151 if (sl->rcount <= len) {
152 memcpy(sl->rbuff, rbuff, sl->rcount);
155 sl->stats.rx_over_errors++;
156 set_bit(SLF_ERROR, &sl->flags);
163 spin_unlock_bh(&sl->lock);
171 /* Set the "sending" flag. This must be atomic, hence the ASM. */
173 static inline void x25_asy_lock(struct x25_asy *sl)
175 netif_stop_queue(sl->dev);
179 /* Clear the "sending" flag. This must be atomic, hence the ASM. */
181 static inline void x25_asy_unlock(struct x25_asy *sl)
183 netif_wake_queue(sl->dev);
186 /* Send one completely decapsulated IP datagram to the IP layer. */
188 static void x25_asy_bump(struct x25_asy *sl)
195 sl->stats.rx_bytes += count;
197 skb = dev_alloc_skb(count+1);
199 printk(KERN_WARNING "%s: memory squeeze, dropping packet.\n",
201 sl->stats.rx_dropped++;
204 skb_push(skb, 1); /* LAPB internal control */
205 memcpy(skb_put(skb, count), sl->rbuff, count);
206 skb->protocol = x25_type_trans(skb, sl->dev);
207 err = lapb_data_received(skb->dev, skb);
208 if (err != LAPB_OK) {
210 printk(KERN_DEBUG "x25_asy: data received err - %d\n", err);
213 sl->dev->last_rx = jiffies;
214 sl->stats.rx_packets++;
218 /* Encapsulate one IP datagram and stuff into a TTY queue. */
219 static void x25_asy_encaps(struct x25_asy *sl, unsigned char *icp, int len)
222 int actual, count, mtu = sl->dev->mtu;
225 /* Sigh, shouldn't occur BUT ... */
227 printk(KERN_DEBUG "%s: truncating oversized transmit packet!\n",
229 sl->stats.tx_dropped++;
235 count = x25_asy_esc(p, (unsigned char *) sl->xbuff, len);
237 /* Order of next two lines is *very* important.
238 * When we are sending a little amount of data,
239 * the transfer may be completed inside driver.write()
240 * routine, because it's running with interrupts enabled.
241 * In this case we *never* got WRITE_WAKEUP event,
242 * if we did not request it before write operation.
243 * 14 Oct 1994 Dmitry Gorodchanin.
245 sl->tty->flags |= (1 << TTY_DO_WRITE_WAKEUP);
246 actual = sl->tty->ops->write(sl->tty, sl->xbuff, count);
247 sl->xleft = count - actual;
248 sl->xhead = sl->xbuff + actual;
250 clear_bit(SLF_OUTWAIT, &sl->flags); /* reset outfill flag */
254 * Called by the driver when there's room for more data. If we have
255 * more packets to send, we send them here.
257 static void x25_asy_write_wakeup(struct tty_struct *tty)
260 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
262 /* First make sure we're connected. */
263 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
266 if (sl->xleft <= 0) {
267 /* Now serial buffer is almost free & we can start
268 * transmission of another packet */
269 sl->stats.tx_packets++;
270 tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
275 actual = tty->ops->write(tty, sl->xhead, sl->xleft);
280 static void x25_asy_timeout(struct net_device *dev)
282 struct x25_asy *sl = dev->priv;
284 spin_lock(&sl->lock);
285 if (netif_queue_stopped(dev)) {
286 /* May be we must check transmitter timeout here ?
287 * 14 Oct 1994 Dmitry Gorodchanin.
289 printk(KERN_WARNING "%s: transmit timed out, %s?\n", dev->name,
290 (tty_chars_in_buffer(sl->tty) || sl->xleft) ?
291 "bad line quality" : "driver error");
293 sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
296 spin_unlock(&sl->lock);
299 /* Encapsulate an IP datagram and kick it into a TTY queue. */
301 static int x25_asy_xmit(struct sk_buff *skb, struct net_device *dev)
303 struct x25_asy *sl = dev->priv;
306 if (!netif_running(sl->dev)) {
307 printk(KERN_ERR "%s: xmit call when iface is down\n",
313 switch (skb->data[0]) {
316 case 0x01: /* Connection request .. do nothing */
317 err = lapb_connect_request(dev);
319 printk(KERN_ERR "x25_asy: lapb_connect_request error - %d\n", err);
322 case 0x02: /* Disconnect request .. do nothing - hang up ?? */
323 err = lapb_disconnect_request(dev);
325 printk(KERN_ERR "x25_asy: lapb_disconnect_request error - %d\n", err);
330 skb_pull(skb, 1); /* Remove control byte */
332 * If we are busy already- too bad. We ought to be able
333 * to queue things at this point, to allow for a little
334 * frame buffer. Oh well...
335 * -----------------------------------------------------
336 * I hate queues in X.25 driver. May be it's efficient,
337 * but for me latency is more important. ;)
339 * 14 Oct 1994 Dmitry Gorodchanin.
342 err = lapb_data_request(dev, skb);
343 if (err != LAPB_OK) {
344 printk(KERN_ERR "x25_asy: lapb_data_request error - %d\n", err);
353 * LAPB interface boilerplate
357 * Called when I frame data arrives. We did the work above - throw it
361 static int x25_asy_data_indication(struct net_device *dev, struct sk_buff *skb)
363 skb->dev->last_rx = jiffies;
364 return netif_rx(skb);
368 * Data has emerged from the LAPB protocol machine. We don't handle
369 * busy cases too well. Its tricky to see how to do this nicely -
370 * perhaps lapb should allow us to bounce this ?
373 static void x25_asy_data_transmit(struct net_device *dev, struct sk_buff *skb)
375 struct x25_asy *sl = dev->priv;
377 spin_lock(&sl->lock);
378 if (netif_queue_stopped(sl->dev) || sl->tty == NULL) {
379 spin_unlock(&sl->lock);
380 printk(KERN_ERR "x25_asy: tbusy drop\n");
384 /* We were not busy, so we are now... :-) */
387 sl->stats.tx_bytes += skb->len;
388 x25_asy_encaps(sl, skb->data, skb->len);
391 spin_unlock(&sl->lock);
395 * LAPB connection establish/down information.
398 static void x25_asy_connected(struct net_device *dev, int reason)
400 struct x25_asy *sl = dev->priv;
404 skb = dev_alloc_skb(1);
406 printk(KERN_ERR "x25_asy: out of memory\n");
410 ptr = skb_put(skb, 1);
413 skb->protocol = x25_type_trans(skb, sl->dev);
415 sl->dev->last_rx = jiffies;
418 static void x25_asy_disconnected(struct net_device *dev, int reason)
420 struct x25_asy *sl = dev->priv;
424 skb = dev_alloc_skb(1);
426 printk(KERN_ERR "x25_asy: out of memory\n");
430 ptr = skb_put(skb, 1);
433 skb->protocol = x25_type_trans(skb, sl->dev);
435 sl->dev->last_rx = jiffies;
438 static struct lapb_register_struct x25_asy_callbacks = {
439 .connect_confirmation = x25_asy_connected,
440 .connect_indication = x25_asy_connected,
441 .disconnect_confirmation = x25_asy_disconnected,
442 .disconnect_indication = x25_asy_disconnected,
443 .data_indication = x25_asy_data_indication,
444 .data_transmit = x25_asy_data_transmit,
449 /* Open the low-level part of the X.25 channel. Easy! */
450 static int x25_asy_open(struct net_device *dev)
452 struct x25_asy *sl = dev->priv;
460 * Allocate the X.25 frame buffers:
462 * rbuff Receive buffer.
463 * xbuff Transmit buffer.
468 sl->rbuff = kmalloc(len + 4, GFP_KERNEL);
469 if (sl->rbuff == NULL)
471 sl->xbuff = kmalloc(len + 4, GFP_KERNEL);
472 if (sl->xbuff == NULL)
478 sl->flags &= (1 << SLF_INUSE); /* Clear ESCAPE & ERROR flags */
480 netif_start_queue(dev);
485 err = lapb_register(dev, &x25_asy_callbacks);
498 /* Close the low-level part of the X.25 channel. Easy! */
499 static int x25_asy_close(struct net_device *dev)
501 struct x25_asy *sl = dev->priv;
504 spin_lock(&sl->lock);
506 sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
508 netif_stop_queue(dev);
511 err = lapb_unregister(dev);
513 printk(KERN_ERR "x25_asy_close: lapb_unregister error -%d\n",
515 spin_unlock(&sl->lock);
520 * Handle the 'receiver data ready' interrupt.
521 * This function is called by the 'tty_io' module in the kernel when
522 * a block of X.25 data has been received, which can now be decapsulated
523 * and sent on to some IP layer for further processing.
526 static void x25_asy_receive_buf(struct tty_struct *tty,
527 const unsigned char *cp, char *fp, int count)
529 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
531 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
535 /* Read the characters out of the buffer */
538 if (!test_and_set_bit(SLF_ERROR, &sl->flags))
539 sl->stats.rx_errors++;
543 x25_asy_unesc(sl, *cp++);
548 * Open the high-level part of the X.25 channel.
549 * This function is called by the TTY module when the
550 * X.25 line discipline is called for. Because we are
551 * sure the tty line exists, we only have to link it to
552 * a free X.25 channel...
555 static int x25_asy_open_tty(struct tty_struct *tty)
557 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
560 if (tty->ops->write == NULL)
563 /* First make sure we're not already connected. */
564 if (sl && sl->magic == X25_ASY_MAGIC)
567 /* OK. Find a free X.25 channel to use. */
568 sl = x25_asy_alloc();
574 tty->receive_room = 65536;
575 tty_driver_flush_buffer(tty);
576 tty_ldisc_flush(tty);
578 /* Restore default settings */
579 sl->dev->type = ARPHRD_X25;
581 /* Perform the low-level X.25 async init */
582 err = x25_asy_open(sl->dev);
585 /* Done. We have linked the TTY line to a channel. */
586 return sl->dev->base_addr;
591 * Close down an X.25 channel.
592 * This means flushing out any pending queues, and then restoring the
593 * TTY line discipline to what it was before it got hooked to X.25
594 * (which usually is TTY again).
596 static void x25_asy_close_tty(struct tty_struct *tty)
598 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
600 /* First make sure we're connected. */
601 if (!sl || sl->magic != X25_ASY_MAGIC)
604 if (sl->dev->flags & IFF_UP)
607 tty->disc_data = NULL;
613 static struct net_device_stats *x25_asy_get_stats(struct net_device *dev)
615 struct x25_asy *sl = dev->priv;
620 /************************************************************************
621 * STANDARD X.25 ENCAPSULATION *
622 ************************************************************************/
624 int x25_asy_esc(unsigned char *s, unsigned char *d, int len)
626 unsigned char *ptr = d;
630 * Send an initial END character to flush out any
631 * data that may have accumulated in the receiver
635 *ptr++ = X25_END; /* Send 10111110 bit seq */
638 * For each byte in the packet, send the appropriate
639 * character sequence, according to the X.25 protocol.
646 *ptr++ = X25_ESCAPE(X25_END);
650 *ptr++ = X25_ESCAPE(X25_ESC);
661 static void x25_asy_unesc(struct x25_asy *sl, unsigned char s)
666 if (!test_and_clear_bit(SLF_ERROR, &sl->flags)
669 clear_bit(SLF_ESCAPE, &sl->flags);
673 set_bit(SLF_ESCAPE, &sl->flags);
675 case X25_ESCAPE(X25_ESC):
676 case X25_ESCAPE(X25_END):
677 if (test_and_clear_bit(SLF_ESCAPE, &sl->flags))
681 if (!test_bit(SLF_ERROR, &sl->flags)) {
682 if (sl->rcount < sl->buffsize) {
683 sl->rbuff[sl->rcount++] = s;
686 sl->stats.rx_over_errors++;
687 set_bit(SLF_ERROR, &sl->flags);
692 /* Perform I/O control on an active X.25 channel. */
693 static int x25_asy_ioctl(struct tty_struct *tty, struct file *file,
694 unsigned int cmd, unsigned long arg)
696 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
698 /* First make sure we're connected. */
699 if (!sl || sl->magic != X25_ASY_MAGIC)
704 if (copy_to_user((void __user *)arg, sl->dev->name,
705 strlen(sl->dev->name) + 1))
711 return tty_mode_ioctl(tty, file, cmd, arg);
715 static int x25_asy_open_dev(struct net_device *dev)
717 struct x25_asy *sl = dev->priv;
723 /* Initialise the X.25 driver. Called by the device init code */
724 static void x25_asy_setup(struct net_device *dev)
726 struct x25_asy *sl = dev->priv;
728 sl->magic = X25_ASY_MAGIC;
730 spin_lock_init(&sl->lock);
731 set_bit(SLF_INUSE, &sl->flags);
734 * Finish setting up the DEVICE info.
738 dev->hard_start_xmit = x25_asy_xmit;
739 dev->tx_timeout = x25_asy_timeout;
740 dev->watchdog_timeo = HZ*20;
741 dev->open = x25_asy_open_dev;
742 dev->stop = x25_asy_close;
743 dev->get_stats = x25_asy_get_stats;
744 dev->change_mtu = x25_asy_change_mtu;
745 dev->hard_header_len = 0;
747 dev->type = ARPHRD_X25;
748 dev->tx_queue_len = 10;
750 /* New-style flags. */
751 dev->flags = IFF_NOARP;
754 static struct tty_ldisc x25_ldisc = {
755 .owner = THIS_MODULE,
756 .magic = TTY_LDISC_MAGIC,
758 .open = x25_asy_open_tty,
759 .close = x25_asy_close_tty,
760 .ioctl = x25_asy_ioctl,
761 .receive_buf = x25_asy_receive_buf,
762 .write_wakeup = x25_asy_write_wakeup,
765 static int __init init_x25_asy(void)
767 if (x25_asy_maxdev < 4)
768 x25_asy_maxdev = 4; /* Sanity */
770 printk(KERN_INFO "X.25 async: version 0.00 ALPHA "
771 "(dynamic channels, max=%d).\n", x25_asy_maxdev);
773 x25_asy_devs = kcalloc(x25_asy_maxdev, sizeof(struct net_device *),
776 printk(KERN_WARNING "X25 async: Can't allocate x25_asy_ctrls[] "
777 "array! Uaargh! (-> No X.25 available)\n");
781 return tty_register_ldisc(N_X25, &x25_ldisc);
785 static void __exit exit_x25_asy(void)
787 struct net_device *dev;
790 for (i = 0; i < x25_asy_maxdev; i++) {
791 dev = x25_asy_devs[i];
793 struct x25_asy *sl = dev->priv;
795 spin_lock_bh(&sl->lock);
799 spin_unlock_bh(&sl->lock);
801 * VSV = if dev->start==0, then device
802 * unregistered while close proc.
804 unregister_netdev(dev);
810 tty_unregister_ldisc(N_X25);
813 module_init(init_x25_asy);
814 module_exit(exit_x25_asy);