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
];
67 sl
= netdev_priv(dev
);
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 */
89 sl
= netdev_priv(dev
);
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
= netdev_priv(dev
);
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 dev
->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 dev
->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
)
191 struct net_device
*dev
= sl
->dev
;
197 dev
->stats
.rx_bytes
+= count
;
199 skb
= dev_alloc_skb(count
+1);
201 printk(KERN_WARNING
"%s: memory squeeze, dropping packet.\n",
203 dev
->stats
.rx_dropped
++;
206 skb_push(skb
, 1); /* LAPB internal control */
207 memcpy(skb_put(skb
, count
), sl
->rbuff
, count
);
208 skb
->protocol
= x25_type_trans(skb
, sl
->dev
);
209 err
= lapb_data_received(skb
->dev
, skb
);
210 if (err
!= LAPB_OK
) {
212 printk(KERN_DEBUG
"x25_asy: data received err - %d\n", err
);
215 dev
->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
->dev
->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 set_bit(TTY_DO_WRITE_WAKEUP
, &sl
->tty
->flags
);
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
= 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
->dev
->stats
.tx_packets
++;
271 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
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
= netdev_priv(dev
);
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 clear_bit(TTY_DO_WRITE_WAKEUP
, &sl
->tty
->flags
);
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
= netdev_priv(dev
);
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 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
= netdev_priv(dev
);
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 dev
->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
= netdev_priv(dev
);
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
);
417 static void x25_asy_disconnected(struct net_device
*dev
, int reason
)
419 struct x25_asy
*sl
= netdev_priv(dev
);
423 skb
= dev_alloc_skb(1);
425 printk(KERN_ERR
"x25_asy: out of memory\n");
429 ptr
= skb_put(skb
, 1);
432 skb
->protocol
= x25_type_trans(skb
, sl
->dev
);
436 static struct lapb_register_struct x25_asy_callbacks
= {
437 .connect_confirmation
= x25_asy_connected
,
438 .connect_indication
= x25_asy_connected
,
439 .disconnect_confirmation
= x25_asy_disconnected
,
440 .disconnect_indication
= x25_asy_disconnected
,
441 .data_indication
= x25_asy_data_indication
,
442 .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
);
502 spin_lock(&sl
->lock
);
504 clear_bit(TTY_DO_WRITE_WAKEUP
, &sl
->tty
->flags
);
506 netif_stop_queue(dev
);
509 err
= lapb_unregister(dev
);
511 printk(KERN_ERR
"x25_asy_close: lapb_unregister error -%d\n",
513 spin_unlock(&sl
->lock
);
518 * Handle the 'receiver data ready' interrupt.
519 * This function is called by the 'tty_io' module in the kernel when
520 * a block of X.25 data has been received, which can now be decapsulated
521 * and sent on to some IP layer for further processing.
524 static void x25_asy_receive_buf(struct tty_struct
*tty
,
525 const unsigned char *cp
, char *fp
, int count
)
527 struct x25_asy
*sl
= tty
->disc_data
;
529 if (!sl
|| sl
->magic
!= X25_ASY_MAGIC
|| !netif_running(sl
->dev
))
533 /* Read the characters out of the buffer */
536 if (!test_and_set_bit(SLF_ERROR
, &sl
->flags
))
537 sl
->dev
->stats
.rx_errors
++;
541 x25_asy_unesc(sl
, *cp
++);
546 * Open the high-level part of the X.25 channel.
547 * This function is called by the TTY module when the
548 * X.25 line discipline is called for. Because we are
549 * sure the tty line exists, we only have to link it to
550 * a free X.25 channel...
553 static int x25_asy_open_tty(struct tty_struct
*tty
)
555 struct x25_asy
*sl
= tty
->disc_data
;
558 if (tty
->ops
->write
== NULL
)
561 /* First make sure we're not already connected. */
562 if (sl
&& sl
->magic
== X25_ASY_MAGIC
)
565 /* OK. Find a free X.25 channel to use. */
566 sl
= x25_asy_alloc();
572 tty
->receive_room
= 65536;
573 tty_driver_flush_buffer(tty
);
574 tty_ldisc_flush(tty
);
576 /* Restore default settings */
577 sl
->dev
->type
= ARPHRD_X25
;
579 /* Perform the low-level X.25 async init */
580 err
= x25_asy_open(sl
->dev
);
583 /* Done. We have linked the TTY line to a channel. */
584 return sl
->dev
->base_addr
;
589 * Close down an X.25 channel.
590 * This means flushing out any pending queues, and then restoring the
591 * TTY line discipline to what it was before it got hooked to X.25
592 * (which usually is TTY again).
594 static void x25_asy_close_tty(struct tty_struct
*tty
)
596 struct x25_asy
*sl
= tty
->disc_data
;
598 /* First make sure we're connected. */
599 if (!sl
|| sl
->magic
!= X25_ASY_MAGIC
)
603 if (sl
->dev
->flags
& IFF_UP
)
607 tty
->disc_data
= NULL
;
612 /************************************************************************
613 * STANDARD X.25 ENCAPSULATION *
614 ************************************************************************/
616 static int x25_asy_esc(unsigned char *s
, unsigned char *d
, int len
)
618 unsigned char *ptr
= d
;
622 * Send an initial END character to flush out any
623 * data that may have accumulated in the receiver
627 *ptr
++ = X25_END
; /* Send 10111110 bit seq */
630 * For each byte in the packet, send the appropriate
631 * character sequence, according to the X.25 protocol.
638 *ptr
++ = X25_ESCAPE(X25_END
);
642 *ptr
++ = X25_ESCAPE(X25_ESC
);
653 static void x25_asy_unesc(struct x25_asy
*sl
, unsigned char s
)
658 if (!test_and_clear_bit(SLF_ERROR
, &sl
->flags
)
661 clear_bit(SLF_ESCAPE
, &sl
->flags
);
665 set_bit(SLF_ESCAPE
, &sl
->flags
);
667 case X25_ESCAPE(X25_ESC
):
668 case X25_ESCAPE(X25_END
):
669 if (test_and_clear_bit(SLF_ESCAPE
, &sl
->flags
))
673 if (!test_bit(SLF_ERROR
, &sl
->flags
)) {
674 if (sl
->rcount
< sl
->buffsize
) {
675 sl
->rbuff
[sl
->rcount
++] = s
;
678 sl
->dev
->stats
.rx_over_errors
++;
679 set_bit(SLF_ERROR
, &sl
->flags
);
684 /* Perform I/O control on an active X.25 channel. */
685 static int x25_asy_ioctl(struct tty_struct
*tty
, struct file
*file
,
686 unsigned int cmd
, unsigned long arg
)
688 struct x25_asy
*sl
= tty
->disc_data
;
690 /* First make sure we're connected. */
691 if (!sl
|| sl
->magic
!= X25_ASY_MAGIC
)
696 if (copy_to_user((void __user
*)arg
, sl
->dev
->name
,
697 strlen(sl
->dev
->name
) + 1))
703 return tty_mode_ioctl(tty
, file
, cmd
, arg
);
707 static int x25_asy_open_dev(struct net_device
*dev
)
709 struct x25_asy
*sl
= netdev_priv(dev
);
715 static const struct net_device_ops x25_asy_netdev_ops
= {
716 .ndo_open
= x25_asy_open_dev
,
717 .ndo_stop
= x25_asy_close
,
718 .ndo_start_xmit
= x25_asy_xmit
,
719 .ndo_tx_timeout
= x25_asy_timeout
,
720 .ndo_change_mtu
= x25_asy_change_mtu
,
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
= netdev_priv(dev
);
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
->netdev_ops
= &x25_asy_netdev_ops
;
739 dev
->watchdog_timeo
= HZ
*20;
740 dev
->hard_header_len
= 0;
742 dev
->type
= ARPHRD_X25
;
743 dev
->tx_queue_len
= 10;
745 /* New-style flags. */
746 dev
->flags
= IFF_NOARP
;
749 static struct tty_ldisc_ops x25_ldisc
= {
750 .owner
= THIS_MODULE
,
751 .magic
= TTY_LDISC_MAGIC
,
753 .open
= x25_asy_open_tty
,
754 .close
= x25_asy_close_tty
,
755 .ioctl
= x25_asy_ioctl
,
756 .receive_buf
= x25_asy_receive_buf
,
757 .write_wakeup
= x25_asy_write_wakeup
,
760 static int __init
init_x25_asy(void)
762 if (x25_asy_maxdev
< 4)
763 x25_asy_maxdev
= 4; /* Sanity */
765 printk(KERN_INFO
"X.25 async: version 0.00 ALPHA "
766 "(dynamic channels, max=%d).\n", x25_asy_maxdev
);
768 x25_asy_devs
= kcalloc(x25_asy_maxdev
, sizeof(struct net_device
*),
771 printk(KERN_WARNING
"X25 async: Can't allocate x25_asy_ctrls[] "
772 "array! Uaargh! (-> No X.25 available)\n");
776 return tty_register_ldisc(N_X25
, &x25_ldisc
);
780 static void __exit
exit_x25_asy(void)
782 struct net_device
*dev
;
785 for (i
= 0; i
< x25_asy_maxdev
; i
++) {
786 dev
= x25_asy_devs
[i
];
788 struct x25_asy
*sl
= netdev_priv(dev
);
790 spin_lock_bh(&sl
->lock
);
794 spin_unlock_bh(&sl
->lock
);
796 * VSV = if dev->start==0, then device
797 * unregistered while close proc.
799 unregister_netdev(dev
);
805 tty_unregister_ldisc(N_X25
);
808 module_init(init_x25_asy
);
809 module_exit(exit_x25_asy
);