drivers/net/ppp_async.c

   1 /*
   2  * PPP async serial channel driver for Linux.
   3  *
   4  * Copyright 1999 Paul Mackerras.
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  */
  20
  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>
  36
  37 #define PPP_VERSION     "2.4.2"
  38
  39 #define OBUFSIZE        256
  40
  41 /* Structure for storing local state. */
  42 struct asyncppp {
  43         struct tty_struct *tty;
  44         unsigned int    flags;
  45         unsigned int    state;
  46         unsigned int    rbits;
  47         int             mru;
  48         spinlock_t      xmit_lock;
  49         spinlock_t      recv_lock;
  50         unsigned long   xmit_flags;
  51         u32             xaccm[8];
  52         u32             raccm;
  53         unsigned int    bytes_sent;
  54         unsigned int    bytes_rcvd;
  55
  56         struct sk_buff  *tpkt;
  57         int             tpkt_pos;
  58         u16             tfcs;
  59         unsigned char   *optr;
  60         unsigned char   *olim;
  61         unsigned long   last_xmit;
  62
  63         struct sk_buff  *rpkt;
  64         int             lcp_fcs;
  65         struct sk_buff_head rqueue;
  66
  67         struct tasklet_struct tsk;
  68
  69         atomic_t        refcnt;
  70         struct semaphore dead_sem;
  71         struct ppp_channel chan;        /* interface to generic ppp layer */
  72         unsigned char   obuf[OBUFSIZE];
  73 };
  74
  75 /* Bit numbers in xmit_flags */
  76 #define XMIT_WAKEUP     0
  77 #define XMIT_FULL       1
  78 #define XMIT_BUSY       2
  79
  80 /* State bits */
  81 #define SC_TOSS         1
  82 #define SC_ESCAPE       2
  83 #define SC_PREV_ERROR   4
  84
  85 /* Bits in rbits */
  86 #define SC_RCV_BITS     (SC_RCV_B7_1|SC_RCV_B7_0|SC_RCV_ODDP|SC_RCV_EVNP)
  87
  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);
  93
  94 /*
  95  * Prototypes.
  96  */
  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,
 104                            unsigned long arg);
 105 static void ppp_async_process(unsigned long arg);
 106
 107 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
 108                            int len, int inbound);
 109
 110 static struct ppp_channel_ops async_ops = {
 111         ppp_async_send,
 112         ppp_async_ioctl
 113 };
 114
 115 /*
 116  * Routines implementing the PPP line discipline.
 117  */
 118
 119 /*
 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.
 127  *
 128  * FIXME: this is no longer true. The _close path for the ldisc is
 129  * now guaranteed to be sane.
 130  */
 131 static DEFINE_RWLOCK(disc_data_lock);
 132
 133 static struct asyncppp *ap_get(struct tty_struct *tty)
 134 {
 135         unsigned long flags;
 136         struct asyncppp *ap;
 137
 138         read_lock_irqsave(&disc_data_lock, flags);
 139         ap = tty->disc_data;
 140         if (ap != NULL)
 141                 atomic_inc(&ap->refcnt);
 142         read_unlock_irqrestore(&disc_data_lock, flags);
 143
 144         return ap;
 145 }
 146
 147 static void ap_put(struct asyncppp *ap)
 148 {
 149         if (atomic_dec_and_test(&ap->refcnt))
 150                 up(&ap->dead_sem);
 151 }
 152
 153 /*
 154  * Called when a tty is put into PPP line discipline. Called in process
 155  * context.
 156  */
 157 static int
 158 ppp_asynctty_open(struct tty_struct *tty)
 159 {
 160         struct asyncppp *ap;
 161         int err;
 162         int speed;
 163
 164         if (tty->ops->write == NULL)
 165                 return -EOPNOTSUPP;
 166
 167         err = -ENOMEM;
 168         ap = kzalloc(sizeof(*ap), GFP_KERNEL);
 169         if (!ap)
 170                 goto out;
 171
 172         /* initialize the asyncppp structure */
 173         ap->tty = tty;
 174         ap->mru = PPP_MRU;
 175         spin_lock_init(&ap->xmit_lock);
 176         spin_lock_init(&ap->recv_lock);
 177         ap->xaccm[0] = ~0U;
 178         ap->xaccm[3] = 0x60000000U;
 179         ap->raccm = ~0U;
 180         ap->optr = ap->obuf;
 181         ap->olim = ap->obuf;
 182         ap->lcp_fcs = -1;
 183
 184         skb_queue_head_init(&ap->rqueue);
 185         tasklet_init(&ap->tsk, ppp_async_process, (unsigned long) ap);
 186
 187         atomic_set(&ap->refcnt, 1);
 188         init_MUTEX_LOCKED(&ap->dead_sem);
 189
 190         ap->chan.private = ap;
 191         ap->chan.ops = &async_ops;
 192         ap->chan.mtu = PPP_MRU;
 193         speed = tty_get_baud_rate(tty);
 194         ap->chan.speed = speed;
 195         err = ppp_register_channel(&ap->chan);
 196         if (err)
 197                 goto out_free;
 198
 199         tty->disc_data = ap;
 200         tty->receive_room = 65536;
 201         return 0;
 202
 203  out_free:
 204         kfree(ap);
 205  out:
 206         return err;
 207 }
 208
 209 /*
 210  * Called when the tty is put into another line discipline
 211  * or it hangs up.  We have to wait for any cpu currently
 212  * executing in any of the other ppp_asynctty_* routines to
 213  * finish before we can call ppp_unregister_channel and free
 214  * the asyncppp struct.  This routine must be called from
 215  * process context, not interrupt or softirq context.
 216  */
 217 static void
 218 ppp_asynctty_close(struct tty_struct *tty)
 219 {
 220         unsigned long flags;
 221         struct asyncppp *ap;
 222
 223         write_lock_irqsave(&disc_data_lock, flags);
 224         ap = tty->disc_data;
 225         tty->disc_data = NULL;
 226         write_unlock_irqrestore(&disc_data_lock, flags);
 227         if (!ap)
 228                 return;
 229
 230         /*
 231          * We have now ensured that nobody can start using ap from now
 232          * on, but we have to wait for all existing users to finish.
 233          * Note that ppp_unregister_channel ensures that no calls to
 234          * our channel ops (i.e. ppp_async_send/ioctl) are in progress
 235          * by the time it returns.
 236          */
 237         if (!atomic_dec_and_test(&ap->refcnt))
 238                 down(&ap->dead_sem);
 239         tasklet_kill(&ap->tsk);
 240
 241         ppp_unregister_channel(&ap->chan);
 242         kfree_skb(ap->rpkt);
 243         skb_queue_purge(&ap->rqueue);
 244         kfree_skb(ap->tpkt);
 245         kfree(ap);
 246 }
 247
 248 /*
 249  * Called on tty hangup in process context.
 250  *
 251  * Wait for I/O to driver to complete and unregister PPP channel.
 252  * This is already done by the close routine, so just call that.
 253  */
 254 static int ppp_asynctty_hangup(struct tty_struct *tty)
 255 {
 256         ppp_asynctty_close(tty);
 257         return 0;
 258 }
 259
 260 /*
 261  * Read does nothing - no data is ever available this way.
 262  * Pppd reads and writes packets via /dev/ppp instead.
 263  */
 264 static ssize_t
 265 ppp_asynctty_read(struct tty_struct *tty, struct file *file,
 266                   unsigned char __user *buf, size_t count)
 267 {
 268         return -EAGAIN;
 269 }
 270
 271 /*
 272  * Write on the tty does nothing, the packets all come in
 273  * from the ppp generic stuff.
 274  */
 275 static ssize_t
 276 ppp_asynctty_write(struct tty_struct *tty, struct file *file,
 277                    const unsigned char *buf, size_t count)
 278 {
 279         return -EAGAIN;
 280 }
 281
 282 /*
 283  * Called in process context only. May be re-entered by multiple
 284  * ioctl calling threads.
 285  */
 286
 287 static int
 288 ppp_asynctty_ioctl(struct tty_struct *tty, struct file *file,
 289                    unsigned int cmd, unsigned long arg)
 290 {
 291         struct asyncppp *ap = ap_get(tty);
 292         int err, val;
 293         int __user *p = (int __user *)arg;
 294
 295         if (!ap)
 296                 return -ENXIO;
 297         err = -EFAULT;
 298         switch (cmd) {
 299         case PPPIOCGCHAN:
 300                 err = -EFAULT;
 301                 if (put_user(ppp_channel_index(&ap->chan), p))
 302                         break;
 303                 err = 0;
 304                 break;
 305
 306         case PPPIOCGUNIT:
 307                 err = -EFAULT;
 308                 if (put_user(ppp_unit_number(&ap->chan), p))
 309                         break;
 310                 err = 0;
 311                 break;
 312
 313         case TCFLSH:
 314                 /* flush our buffers and the serial port's buffer */
 315                 if (arg == TCIOFLUSH || arg == TCOFLUSH)
 316                         ppp_async_flush_output(ap);
 317                 err = tty_perform_flush(tty, arg);
 318                 break;
 319
 320         case FIONREAD:
 321                 val = 0;
 322                 if (put_user(val, p))
 323                         break;
 324                 err = 0;
 325                 break;
 326
 327         default:
 328                 /* Try the various mode ioctls */
 329                 err = tty_mode_ioctl(tty, file, cmd, arg);
 330         }
 331
 332         ap_put(ap);
 333         return err;
 334 }
 335
 336 /* No kernel lock - fine */
 337 static unsigned int
 338 ppp_asynctty_poll(struct tty_struct *tty, struct file *file, poll_table *wait)
 339 {
 340         return 0;
 341 }
 342
 343 /*
 344  * This can now be called from hard interrupt level as well
 345  * as soft interrupt level or mainline.
 346  */
 347 static void
 348 ppp_asynctty_receive(struct tty_struct *tty, const unsigned char *buf,
 349                   char *cflags, int count)
 350 {
 351         struct asyncppp *ap = ap_get(tty);
 352         unsigned long flags;
 353
 354         if (!ap)
 355                 return;
 356         spin_lock_irqsave(&ap->recv_lock, flags);
 357         ppp_async_input(ap, buf, cflags, count);
 358         spin_unlock_irqrestore(&ap->recv_lock, flags);
 359         if (!skb_queue_empty(&ap->rqueue))
 360                 tasklet_schedule(&ap->tsk);
 361         ap_put(ap);
 362 }
 363
 364 static void
 365 ppp_asynctty_wakeup(struct tty_struct *tty)
 366 {
 367         struct asyncppp *ap = ap_get(tty);
 368
 369         clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 370         if (!ap)
 371                 return;
 372         set_bit(XMIT_WAKEUP, &ap->xmit_flags);
 373         tasklet_schedule(&ap->tsk);
 374         ap_put(ap);
 375 }
 376
 377
 378 static struct tty_ldisc_ops ppp_ldisc = {
 379         .owner  = THIS_MODULE,
 380         .magic  = TTY_LDISC_MAGIC,
 381         .name   = "ppp",
 382         .open   = ppp_asynctty_open,
 383         .close  = ppp_asynctty_close,
 384         .hangup = ppp_asynctty_hangup,
 385         .read   = ppp_asynctty_read,
 386         .write  = ppp_asynctty_write,
 387         .ioctl  = ppp_asynctty_ioctl,
 388         .poll   = ppp_asynctty_poll,
 389         .receive_buf = ppp_asynctty_receive,
 390         .write_wakeup = ppp_asynctty_wakeup,
 391 };
 392
 393 static int __init
 394 ppp_async_init(void)
 395 {
 396         int err;
 397
 398         err = tty_register_ldisc(N_PPP, &ppp_ldisc);
 399         if (err != 0)
 400                 printk(KERN_ERR "PPP_async: error %d registering line disc.\n",
 401                        err);
 402         return err;
 403 }
 404
 405 /*
 406  * The following routines provide the PPP channel interface.
 407  */
 408 static int
 409 ppp_async_ioctl(struct ppp_channel *chan, unsigned int cmd, unsigned long arg)
 410 {
 411         struct asyncppp *ap = chan->private;
 412         void __user *argp = (void __user *)arg;
 413         int __user *p = argp;
 414         int err, val;
 415         u32 accm[8];
 416
 417         err = -EFAULT;
 418         switch (cmd) {
 419         case PPPIOCGFLAGS:
 420                 val = ap->flags | ap->rbits;
 421                 if (put_user(val, p))
 422                         break;
 423                 err = 0;
 424                 break;
 425         case PPPIOCSFLAGS:
 426                 if (get_user(val, p))
 427                         break;
 428                 ap->flags = val & ~SC_RCV_BITS;
 429                 spin_lock_irq(&ap->recv_lock);
 430                 ap->rbits = val & SC_RCV_BITS;
 431                 spin_unlock_irq(&ap->recv_lock);
 432                 err = 0;
 433                 break;
 434
 435         case PPPIOCGASYNCMAP:
 436                 if (put_user(ap->xaccm[0], (u32 __user *)argp))
 437                         break;
 438                 err = 0;
 439                 break;
 440         case PPPIOCSASYNCMAP:
 441                 if (get_user(ap->xaccm[0], (u32 __user *)argp))
 442                         break;
 443                 err = 0;
 444                 break;
 445
 446         case PPPIOCGRASYNCMAP:
 447                 if (put_user(ap->raccm, (u32 __user *)argp))
 448                         break;
 449                 err = 0;
 450                 break;
 451         case PPPIOCSRASYNCMAP:
 452                 if (get_user(ap->raccm, (u32 __user *)argp))
 453                         break;
 454                 err = 0;
 455                 break;
 456
 457         case PPPIOCGXASYNCMAP:
 458                 if (copy_to_user(argp, ap->xaccm, sizeof(ap->xaccm)))
 459                         break;
 460                 err = 0;
 461                 break;
 462         case PPPIOCSXASYNCMAP:
 463                 if (copy_from_user(accm, argp, sizeof(accm)))
 464                         break;
 465                 accm[2] &= ~0x40000000U;        /* can't escape 0x5e */
 466                 accm[3] |= 0x60000000U;         /* must escape 0x7d, 0x7e */
 467                 memcpy(ap->xaccm, accm, sizeof(ap->xaccm));
 468                 err = 0;
 469                 break;
 470
 471         case PPPIOCGMRU:
 472                 if (put_user(ap->mru, p))
 473                         break;
 474                 err = 0;
 475                 break;
 476         case PPPIOCSMRU:
 477                 if (get_user(val, p))
 478                         break;
 479                 if (val < PPP_MRU)
 480                         val = PPP_MRU;
 481                 ap->mru = val;
 482                 err = 0;
 483                 break;
 484
 485         default:
 486                 err = -ENOTTY;
 487         }
 488
 489         return err;
 490 }
 491
 492 /*
 493  * This is called at softirq level to deliver received packets
 494  * to the ppp_generic code, and to tell the ppp_generic code
 495  * if we can accept more output now.
 496  */
 497 static void ppp_async_process(unsigned long arg)
 498 {
 499         struct asyncppp *ap = (struct asyncppp *) arg;
 500         struct sk_buff *skb;
 501
 502         /* process received packets */
 503         while ((skb = skb_dequeue(&ap->rqueue)) != NULL) {
 504                 if (skb->cb[0])
 505                         ppp_input_error(&ap->chan, 0);
 506                 ppp_input(&ap->chan, skb);
 507         }
 508
 509         /* try to push more stuff out */
 510         if (test_bit(XMIT_WAKEUP, &ap->xmit_flags) && ppp_async_push(ap))
 511                 ppp_output_wakeup(&ap->chan);
 512 }
 513
 514 /*
 515  * Procedures for encapsulation and framing.
 516  */
 517
 518 /*
 519  * Procedure to encode the data for async serial transmission.
 520  * Does octet stuffing (escaping), puts the address/control bytes
 521  * on if A/C compression is disabled, and does protocol compression.
 522  * Assumes ap->tpkt != 0 on entry.
 523  * Returns 1 if we finished the current frame, 0 otherwise.
 524  */
 525
 526 #define PUT_BYTE(ap, buf, c, islcp)     do {            \
 527         if ((islcp && c < 0x20) || (ap->xaccm[c >> 5] & (1 << (c & 0x1f)))) {\
 528                 *buf++ = PPP_ESCAPE;                    \
 529                 *buf++ = c ^ 0x20;                      \
 530         } else                                          \
 531                 *buf++ = c;                             \
 532 } while (0)
 533
 534 static int
 535 ppp_async_encode(struct asyncppp *ap)
 536 {
 537         int fcs, i, count, c, proto;
 538         unsigned char *buf, *buflim;
 539         unsigned char *data;
 540         int islcp;
 541
 542         buf = ap->obuf;
 543         ap->olim = buf;
 544         ap->optr = buf;
 545         i = ap->tpkt_pos;
 546         data = ap->tpkt->data;
 547         count = ap->tpkt->len;
 548         fcs = ap->tfcs;
 549         proto = (data[0] << 8) + data[1];
 550
 551         /*
 552          * LCP packets with code values between 1 (configure-reqest)
 553          * and 7 (code-reject) must be sent as though no options
 554          * had been negotiated.
 555          */
 556         islcp = proto == PPP_LCP && 1 <= data[2] && data[2] <= 7;
 557
 558         if (i == 0) {
 559                 if (islcp)
 560                         async_lcp_peek(ap, data, count, 0);
 561
 562                 /*
 563                  * Start of a new packet - insert the leading FLAG
 564                  * character if necessary.
 565                  */
 566                 if (islcp || flag_time == 0
 567                     || time_after_eq(jiffies, ap->last_xmit + flag_time))
 568                         *buf++ = PPP_FLAG;
 569                 ap->last_xmit = jiffies;
 570                 fcs = PPP_INITFCS;
 571
 572                 /*
 573                  * Put in the address/control bytes if necessary
 574                  */
 575                 if ((ap->flags & SC_COMP_AC) == 0 || islcp) {
 576                         PUT_BYTE(ap, buf, 0xff, islcp);
 577                         fcs = PPP_FCS(fcs, 0xff);
 578                         PUT_BYTE(ap, buf, 0x03, islcp);
 579                         fcs = PPP_FCS(fcs, 0x03);
 580                 }
 581         }
 582
 583         /*
 584          * Once we put in the last byte, we need to put in the FCS
 585          * and closing flag, so make sure there is at least 7 bytes
 586          * of free space in the output buffer.
 587          */
 588         buflim = ap->obuf + OBUFSIZE - 6;
 589         while (i < count && buf < buflim) {
 590                 c = data[i++];
 591                 if (i == 1 && c == 0 && (ap->flags & SC_COMP_PROT))
 592                         continue;       /* compress protocol field */
 593                 fcs = PPP_FCS(fcs, c);
 594                 PUT_BYTE(ap, buf, c, islcp);
 595         }
 596
 597         if (i < count) {
 598                 /*
 599                  * Remember where we are up to in this packet.
 600                  */
 601                 ap->olim = buf;
 602                 ap->tpkt_pos = i;
 603                 ap->tfcs = fcs;
 604                 return 0;
 605         }
 606
 607         /*
 608          * We have finished the packet.  Add the FCS and flag.
 609          */
 610         fcs = ~fcs;
 611         c = fcs & 0xff;
 612         PUT_BYTE(ap, buf, c, islcp);
 613         c = (fcs >> 8) & 0xff;
 614         PUT_BYTE(ap, buf, c, islcp);
 615         *buf++ = PPP_FLAG;
 616         ap->olim = buf;
 617
 618         kfree_skb(ap->tpkt);
 619         ap->tpkt = NULL;
 620         return 1;
 621 }
 622
 623 /*
 624  * Transmit-side routines.
 625  */
 626
 627 /*
 628  * Send a packet to the peer over an async tty line.
 629  * Returns 1 iff the packet was accepted.
 630  * If the packet was not accepted, we will call ppp_output_wakeup
 631  * at some later time.
 632  */
 633 static int
 634 ppp_async_send(struct ppp_channel *chan, struct sk_buff *skb)
 635 {
 636         struct asyncppp *ap = chan->private;
 637
 638         ppp_async_push(ap);
 639
 640         if (test_and_set_bit(XMIT_FULL, &ap->xmit_flags))
 641                 return 0;       /* already full */
 642         ap->tpkt = skb;
 643         ap->tpkt_pos = 0;
 644
 645         ppp_async_push(ap);
 646         return 1;
 647 }
 648
 649 /*
 650  * Push as much data as possible out to the tty.
 651  */
 652 static int
 653 ppp_async_push(struct asyncppp *ap)
 654 {
 655         int avail, sent, done = 0;
 656         struct tty_struct *tty = ap->tty;
 657         int tty_stuffed = 0;
 658
 659         /*
 660          * We can get called recursively here if the tty write
 661          * function calls our wakeup function.  This can happen
 662          * for example on a pty with both the master and slave
 663          * set to PPP line discipline.
 664          * We use the XMIT_BUSY bit to detect this and get out,
 665          * leaving the XMIT_WAKEUP bit set to tell the other
 666          * instance that it may now be able to write more now.
 667          */
 668         if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
 669                 return 0;
 670         spin_lock_bh(&ap->xmit_lock);
 671         for (;;) {
 672                 if (test_and_clear_bit(XMIT_WAKEUP, &ap->xmit_flags))
 673                         tty_stuffed = 0;
 674                 if (!tty_stuffed && ap->optr < ap->olim) {
 675                         avail = ap->olim - ap->optr;
 676                         set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
 677                         sent = tty->ops->write(tty, ap->optr, avail);
 678                         if (sent < 0)
 679                                 goto flush;     /* error, e.g. loss of CD */
 680                         ap->optr += sent;
 681                         if (sent < avail)
 682                                 tty_stuffed = 1;
 683                         continue;
 684                 }
 685                 if (ap->optr >= ap->olim && ap->tpkt) {
 686                         if (ppp_async_encode(ap)) {
 687                                 /* finished processing ap->tpkt */
 688                                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 689                                 done = 1;
 690                         }
 691                         continue;
 692                 }
 693                 /*
 694                  * We haven't made any progress this time around.
 695                  * Clear XMIT_BUSY to let other callers in, but
 696                  * after doing so we have to check if anyone set
 697                  * XMIT_WAKEUP since we last checked it.  If they
 698                  * did, we should try again to set XMIT_BUSY and go
 699                  * around again in case XMIT_BUSY was still set when
 700                  * the other caller tried.
 701                  */
 702                 clear_bit(XMIT_BUSY, &ap->xmit_flags);
 703                 /* any more work to do? if not, exit the loop */
 704                 if (!(test_bit(XMIT_WAKEUP, &ap->xmit_flags)
 705                       || (!tty_stuffed && ap->tpkt)))
 706                         break;
 707                 /* more work to do, see if we can do it now */
 708                 if (test_and_set_bit(XMIT_BUSY, &ap->xmit_flags))
 709                         break;
 710         }
 711         spin_unlock_bh(&ap->xmit_lock);
 712         return done;
 713
 714 flush:
 715         clear_bit(XMIT_BUSY, &ap->xmit_flags);
 716         if (ap->tpkt) {
 717                 kfree_skb(ap->tpkt);
 718                 ap->tpkt = NULL;
 719                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 720                 done = 1;
 721         }
 722         ap->optr = ap->olim;
 723         spin_unlock_bh(&ap->xmit_lock);
 724         return done;
 725 }
 726
 727 /*
 728  * Flush output from our internal buffers.
 729  * Called for the TCFLSH ioctl. Can be entered in parallel
 730  * but this is covered by the xmit_lock.
 731  */
 732 static void
 733 ppp_async_flush_output(struct asyncppp *ap)
 734 {
 735         int done = 0;
 736
 737         spin_lock_bh(&ap->xmit_lock);
 738         ap->optr = ap->olim;
 739         if (ap->tpkt != NULL) {
 740                 kfree_skb(ap->tpkt);
 741                 ap->tpkt = NULL;
 742                 clear_bit(XMIT_FULL, &ap->xmit_flags);
 743                 done = 1;
 744         }
 745         spin_unlock_bh(&ap->xmit_lock);
 746         if (done)
 747                 ppp_output_wakeup(&ap->chan);
 748 }
 749
 750 /*
 751  * Receive-side routines.
 752  */
 753
 754 /* see how many ordinary chars there are at the start of buf */
 755 static inline int
 756 scan_ordinary(struct asyncppp *ap, const unsigned char *buf, int count)
 757 {
 758         int i, c;
 759
 760         for (i = 0; i < count; ++i) {
 761                 c = buf[i];
 762                 if (c == PPP_ESCAPE || c == PPP_FLAG
 763                     || (c < 0x20 && (ap->raccm & (1 << c)) != 0))
 764                         break;
 765         }
 766         return i;
 767 }
 768
 769 /* called when a flag is seen - do end-of-packet processing */
 770 static void
 771 process_input_packet(struct asyncppp *ap)
 772 {
 773         struct sk_buff *skb;
 774         unsigned char *p;
 775         unsigned int len, fcs, proto;
 776
 777         skb = ap->rpkt;
 778         if (ap->state & (SC_TOSS | SC_ESCAPE))
 779                 goto err;
 780
 781         if (skb == NULL)
 782                 return;         /* 0-length packet */
 783
 784         /* check the FCS */
 785         p = skb->data;
 786         len = skb->len;
 787         if (len < 3)
 788                 goto err;       /* too short */
 789         fcs = PPP_INITFCS;
 790         for (; len > 0; --len)
 791                 fcs = PPP_FCS(fcs, *p++);
 792         if (fcs != PPP_GOODFCS)
 793                 goto err;       /* bad FCS */
 794         skb_trim(skb, skb->len - 2);
 795
 796         /* check for address/control and protocol compression */
 797         p = skb->data;
 798         if (p[0] == PPP_ALLSTATIONS) {
 799                 /* chop off address/control */
 800                 if (p[1] != PPP_UI || skb->len < 3)
 801                         goto err;
 802                 p = skb_pull(skb, 2);
 803         }
 804         proto = p[0];
 805         if (proto & 1) {
 806                 /* protocol is compressed */
 807                 skb_push(skb, 1)[0] = 0;
 808         } else {
 809                 if (skb->len < 2)
 810                         goto err;
 811                 proto = (proto << 8) + p[1];
 812                 if (proto == PPP_LCP)
 813                         async_lcp_peek(ap, p, skb->len, 1);
 814         }
 815
 816         /* queue the frame to be processed */
 817         skb->cb[0] = ap->state;
 818         skb_queue_tail(&ap->rqueue, skb);
 819         ap->rpkt = NULL;
 820         ap->state = 0;
 821         return;
 822
 823  err:
 824         /* frame had an error, remember that, reset SC_TOSS & SC_ESCAPE */
 825         ap->state = SC_PREV_ERROR;
 826         if (skb) {
 827                 /* make skb appear as freshly allocated */
 828                 skb_trim(skb, 0);
 829                 skb_reserve(skb, - skb_headroom(skb));
 830         }
 831 }
 832
 833 /* Called when the tty driver has data for us. Runs parallel with the
 834    other ldisc functions but will not be re-entered */
 835
 836 static void
 837 ppp_async_input(struct asyncppp *ap, const unsigned char *buf,
 838                 char *flags, int count)
 839 {
 840         struct sk_buff *skb;
 841         int c, i, j, n, s, f;
 842         unsigned char *sp;
 843
 844         /* update bits used for 8-bit cleanness detection */
 845         if (~ap->rbits & SC_RCV_BITS) {
 846                 s = 0;
 847                 for (i = 0; i < count; ++i) {
 848                         c = buf[i];
 849                         if (flags && flags[i] != 0)
 850                                 continue;
 851                         s |= (c & 0x80)? SC_RCV_B7_1: SC_RCV_B7_0;
 852                         c = ((c >> 4) ^ c) & 0xf;
 853                         s |= (0x6996 & (1 << c))? SC_RCV_ODDP: SC_RCV_EVNP;
 854                 }
 855                 ap->rbits |= s;
 856         }
 857
 858         while (count > 0) {
 859                 /* scan through and see how many chars we can do in bulk */
 860                 if ((ap->state & SC_ESCAPE) && buf[0] == PPP_ESCAPE)
 861                         n = 1;
 862                 else
 863                         n = scan_ordinary(ap, buf, count);
 864
 865                 f = 0;
 866                 if (flags && (ap->state & SC_TOSS) == 0) {
 867                         /* check the flags to see if any char had an error */
 868                         for (j = 0; j < n; ++j)
 869                                 if ((f = flags[j]) != 0)
 870                                         break;
 871                 }
 872                 if (f != 0) {
 873                         /* start tossing */
 874                         ap->state |= SC_TOSS;
 875
 876                 } else if (n > 0 && (ap->state & SC_TOSS) == 0) {
 877                         /* stuff the chars in the skb */
 878                         skb = ap->rpkt;
 879                         if (!skb) {
 880                                 skb = dev_alloc_skb(ap->mru + PPP_HDRLEN + 2);
 881                                 if (!skb)
 882                                         goto nomem;
 883                                 ap->rpkt = skb;
 884                         }
 885                         if (skb->len == 0) {
 886                                 /* Try to get the payload 4-byte aligned.
 887                                  * This should match the
 888                                  * PPP_ALLSTATIONS/PPP_UI/compressed tests in
 889                                  * process_input_packet, but we do not have
 890                                  * enough chars here to test buf[1] and buf[2].
 891                                  */
 892                                 if (buf[0] != PPP_ALLSTATIONS)
 893                                         skb_reserve(skb, 2 + (buf[0] & 1));
 894                         }
 895                         if (n > skb_tailroom(skb)) {
 896                                 /* packet overflowed MRU */
 897                                 ap->state |= SC_TOSS;
 898                         } else {
 899                                 sp = skb_put(skb, n);
 900                                 memcpy(sp, buf, n);
 901                                 if (ap->state & SC_ESCAPE) {
 902                                         sp[0] ^= 0x20;
 903                                         ap->state &= ~SC_ESCAPE;
 904                                 }
 905                         }
 906                 }
 907
 908                 if (n >= count)
 909                         break;
 910
 911                 c = buf[n];
 912                 if (flags != NULL && flags[n] != 0) {
 913                         ap->state |= SC_TOSS;
 914                 } else if (c == PPP_FLAG) {
 915                         process_input_packet(ap);
 916                 } else if (c == PPP_ESCAPE) {
 917                         ap->state |= SC_ESCAPE;
 918                 } else if (I_IXON(ap->tty)) {
 919                         if (c == START_CHAR(ap->tty))
 920                                 start_tty(ap->tty);
 921                         else if (c == STOP_CHAR(ap->tty))
 922                                 stop_tty(ap->tty);
 923                 }
 924                 /* otherwise it's a char in the recv ACCM */
 925                 ++n;
 926
 927                 buf += n;
 928                 if (flags)
 929                         flags += n;
 930                 count -= n;
 931         }
 932         return;
 933
 934  nomem:
 935         printk(KERN_ERR "PPPasync: no memory (input pkt)\n");
 936         ap->state |= SC_TOSS;
 937 }
 938
 939 /*
 940  * We look at LCP frames going past so that we can notice
 941  * and react to the LCP configure-ack from the peer.
 942  * In the situation where the peer has been sent a configure-ack
 943  * already, LCP is up once it has sent its configure-ack
 944  * so the immediately following packet can be sent with the
 945  * configured LCP options.  This allows us to process the following
 946  * packet correctly without pppd needing to respond quickly.
 947  *
 948  * We only respond to the received configure-ack if we have just
 949  * sent a configure-request, and the configure-ack contains the
 950  * same data (this is checked using a 16-bit crc of the data).
 951  */
 952 #define CONFREQ         1       /* LCP code field values */
 953 #define CONFACK         2
 954 #define LCP_MRU         1       /* LCP option numbers */
 955 #define LCP_ASYNCMAP    2
 956
 957 static void async_lcp_peek(struct asyncppp *ap, unsigned char *data,
 958                            int len, int inbound)
 959 {
 960         int dlen, fcs, i, code;
 961         u32 val;
 962
 963         data += 2;              /* skip protocol bytes */
 964         len -= 2;
 965         if (len < 4)            /* 4 = code, ID, length */
 966                 return;
 967         code = data[0];
 968         if (code != CONFACK && code != CONFREQ)
 969                 return;
 970         dlen = (data[2] << 8) + data[3];
 971         if (len < dlen)
 972                 return;         /* packet got truncated or length is bogus */
 973
 974         if (code == (inbound? CONFACK: CONFREQ)) {
 975                 /*
 976                  * sent confreq or received confack:
 977                  * calculate the crc of the data from the ID field on.
 978                  */
 979                 fcs = PPP_INITFCS;
 980                 for (i = 1; i < dlen; ++i)
 981                         fcs = PPP_FCS(fcs, data[i]);
 982
 983                 if (!inbound) {
 984                         /* outbound confreq - remember the crc for later */
 985                         ap->lcp_fcs = fcs;
 986                         return;
 987                 }
 988
 989                 /* received confack, check the crc */
 990                 fcs ^= ap->lcp_fcs;
 991                 ap->lcp_fcs = -1;
 992                 if (fcs != 0)
 993                         return;
 994         } else if (inbound)
 995                 return; /* not interested in received confreq */
 996
 997         /* process the options in the confack */
 998         data += 4;
 999         dlen -= 4;
1000         /* data[0] is code, data[1] is length */
1001         while (dlen >= 2 && dlen >= data[1] && data[1] >= 2) {
1002                 switch (data[0]) {
1003                 case LCP_MRU:
1004                         val = (data[2] << 8) + data[3];
1005                         if (inbound)
1006                                 ap->mru = val;
1007                         else
1008                                 ap->chan.mtu = val;
1009                         break;
1010                 case LCP_ASYNCMAP:
1011                         val = (data[2] << 24) + (data[3] << 16)
1012                                 + (data[4] << 8) + data[5];
1013                         if (inbound)
1014                                 ap->raccm = val;
1015                         else
1016                                 ap->xaccm[0] = val;
1017                         break;
1018                 }
1019                 dlen -= data[1];
1020                 data += data[1];
1021         }
1022 }
1023
1024 static void __exit ppp_async_cleanup(void)
1025 {
1026         if (tty_unregister_ldisc(N_PPP) != 0)
1027                 printk(KERN_ERR "failed to unregister PPP line discipline\n");
1028 }
1029
1030 module_init(ppp_async_init);
1031 module_exit(ppp_async_cleanup);