pppd/lcp.h

   1 /*
   2  * lcp.h - Link Control Protocol definitions.
   3  *
   4  * Copyright (c) 1984-2000 Carnegie Mellon University. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  * 3. The name "Carnegie Mellon University" must not be used to
  19  *    endorse or promote products derived from this software without
  20  *    prior written permission. For permission or any legal
  21  *    details, please contact
  22  *      Office of Technology Transfer
  23  *      Carnegie Mellon University
  24  *      5000 Forbes Avenue
  25  *      Pittsburgh, PA  15213-3890
  26  *      (412) 268-4387, fax: (412) 268-7395
  27  *      tech-transfer@andrew.cmu.edu
  28  *
  29  * 4. Redistributions of any form whatsoever must retain the following
  30  *    acknowledgment:
  31  *    "This product includes software developed by Computing Services
  32  *     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  33  *
  34  * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  35  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  36  * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  37  * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  38  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  39  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  40  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  41  */
  42 #ifndef PPP_LCP_H
  43 #define PPP_LCP_H
  44
  45 #include "pppdconf.h"
  46
  47 /*
  48  * Options.
  49  */
  50 #define CI_VENDOR       0       /* Vendor Specific */
  51 #define CI_MRU          1       /* Maximum Receive Unit */
  52 #define CI_ASYNCMAP     2       /* Async Control Character Map */
  53 #define CI_AUTHTYPE     3       /* Authentication Type */
  54 #define CI_QUALITY      4       /* Quality Protocol */
  55 #define CI_MAGICNUMBER  5       /* Magic Number */
  56 #define CI_PCOMPRESSION 7       /* Protocol Field Compression */
  57 #define CI_ACCOMPRESSION 8      /* Address/Control Field Compression */
  58 #define CI_FCSALTERN    9       /* FCS-Alternatives */
  59 #define CI_SDP          10      /* Self-Describing-Pad */
  60 #define CI_NUMBERED     11      /* Numbered-Mode */
  61 #define CI_CALLBACK     13      /* callback */
  62 #define CI_MRRU         17      /* max reconstructed receive unit; multilink */
  63 #define CI_SSNHF        18      /* short sequence numbers for multilink */
  64 #define CI_EPDISC       19      /* endpoint discriminator */
  65 #define CI_MPPLUS       22      /* Multi-Link-Plus-Procedure */
  66 #define CI_LDISC        23      /* Link-Discriminator */
  67 #define CI_LCPAUTH      24      /* LCP Authentication */
  68 #define CI_COBS         25      /* Consistent Overhead Byte Stuffing */
  69 #define CI_PREFELIS     26      /* Prefix Elision */
  70 #define CI_MPHDRFMT     27      /* MP Header Format */
  71 #define CI_I18N         28      /* Internationalization */
  72 #define CI_SDL          29      /* Simple Data Link */
  73
  74 /*
  75  * LCP-specific packet types (code numbers).
  76  */
  77 #define PROTREJ         8       /* Protocol Reject */
  78 #define ECHOREQ         9       /* Echo Request */
  79 #define ECHOREP         10      /* Echo Reply */
  80 #define DISCREQ         11      /* Discard Request */
  81 #define IDENTIF         12      /* Identification */
  82 #define TIMEREM         13      /* Time Remaining */
  83
  84 /* Value used as data for CI_CALLBACK option */
  85 #define CBCP_OPT        6       /* Use callback control protocol */
  86
  87 /* An endpoint discriminator, used with multilink. */
  88 #define MAX_ENDP_LEN    20      /* maximum length of discriminator value */
  89 struct epdisc {
  90     unsigned char       class;
  91     unsigned char       length;
  92     unsigned char       value[MAX_ENDP_LEN];
  93 };
  94
  95 /*
  96  * The state of options is described by an lcp_options structure.
  97  */
  98 typedef struct lcp_options {
  99     bool passive;               /* Don't die if we don't get a response */
 100     bool silent;                /* Wait for the other end to start first */
 101     bool restart;               /* Restart vs. exit after close */
 102     bool neg_mru;               /* Negotiate the MRU? */
 103     bool neg_asyncmap;          /* Negotiate the async map? */
 104     bool neg_upap;              /* Ask for UPAP authentication? */
 105     bool neg_chap;              /* Ask for CHAP authentication? */
 106     bool neg_eap;               /* Ask for EAP authentication? */
 107     bool neg_magicnumber;       /* Ask for magic number? */
 108     bool neg_pcompression;      /* HDLC Protocol Field Compression? */
 109     bool neg_accompression;     /* HDLC Address/Control Field Compression? */
 110     bool neg_lqr;               /* Negotiate use of Link Quality Reports */
 111     bool neg_cbcp;              /* Negotiate use of CBCP */
 112     bool neg_mrru;              /* negotiate multilink MRRU */
 113     bool neg_ssnhf;             /* negotiate short sequence numbers */
 114     bool neg_endpoint;          /* negotiate endpoint discriminator */
 115     int  mru;                   /* Value of MRU */
 116     int  mrru;                  /* Value of MRRU, and multilink enable */
 117     unsigned char chap_mdtype;          /* which MD types (hashing algorithm) */
 118     uint32_t asyncmap;          /* Value of async map */
 119     uint32_t magicnumber;
 120     int  numloops;              /* Number of loops during magic number neg. */
 121     uint32_t lqr_period;        /* Reporting period for LQR 1/100ths second */
 122     struct epdisc endpoint;     /* endpoint discriminator */
 123 } lcp_options;
 124
 125 extern fsm lcp_fsm[];
 126 extern lcp_options lcp_wantoptions[];
 127 extern lcp_options lcp_gotoptions[];
 128 extern lcp_options lcp_allowoptions[];
 129 extern lcp_options lcp_hisoptions[];
 130
 131 #define DEFMRU  1500            /* Try for this */
 132 #define MINMRU  128             /* No MRUs below this */
 133 #define MAXMRU  16384           /* Normally limit MRU to this */
 134
 135 void lcp_open(int);
 136 void lcp_close(int, char *);
 137 void lcp_lowerup(int);
 138 void lcp_lowerdown(int);
 139 void lcp_sprotrej(int, unsigned char *, int);   /* send protocol reject */
 140
 141 extern struct protent lcp_protent;
 142
 143 /* Default number of times we receive our magic number from the peer
 144    before deciding the link is looped-back. */
 145 #define DEFLOOPBACKFAIL 10
 146
 147 #endif