include/net/ppp_defs.h

   1 /*      $Id: ppp_defs.h,v 1.1 1994/09/19 04:18:43 paulus Exp $  */
   2
   3 /*
   4  * ppp_defs.h - PPP definitions.
   5  *
   6  * Copyright (c) 1994 The Australian National University.
   7  * All rights reserved.
   8  *
   9  * Permission to use, copy, modify, and distribute this software and its
  10  * documentation is hereby granted, provided that the above copyright
  11  * notice appears in all copies.  This software is provided without any
  12  * warranty, express or implied. The Australian National University
  13  * makes no representations about the suitability of this software for
  14  * any purpose.
  15  *
  16  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
  17  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  18  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
  19  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
  20  * OF SUCH DAMAGE.
  21  *
  22  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  23  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  24  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  25  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
  26  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
  27  * OR MODIFICATIONS.
  28  */
  29
  30 /*
  31  * The basic PPP frame.
  32  */
  33 #define PPP_HDRLEN      4       /* octets for standard ppp header */
  34 #define PPP_FCSLEN      2       /* octets for FCS */
  35 #define PPP_MRU         1500    /* default MRU = max length of info field */
  36
  37 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
  38 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
  39 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
  40
  41 /*
  42  * Significant octet values.
  43  */
  44 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
  45 #define PPP_UI          0x03    /* Unnumbered Information */
  46 #define PPP_FLAG        0x7e    /* Flag Sequence */
  47 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
  48 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
  49
  50 /*
  51  * Protocol field values.
  52  */
  53 #define PPP_IP          0x21    /* Internet Protocol */
  54 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
  55 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
  56 #define PPP_COMP        0xfd    /* compressed packet */
  57 #define PPP_LCP         0xc021  /* Link Control Protocol */
  58 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
  59
  60 /*
  61  * Values for FCS calculations.
  62  */
  63 #define PPP_INITFCS     0xffff  /* Initial FCS value */
  64 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
  65 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
  66
  67 /*
  68  * A 32-bit unsigned integral type.
  69  */
  70 #ifndef __BIT_TYPES_DEFINED__
  71 #ifdef  UINT32_T
  72 typedef UINT32_T        u_int32_t;
  73 #else
  74 typedef unsigned long   u_int32_t;
  75 #endif
  76 #endif
  77
  78 /*
  79  * Extended asyncmap - allows any character to be escaped.
  80  */
  81 typedef u_int32_t       ext_accm[8];
  82
  83 /*
  84  * What to do with network protocol (NP) packets.
  85  */
  86 enum NPmode {
  87     NPMODE_PASS,                /* pass the packet through */
  88     NPMODE_DROP,                /* silently drop the packet */
  89     NPMODE_ERROR,               /* return an error */
  90     NPMODE_QUEUE                /* save it up for later. */
  91 };
  92
  93 /*
  94  * Statistics.
  95  */
  96 struct pppstat  {
  97     u_int       ppp_ibytes;     /* bytes received */
  98     u_int       ppp_ipackets;   /* packets received */
  99     u_int       ppp_ierrors;    /* receive errors */
 100     u_int       ppp_obytes;     /* bytes sent */
 101     u_int       ppp_opackets;   /* packets sent */
 102     u_int       ppp_oerrors;    /* transmit errors */
 103 };
 104
 105 struct vjstat {
 106     u_int       vjs_packets;    /* outbound packets */
 107     u_int       vjs_compressed; /* outbound compressed packets */
 108     u_int       vjs_searches;   /* searches for connection state */
 109     u_int       vjs_misses;     /* times couldn't find conn. state */
 110     u_int       vjs_uncompressedin; /* inbound uncompressed packets */
 111     u_int       vjs_compressedin;   /* inbound compressed packets */
 112     u_int       vjs_errorin;    /* inbound unknown type packets */
 113     u_int       vjs_tossed;     /* inbound packets tossed because of error */
 114 };
 115
 116 struct compstat {
 117     u_int       unc_bytes;      /* total uncompressed bytes */
 118     u_int       unc_packets;    /* total uncompressed packets */
 119     u_int       comp_bytes;     /* compressed bytes */
 120     u_int       comp_packets;   /* compressed packets */
 121     u_int       inc_bytes;      /* incompressible bytes */
 122     u_int       inc_packets;    /* incompressible packets */
 123     double      ratio;          /* recent compression ratio */
 124 };
 125
 126 struct ppp_stats {
 127     struct pppstat      p;      /* basic PPP statistics */
 128     struct vjstat       vj;     /* VJ header compression statistics */
 129     struct compstat     c;      /* packet compression statistics */
 130     struct compstat     d;      /* packet decompression statistics */
 131 };
 132
 133 #ifndef __P
 134 #ifdef __STDC__
 135 #define __P(x)  x
 136 #else
 137 #define __P(x)  ()
 138 #endif
 139 #endif