freebsd-2.0/ppp_defs.h

   1 /*      $Id: ppp_defs.h,v 1.3 2002/12/06 09:49:15 paulus Exp $  */
   2
   3 /*
   4  * ppp_defs.h - PPP definitions.
   5  *
   6  * Copyright (c) 1989-2002 Paul Mackerras. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. The name(s) of the authors of this software must not be used to
  21  *    endorse or promote products derived from this software without
  22  *    prior written permission.
  23  *
  24  * 4. Redistributions of any form whatsoever must retain the following
  25  *    acknowledgment:
  26  *    "This product includes software developed by Paul Mackerras
  27  *     <paulus@samba.org>".
  28  *
  29  * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
  30  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  31  * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  32  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  33  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  34  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  35  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  36  */
  37
  38 #ifndef _PPP_DEFS_H_
  39 #define _PPP_DEFS_H_
  40
  41 /*
  42  * The basic PPP frame.
  43  */
  44 #define PPP_HDRLEN      4       /* octets for standard ppp header */
  45 #define PPP_FCSLEN      2       /* octets for FCS */
  46 #define PPP_MRU         1500    /* default MRU = max length of info field */
  47
  48 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
  49 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
  50 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
  51
  52 /*
  53  * Significant octet values.
  54  */
  55 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
  56 #define PPP_UI          0x03    /* Unnumbered Information */
  57 #define PPP_FLAG        0x7e    /* Flag Sequence */
  58 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
  59 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
  60
  61 /*
  62  * Protocol field values.
  63  */
  64 #define PPP_IP          0x21    /* Internet Protocol */
  65 #define PPP_AT          0x29    /* AppleTalk Protocol */
  66 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
  67 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
  68 #define PPP_COMP        0xfd    /* compressed packet */
  69 #define PPP_IPCP        0x8021  /* IP Control Protocol */
  70 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
  71 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
  72 #define PPP_LCP         0xc021  /* Link Control Protocol */
  73 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
  74 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
  75 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
  76 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
  77
  78 /*
  79  * Values for FCS calculations.
  80  */
  81 #define PPP_INITFCS     0xffff  /* Initial FCS value */
  82 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
  83 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
  84
  85 /*
  86  * Extended asyncmap - allows any character to be escaped.
  87  */
  88 typedef u_int32_t       ext_accm[8];
  89
  90 /*
  91  * What to do with network protocol (NP) packets.
  92  */
  93 enum NPmode {
  94     NPMODE_PASS,                /* pass the packet through */
  95     NPMODE_DROP,                /* silently drop the packet */
  96     NPMODE_ERROR,               /* return an error */
  97     NPMODE_QUEUE                /* save it up for later. */
  98 };
  99
 100 /*
 101  * Statistics.
 102  */
 103 struct pppstat  {
 104     unsigned int ppp_ibytes;    /* bytes received */
 105     unsigned int ppp_ipackets;  /* packets received */
 106     unsigned int ppp_ierrors;   /* receive errors */
 107     unsigned int ppp_obytes;    /* bytes sent */
 108     unsigned int ppp_opackets;  /* packets sent */
 109     unsigned int ppp_oerrors;   /* transmit errors */
 110 };
 111
 112 struct vjstat {
 113     unsigned int vjs_packets;   /* outbound packets */
 114     unsigned int vjs_compressed; /* outbound compressed packets */
 115     unsigned int vjs_searches;  /* searches for connection state */
 116     unsigned int vjs_misses;    /* times couldn't find conn. state */
 117     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
 118     unsigned int vjs_compressedin; /* inbound compressed packets */
 119     unsigned int vjs_errorin;   /* inbound unknown type packets */
 120     unsigned int vjs_tossed;    /* inbound packets tossed because of error */
 121 };
 122
 123 struct ppp_stats {
 124     struct pppstat p;           /* basic PPP statistics */
 125     struct vjstat vj;           /* VJ header compression statistics */
 126 };
 127
 128 struct compstat {
 129     unsigned int unc_bytes;     /* total uncompressed bytes */
 130     unsigned int unc_packets;   /* total uncompressed packets */
 131     unsigned int comp_bytes;    /* compressed bytes */
 132     unsigned int comp_packets;  /* compressed packets */
 133     unsigned int inc_bytes;     /* incompressible bytes */
 134     unsigned int inc_packets;   /* incompressible packets */
 135     unsigned int ratio;         /* recent compression ratio << 8 */
 136 };
 137
 138 struct ppp_comp_stats {
 139     struct compstat c;          /* packet compression statistics */
 140     struct compstat d;          /* packet decompression statistics */
 141 };
 142
 143 /*
 144  * The following structure records the time in seconds since
 145  * the last NP packet was sent or received.
 146  */
 147 struct ppp_idle {
 148     time_t xmit_idle;           /* time since last NP packet sent */
 149     time_t recv_idle;           /* time since last NP packet received */
 150 };
 151
 152 #ifndef __P
 153 #ifdef __STDC__
 154 #define __P(x)  x
 155 #else
 156 #define __P(x)  ()
 157 #endif
 158 #endif
 159
 160 #endif /* _PPP_DEFS_H_ */