2 * PPP async serial channel driver for Linux.
4 * Copyright 1999 Paul Mackerras.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
11 * This driver provides the encapsulation and framing for sending
12 * and receiving PPP frames over async serial lines. It relies on
13 * the generic PPP layer to give it frames to send and to process
14 * received frames. It implements the PPP line discipline.
16 * Part of the code in this driver was inspired by the old async-only
17 * PPP driver, written by Michael Callahan and Al Longyear, and
18 * subsequently hacked by Paul Mackerras.
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/skbuff.h>
24 #include <linux/tty.h>
25 #include <linux/netdevice.h>
26 #include <linux/poll.h>
27 #include <linux/crc-ccitt.h>
28 #include <linux/ppp_defs.h>
29 #include <linux/if_ppp.h>
30 #include <linux/ppp_channel.h>
31 #include <linux/spinlock.h>
32 #include <linux/init.h>
33 #include <linux/jiffies.h>
34 #include <asm/uaccess.h>
35 #include <asm/string.h>
37 #define PPP_VERSION "2.4.2"
41 /* Structure for storing local state. */
43 struct tty_struct *tty;
50 unsigned long xmit_flags;
53 unsigned int bytes_sent;
54 unsigned int bytes_rcvd;
61 unsigned long last_xmit;
65 struct sk_buff_head rqueue;
67 struct tasklet_struct tsk;
70 struct semaphore dead_sem;
71 struct ppp_channel chan; /* interface to generic ppp layer */
72 unsigned char obuf[OBUFSIZE];
75 /* Bit numbers in xmit_flags */
83 #define SC_PREV_ERROR 4
86 #define SC_RCV_BITS (SC_RCV_B7_1|SC_RCV_B7_0|SC_RCV_ODDP|SC_RCV_EVNP)
88 static int flag_time = HZ;
89 module_param(flag_time, int, 0);
90 MODULE_PARM_DESC(flag_time, "ppp_async: interval between flagged packets (in clock ticks)");
91 MODULE_LICENSE("GPL");
92 MODULE_ALIAS_LDISC(N_PPP);
97 static int ppp_async_encode(struct asyncppp *ap);
98 static int ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb);
99 static int ppp_async_push(struct asyncppp *ap);
100 static void ppp_async_flush_output(struct asyncppp *ap);
101 static void ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
102 char *flags, int count);
103 static int ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd,
105 static void ppp_async_process(unsigned long arg);
107 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
108 int len, int inbound);
110 static struct ppp_channel_ops async_ops = {
116 * Routines implementing the PPP line discipline.
120 * We have a potential race on dereferencing tty->disc_data,
121 * because the tty layer provides no locking at all - thus one
122 * cpu could be running ppp_asynctty_receive while another
123 * calls ppp_asynctty_close, which zeroes tty->disc_data and
124 * frees the memory that ppp_asynctty_receive is using. The best
125 * way to fix this is to use a rwlock in the tty struct, but for now
126 * we use a single global rwlock for all ttys in ppp line discipline.
128 * FIXME: this is no longer true. The _close path for the ldisc is
129 * now guaranteed to be sane.
131 static DEFINE_RWLOCK(disc_data_lock);
133 static struct asyncppp *ap_get(struct tty_struct *tty)
137 read_lock(&disc_data_lock);
140 atomic_inc(&ap->refcnt);
141 read_unlock(&disc_data_lock);
145 static void ap_put(struct asyncppp *ap)
147 if (atomic_dec_and_test(&ap->refcnt))
152 * Called when a tty is put into PPP line discipline. Called in process
156 ppp_asynctty_open(struct tty_struct *tty)
162 ap = kmalloc(sizeof(*ap), GFP_KERNEL);
166 /* initialize the asyncppp structure */
167 memset(ap, 0, sizeof(*ap));
170 spin_lock_init(&ap->xmit_lock);
171 spin_lock_init(&ap->recv_lock);
173 ap->xaccm[3] = 0x60000000U;
179 skb_queue_head_init(&ap->rqueue);
180 tasklet_init(&ap->tsk, ppp_async_process, (unsigned long) ap);
182 atomic_set(&ap->refcnt, 1);
183 init_MUTEX_LOCKED(&ap->dead_sem);
185 ap->chan.private = ap;
186 ap->chan.ops = &async_ops;
187 ap->chan.mtu = PPP_MRU;
188 err = ppp_register_channel(&ap->chan);
193 tty->receive_room = 65536;
203 * Called when the tty is put into another line discipline
204 * or it hangs up. We have to wait for any cpu currently
205 * executing in any of the other ppp_asynctty_* routines to
206 * finish before we can call ppp_unregister_channel and free
207 * the asyncppp struct. This routine must be called from
208 * process context, not interrupt or softirq context.
211 ppp_asynctty_close(struct tty_struct *tty)
215 write_lock_irq(&disc_data_lock);
217 tty->disc_data = NULL;
218 write_unlock_irq(&disc_data_lock);
223 * We have now ensured that nobody can start using ap from now
224 * on, but we have to wait for all existing users to finish.
225 * Note that ppp_unregister_channel ensures that no calls to
226 * our channel ops (i.e. ppp_async_send/ioctl) are in progress
227 * by the time it returns.
229 if (!atomic_dec_and_test(&ap->refcnt))
231 tasklet_kill(&ap->tsk);
233 ppp_unregister_channel(&ap->chan);
236 skb_queue_purge(&ap->rqueue);
243 * Called on tty hangup in process context.
245 * Wait for I/O to driver to complete and unregister PPP channel.
246 * This is already done by the close routine, so just call that.
248 static int ppp_asynctty_hangup(struct tty_struct *tty)
250 ppp_asynctty_close(tty);
255 * Read does nothing - no data is ever available this way.
256 * Pppd reads and writes packets via /dev/ppp instead.
259 ppp_asynctty_read(struct tty_struct *tty, struct file *file,
260 unsigned char __user *buf, size_t count)
266 * Write on the tty does nothing, the packets all come in
267 * from the ppp generic stuff.
270 ppp_asynctty_write(struct tty_struct *tty, struct file *file,
271 const unsigned char *buf, size_t count)
277 * Called in process context only. May be re-entered by multiple
278 * ioctl calling threads.
282 ppp_asynctty_ioctl(struct tty_struct *tty, struct file *file,
283 unsigned int cmd, unsigned long arg)
285 struct asyncppp *ap = ap_get(tty);
287 int __user *p = (int __user *)arg;
298 if (put_user(ppp_channel_index(&ap->chan), p))
308 if (put_user(ppp_unit_number(&ap->chan), p))
315 err = n_tty_ioctl(tty, file, cmd, arg);
319 /* flush our buffers and the serial port's buffer */
320 if (arg == TCIOFLUSH || arg == TCOFLUSH)
321 ppp_async_flush_output(ap);
322 err = n_tty_ioctl(tty, file, cmd, arg);
327 if (put_user(val, p))
340 /* No kernel lock - fine */
342 ppp_asynctty_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
348 * This can now be called from hard interrupt level as well
349 * as soft interrupt level or mainline.
352 ppp_asynctty_receive(struct tty_struct *tty, const unsigned char *buf,
353 char *cflags, int count)
355 struct asyncppp *ap = ap_get(tty);
360 spin_lock_irqsave(&ap->recv_lock, flags);
361 ppp_async_input(ap, buf, cflags, count);
362 spin_unlock_irqrestore(&ap->recv_lock, flags);
363 if (!skb_queue_empty(&ap->rqueue))
364 tasklet_schedule(&ap->tsk);
366 if (test_and_clear_bit(TTY_THROTTLED, &tty->flags)
367 && tty->driver->unthrottle)
368 tty->driver->unthrottle(tty);
372 ppp_asynctty_wakeup(struct tty_struct *tty)
374 struct asyncppp *ap = ap_get(tty);
376 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
379 set_bit(XMIT_WAKEUP, &ap->xmit_flags);
380 tasklet_schedule(&ap->tsk);
385 static struct tty_ldisc ppp_ldisc = {
386 .owner = THIS_MODULE,
387 .magic = TTY_LDISC_MAGIC,
389 .open = ppp_asynctty_open,
390 .close = ppp_asynctty_close,
391 .hangup = ppp_asynctty_hangup,
392 .read = ppp_asynctty_read,
393 .write = ppp_asynctty_write,
394 .ioctl = ppp_asynctty_ioctl,
395 .poll = ppp_asynctty_poll,
396 .receive_buf = ppp_asynctty_receive,
397 .write_wakeup = ppp_asynctty_wakeup,
405 err = tty_register_ldisc(N_PPP, &ppp_ldisc);
407 printk(KERN_ERR "PPP_async: error %d registering line disc.\n",
413 * The following routines provide the PPP channel interface.
416 ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd, unsigned long arg)
418 struct asyncppp *ap = chan->private;
419 void __user *argp = (void __user *)arg;
420 int __user *p = argp;
427 val = ap->flags | ap->rbits;
428 if (put_user(val, p))
433 if (get_user(val, p))
435 ap->flags = val & ~SC_RCV_BITS;
436 spin_lock_irq(&ap->recv_lock);
437 ap->rbits = val & SC_RCV_BITS;
438 spin_unlock_irq(&ap->recv_lock);
442 case PPPIOCGASYNCMAP:
443 if (put_user(ap->xaccm[0], (u32 __user *)argp))
447 case PPPIOCSASYNCMAP:
448 if (get_user(ap->xaccm[0], (u32 __user *)argp))
453 case PPPIOCGRASYNCMAP:
454 if (put_user(ap->raccm, (u32 __user *)argp))
458 case PPPIOCSRASYNCMAP:
459 if (get_user(ap->raccm, (u32 __user *)argp))
464 case PPPIOCGXASYNCMAP:
465 if (copy_to_user(argp, ap->xaccm, sizeof(ap->xaccm)))
469 case PPPIOCSXASYNCMAP:
470 if (copy_from_user(accm, argp, sizeof(accm)))
472 accm[2] &= ~0x40000000U; /* can't escape 0x5e */
473 accm[3] |= 0x60000000U; /* must escape 0x7d, 0x7e */
474 memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
479 if (put_user(ap->mru, p))
484 if (get_user(val, p))
500 * This is called at softirq level to deliver received packets
501 * to the ppp_generic code, and to tell the ppp_generic code
502 * if we can accept more output now.
504 static void ppp_async_process(unsigned long arg)
506 struct asyncppp *ap = (struct asyncppp *) arg;
509 /* process received packets */
510 while ((skb = skb_dequeue(&ap->rqueue)) != NULL) {
512 ppp_input_error(&ap->chan, 0);
513 ppp_input(&ap->chan, skb);
516 /* try to push more stuff out */
517 if (test_bit(XMIT_WAKEUP, &ap->xmit_flags) && ppp_async_push(ap))
518 ppp_output_wakeup(&ap->chan);
522 * Procedures for encapsulation and framing.
526 * Procedure to encode the data for async serial transmission.
527 * Does octet stuffing (escaping), puts the address/control bytes
528 * on if A/C compression is disabled, and does protocol compression.
529 * Assumes ap->tpkt != 0 on entry.
530 * Returns 1 if we finished the current frame, 0 otherwise.
533 #define PUT_BYTE(ap, buf, c, islcp) do { \
534 if ((islcp && c < 0x20) || (ap->xaccm[c >> 5] & (1 << (c & 0x1f)))) {\
535 *buf++ = PPP_ESCAPE; \
542 ppp_async_encode(struct asyncppp *ap)
544 int fcs, i, count, c, proto;
545 unsigned char *buf, *buflim;
553 data = ap->tpkt->data;
554 count = ap->tpkt->len;
556 proto = (data[0] << 8) + data[1];
559 * LCP packets with code values between 1 (configure-reqest)
560 * and 7 (code-reject) must be sent as though no options
561 * had been negotiated.
563 islcp = proto == PPP_LCP && 1 <= data[2] && data[2] <= 7;
567 async_lcp_peek(ap, data, count, 0);
570 * Start of a new packet - insert the leading FLAG
571 * character if necessary.
573 if (islcp || flag_time == 0
574 || time_after_eq(jiffies, ap->last_xmit + flag_time))
576 ap->last_xmit = jiffies;
580 * Put in the address/control bytes if necessary
582 if ((ap->flags & SC_COMP_AC) == 0 || islcp) {
583 PUT_BYTE(ap, buf, 0xff, islcp);
584 fcs = PPP_FCS(fcs, 0xff);
585 PUT_BYTE(ap, buf, 0x03, islcp);
586 fcs = PPP_FCS(fcs, 0x03);
591 * Once we put in the last byte, we need to put in the FCS
592 * and closing flag, so make sure there is at least 7 bytes
593 * of free space in the output buffer.
595 buflim = ap->obuf + OBUFSIZE - 6;
596 while (i < count && buf < buflim) {
598 if (i == 1 && c == 0 && (ap->flags & SC_COMP_PROT))
599 continue; /* compress protocol field */
600 fcs = PPP_FCS(fcs, c);
601 PUT_BYTE(ap, buf, c, islcp);
606 * Remember where we are up to in this packet.
615 * We have finished the packet. Add the FCS and flag.
619 PUT_BYTE(ap, buf, c, islcp);
620 c = (fcs >> 8) & 0xff;
621 PUT_BYTE(ap, buf, c, islcp);
631 * Transmit-side routines.
635 * Send a packet to the peer over an async tty line.
636 * Returns 1 iff the packet was accepted.
637 * If the packet was not accepted, we will call ppp_output_wakeup
638 * at some later time.
641 ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb)
643 struct asyncppp *ap = chan->private;
647 if (test_and_set_bit(XMIT_FULL, &ap->xmit_flags))
648 return 0; /* already full */
657 * Push as much data as possible out to the tty.
660 ppp_async_push(struct asyncppp *ap)
662 int avail, sent, done = 0;
663 struct tty_struct *tty = ap->tty;
667 * We can get called recursively here if the tty write
668 * function calls our wakeup function. This can happen
669 * for example on a pty with both the master and slave
670 * set to PPP line discipline.
671 * We use the XMIT_BUSY bit to detect this and get out,
672 * leaving the XMIT_WAKEUP bit set to tell the other
673 * instance that it may now be able to write more now.
675 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
677 spin_lock_bh(&ap->xmit_lock);
679 if (test_and_clear_bit(XMIT_WAKEUP, &ap->xmit_flags))
681 if (!tty_stuffed && ap->optr < ap->olim) {
682 avail = ap->olim - ap->optr;
683 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
684 sent = tty->driver->write(tty, ap->optr, avail);
686 goto flush; /* error, e.g. loss of CD */
692 if (ap->optr >= ap->olim && ap->tpkt != 0) {
693 if (ppp_async_encode(ap)) {
694 /* finished processing ap->tpkt */
695 clear_bit(XMIT_FULL, &ap->xmit_flags);
701 * We haven't made any progress this time around.
702 * Clear XMIT_BUSY to let other callers in, but
703 * after doing so we have to check if anyone set
704 * XMIT_WAKEUP since we last checked it. If they
705 * did, we should try again to set XMIT_BUSY and go
706 * around again in case XMIT_BUSY was still set when
707 * the other caller tried.
709 clear_bit(XMIT_BUSY, &ap->xmit_flags);
710 /* any more work to do? if not, exit the loop */
711 if (!(test_bit(XMIT_WAKEUP, &ap->xmit_flags)
712 || (!tty_stuffed && ap->tpkt != 0)))
714 /* more work to do, see if we can do it now */
715 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
718 spin_unlock_bh(&ap->xmit_lock);
722 clear_bit(XMIT_BUSY, &ap->xmit_flags);
726 clear_bit(XMIT_FULL, &ap->xmit_flags);
730 spin_unlock_bh(&ap->xmit_lock);
735 * Flush output from our internal buffers.
736 * Called for the TCFLSH ioctl. Can be entered in parallel
737 * but this is covered by the xmit_lock.
740 ppp_async_flush_output(struct asyncppp *ap)
744 spin_lock_bh(&ap->xmit_lock);
746 if (ap->tpkt != NULL) {
749 clear_bit(XMIT_FULL, &ap->xmit_flags);
752 spin_unlock_bh(&ap->xmit_lock);
754 ppp_output_wakeup(&ap->chan);
758 * Receive-side routines.
761 /* see how many ordinary chars there are at the start of buf */
763 scan_ordinary(struct asyncppp *ap, const unsigned char *buf, int count)
767 for (i = 0; i < count; ++i) {
769 if (c == PPP_ESCAPE || c == PPP_FLAG
770 || (c < 0x20 && (ap->raccm & (1 << c)) != 0))
776 /* called when a flag is seen - do end-of-packet processing */
778 process_input_packet(struct asyncppp *ap)
782 unsigned int len, fcs, proto;
785 if (ap->state & (SC_TOSS | SC_ESCAPE))
789 return; /* 0-length packet */
795 goto err; /* too short */
797 for (; len > 0; --len)
798 fcs = PPP_FCS(fcs, *p++);
799 if (fcs != PPP_GOODFCS)
800 goto err; /* bad FCS */
801 skb_trim(skb, skb->len - 2);
803 /* check for address/control and protocol compression */
805 if (p[0] == PPP_ALLSTATIONS) {
806 /* chop off address/control */
807 if (p[1] != PPP_UI || skb->len < 3)
809 p = skb_pull(skb, 2);
813 /* protocol is compressed */
814 skb_push(skb, 1)[0] = 0;
818 proto = (proto << 8) + p[1];
819 if (proto == PPP_LCP)
820 async_lcp_peek(ap, p, skb->len, 1);
823 /* queue the frame to be processed */
824 skb->cb[0] = ap->state;
825 skb_queue_tail(&ap->rqueue, skb);
831 /* frame had an error, remember that, reset SC_TOSS & SC_ESCAPE */
832 ap->state = SC_PREV_ERROR;
834 /* make skb appear as freshly allocated */
836 skb_reserve(skb, - skb_headroom(skb));
840 /* Called when the tty driver has data for us. Runs parallel with the
841 other ldisc functions but will not be re-entered */
844 ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
845 char *flags, int count)
848 int c, i, j, n, s, f;
851 /* update bits used for 8-bit cleanness detection */
852 if (~ap->rbits & SC_RCV_BITS) {
854 for (i = 0; i < count; ++i) {
856 if (flags != 0 && flags[i] != 0)
858 s |= (c & 0x80)? SC_RCV_B7_1: SC_RCV_B7_0;
859 c = ((c >> 4) ^ c) & 0xf;
860 s |= (0x6996 & (1 << c))? SC_RCV_ODDP: SC_RCV_EVNP;
866 /* scan through and see how many chars we can do in bulk */
867 if ((ap->state & SC_ESCAPE) && buf[0] == PPP_ESCAPE)
870 n = scan_ordinary(ap, buf, count);
873 if (flags != 0 && (ap->state & SC_TOSS) == 0) {
874 /* check the flags to see if any char had an error */
875 for (j = 0; j < n; ++j)
876 if ((f = flags[j]) != 0)
881 ap->state |= SC_TOSS;
883 } else if (n > 0 && (ap->state & SC_TOSS) == 0) {
884 /* stuff the chars in the skb */
887 skb = dev_alloc_skb(ap->mru + PPP_HDRLEN + 2);
893 /* Try to get the payload 4-byte aligned.
894 * This should match the
895 * PPP_ALLSTATIONS/PPP_UI/compressed tests in
896 * process_input_packet, but we do not have
897 * enough chars here to test buf[1] and buf[2].
899 if (buf[0] != PPP_ALLSTATIONS)
900 skb_reserve(skb, 2 + (buf[0] & 1));
902 if (n > skb_tailroom(skb)) {
903 /* packet overflowed MRU */
904 ap->state |= SC_TOSS;
906 sp = skb_put(skb, n);
908 if (ap->state & SC_ESCAPE) {
910 ap->state &= ~SC_ESCAPE;
919 if (flags != NULL && flags[n] != 0) {
920 ap->state |= SC_TOSS;
921 } else if (c == PPP_FLAG) {
922 process_input_packet(ap);
923 } else if (c == PPP_ESCAPE) {
924 ap->state |= SC_ESCAPE;
925 } else if (I_IXON(ap->tty)) {
926 if (c == START_CHAR(ap->tty))
928 else if (c == STOP_CHAR(ap->tty))
931 /* otherwise it's a char in the recv ACCM */
942 printk(KERN_ERR "PPPasync: no memory (input pkt)\n");
943 ap->state |= SC_TOSS;
947 * We look at LCP frames going past so that we can notice
948 * and react to the LCP configure-ack from the peer.
949 * In the situation where the peer has been sent a configure-ack
950 * already, LCP is up once it has sent its configure-ack
951 * so the immediately following packet can be sent with the
952 * configured LCP options. This allows us to process the following
953 * packet correctly without pppd needing to respond quickly.
955 * We only respond to the received configure-ack if we have just
956 * sent a configure-request, and the configure-ack contains the
957 * same data (this is checked using a 16-bit crc of the data).
959 #define CONFREQ 1 /* LCP code field values */
961 #define LCP_MRU 1 /* LCP option numbers */
962 #define LCP_ASYNCMAP 2
964 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
965 int len, int inbound)
967 int dlen, fcs, i, code;
970 data += 2; /* skip protocol bytes */
972 if (len < 4) /* 4 = code, ID, length */
975 if (code != CONFACK && code != CONFREQ)
977 dlen = (data[2] << 8) + data[3];
979 return; /* packet got truncated or length is bogus */
981 if (code == (inbound? CONFACK: CONFREQ)) {
983 * sent confreq or received confack:
984 * calculate the crc of the data from the ID field on.
987 for (i = 1; i < dlen; ++i)
988 fcs = PPP_FCS(fcs, data[i]);
991 /* outbound confreq - remember the crc for later */
996 /* received confack, check the crc */
1002 return; /* not interested in received confreq */
1004 /* process the options in the confack */
1007 /* data[0] is code, data[1] is length */
1008 while (dlen >= 2 && dlen >= data[1] && data[1] >= 2) {
1011 val = (data[2] << 8) + data[3];
1018 val = (data[2] << 24) + (data[3] << 16)
1019 + (data[4] << 8) + data[5];
1031 static void __exit ppp_async_cleanup(void)
1033 if (tty_unregister_ldisc(N_PPP) != 0)
1034 printk(KERN_ERR "failed to unregister PPP line discipline\n");
1037 module_init(ppp_async_init);
1038 module_exit(ppp_async_cleanup);