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 <asm/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("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("%s: x25_asy_free for already free unit.\n", sl->dev->name);
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;
126 xbuff = (unsigned char *) kmalloc (len + 4, GFP_ATOMIC);
127 rbuff = (unsigned char *) kmalloc (len + 4, GFP_ATOMIC);
129 if (xbuff == NULL || rbuff == NULL)
131 printk("%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);
201 printk("%s: memory squeeze, dropping packet.\n", sl->dev->name);
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 if((err=lapb_data_received(skb->dev, skb))!=LAPB_OK)
211 printk(KERN_DEBUG "x25_asy: data received err - %d\n",err);
216 sl->dev->last_rx = jiffies;
217 sl->stats.rx_packets++;
221 /* Encapsulate one IP datagram and stuff into a TTY queue. */
222 static void x25_asy_encaps(struct x25_asy *sl, unsigned char *icp, int len)
225 int actual, count, mtu = sl->dev->mtu;
228 { /* Sigh, shouldn't occur BUT ... */
230 printk ("%s: truncating oversized transmit packet!\n", sl->dev->name);
231 sl->stats.tx_dropped++;
237 count = x25_asy_esc(p, (unsigned char *) sl->xbuff, len);
239 /* Order of next two lines is *very* important.
240 * When we are sending a little amount of data,
241 * the transfer may be completed inside driver.write()
242 * routine, because it's running with interrupts enabled.
243 * In this case we *never* got WRITE_WAKEUP event,
244 * if we did not request it before write operation.
245 * 14 Oct 1994 Dmitry Gorodchanin.
247 sl->tty->flags |= (1 << TTY_DO_WRITE_WAKEUP);
248 actual = sl->tty->driver->write(sl->tty, sl->xbuff, count);
249 sl->xleft = count - actual;
250 sl->xhead = sl->xbuff + actual;
252 clear_bit(SLF_OUTWAIT, &sl->flags); /* reset outfill flag */
256 * Called by the driver when there's room for more data. If we have
257 * more packets to send, we send them here.
259 static void x25_asy_write_wakeup(struct tty_struct *tty)
262 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
264 /* First make sure we're connected. */
265 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
270 /* Now serial buffer is almost free & we can start
271 * transmission of another packet */
272 sl->stats.tx_packets++;
273 tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
278 actual = tty->driver->write(tty, sl->xhead, sl->xleft);
283 static void x25_asy_timeout(struct net_device *dev)
285 struct x25_asy *sl = (struct x25_asy*)(dev->priv);
287 spin_lock(&sl->lock);
288 if (netif_queue_stopped(dev)) {
289 /* May be we must check transmitter timeout here ?
290 * 14 Oct 1994 Dmitry Gorodchanin.
292 printk(KERN_WARNING "%s: transmit timed out, %s?\n", dev->name,
293 (sl->tty->driver->chars_in_buffer(sl->tty) || sl->xleft) ?
294 "bad line quality" : "driver error");
296 sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
299 spin_unlock(&sl->lock);
302 /* Encapsulate an IP datagram and kick it into a TTY queue. */
304 static int x25_asy_xmit(struct sk_buff *skb, struct net_device *dev)
306 struct x25_asy *sl = (struct x25_asy*)(dev->priv);
309 if (!netif_running(sl->dev)) {
310 printk("%s: xmit call when iface is down\n", dev->name);
318 case 0x01: /* Connection request .. do nothing */
319 if((err=lapb_connect_request(dev))!=LAPB_OK)
320 printk(KERN_ERR "x25_asy: lapb_connect_request error - %d\n", err);
323 case 0x02: /* Disconnect request .. do nothing - hang up ?? */
324 if((err=lapb_disconnect_request(dev))!=LAPB_OK)
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 if((err=lapb_data_request(dev,skb))!=LAPB_OK)
344 printk(KERN_ERR "lapbeth: 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)
380 spin_unlock(&sl->lock);
381 printk(KERN_ERR "x25_asy: tbusy drop\n");
385 /* We were not busy, so we are now... :-) */
389 sl->stats.tx_bytes+=skb->len;
390 x25_asy_encaps(sl, skb->data, skb->len);
393 spin_unlock(&sl->lock);
397 * LAPB connection establish/down information.
400 static void x25_asy_connected(struct net_device *dev, int reason)
402 struct x25_asy *sl = dev->priv;
406 if ((skb = dev_alloc_skb(1)) == NULL) {
407 printk(KERN_ERR "lapbeth: 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 if ((skb = dev_alloc_skb(1)) == NULL) {
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 = (struct x25_asy*)(dev->priv);
460 * Allocate the X.25 frame buffers:
462 * rbuff Receive buffer.
463 * xbuff Transmit buffer.
468 sl->rbuff = (unsigned char *) kmalloc(len + 4, GFP_KERNEL);
469 if (sl->rbuff == NULL) {
472 sl->xbuff = (unsigned char *) kmalloc(len + 4, GFP_KERNEL);
473 if (sl->xbuff == NULL) {
480 sl->flags &= (1 << SLF_INUSE); /* Clear ESCAPE & ERROR flags */
482 netif_start_queue(dev);
487 if((err=lapb_register(dev, &x25_asy_callbacks))==LAPB_OK)
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 = (struct x25_asy*)(dev->priv);
505 spin_lock(&sl->lock);
507 sl->tty->flags &= ~(1 << TTY_DO_WRITE_WAKEUP);
509 netif_stop_queue(dev);
512 if((err=lapb_unregister(dev))!=LAPB_OK)
513 printk(KERN_ERR "x25_asy_close: lapb_unregister error -%d\n",err);
514 spin_unlock(&sl->lock);
518 static int x25_asy_receive_room(struct tty_struct *tty)
520 return 65536; /* We can handle an infinite amount of data. :-) */
524 * Handle the 'receiver data ready' interrupt.
525 * This function is called by the 'tty_io' module in the kernel when
526 * a block of X.25 data has been received, which can now be decapsulated
527 * and sent on to some IP layer for further processing.
530 static void x25_asy_receive_buf(struct tty_struct *tty, const unsigned char *cp, char *fp, int count)
532 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
534 if (!sl || sl->magic != X25_ASY_MAGIC || !netif_running(sl->dev))
538 /* Read the characters out of the buffer */
541 if (!test_and_set_bit(SLF_ERROR, &sl->flags)) {
542 sl->stats.rx_errors++;
547 x25_asy_unesc(sl, *cp++);
552 * Open the high-level part of the X.25 channel.
553 * This function is called by the TTY module when the
554 * X.25 line discipline is called for. Because we are
555 * sure the tty line exists, we only have to link it to
556 * a free X.25 channel...
559 static int x25_asy_open_tty(struct tty_struct *tty)
561 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
564 /* First make sure we're not already connected. */
565 if (sl && sl->magic == X25_ASY_MAGIC) {
569 /* OK. Find a free X.25 channel to use. */
570 if ((sl = x25_asy_alloc()) == NULL) {
576 if (tty->driver->flush_buffer) {
577 tty->driver->flush_buffer(tty);
579 if (tty->ldisc.flush_buffer) {
580 tty->ldisc.flush_buffer(tty);
583 /* Restore default settings */
584 sl->dev->type = ARPHRD_X25;
586 /* Perform the low-level X.25 async init */
587 if ((err = x25_asy_open(sl->dev)))
590 /* Done. We have linked the TTY line to a channel. */
591 return sl->dev->base_addr;
596 * Close down an X.25 channel.
597 * This means flushing out any pending queues, and then restoring the
598 * TTY line discipline to what it was before it got hooked to X.25
599 * (which usually is TTY again).
601 static void x25_asy_close_tty(struct tty_struct *tty)
603 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
605 /* First make sure we're connected. */
606 if (!sl || sl->magic != X25_ASY_MAGIC)
609 if (sl->dev->flags & IFF_UP)
611 (void) dev_close(sl->dev);
614 tty->disc_data = NULL;
620 static struct net_device_stats *x25_asy_get_stats(struct net_device *dev)
622 struct x25_asy *sl = (struct x25_asy*)(dev->priv);
628 /************************************************************************
629 * STANDARD X.25 ENCAPSULATION *
630 ************************************************************************/
632 int x25_asy_esc(unsigned char *s, unsigned char *d, int len)
634 unsigned char *ptr = d;
638 * Send an initial END character to flush out any
639 * data that may have accumulated in the receiver
643 *ptr++ = X25_END; /* Send 10111110 bit seq */
646 * For each byte in the packet, send the appropriate
647 * character sequence, according to the X.25 protocol.
656 *ptr++ = X25_ESCAPE(X25_END);
660 *ptr++ = X25_ESCAPE(X25_ESC);
671 static void x25_asy_unesc(struct x25_asy *sl, unsigned char s)
677 if (!test_and_clear_bit(SLF_ERROR, &sl->flags) && (sl->rcount > 2))
681 clear_bit(SLF_ESCAPE, &sl->flags);
686 set_bit(SLF_ESCAPE, &sl->flags);
689 case X25_ESCAPE(X25_ESC):
690 case X25_ESCAPE(X25_END):
691 if (test_and_clear_bit(SLF_ESCAPE, &sl->flags))
695 if (!test_bit(SLF_ERROR, &sl->flags))
697 if (sl->rcount < sl->buffsize)
699 sl->rbuff[sl->rcount++] = s;
702 sl->stats.rx_over_errors++;
703 set_bit(SLF_ERROR, &sl->flags);
708 /* Perform I/O control on an active X.25 channel. */
709 static int x25_asy_ioctl(struct tty_struct *tty, struct file *file,
710 unsigned int cmd, unsigned long arg)
712 struct x25_asy *sl = (struct x25_asy *) tty->disc_data;
714 /* First make sure we're connected. */
715 if (!sl || sl->magic != X25_ASY_MAGIC)
720 if (copy_to_user((void __user *)arg, sl->dev->name,
721 strlen(sl->dev->name) + 1))
726 /* Allow stty to read, but not set, the serial port */
729 return n_tty_ioctl(tty, file, cmd, arg);
735 static int x25_asy_open_dev(struct net_device *dev)
737 struct x25_asy *sl = (struct x25_asy*)(dev->priv);
743 /* Initialise the X.25 driver. Called by the device init code */
744 static void x25_asy_setup(struct net_device *dev)
746 struct x25_asy *sl = dev->priv;
748 sl->magic = X25_ASY_MAGIC;
750 spin_lock_init(&sl->lock);
751 set_bit(SLF_INUSE, &sl->flags);
754 * Finish setting up the DEVICE info.
758 dev->hard_start_xmit = x25_asy_xmit;
759 dev->tx_timeout = x25_asy_timeout;
760 dev->watchdog_timeo = HZ*20;
761 dev->open = x25_asy_open_dev;
762 dev->stop = x25_asy_close;
763 dev->get_stats = x25_asy_get_stats;
764 dev->change_mtu = x25_asy_change_mtu;
765 dev->hard_header_len = 0;
767 dev->type = ARPHRD_X25;
768 dev->tx_queue_len = 10;
770 /* New-style flags. */
771 dev->flags = IFF_NOARP;
774 static struct tty_ldisc x25_ldisc = {
775 .owner = THIS_MODULE,
776 .magic = TTY_LDISC_MAGIC,
778 .open = x25_asy_open_tty,
779 .close = x25_asy_close_tty,
780 .ioctl = x25_asy_ioctl,
781 .receive_buf = x25_asy_receive_buf,
782 .receive_room = x25_asy_receive_room,
783 .write_wakeup = x25_asy_write_wakeup,
786 static int __init init_x25_asy(void)
788 if (x25_asy_maxdev < 4)
789 x25_asy_maxdev = 4; /* Sanity */
791 printk(KERN_INFO "X.25 async: version 0.00 ALPHA "
792 "(dynamic channels, max=%d).\n", x25_asy_maxdev );
794 x25_asy_devs = kmalloc(sizeof(struct net_device *)*x25_asy_maxdev,
797 printk(KERN_WARNING "X25 async: Can't allocate x25_asy_ctrls[] "
798 "array! Uaargh! (-> No X.25 available)\n");
801 memset(x25_asy_devs, 0, sizeof(struct net_device *)*x25_asy_maxdev);
803 return tty_register_ldisc(N_X25, &x25_ldisc);
807 static void __exit exit_x25_asy(void)
809 struct net_device *dev;
812 for (i = 0; i < x25_asy_maxdev; i++) {
813 dev = x25_asy_devs[i];
815 struct x25_asy *sl = dev->priv;
817 spin_lock_bh(&sl->lock);
821 spin_unlock_bh(&sl->lock);
823 * VSV = if dev->start==0, then device
824 * unregistered while close proc.
826 unregister_netdev(dev);
832 tty_register_ldisc(N_X25, NULL);
835 module_init(init_x25_asy);
836 module_exit(exit_x25_asy);