1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * PPP async serial channel driver for Linux.
5 * Copyright 1999 Paul Mackerras.
7 * This driver provides the encapsulation and framing for sending
8 * and receiving PPP frames over async serial lines. It relies on
9 * the generic PPP layer to give it frames to send and to process
10 * received frames. It implements the PPP line discipline.
12 * Part of the code in this driver was inspired by the old async-only
13 * PPP driver, written by Michael Callahan and Al Longyear, and
14 * subsequently hacked by Paul Mackerras.
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/skbuff.h>
20 #include <linux/tty.h>
21 #include <linux/netdevice.h>
22 #include <linux/poll.h>
23 #include <linux/crc-ccitt.h>
24 #include <linux/ppp_defs.h>
25 #include <linux/ppp-ioctl.h>
26 #include <linux/ppp_channel.h>
27 #include <linux/spinlock.h>
28 #include <linux/init.h>
29 #include <linux/interrupt.h>
30 #include <linux/jiffies.h>
31 #include <linux/slab.h>
32 #include <asm/unaligned.h>
33 #include <linux/uaccess.h>
34 #include <asm/string.h>
36 #define PPP_VERSION "2.4.2"
40 /* Structure for storing local state. */
42 struct tty_struct *tty;
49 unsigned long xmit_flags;
52 unsigned int bytes_sent;
53 unsigned int bytes_rcvd;
60 unsigned long last_xmit;
64 struct sk_buff_head rqueue;
66 struct tasklet_struct tsk;
69 struct completion dead;
70 struct ppp_channel chan; /* interface to generic ppp layer */
71 unsigned char obuf[OBUFSIZE];
74 /* Bit numbers in xmit_flags */
82 #define SC_PREV_ERROR 4
85 #define SC_RCV_BITS (SC_RCV_B7_1|SC_RCV_B7_0|SC_RCV_ODDP|SC_RCV_EVNP)
87 static int flag_time = HZ;
88 module_param(flag_time, int, 0);
89 MODULE_PARM_DESC(flag_time, "ppp_async: interval between flagged packets (in clock ticks)");
90 MODULE_LICENSE("GPL");
91 MODULE_ALIAS_LDISC(N_PPP);
96 static int ppp_async_encode(struct asyncppp *ap);
97 static int ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb);
98 static int ppp_async_push(struct asyncppp *ap);
99 static void ppp_async_flush_output(struct asyncppp *ap);
100 static void ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
101 char *flags, int count);
102 static int ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd,
104 static void ppp_async_process(unsigned long arg);
106 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
107 int len, int inbound);
109 static const struct ppp_channel_ops async_ops = {
110 .start_xmit = ppp_async_send,
111 .ioctl = ppp_async_ioctl,
115 * Routines implementing the PPP line discipline.
119 * We have a potential race on dereferencing tty->disc_data,
120 * because the tty layer provides no locking at all - thus one
121 * cpu could be running ppp_asynctty_receive while another
122 * calls ppp_asynctty_close, which zeroes tty->disc_data and
123 * frees the memory that ppp_asynctty_receive is using. The best
124 * way to fix this is to use a rwlock in the tty struct, but for now
125 * we use a single global rwlock for all ttys in ppp line discipline.
127 * FIXME: this is no longer true. The _close path for the ldisc is
128 * now guaranteed to be sane.
130 static DEFINE_RWLOCK(disc_data_lock);
132 static struct asyncppp *ap_get(struct tty_struct *tty)
136 read_lock(&disc_data_lock);
139 refcount_inc(&ap->refcnt);
140 read_unlock(&disc_data_lock);
144 static void ap_put(struct asyncppp *ap)
146 if (refcount_dec_and_test(&ap->refcnt))
151 * Called when a tty is put into PPP line discipline. Called in process
155 ppp_asynctty_open(struct tty_struct *tty)
161 if (tty->ops->write == NULL)
165 ap = kzalloc(sizeof(*ap), GFP_KERNEL);
169 /* initialize the asyncppp structure */
172 spin_lock_init(&ap->xmit_lock);
173 spin_lock_init(&ap->recv_lock);
175 ap->xaccm[3] = 0x60000000U;
181 skb_queue_head_init(&ap->rqueue);
182 tasklet_init(&ap->tsk, ppp_async_process, (unsigned long) ap);
184 refcount_set(&ap->refcnt, 1);
185 init_completion(&ap->dead);
187 ap->chan.private = ap;
188 ap->chan.ops = &async_ops;
189 ap->chan.mtu = PPP_MRU;
190 speed = tty_get_baud_rate(tty);
191 ap->chan.speed = speed;
192 err = ppp_register_channel(&ap->chan);
197 tty->receive_room = 65536;
207 * Called when the tty is put into another line discipline
208 * or it hangs up. We have to wait for any cpu currently
209 * executing in any of the other ppp_asynctty_* routines to
210 * finish before we can call ppp_unregister_channel and free
211 * the asyncppp struct. This routine must be called from
212 * process context, not interrupt or softirq context.
215 ppp_asynctty_close(struct tty_struct *tty)
219 write_lock_irq(&disc_data_lock);
221 tty->disc_data = NULL;
222 write_unlock_irq(&disc_data_lock);
227 * We have now ensured that nobody can start using ap from now
228 * on, but we have to wait for all existing users to finish.
229 * Note that ppp_unregister_channel ensures that no calls to
230 * our channel ops (i.e. ppp_async_send/ioctl) are in progress
231 * by the time it returns.
233 if (!refcount_dec_and_test(&ap->refcnt))
234 wait_for_completion(&ap->dead);
235 tasklet_kill(&ap->tsk);
237 ppp_unregister_channel(&ap->chan);
239 skb_queue_purge(&ap->rqueue);
245 * Called on tty hangup in process context.
247 * Wait for I/O to driver to complete and unregister PPP channel.
248 * This is already done by the close routine, so just call that.
250 static int ppp_asynctty_hangup(struct tty_struct *tty)
252 ppp_asynctty_close(tty);
257 * Read does nothing - no data is ever available this way.
258 * Pppd reads and writes packets via /dev/ppp instead.
261 ppp_asynctty_read(struct tty_struct *tty, struct file *file,
262 unsigned char *buf, size_t count,
263 void **cookie, unsigned long offset)
269 * Write on the tty does nothing, the packets all come in
270 * from the ppp generic stuff.
273 ppp_asynctty_write(struct tty_struct *tty, struct file *file,
274 const unsigned char *buf, size_t count)
280 * Called in process context only. May be re-entered by multiple
281 * ioctl calling threads.
285 ppp_asynctty_ioctl(struct tty_struct *tty, struct file *file,
286 unsigned int cmd, unsigned long arg)
288 struct asyncppp *ap = ap_get(tty);
290 int __user *p = (int __user *)arg;
298 if (put_user(ppp_channel_index(&ap->chan), p))
305 if (put_user(ppp_unit_number(&ap->chan), p))
311 /* flush our buffers and the serial port's buffer */
312 if (arg == TCIOFLUSH || arg == TCOFLUSH)
313 ppp_async_flush_output(ap);
314 err = n_tty_ioctl_helper(tty, file, cmd, arg);
319 if (put_user(val, p))
325 /* Try the various mode ioctls */
326 err = tty_mode_ioctl(tty, file, cmd, arg);
333 /* No kernel lock - fine */
335 ppp_asynctty_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
340 /* May sleep, don't call from interrupt level or with interrupts disabled */
342 ppp_asynctty_receive(struct tty_struct *tty, const unsigned char *buf,
343 char *cflags, int count)
345 struct asyncppp *ap = ap_get(tty);
350 spin_lock_irqsave(&ap->recv_lock, flags);
351 ppp_async_input(ap, buf, cflags, count);
352 spin_unlock_irqrestore(&ap->recv_lock, flags);
353 if (!skb_queue_empty(&ap->rqueue))
354 tasklet_schedule(&ap->tsk);
360 ppp_asynctty_wakeup(struct tty_struct *tty)
362 struct asyncppp *ap = ap_get(tty);
364 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
367 set_bit(XMIT_WAKEUP, &ap->xmit_flags);
368 tasklet_schedule(&ap->tsk);
373 static struct tty_ldisc_ops ppp_ldisc = {
374 .owner = THIS_MODULE,
375 .magic = TTY_LDISC_MAGIC,
377 .open = ppp_asynctty_open,
378 .close = ppp_asynctty_close,
379 .hangup = ppp_asynctty_hangup,
380 .read = ppp_asynctty_read,
381 .write = ppp_asynctty_write,
382 .ioctl = ppp_asynctty_ioctl,
383 .poll = ppp_asynctty_poll,
384 .receive_buf = ppp_asynctty_receive,
385 .write_wakeup = ppp_asynctty_wakeup,
393 err = tty_register_ldisc(N_PPP, &ppp_ldisc);
395 printk(KERN_ERR "PPP_async: error %d registering line disc.\n",
401 * The following routines provide the PPP channel interface.
404 ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd, unsigned long arg)
406 struct asyncppp *ap = chan->private;
407 void __user *argp = (void __user *)arg;
408 int __user *p = argp;
415 val = ap->flags | ap->rbits;
416 if (put_user(val, p))
421 if (get_user(val, p))
423 ap->flags = val & ~SC_RCV_BITS;
424 spin_lock_irq(&ap->recv_lock);
425 ap->rbits = val & SC_RCV_BITS;
426 spin_unlock_irq(&ap->recv_lock);
430 case PPPIOCGASYNCMAP:
431 if (put_user(ap->xaccm[0], (u32 __user *)argp))
435 case PPPIOCSASYNCMAP:
436 if (get_user(ap->xaccm[0], (u32 __user *)argp))
441 case PPPIOCGRASYNCMAP:
442 if (put_user(ap->raccm, (u32 __user *)argp))
446 case PPPIOCSRASYNCMAP:
447 if (get_user(ap->raccm, (u32 __user *)argp))
452 case PPPIOCGXASYNCMAP:
453 if (copy_to_user(argp, ap->xaccm, sizeof(ap->xaccm)))
457 case PPPIOCSXASYNCMAP:
458 if (copy_from_user(accm, argp, sizeof(accm)))
460 accm[2] &= ~0x40000000U; /* can't escape 0x5e */
461 accm[3] |= 0x60000000U; /* must escape 0x7d, 0x7e */
462 memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
467 if (put_user(ap->mru, p))
472 if (get_user(val, p))
492 * This is called at softirq level to deliver received packets
493 * to the ppp_generic code, and to tell the ppp_generic code
494 * if we can accept more output now.
496 static void ppp_async_process(unsigned long arg)
498 struct asyncppp *ap = (struct asyncppp *) arg;
501 /* process received packets */
502 while ((skb = skb_dequeue(&ap->rqueue)) != NULL) {
504 ppp_input_error(&ap->chan, 0);
505 ppp_input(&ap->chan, skb);
508 /* try to push more stuff out */
509 if (test_bit(XMIT_WAKEUP, &ap->xmit_flags) && ppp_async_push(ap))
510 ppp_output_wakeup(&ap->chan);
514 * Procedures for encapsulation and framing.
518 * Procedure to encode the data for async serial transmission.
519 * Does octet stuffing (escaping), puts the address/control bytes
520 * on if A/C compression is disabled, and does protocol compression.
521 * Assumes ap->tpkt != 0 on entry.
522 * Returns 1 if we finished the current frame, 0 otherwise.
525 #define PUT_BYTE(ap, buf, c, islcp) do { \
526 if ((islcp && c < 0x20) || (ap->xaccm[c >> 5] & (1 << (c & 0x1f)))) {\
527 *buf++ = PPP_ESCAPE; \
528 *buf++ = c ^ PPP_TRANS; \
534 ppp_async_encode(struct asyncppp *ap)
536 int fcs, i, count, c, proto;
537 unsigned char *buf, *buflim;
545 data = ap->tpkt->data;
546 count = ap->tpkt->len;
548 proto = get_unaligned_be16(data);
551 * LCP packets with code values between 1 (configure-reqest)
552 * and 7 (code-reject) must be sent as though no options
553 * had been negotiated.
555 islcp = proto == PPP_LCP && 1 <= data[2] && data[2] <= 7;
559 async_lcp_peek(ap, data, count, 0);
562 * Start of a new packet - insert the leading FLAG
563 * character if necessary.
565 if (islcp || flag_time == 0 ||
566 time_after_eq(jiffies, ap->last_xmit + flag_time))
568 ap->last_xmit = jiffies;
572 * Put in the address/control bytes if necessary
574 if ((ap->flags & SC_COMP_AC) == 0 || islcp) {
575 PUT_BYTE(ap, buf, 0xff, islcp);
576 fcs = PPP_FCS(fcs, 0xff);
577 PUT_BYTE(ap, buf, 0x03, islcp);
578 fcs = PPP_FCS(fcs, 0x03);
583 * Once we put in the last byte, we need to put in the FCS
584 * and closing flag, so make sure there is at least 7 bytes
585 * of free space in the output buffer.
587 buflim = ap->obuf + OBUFSIZE - 6;
588 while (i < count && buf < buflim) {
590 if (i == 1 && c == 0 && (ap->flags & SC_COMP_PROT))
591 continue; /* compress protocol field */
592 fcs = PPP_FCS(fcs, c);
593 PUT_BYTE(ap, buf, c, islcp);
598 * Remember where we are up to in this packet.
607 * We have finished the packet. Add the FCS and flag.
611 PUT_BYTE(ap, buf, c, islcp);
612 c = (fcs >> 8) & 0xff;
613 PUT_BYTE(ap, buf, c, islcp);
617 consume_skb(ap->tpkt);
623 * Transmit-side routines.
627 * Send a packet to the peer over an async tty line.
628 * Returns 1 iff the packet was accepted.
629 * If the packet was not accepted, we will call ppp_output_wakeup
630 * at some later time.
633 ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb)
635 struct asyncppp *ap = chan->private;
639 if (test_and_set_bit(XMIT_FULL, &ap->xmit_flags))
640 return 0; /* already full */
649 * Push as much data as possible out to the tty.
652 ppp_async_push(struct asyncppp *ap)
654 int avail, sent, done = 0;
655 struct tty_struct *tty = ap->tty;
659 * We can get called recursively here if the tty write
660 * function calls our wakeup function. This can happen
661 * for example on a pty with both the master and slave
662 * set to PPP line discipline.
663 * We use the XMIT_BUSY bit to detect this and get out,
664 * leaving the XMIT_WAKEUP bit set to tell the other
665 * instance that it may now be able to write more now.
667 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
669 spin_lock_bh(&ap->xmit_lock);
671 if (test_and_clear_bit(XMIT_WAKEUP, &ap->xmit_flags))
673 if (!tty_stuffed && ap->optr < ap->olim) {
674 avail = ap->olim - ap->optr;
675 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
676 sent = tty->ops->write(tty, ap->optr, avail);
678 goto flush; /* error, e.g. loss of CD */
684 if (ap->optr >= ap->olim && ap->tpkt) {
685 if (ppp_async_encode(ap)) {
686 /* finished processing ap->tpkt */
687 clear_bit(XMIT_FULL, &ap->xmit_flags);
693 * We haven't made any progress this time around.
694 * Clear XMIT_BUSY to let other callers in, but
695 * after doing so we have to check if anyone set
696 * XMIT_WAKEUP since we last checked it. If they
697 * did, we should try again to set XMIT_BUSY and go
698 * around again in case XMIT_BUSY was still set when
699 * the other caller tried.
701 clear_bit(XMIT_BUSY, &ap->xmit_flags);
702 /* any more work to do? if not, exit the loop */
703 if (!(test_bit(XMIT_WAKEUP, &ap->xmit_flags) ||
704 (!tty_stuffed && ap->tpkt)))
706 /* more work to do, see if we can do it now */
707 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
710 spin_unlock_bh(&ap->xmit_lock);
714 clear_bit(XMIT_BUSY, &ap->xmit_flags);
718 clear_bit(XMIT_FULL, &ap->xmit_flags);
722 spin_unlock_bh(&ap->xmit_lock);
727 * Flush output from our internal buffers.
728 * Called for the TCFLSH ioctl. Can be entered in parallel
729 * but this is covered by the xmit_lock.
732 ppp_async_flush_output(struct asyncppp *ap)
736 spin_lock_bh(&ap->xmit_lock);
738 if (ap->tpkt != NULL) {
741 clear_bit(XMIT_FULL, &ap->xmit_flags);
744 spin_unlock_bh(&ap->xmit_lock);
746 ppp_output_wakeup(&ap->chan);
750 * Receive-side routines.
753 /* see how many ordinary chars there are at the start of buf */
755 scan_ordinary(struct asyncppp *ap, const unsigned char *buf, int count)
759 for (i = 0; i < count; ++i) {
761 if (c == PPP_ESCAPE || c == PPP_FLAG ||
762 (c < 0x20 && (ap->raccm & (1 << c)) != 0))
768 /* called when a flag is seen - do end-of-packet processing */
770 process_input_packet(struct asyncppp *ap)
774 unsigned int len, fcs;
777 if (ap->state & (SC_TOSS | SC_ESCAPE))
781 return; /* 0-length packet */
787 goto err; /* too short */
789 for (; len > 0; --len)
790 fcs = PPP_FCS(fcs, *p++);
791 if (fcs != PPP_GOODFCS)
792 goto err; /* bad FCS */
793 skb_trim(skb, skb->len - 2);
795 /* check for address/control and protocol compression */
797 if (p[0] == PPP_ALLSTATIONS) {
798 /* chop off address/control */
799 if (p[1] != PPP_UI || skb->len < 3)
801 p = skb_pull(skb, 2);
804 /* If protocol field is not compressed, it can be LCP packet */
805 if (!(p[0] & 0x01)) {
810 proto = (p[0] << 8) + p[1];
811 if (proto == PPP_LCP)
812 async_lcp_peek(ap, p, skb->len, 1);
815 /* queue the frame to be processed */
816 skb->cb[0] = ap->state;
817 skb_queue_tail(&ap->rqueue, skb);
823 /* frame had an error, remember that, reset SC_TOSS & SC_ESCAPE */
824 ap->state = SC_PREV_ERROR;
826 /* make skb appear as freshly allocated */
828 skb_reserve(skb, - skb_headroom(skb));
832 /* Called when the tty driver has data for us. Runs parallel with the
833 other ldisc functions but will not be re-entered */
836 ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
837 char *flags, int count)
840 int c, i, j, n, s, f;
843 /* update bits used for 8-bit cleanness detection */
844 if (~ap->rbits & SC_RCV_BITS) {
846 for (i = 0; i < count; ++i) {
848 if (flags && flags[i] != 0)
850 s |= (c & 0x80)? SC_RCV_B7_1: SC_RCV_B7_0;
851 c = ((c >> 4) ^ c) & 0xf;
852 s |= (0x6996 & (1 << c))? SC_RCV_ODDP: SC_RCV_EVNP;
858 /* scan through and see how many chars we can do in bulk */
859 if ((ap->state & SC_ESCAPE) && buf[0] == PPP_ESCAPE)
862 n = scan_ordinary(ap, buf, count);
865 if (flags && (ap->state & SC_TOSS) == 0) {
866 /* check the flags to see if any char had an error */
867 for (j = 0; j < n; ++j)
868 if ((f = flags[j]) != 0)
873 ap->state |= SC_TOSS;
875 } else if (n > 0 && (ap->state & SC_TOSS) == 0) {
876 /* stuff the chars in the skb */
879 skb = dev_alloc_skb(ap->mru + PPP_HDRLEN + 2);
885 /* Try to get the payload 4-byte aligned.
886 * This should match the
887 * PPP_ALLSTATIONS/PPP_UI/compressed tests in
888 * process_input_packet, but we do not have
889 * enough chars here to test buf[1] and buf[2].
891 if (buf[0] != PPP_ALLSTATIONS)
892 skb_reserve(skb, 2 + (buf[0] & 1));
894 if (n > skb_tailroom(skb)) {
895 /* packet overflowed MRU */
896 ap->state |= SC_TOSS;
898 sp = skb_put_data(skb, buf, n);
899 if (ap->state & SC_ESCAPE) {
901 ap->state &= ~SC_ESCAPE;
910 if (flags != NULL && flags[n] != 0) {
911 ap->state |= SC_TOSS;
912 } else if (c == PPP_FLAG) {
913 process_input_packet(ap);
914 } else if (c == PPP_ESCAPE) {
915 ap->state |= SC_ESCAPE;
916 } else if (I_IXON(ap->tty)) {
917 if (c == START_CHAR(ap->tty))
919 else if (c == STOP_CHAR(ap->tty))
922 /* otherwise it's a char in the recv ACCM */
933 printk(KERN_ERR "PPPasync: no memory (input pkt)\n");
934 ap->state |= SC_TOSS;
938 * We look at LCP frames going past so that we can notice
939 * and react to the LCP configure-ack from the peer.
940 * In the situation where the peer has been sent a configure-ack
941 * already, LCP is up once it has sent its configure-ack
942 * so the immediately following packet can be sent with the
943 * configured LCP options. This allows us to process the following
944 * packet correctly without pppd needing to respond quickly.
946 * We only respond to the received configure-ack if we have just
947 * sent a configure-request, and the configure-ack contains the
948 * same data (this is checked using a 16-bit crc of the data).
950 #define CONFREQ 1 /* LCP code field values */
952 #define LCP_MRU 1 /* LCP option numbers */
953 #define LCP_ASYNCMAP 2
955 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
956 int len, int inbound)
958 int dlen, fcs, i, code;
961 data += 2; /* skip protocol bytes */
963 if (len < 4) /* 4 = code, ID, length */
966 if (code != CONFACK && code != CONFREQ)
968 dlen = get_unaligned_be16(data + 2);
970 return; /* packet got truncated or length is bogus */
972 if (code == (inbound? CONFACK: CONFREQ)) {
974 * sent confreq or received confack:
975 * calculate the crc of the data from the ID field on.
978 for (i = 1; i < dlen; ++i)
979 fcs = PPP_FCS(fcs, data[i]);
982 /* outbound confreq - remember the crc for later */
987 /* received confack, check the crc */
993 return; /* not interested in received confreq */
995 /* process the options in the confack */
998 /* data[0] is code, data[1] is length */
999 while (dlen >= 2 && dlen >= data[1] && data[1] >= 2) {
1002 val = get_unaligned_be16(data + 2);
1009 val = get_unaligned_be32(data + 2);
1021 static void __exit ppp_async_cleanup(void)
1023 if (tty_unregister_ldisc(N_PPP) != 0)
1024 printk(KERN_ERR "failed to unregister PPP line discipline\n");
1027 module_init(ppp_async_init);
1028 module_exit(ppp_async_cleanup);