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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/module.h>
21 #include <linux/uaccess.h>
22 #include <linux/bitops.h>
23 #include <linux/string.h>
25 #include <linux/interrupt.h>
27 #include <linux/tty.h>
28 #include <linux/errno.h>
29 #include <linux/netdevice.h>
30 #include <linux/etherdevice.h>
31 #include <linux/skbuff.h>
32 #include <linux/if_arp.h>
33 #include <linux/lapb.h>
34 #include <linux/init.h>
35 #include <linux/rtnetlink.h>
36 #include <linux/compat.h>
37 #include <linux/slab.h>
38 #include <net/x25device.h>
41 static struct net_device **x25_asy_devs;
42 static int x25_asy_maxdev = SL_NRUNIT;
44 module_param(x25_asy_maxdev, int, 0);
45 MODULE_LICENSE("GPL");
47 static int x25_asy_esc(unsigned char *p, unsigned char *d, int len);
48 static void x25_asy_unesc(struct x25_asy *sl, unsigned char c);
49 static void x25_asy_setup(struct net_device *dev);
51 /* Find a free X.25 channel, and link in this `tty' line. */
52 static struct x25_asy *x25_asy_alloc(void)
54 struct net_device *dev = NULL;
58 if (x25_asy_devs == NULL)
59 return NULL; /* Master array missing ! */
61 for (i = 0; i < x25_asy_maxdev; i++) {
62 dev = x25_asy_devs[i];
68 sl = netdev_priv(dev);
70 if (!test_and_set_bit(SLF_INUSE, &sl->flags))
75 /* Sorry, too many, all slots in use */
76 if (i >= x25_asy_maxdev)
79 /* If no channels are available, allocate one */
82 sprintf(name, "x25asy%d", i);
84 dev = alloc_netdev(sizeof(struct x25_asy), name,
85 NET_NAME_UNKNOWN, x25_asy_setup);
89 /* Initialize channel control data */
90 sl = netdev_priv(dev);
93 /* register device so that it can be ifconfig'ed */
94 if (register_netdev(dev) == 0) {
95 /* (Re-)Set the INUSE bit. Very Important! */
96 set_bit(SLF_INUSE, &sl->flags);
97 x25_asy_devs[i] = dev;
100 pr_warn("%s(): register_netdev() failure\n", __func__);
108 /* Free an X.25 channel. */
109 static void x25_asy_free(struct x25_asy *sl)
111 /* Free all X.25 frame buffers. */
117 if (!test_and_clear_bit(SLF_INUSE, &sl->flags))
118 netdev_err(sl->dev, "x25_asy_free for already free unit\n");
121 static int x25_asy_change_mtu(struct net_device *dev, int newmtu)
123 struct x25_asy *sl = netdev_priv(dev);
124 unsigned char *xbuff, *rbuff;
128 xbuff = kmalloc(len + 4, GFP_ATOMIC);
129 rbuff = kmalloc(len + 4, GFP_ATOMIC);
131 if (xbuff == NULL || rbuff == NULL) {
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 dev->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 dev->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)
190 struct net_device *dev = sl->dev;
196 dev->stats.rx_bytes += count;
198 skb = dev_alloc_skb(count+1);
200 netdev_warn(sl->dev, "memory squeeze, dropping packet\n");
201 dev->stats.rx_dropped++;
204 skb_push(skb, 1); /* LAPB internal control */
205 skb_put_data(skb, 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 dev->stats.rx_packets++;
217 /* Encapsulate one IP datagram and stuff into a TTY queue. */
218 static void x25_asy_encaps(struct x25_asy *sl, unsigned char *icp, int len)
221 int actual, count, mtu = sl->dev->mtu;
224 /* Sigh, shouldn't occur BUT ... */
226 printk(KERN_DEBUG "%s: truncating oversized transmit packet!\n",
228 sl->dev->stats.tx_dropped++;
234 count = x25_asy_esc(p, sl->xbuff, len);
236 /* Order of next two lines is *very* important.
237 * When we are sending a little amount of data,
238 * the transfer may be completed inside driver.write()
239 * routine, because it's running with interrupts enabled.
240 * In this case we *never* got WRITE_WAKEUP event,
241 * if we did not request it before write operation.
242 * 14 Oct 1994 Dmitry Gorodchanin.
244 set_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
245 actual = sl->tty->ops->write(sl->tty, sl->xbuff, count);
246 sl->xleft = count - actual;
247 sl->xhead = sl->xbuff + actual;
249 clear_bit(SLF_OUTWAIT, &sl->flags); /* reset outfill flag */
253 * Called by the driver when there's room for more data. If we have
254 * more packets to send, we send them here.
256 static void x25_asy_write_wakeup(struct tty_struct *tty)
259 struct x25_asy *sl = tty->disc_data;
261 /* First make sure we're connected. */
262 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
265 if (sl->xleft <= 0) {
266 /* Now serial buffer is almost free & we can start
267 * transmission of another packet */
268 sl->dev->stats.tx_packets++;
269 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
274 actual = tty->ops->write(tty, sl->xhead, sl->xleft);
279 static void x25_asy_timeout(struct net_device *dev)
281 struct x25_asy *sl = netdev_priv(dev);
283 spin_lock(&sl->lock);
284 if (netif_queue_stopped(dev)) {
285 /* May be we must check transmitter timeout here ?
286 * 14 Oct 1994 Dmitry Gorodchanin.
288 netdev_warn(dev, "transmit timed out, %s?\n",
289 (tty_chars_in_buffer(sl->tty) || sl->xleft) ?
290 "bad line quality" : "driver error");
292 clear_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
295 spin_unlock(&sl->lock);
298 /* Encapsulate an IP datagram and kick it into a TTY queue. */
300 static netdev_tx_t x25_asy_xmit(struct sk_buff *skb,
301 struct net_device *dev)
303 struct x25_asy *sl = netdev_priv(dev);
306 if (!netif_running(sl->dev)) {
307 netdev_err(dev, "xmit call when iface is down\n");
312 switch (skb->data[0]) {
315 case X25_IFACE_CONNECT: /* Connection request .. do nothing */
316 err = lapb_connect_request(dev);
318 netdev_err(dev, "lapb_connect_request error: %d\n",
322 case X25_IFACE_DISCONNECT: /* do nothing - hang up ?? */
323 err = lapb_disconnect_request(dev);
325 netdev_err(dev, "lapb_disconnect_request error: %d\n",
332 skb_pull(skb, 1); /* Remove control byte */
334 * If we are busy already- too bad. We ought to be able
335 * to queue things at this point, to allow for a little
336 * frame buffer. Oh well...
337 * -----------------------------------------------------
338 * I hate queues in X.25 driver. May be it's efficient,
339 * but for me latency is more important. ;)
341 * 14 Oct 1994 Dmitry Gorodchanin.
344 err = lapb_data_request(dev, skb);
345 if (err != LAPB_OK) {
346 netdev_err(dev, "lapb_data_request error: %d\n", err);
355 * LAPB interface boilerplate
359 * Called when I frame data arrives. We did the work above - throw it
363 static int x25_asy_data_indication(struct net_device *dev, struct sk_buff *skb)
365 return netif_rx(skb);
369 * Data has emerged from the LAPB protocol machine. We don't handle
370 * busy cases too well. Its tricky to see how to do this nicely -
371 * perhaps lapb should allow us to bounce this ?
374 static void x25_asy_data_transmit(struct net_device *dev, struct sk_buff *skb)
376 struct x25_asy *sl = netdev_priv(dev);
378 spin_lock(&sl->lock);
379 if (netif_queue_stopped(sl->dev) || sl->tty == NULL) {
380 spin_unlock(&sl->lock);
381 netdev_err(dev, "tbusy drop\n");
385 /* We were not busy, so we are now... :-) */
388 dev->stats.tx_bytes += skb->len;
389 x25_asy_encaps(sl, skb->data, skb->len);
392 spin_unlock(&sl->lock);
396 * LAPB connection establish/down information.
399 static void x25_asy_connected(struct net_device *dev, int reason)
401 struct x25_asy *sl = netdev_priv(dev);
405 skb = dev_alloc_skb(1);
407 netdev_err(dev, "out of memory\n");
411 ptr = skb_put(skb, 1);
412 *ptr = X25_IFACE_CONNECT;
414 skb->protocol = x25_type_trans(skb, sl->dev);
418 static void x25_asy_disconnected(struct net_device *dev, int reason)
420 struct x25_asy *sl = netdev_priv(dev);
424 skb = dev_alloc_skb(1);
426 netdev_err(dev, "out of memory\n");
430 ptr = skb_put(skb, 1);
431 *ptr = X25_IFACE_DISCONNECT;
433 skb->protocol = x25_type_trans(skb, sl->dev);
437 static const struct lapb_register_struct x25_asy_callbacks = {
438 .connect_confirmation = x25_asy_connected,
439 .connect_indication = x25_asy_connected,
440 .disconnect_confirmation = x25_asy_disconnected,
441 .disconnect_indication = x25_asy_disconnected,
442 .data_indication = x25_asy_data_indication,
443 .data_transmit = x25_asy_data_transmit,
447 /* Open the low-level part of the X.25 channel. Easy! */
448 static int x25_asy_open(struct net_device *dev)
450 struct x25_asy *sl = netdev_priv(dev);
458 * Allocate the X.25 frame buffers:
460 * rbuff Receive buffer.
461 * xbuff Transmit buffer.
466 sl->rbuff = kmalloc(len + 4, GFP_KERNEL);
467 if (sl->rbuff == NULL)
469 sl->xbuff = kmalloc(len + 4, GFP_KERNEL);
470 if (sl->xbuff == NULL)
476 sl->flags &= (1 << SLF_INUSE); /* Clear ESCAPE & ERROR flags */
478 netif_start_queue(dev);
483 err = lapb_register(dev, &x25_asy_callbacks);
496 /* Close the low-level part of the X.25 channel. Easy! */
497 static int x25_asy_close(struct net_device *dev)
499 struct x25_asy *sl = netdev_priv(dev);
501 spin_lock(&sl->lock);
503 clear_bit(TTY_DO_WRITE_WAKEUP, &sl->tty->flags);
505 netif_stop_queue(dev);
508 spin_unlock(&sl->lock);
513 * Handle the 'receiver data ready' interrupt.
514 * This function is called by the 'tty_io' module in the kernel when
515 * a block of X.25 data has been received, which can now be decapsulated
516 * and sent on to some IP layer for further processing.
519 static void x25_asy_receive_buf(struct tty_struct *tty,
520 const unsigned char *cp, char *fp, int count)
522 struct x25_asy *sl = tty->disc_data;
524 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
528 /* Read the characters out of the buffer */
531 if (!test_and_set_bit(SLF_ERROR, &sl->flags))
532 sl->dev->stats.rx_errors++;
536 x25_asy_unesc(sl, *cp++);
541 * Open the high-level part of the X.25 channel.
542 * This function is called by the TTY module when the
543 * X.25 line discipline is called for. Because we are
544 * sure the tty line exists, we only have to link it to
545 * a free X.25 channel...
548 static int x25_asy_open_tty(struct tty_struct *tty)
553 if (tty->ops->write == NULL)
556 /* OK. Find a free X.25 channel to use. */
557 sl = x25_asy_alloc();
563 tty->receive_room = 65536;
564 tty_driver_flush_buffer(tty);
565 tty_ldisc_flush(tty);
567 /* Restore default settings */
568 sl->dev->type = ARPHRD_X25;
570 /* Perform the low-level X.25 async init */
571 err = x25_asy_open(sl->dev);
576 /* Done. We have linked the TTY line to a channel. */
582 * Close down an X.25 channel.
583 * This means flushing out any pending queues, and then restoring the
584 * TTY line discipline to what it was before it got hooked to X.25
585 * (which usually is TTY again).
587 static void x25_asy_close_tty(struct tty_struct *tty)
589 struct x25_asy *sl = tty->disc_data;
592 /* First make sure we're connected. */
593 if (!sl || sl->magic != X25_ASY_MAGIC)
597 if (sl->dev->flags & IFF_UP)
601 err = lapb_unregister(sl->dev);
603 pr_err("x25_asy_close: lapb_unregister error: %d\n",
606 tty->disc_data = NULL;
611 /************************************************************************
612 * STANDARD X.25 ENCAPSULATION *
613 ************************************************************************/
615 static int x25_asy_esc(unsigned char *s, unsigned char *d, int len)
617 unsigned char *ptr = d;
621 * Send an initial END character to flush out any
622 * data that may have accumulated in the receiver
626 *ptr++ = X25_END; /* Send 10111110 bit seq */
629 * For each byte in the packet, send the appropriate
630 * character sequence, according to the X.25 protocol.
637 *ptr++ = X25_ESCAPE(X25_END);
641 *ptr++ = X25_ESCAPE(X25_ESC);
652 static void x25_asy_unesc(struct x25_asy *sl, unsigned char s)
657 if (!test_and_clear_bit(SLF_ERROR, &sl->flags) &&
660 clear_bit(SLF_ESCAPE, &sl->flags);
664 set_bit(SLF_ESCAPE, &sl->flags);
666 case X25_ESCAPE(X25_ESC):
667 case X25_ESCAPE(X25_END):
668 if (test_and_clear_bit(SLF_ESCAPE, &sl->flags))
672 if (!test_bit(SLF_ERROR, &sl->flags)) {
673 if (sl->rcount < sl->buffsize) {
674 sl->rbuff[sl->rcount++] = s;
677 sl->dev->stats.rx_over_errors++;
678 set_bit(SLF_ERROR, &sl->flags);
683 /* Perform I/O control on an active X.25 channel. */
684 static int x25_asy_ioctl(struct tty_struct *tty, struct file *file,
685 unsigned int cmd, unsigned long arg)
687 struct x25_asy *sl = tty->disc_data;
689 /* First make sure we're connected. */
690 if (!sl || sl->magic != X25_ASY_MAGIC)
695 if (copy_to_user((void __user *)arg, sl->dev->name,
696 strlen(sl->dev->name) + 1))
702 return tty_mode_ioctl(tty, file, cmd, arg);
707 static long x25_asy_compat_ioctl(struct tty_struct *tty, struct file *file,
708 unsigned int cmd, unsigned long arg)
713 return x25_asy_ioctl(tty, file, cmd,
714 (unsigned long)compat_ptr(arg));
721 static int x25_asy_open_dev(struct net_device *dev)
723 struct x25_asy *sl = netdev_priv(dev);
729 static const struct net_device_ops x25_asy_netdev_ops = {
730 .ndo_open = x25_asy_open_dev,
731 .ndo_stop = x25_asy_close,
732 .ndo_start_xmit = x25_asy_xmit,
733 .ndo_tx_timeout = x25_asy_timeout,
734 .ndo_change_mtu = x25_asy_change_mtu,
737 /* Initialise the X.25 driver. Called by the device init code */
738 static void x25_asy_setup(struct net_device *dev)
740 struct x25_asy *sl = netdev_priv(dev);
742 sl->magic = X25_ASY_MAGIC;
744 spin_lock_init(&sl->lock);
745 set_bit(SLF_INUSE, &sl->flags);
748 * Finish setting up the DEVICE info.
753 dev->max_mtu = 65534;
754 dev->netdev_ops = &x25_asy_netdev_ops;
755 dev->watchdog_timeo = HZ*20;
756 dev->hard_header_len = 0;
758 dev->type = ARPHRD_X25;
759 dev->tx_queue_len = 10;
761 /* New-style flags. */
762 dev->flags = IFF_NOARP;
765 static struct tty_ldisc_ops x25_ldisc = {
766 .owner = THIS_MODULE,
767 .magic = TTY_LDISC_MAGIC,
769 .open = x25_asy_open_tty,
770 .close = x25_asy_close_tty,
771 .ioctl = x25_asy_ioctl,
773 .compat_ioctl = x25_asy_compat_ioctl,
775 .receive_buf = x25_asy_receive_buf,
776 .write_wakeup = x25_asy_write_wakeup,
779 static int __init init_x25_asy(void)
781 if (x25_asy_maxdev < 4)
782 x25_asy_maxdev = 4; /* Sanity */
784 pr_info("X.25 async: version 0.00 ALPHA (dynamic channels, max=%d)\n",
787 x25_asy_devs = kcalloc(x25_asy_maxdev, sizeof(struct net_device *),
792 return tty_register_ldisc(N_X25, &x25_ldisc);
796 static void __exit exit_x25_asy(void)
798 struct net_device *dev;
801 for (i = 0; i < x25_asy_maxdev; i++) {
802 dev = x25_asy_devs[i];
804 struct x25_asy *sl = netdev_priv(dev);
806 spin_lock_bh(&sl->lock);
810 spin_unlock_bh(&sl->lock);
812 * VSV = if dev->start==0, then device
813 * unregistered while close proc.
815 unregister_netdev(dev);
821 tty_unregister_ldisc(N_X25);
824 module_init(init_x25_asy);
825 module_exit(exit_x25_asy);