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 = kzalloc(sizeof(*ap), GFP_KERNEL);
166 /* initialize the asyncppp structure */
169 spin_lock_init(&ap->xmit_lock);
170 spin_lock_init(&ap->recv_lock);
172 ap->xaccm[3] = 0x60000000U;
178 skb_queue_head_init(&ap->rqueue);
179 tasklet_init(&ap->tsk, ppp_async_process, (unsigned long) ap);
181 atomic_set(&ap->refcnt, 1);
182 init_MUTEX_LOCKED(&ap->dead_sem);
184 ap->chan.private = ap;
185 ap->chan.ops = &async_ops;
186 ap->chan.mtu = PPP_MRU;
187 err = ppp_register_channel(&ap->chan);
192 tty->receive_room = 65536;
202 * Called when the tty is put into another line discipline
203 * or it hangs up. We have to wait for any cpu currently
204 * executing in any of the other ppp_asynctty_* routines to
205 * finish before we can call ppp_unregister_channel and free
206 * the asyncppp struct. This routine must be called from
207 * process context, not interrupt or softirq context.
210 ppp_asynctty_close(struct tty_struct *tty)
214 write_lock_irq(&disc_data_lock);
216 tty->disc_data = NULL;
217 write_unlock_irq(&disc_data_lock);
222 * We have now ensured that nobody can start using ap from now
223 * on, but we have to wait for all existing users to finish.
224 * Note that ppp_unregister_channel ensures that no calls to
225 * our channel ops (i.e. ppp_async_send/ioctl) are in progress
226 * by the time it returns.
228 if (!atomic_dec_and_test(&ap->refcnt))
230 tasklet_kill(&ap->tsk);
232 ppp_unregister_channel(&ap->chan);
235 skb_queue_purge(&ap->rqueue);
242 * Called on tty hangup in process context.
244 * Wait for I/O to driver to complete and unregister PPP channel.
245 * This is already done by the close routine, so just call that.
247 static int ppp_asynctty_hangup(struct tty_struct *tty)
249 ppp_asynctty_close(tty);
254 * Read does nothing - no data is ever available this way.
255 * Pppd reads and writes packets via /dev/ppp instead.
258 ppp_asynctty_read(struct tty_struct *tty, struct file *file,
259 unsigned char __user *buf, size_t count)
265 * Write on the tty does nothing, the packets all come in
266 * from the ppp generic stuff.
269 ppp_asynctty_write(struct tty_struct *tty, struct file *file,
270 const unsigned char *buf, size_t count)
276 * Called in process context only. May be re-entered by multiple
277 * ioctl calling threads.
281 ppp_asynctty_ioctl(struct tty_struct *tty, struct file *file,
282 unsigned int cmd, unsigned long arg)
284 struct asyncppp *ap = ap_get(tty);
286 int __user *p = (int __user *)arg;
297 if (put_user(ppp_channel_index(&ap->chan), p))
307 if (put_user(ppp_unit_number(&ap->chan), p))
313 /* flush our buffers and the serial port's buffer */
314 if (arg == TCIOFLUSH || arg == TCOFLUSH)
315 ppp_async_flush_output(ap);
316 err = tty_perform_flush(tty, arg);
321 if (put_user(val, p))
327 /* Try the various mode ioctls */
328 err = tty_mode_ioctl(tty, file, cmd, arg);
335 /* No kernel lock - fine */
337 ppp_asynctty_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
343 * This can now be called from hard interrupt level as well
344 * as soft interrupt level or mainline.
347 ppp_asynctty_receive(struct tty_struct *tty, const unsigned char *buf,
348 char *cflags, int count)
350 struct asyncppp *ap = ap_get(tty);
355 spin_lock_irqsave(&ap->recv_lock, flags);
356 ppp_async_input(ap, buf, cflags, count);
357 spin_unlock_irqrestore(&ap->recv_lock, flags);
358 if (!skb_queue_empty(&ap->rqueue))
359 tasklet_schedule(&ap->tsk);
361 if (test_and_clear_bit(TTY_THROTTLED, &tty->flags)
362 && tty->driver->unthrottle)
363 tty->driver->unthrottle(tty);
367 ppp_asynctty_wakeup(struct tty_struct *tty)
369 struct asyncppp *ap = ap_get(tty);
371 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
374 set_bit(XMIT_WAKEUP, &ap->xmit_flags);
375 tasklet_schedule(&ap->tsk);
380 static struct tty_ldisc ppp_ldisc = {
381 .owner = THIS_MODULE,
382 .magic = TTY_LDISC_MAGIC,
384 .open = ppp_asynctty_open,
385 .close = ppp_asynctty_close,
386 .hangup = ppp_asynctty_hangup,
387 .read = ppp_asynctty_read,
388 .write = ppp_asynctty_write,
389 .ioctl = ppp_asynctty_ioctl,
390 .poll = ppp_asynctty_poll,
391 .receive_buf = ppp_asynctty_receive,
392 .write_wakeup = ppp_asynctty_wakeup,
400 err = tty_register_ldisc(N_PPP, &ppp_ldisc);
402 printk(KERN_ERR "PPP_async: error %d registering line disc.\n",
408 * The following routines provide the PPP channel interface.
411 ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd, unsigned long arg)
413 struct asyncppp *ap = chan->private;
414 void __user *argp = (void __user *)arg;
415 int __user *p = argp;
422 val = ap->flags | ap->rbits;
423 if (put_user(val, p))
428 if (get_user(val, p))
430 ap->flags = val & ~SC_RCV_BITS;
431 spin_lock_irq(&ap->recv_lock);
432 ap->rbits = val & SC_RCV_BITS;
433 spin_unlock_irq(&ap->recv_lock);
437 case PPPIOCGASYNCMAP:
438 if (put_user(ap->xaccm[0], (u32 __user *)argp))
442 case PPPIOCSASYNCMAP:
443 if (get_user(ap->xaccm[0], (u32 __user *)argp))
448 case PPPIOCGRASYNCMAP:
449 if (put_user(ap->raccm, (u32 __user *)argp))
453 case PPPIOCSRASYNCMAP:
454 if (get_user(ap->raccm, (u32 __user *)argp))
459 case PPPIOCGXASYNCMAP:
460 if (copy_to_user(argp, ap->xaccm, sizeof(ap->xaccm)))
464 case PPPIOCSXASYNCMAP:
465 if (copy_from_user(accm, argp, sizeof(accm)))
467 accm[2] &= ~0x40000000U; /* can't escape 0x5e */
468 accm[3] |= 0x60000000U; /* must escape 0x7d, 0x7e */
469 memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
474 if (put_user(ap->mru, p))
479 if (get_user(val, p))
495 * This is called at softirq level to deliver received packets
496 * to the ppp_generic code, and to tell the ppp_generic code
497 * if we can accept more output now.
499 static void ppp_async_process(unsigned long arg)
501 struct asyncppp *ap = (struct asyncppp *) arg;
504 /* process received packets */
505 while ((skb = skb_dequeue(&ap->rqueue)) != NULL) {
507 ppp_input_error(&ap->chan, 0);
508 ppp_input(&ap->chan, skb);
511 /* try to push more stuff out */
512 if (test_bit(XMIT_WAKEUP, &ap->xmit_flags) && ppp_async_push(ap))
513 ppp_output_wakeup(&ap->chan);
517 * Procedures for encapsulation and framing.
521 * Procedure to encode the data for async serial transmission.
522 * Does octet stuffing (escaping), puts the address/control bytes
523 * on if A/C compression is disabled, and does protocol compression.
524 * Assumes ap->tpkt != 0 on entry.
525 * Returns 1 if we finished the current frame, 0 otherwise.
528 #define PUT_BYTE(ap, buf, c, islcp) do { \
529 if ((islcp && c < 0x20) || (ap->xaccm[c >> 5] & (1 << (c & 0x1f)))) {\
530 *buf++ = PPP_ESCAPE; \
537 ppp_async_encode(struct asyncppp *ap)
539 int fcs, i, count, c, proto;
540 unsigned char *buf, *buflim;
548 data = ap->tpkt->data;
549 count = ap->tpkt->len;
551 proto = (data[0] << 8) + data[1];
554 * LCP packets with code values between 1 (configure-reqest)
555 * and 7 (code-reject) must be sent as though no options
556 * had been negotiated.
558 islcp = proto == PPP_LCP && 1 <= data[2] && data[2] <= 7;
562 async_lcp_peek(ap, data, count, 0);
565 * Start of a new packet - insert the leading FLAG
566 * character if necessary.
568 if (islcp || flag_time == 0
569 || time_after_eq(jiffies, ap->last_xmit + flag_time))
571 ap->last_xmit = jiffies;
575 * Put in the address/control bytes if necessary
577 if ((ap->flags & SC_COMP_AC) == 0 || islcp) {
578 PUT_BYTE(ap, buf, 0xff, islcp);
579 fcs = PPP_FCS(fcs, 0xff);
580 PUT_BYTE(ap, buf, 0x03, islcp);
581 fcs = PPP_FCS(fcs, 0x03);
586 * Once we put in the last byte, we need to put in the FCS
587 * and closing flag, so make sure there is at least 7 bytes
588 * of free space in the output buffer.
590 buflim = ap->obuf + OBUFSIZE - 6;
591 while (i < count && buf < buflim) {
593 if (i == 1 && c == 0 && (ap->flags & SC_COMP_PROT))
594 continue; /* compress protocol field */
595 fcs = PPP_FCS(fcs, c);
596 PUT_BYTE(ap, buf, c, islcp);
601 * Remember where we are up to in this packet.
610 * We have finished the packet. Add the FCS and flag.
614 PUT_BYTE(ap, buf, c, islcp);
615 c = (fcs >> 8) & 0xff;
616 PUT_BYTE(ap, buf, c, islcp);
626 * Transmit-side routines.
630 * Send a packet to the peer over an async tty line.
631 * Returns 1 iff the packet was accepted.
632 * If the packet was not accepted, we will call ppp_output_wakeup
633 * at some later time.
636 ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb)
638 struct asyncppp *ap = chan->private;
642 if (test_and_set_bit(XMIT_FULL, &ap->xmit_flags))
643 return 0; /* already full */
652 * Push as much data as possible out to the tty.
655 ppp_async_push(struct asyncppp *ap)
657 int avail, sent, done = 0;
658 struct tty_struct *tty = ap->tty;
662 * We can get called recursively here if the tty write
663 * function calls our wakeup function. This can happen
664 * for example on a pty with both the master and slave
665 * set to PPP line discipline.
666 * We use the XMIT_BUSY bit to detect this and get out,
667 * leaving the XMIT_WAKEUP bit set to tell the other
668 * instance that it may now be able to write more now.
670 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
672 spin_lock_bh(&ap->xmit_lock);
674 if (test_and_clear_bit(XMIT_WAKEUP, &ap->xmit_flags))
676 if (!tty_stuffed && ap->optr < ap->olim) {
677 avail = ap->olim - ap->optr;
678 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
679 sent = tty->driver->write(tty, ap->optr, avail);
681 goto flush; /* error, e.g. loss of CD */
687 if (ap->optr >= ap->olim && ap->tpkt) {
688 if (ppp_async_encode(ap)) {
689 /* finished processing ap->tpkt */
690 clear_bit(XMIT_FULL, &ap->xmit_flags);
696 * We haven't made any progress this time around.
697 * Clear XMIT_BUSY to let other callers in, but
698 * after doing so we have to check if anyone set
699 * XMIT_WAKEUP since we last checked it. If they
700 * did, we should try again to set XMIT_BUSY and go
701 * around again in case XMIT_BUSY was still set when
702 * the other caller tried.
704 clear_bit(XMIT_BUSY, &ap->xmit_flags);
705 /* any more work to do? if not, exit the loop */
706 if (!(test_bit(XMIT_WAKEUP, &ap->xmit_flags)
707 || (!tty_stuffed && ap->tpkt)))
709 /* more work to do, see if we can do it now */
710 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
713 spin_unlock_bh(&ap->xmit_lock);
717 clear_bit(XMIT_BUSY, &ap->xmit_flags);
721 clear_bit(XMIT_FULL, &ap->xmit_flags);
725 spin_unlock_bh(&ap->xmit_lock);
730 * Flush output from our internal buffers.
731 * Called for the TCFLSH ioctl. Can be entered in parallel
732 * but this is covered by the xmit_lock.
735 ppp_async_flush_output(struct asyncppp *ap)
739 spin_lock_bh(&ap->xmit_lock);
741 if (ap->tpkt != NULL) {
744 clear_bit(XMIT_FULL, &ap->xmit_flags);
747 spin_unlock_bh(&ap->xmit_lock);
749 ppp_output_wakeup(&ap->chan);
753 * Receive-side routines.
756 /* see how many ordinary chars there are at the start of buf */
758 scan_ordinary(struct asyncppp *ap, const unsigned char *buf, int count)
762 for (i = 0; i < count; ++i) {
764 if (c == PPP_ESCAPE || c == PPP_FLAG
765 || (c < 0x20 && (ap->raccm & (1 << c)) != 0))
771 /* called when a flag is seen - do end-of-packet processing */
773 process_input_packet(struct asyncppp *ap)
777 unsigned int len, fcs, proto;
780 if (ap->state & (SC_TOSS | SC_ESCAPE))
784 return; /* 0-length packet */
790 goto err; /* too short */
792 for (; len > 0; --len)
793 fcs = PPP_FCS(fcs, *p++);
794 if (fcs != PPP_GOODFCS)
795 goto err; /* bad FCS */
796 skb_trim(skb, skb->len - 2);
798 /* check for address/control and protocol compression */
800 if (p[0] == PPP_ALLSTATIONS) {
801 /* chop off address/control */
802 if (p[1] != PPP_UI || skb->len < 3)
804 p = skb_pull(skb, 2);
808 /* protocol is compressed */
809 skb_push(skb, 1)[0] = 0;
813 proto = (proto << 8) + p[1];
814 if (proto == PPP_LCP)
815 async_lcp_peek(ap, p, skb->len, 1);
818 /* queue the frame to be processed */
819 skb->cb[0] = ap->state;
820 skb_queue_tail(&ap->rqueue, skb);
826 /* frame had an error, remember that, reset SC_TOSS & SC_ESCAPE */
827 ap->state = SC_PREV_ERROR;
829 /* make skb appear as freshly allocated */
831 skb_reserve(skb, - skb_headroom(skb));
835 /* Called when the tty driver has data for us. Runs parallel with the
836 other ldisc functions but will not be re-entered */
839 ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
840 char *flags, int count)
843 int c, i, j, n, s, f;
846 /* update bits used for 8-bit cleanness detection */
847 if (~ap->rbits & SC_RCV_BITS) {
849 for (i = 0; i < count; ++i) {
851 if (flags && flags[i] != 0)
853 s |= (c & 0x80)? SC_RCV_B7_1: SC_RCV_B7_0;
854 c = ((c >> 4) ^ c) & 0xf;
855 s |= (0x6996 & (1 << c))? SC_RCV_ODDP: SC_RCV_EVNP;
861 /* scan through and see how many chars we can do in bulk */
862 if ((ap->state & SC_ESCAPE) && buf[0] == PPP_ESCAPE)
865 n = scan_ordinary(ap, buf, count);
868 if (flags && (ap->state & SC_TOSS) == 0) {
869 /* check the flags to see if any char had an error */
870 for (j = 0; j < n; ++j)
871 if ((f = flags[j]) != 0)
876 ap->state |= SC_TOSS;
878 } else if (n > 0 && (ap->state & SC_TOSS) == 0) {
879 /* stuff the chars in the skb */
882 skb = dev_alloc_skb(ap->mru + PPP_HDRLEN + 2);
888 /* Try to get the payload 4-byte aligned.
889 * This should match the
890 * PPP_ALLSTATIONS/PPP_UI/compressed tests in
891 * process_input_packet, but we do not have
892 * enough chars here to test buf[1] and buf[2].
894 if (buf[0] != PPP_ALLSTATIONS)
895 skb_reserve(skb, 2 + (buf[0] & 1));
897 if (n > skb_tailroom(skb)) {
898 /* packet overflowed MRU */
899 ap->state |= SC_TOSS;
901 sp = skb_put(skb, n);
903 if (ap->state & SC_ESCAPE) {
905 ap->state &= ~SC_ESCAPE;
914 if (flags != NULL && flags[n] != 0) {
915 ap->state |= SC_TOSS;
916 } else if (c == PPP_FLAG) {
917 process_input_packet(ap);
918 } else if (c == PPP_ESCAPE) {
919 ap->state |= SC_ESCAPE;
920 } else if (I_IXON(ap->tty)) {
921 if (c == START_CHAR(ap->tty))
923 else if (c == STOP_CHAR(ap->tty))
926 /* otherwise it's a char in the recv ACCM */
937 printk(KERN_ERR "PPPasync: no memory (input pkt)\n");
938 ap->state |= SC_TOSS;
942 * We look at LCP frames going past so that we can notice
943 * and react to the LCP configure-ack from the peer.
944 * In the situation where the peer has been sent a configure-ack
945 * already, LCP is up once it has sent its configure-ack
946 * so the immediately following packet can be sent with the
947 * configured LCP options. This allows us to process the following
948 * packet correctly without pppd needing to respond quickly.
950 * We only respond to the received configure-ack if we have just
951 * sent a configure-request, and the configure-ack contains the
952 * same data (this is checked using a 16-bit crc of the data).
954 #define CONFREQ 1 /* LCP code field values */
956 #define LCP_MRU 1 /* LCP option numbers */
957 #define LCP_ASYNCMAP 2
959 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
960 int len, int inbound)
962 int dlen, fcs, i, code;
965 data += 2; /* skip protocol bytes */
967 if (len < 4) /* 4 = code, ID, length */
970 if (code != CONFACK && code != CONFREQ)
972 dlen = (data[2] << 8) + data[3];
974 return; /* packet got truncated or length is bogus */
976 if (code == (inbound? CONFACK: CONFREQ)) {
978 * sent confreq or received confack:
979 * calculate the crc of the data from the ID field on.
982 for (i = 1; i < dlen; ++i)
983 fcs = PPP_FCS(fcs, data[i]);
986 /* outbound confreq - remember the crc for later */
991 /* received confack, check the crc */
997 return; /* not interested in received confreq */
999 /* process the options in the confack */
1002 /* data[0] is code, data[1] is length */
1003 while (dlen >= 2 && dlen >= data[1] && data[1] >= 2) {
1006 val = (data[2] << 8) + data[3];
1013 val = (data[2] << 24) + (data[3] << 16)
1014 + (data[4] << 8) + data[5];
1026 static void __exit ppp_async_cleanup(void)
1028 if (tty_unregister_ldisc(N_PPP) != 0)
1029 printk(KERN_ERR "failed to unregister PPP line discipline\n");
1032 module_init(ppp_async_init);
1033 module_exit(ppp_async_cleanup);