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>
35 #include <linux/rtnetlink.h>
38 #include <net/x25device.h>
40 static struct net_device **x25_asy_devs;
41 static int x25_asy_maxdev = SL_NRUNIT;
43 module_param(x25_asy_maxdev, int, 0);
44 MODULE_LICENSE("GPL");
46 static int x25_asy_esc(unsigned char *p, unsigned char *d, int len);
47 static void x25_asy_unesc(struct x25_asy *sl, unsigned char c);
48 static void x25_asy_setup(struct net_device *dev);
50 /* Find a free X.25 channel, and link in this `tty' line. */
51 static struct x25_asy *x25_asy_alloc(void)
53 struct net_device *dev = NULL;
57 if (x25_asy_devs == NULL)
58 return NULL; /* Master array missing ! */
60 for (i = 0; i < x25_asy_maxdev; i++) {
61 dev = x25_asy_devs[i];
69 if (!test_and_set_bit(SLF_INUSE, &sl->flags))
74 /* Sorry, too many, all slots in use */
75 if (i >= x25_asy_maxdev)
78 /* If no channels are available, allocate one */
81 sprintf(name, "x25asy%d", i);
83 dev = alloc_netdev(sizeof(struct x25_asy),
88 /* Initialize channel control data */
92 /* register device so that it can be ifconfig'ed */
93 if (register_netdev(dev) == 0) {
94 /* (Re-)Set the INUSE bit. Very Important! */
95 set_bit(SLF_INUSE, &sl->flags);
96 x25_asy_devs[i] = dev;
99 printk(KERN_WARNING "x25_asy_alloc() - register_netdev() failure.\n");
107 /* Free an X.25 channel. */
108 static void x25_asy_free(struct x25_asy *sl)
110 /* Free all X.25 frame buffers. */
116 if (!test_and_clear_bit(SLF_INUSE, &sl->flags))
117 printk(KERN_ERR "%s: 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 = dev->priv;
124 unsigned char *xbuff, *rbuff;
125 int len = 2 * newmtu;
127 xbuff = kmalloc(len + 4, GFP_ATOMIC);
128 rbuff = kmalloc(len + 4, GFP_ATOMIC);
130 if (xbuff == NULL || rbuff == NULL) {
131 printk(KERN_WARNING "%s: unable to grow X.25 buffers, MTU change cancelled.\n",
138 spin_lock_bh(&sl->lock);
139 xbuff = xchg(&sl->xbuff, xbuff);
141 if (sl->xleft <= len) {
142 memcpy(sl->xbuff, sl->xhead, sl->xleft);
145 sl->stats.tx_dropped++;
148 sl->xhead = sl->xbuff;
150 rbuff = xchg(&sl->rbuff, rbuff);
152 if (sl->rcount <= len) {
153 memcpy(sl->rbuff, rbuff, sl->rcount);
156 sl->stats.rx_over_errors++;
157 set_bit(SLF_ERROR, &sl->flags);
164 spin_unlock_bh(&sl->lock);
172 /* Set the "sending" flag. This must be atomic, hence the ASM. */
174 static inline void x25_asy_lock(struct x25_asy *sl)
176 netif_stop_queue(sl->dev);
180 /* Clear the "sending" flag. This must be atomic, hence the ASM. */
182 static inline void x25_asy_unlock(struct x25_asy *sl)
184 netif_wake_queue(sl->dev);
187 /* Send one completely decapsulated IP datagram to the IP layer. */
189 static void x25_asy_bump(struct x25_asy *sl)
196 sl->stats.rx_bytes += count;
198 skb = dev_alloc_skb(count+1);
200 printk(KERN_WARNING "%s: memory squeeze, dropping packet.\n",
202 sl->stats.rx_dropped++;
205 skb_push(skb, 1); /* LAPB internal control */
206 memcpy(skb_put(skb, count), sl->rbuff, count);
207 skb->protocol = x25_type_trans(skb, sl->dev);
208 err = lapb_data_received(skb->dev, skb);
209 if (err != LAPB_OK) {
211 printk(KERN_DEBUG "x25_asy: data received err - %d\n", err);
214 sl->dev->last_rx = jiffies;
215 sl->stats.rx_packets++;
219 /* Encapsulate one IP datagram and stuff into a TTY queue. */
220 static void x25_asy_encaps(struct x25_asy *sl, unsigned char *icp, int len)
223 int actual, count, mtu = sl->dev->mtu;
226 /* Sigh, shouldn't occur BUT ... */
228 printk(KERN_DEBUG "%s: truncating oversized transmit packet!\n",
230 sl->stats.tx_dropped++;
236 count = x25_asy_esc(p, (unsigned char *) sl->xbuff, len);
238 /* Order of next two lines is *very* important.
239 * When we are sending a little amount of data,
240 * the transfer may be completed inside driver.write()
241 * routine, because it's running with interrupts enabled.
242 * In this case we *never* got WRITE_WAKEUP event,
243 * if we did not request it before write operation.
244 * 14 Oct 1994 Dmitry Gorodchanin.
246 sl->tty->flags |= (1 << TTY_DO_WRITE_WAKEUP);
247 actual = sl->tty->ops->write(sl->tty, sl->xbuff, count);
248 sl->xleft = count - actual;
249 sl->xhead = sl->xbuff + actual;
251 clear_bit(SLF_OUTWAIT, &sl->flags); /* reset outfill flag */
255 * Called by the driver when there's room for more data. If we have
256 * more packets to send, we send them here.
258 static void x25_asy_write_wakeup(struct tty_struct *tty)
261 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
263 /* First make sure we're connected. */
264 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
267 if (sl->xleft <= 0) {
268 /* Now serial buffer is almost free & we can start
269 * transmission of another packet */
270 sl->stats.tx_packets++;
271 tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
276 actual = tty->ops->write(tty, sl->xhead, sl->xleft);
281 static void x25_asy_timeout(struct net_device *dev)
283 struct x25_asy *sl = dev->priv;
285 spin_lock(&sl->lock);
286 if (netif_queue_stopped(dev)) {
287 /* May be we must check transmitter timeout here ?
288 * 14 Oct 1994 Dmitry Gorodchanin.
290 printk(KERN_WARNING "%s: transmit timed out, %s?\n", dev->name,
291 (tty_chars_in_buffer(sl->tty) || sl->xleft) ?
292 "bad line quality" : "driver error");
294 sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
297 spin_unlock(&sl->lock);
300 /* Encapsulate an IP datagram and kick it into a TTY queue. */
302 static int x25_asy_xmit(struct sk_buff *skb, struct net_device *dev)
304 struct x25_asy *sl = dev->priv;
307 if (!netif_running(sl->dev)) {
308 printk(KERN_ERR "%s: xmit call when iface is down\n",
314 switch (skb->data[0]) {
317 case 0x01: /* Connection request .. do nothing */
318 err = lapb_connect_request(dev);
320 printk(KERN_ERR "x25_asy: lapb_connect_request error - %d\n", err);
323 case 0x02: /* Disconnect request .. do nothing - hang up ?? */
324 err = lapb_disconnect_request(dev);
326 printk(KERN_ERR "x25_asy: lapb_disconnect_request error - %d\n", err);
331 skb_pull(skb, 1); /* Remove control byte */
333 * If we are busy already- too bad. We ought to be able
334 * to queue things at this point, to allow for a little
335 * frame buffer. Oh well...
336 * -----------------------------------------------------
337 * I hate queues in X.25 driver. May be it's efficient,
338 * but for me latency is more important. ;)
340 * 14 Oct 1994 Dmitry Gorodchanin.
343 err = lapb_data_request(dev, skb);
344 if (err != LAPB_OK) {
345 printk(KERN_ERR "x25_asy: lapb_data_request error - %d\n", err);
354 * LAPB interface boilerplate
358 * Called when I frame data arrives. We did the work above - throw it
362 static int x25_asy_data_indication(struct net_device *dev, struct sk_buff *skb)
364 skb->dev->last_rx = jiffies;
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 = dev->priv;
378 spin_lock(&sl->lock);
379 if (netif_queue_stopped(sl->dev) || sl->tty == NULL) {
380 spin_unlock(&sl->lock);
381 printk(KERN_ERR "x25_asy: tbusy drop\n");
385 /* We were not busy, so we are now... :-) */
388 sl->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 = dev->priv;
405 skb = dev_alloc_skb(1);
407 printk(KERN_ERR "x25_asy: out of memory\n");
411 ptr = skb_put(skb, 1);
414 skb->protocol = x25_type_trans(skb, sl->dev);
416 sl->dev->last_rx = jiffies;
419 static void x25_asy_disconnected(struct net_device *dev, int reason)
421 struct x25_asy *sl = dev->priv;
425 skb = dev_alloc_skb(1);
427 printk(KERN_ERR "x25_asy: out of memory\n");
431 ptr = skb_put(skb, 1);
434 skb->protocol = x25_type_trans(skb, sl->dev);
436 sl->dev->last_rx = jiffies;
439 static struct lapb_register_struct x25_asy_callbacks = {
440 .connect_confirmation = x25_asy_connected,
441 .connect_indication = x25_asy_connected,
442 .disconnect_confirmation = x25_asy_disconnected,
443 .disconnect_indication = x25_asy_disconnected,
444 .data_indication = x25_asy_data_indication,
445 .data_transmit = x25_asy_data_transmit,
450 /* Open the low-level part of the X.25 channel. Easy! */
451 static int x25_asy_open(struct net_device *dev)
453 struct x25_asy *sl = dev->priv;
461 * Allocate the X.25 frame buffers:
463 * rbuff Receive buffer.
464 * xbuff Transmit buffer.
469 sl->rbuff = kmalloc(len + 4, GFP_KERNEL);
470 if (sl->rbuff == NULL)
472 sl->xbuff = kmalloc(len + 4, GFP_KERNEL);
473 if (sl->xbuff == NULL)
479 sl->flags &= (1 << SLF_INUSE); /* Clear ESCAPE & ERROR flags */
481 netif_start_queue(dev);
486 err = lapb_register(dev, &x25_asy_callbacks);
499 /* Close the low-level part of the X.25 channel. Easy! */
500 static int x25_asy_close(struct net_device *dev)
502 struct x25_asy *sl = dev->priv;
505 spin_lock(&sl->lock);
507 sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
509 netif_stop_queue(dev);
512 err = lapb_unregister(dev);
514 printk(KERN_ERR "x25_asy_close: lapb_unregister error -%d\n",
516 spin_unlock(&sl->lock);
521 * Handle the 'receiver data ready' interrupt.
522 * This function is called by the 'tty_io' module in the kernel when
523 * a block of X.25 data has been received, which can now be decapsulated
524 * and sent on to some IP layer for further processing.
527 static void x25_asy_receive_buf(struct tty_struct *tty,
528 const unsigned char *cp, char *fp, int count)
530 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
532 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
536 /* Read the characters out of the buffer */
539 if (!test_and_set_bit(SLF_ERROR, &sl->flags))
540 sl->stats.rx_errors++;
544 x25_asy_unesc(sl, *cp++);
549 * Open the high-level part of the X.25 channel.
550 * This function is called by the TTY module when the
551 * X.25 line discipline is called for. Because we are
552 * sure the tty line exists, we only have to link it to
553 * a free X.25 channel...
556 static int x25_asy_open_tty(struct tty_struct *tty)
558 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
561 if (tty->ops->write == NULL)
564 /* First make sure we're not already connected. */
565 if (sl && sl->magic == X25_ASY_MAGIC)
568 /* OK. Find a free X.25 channel to use. */
569 sl = x25_asy_alloc();
575 tty->receive_room = 65536;
576 tty_driver_flush_buffer(tty);
577 tty_ldisc_flush(tty);
579 /* Restore default settings */
580 sl->dev->type = ARPHRD_X25;
582 /* Perform the low-level X.25 async init */
583 err = x25_asy_open(sl->dev);
586 /* Done. We have linked the TTY line to a channel. */
587 return sl->dev->base_addr;
592 * Close down an X.25 channel.
593 * This means flushing out any pending queues, and then restoring the
594 * TTY line discipline to what it was before it got hooked to X.25
595 * (which usually is TTY again).
597 static void x25_asy_close_tty(struct tty_struct *tty)
599 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
601 /* First make sure we're connected. */
602 if (!sl || sl->magic != X25_ASY_MAGIC)
606 if (sl->dev->flags & IFF_UP)
610 tty->disc_data = NULL;
616 static struct net_device_stats *x25_asy_get_stats(struct net_device *dev)
618 struct x25_asy *sl = dev->priv;
623 /************************************************************************
624 * STANDARD X.25 ENCAPSULATION *
625 ************************************************************************/
627 int x25_asy_esc(unsigned char *s, unsigned char *d, int len)
629 unsigned char *ptr = d;
633 * Send an initial END character to flush out any
634 * data that may have accumulated in the receiver
638 *ptr++ = X25_END; /* Send 10111110 bit seq */
641 * For each byte in the packet, send the appropriate
642 * character sequence, according to the X.25 protocol.
649 *ptr++ = X25_ESCAPE(X25_END);
653 *ptr++ = X25_ESCAPE(X25_ESC);
664 static void x25_asy_unesc(struct x25_asy *sl, unsigned char s)
669 if (!test_and_clear_bit(SLF_ERROR, &sl->flags)
672 clear_bit(SLF_ESCAPE, &sl->flags);
676 set_bit(SLF_ESCAPE, &sl->flags);
678 case X25_ESCAPE(X25_ESC):
679 case X25_ESCAPE(X25_END):
680 if (test_and_clear_bit(SLF_ESCAPE, &sl->flags))
684 if (!test_bit(SLF_ERROR, &sl->flags)) {
685 if (sl->rcount < sl->buffsize) {
686 sl->rbuff[sl->rcount++] = s;
689 sl->stats.rx_over_errors++;
690 set_bit(SLF_ERROR, &sl->flags);
695 /* Perform I/O control on an active X.25 channel. */
696 static int x25_asy_ioctl(struct tty_struct *tty, struct file *file,
697 unsigned int cmd, unsigned long arg)
699 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
701 /* First make sure we're connected. */
702 if (!sl || sl->magic != X25_ASY_MAGIC)
707 if (copy_to_user((void __user *)arg, sl->dev->name,
708 strlen(sl->dev->name) + 1))
714 return tty_mode_ioctl(tty, file, cmd, arg);
718 static int x25_asy_open_dev(struct net_device *dev)
720 struct x25_asy *sl = dev->priv;
726 /* Initialise the X.25 driver. Called by the device init code */
727 static void x25_asy_setup(struct net_device *dev)
729 struct x25_asy *sl = dev->priv;
731 sl->magic = X25_ASY_MAGIC;
733 spin_lock_init(&sl->lock);
734 set_bit(SLF_INUSE, &sl->flags);
737 * Finish setting up the DEVICE info.
741 dev->hard_start_xmit = x25_asy_xmit;
742 dev->tx_timeout = x25_asy_timeout;
743 dev->watchdog_timeo = HZ*20;
744 dev->open = x25_asy_open_dev;
745 dev->stop = x25_asy_close;
746 dev->get_stats = x25_asy_get_stats;
747 dev->change_mtu = x25_asy_change_mtu;
748 dev->hard_header_len = 0;
750 dev->type = ARPHRD_X25;
751 dev->tx_queue_len = 10;
753 /* New-style flags. */
754 dev->flags = IFF_NOARP;
757 static struct tty_ldisc_ops x25_ldisc = {
758 .owner = THIS_MODULE,
759 .magic = TTY_LDISC_MAGIC,
761 .open = x25_asy_open_tty,
762 .close = x25_asy_close_tty,
763 .ioctl = x25_asy_ioctl,
764 .receive_buf = x25_asy_receive_buf,
765 .write_wakeup = x25_asy_write_wakeup,
768 static int __init init_x25_asy(void)
770 if (x25_asy_maxdev < 4)
771 x25_asy_maxdev = 4; /* Sanity */
773 printk(KERN_INFO "X.25 async: version 0.00 ALPHA "
774 "(dynamic channels, max=%d).\n", x25_asy_maxdev);
776 x25_asy_devs = kcalloc(x25_asy_maxdev, sizeof(struct net_device *),
779 printk(KERN_WARNING "X25 async: Can't allocate x25_asy_ctrls[] "
780 "array! Uaargh! (-> No X.25 available)\n");
784 return tty_register_ldisc(N_X25, &x25_ldisc);
788 static void __exit exit_x25_asy(void)
790 struct net_device *dev;
793 for (i = 0; i < x25_asy_maxdev; i++) {
794 dev = x25_asy_devs[i];
796 struct x25_asy *sl = dev->priv;
798 spin_lock_bh(&sl->lock);
802 spin_unlock_bh(&sl->lock);
804 * VSV = if dev->start==0, then device
805 * unregistered while close proc.
807 unregister_netdev(dev);
813 tty_unregister_ldisc(N_X25);
816 module_init(init_x25_asy);
817 module_exit(exit_x25_asy);