release/src/router/ppp/include/net/ppp_defs.h

   1 /*      $Id: ppp_defs.h,v 1.1.1.4 2003/10/14 08:09:53 sparq 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 #ifndef _PPP_DEFS_H_
  31 #define _PPP_DEFS_H_
  32
  33 /*
  34  * The basic PPP frame.
  35  */
  36 #define PPP_HDRLEN      4       /* octets for standard ppp header */
  37 #define PPP_FCSLEN      2       /* octets for FCS */
  38
  39 #define PPP_MTU         1500    /* Default MTU (size of Info field) */
  40 #define PPP_MAXMTU      65535 - (PPP_HDRLEN + PPP_FCSLEN)
  41 #define PPP_MINMTU      64
  42 #define PPP_MRU         1500    /* default MRU = max length of info field */
  43 #define PPP_MAXMRU      65000   /* Largest MRU we allow */
  44 #define PPP_MINMRU      128
  45
  46 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
  47 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
  48 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
  49
  50 /*
  51  * Significant octet values.
  52  */
  53 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
  54 #define PPP_UI          0x03    /* Unnumbered Information */
  55 #define PPP_FLAG        0x7e    /* Flag Sequence */
  56 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
  57 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
  58
  59 /*
  60  * Protocol field values.
  61  */
  62 #define PPP_IP          0x21    /* Internet Protocol */
  63 #define PPP_AT          0x29    /* AppleTalk Protocol */
  64 #define PPP_IPX         0x2b    /* IPX protocol */
  65 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
  66 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
  67 #define PPP_IPV6        0x57    /* Internet Protocol Version 6 */
  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_IPXCP       0x802b  /* IPX Control Protocol */
  72 #define PPP_IPV6CP      0x8057  /* IPv6 Control Protocol */
  73 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
  74 #define PPP_LCP         0xc021  /* Link Control Protocol */
  75 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
  76 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
  77 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
  78 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
  79
  80 /*
  81  * Values for FCS calculations.
  82  */
  83 #define PPP_INITFCS     0xffff  /* Initial FCS value */
  84 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
  85 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
  86
  87 /*
  88  * A 32-bit unsigned integral type.
  89  */
  90
  91 #if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES) \
  92  && !defined(__FreeBSD__) && (NS_TARGET < 40)
  93 #ifdef  UINT32_T
  94 typedef UINT32_T        u_int32_t;
  95 #else
  96 typedef unsigned int    u_int32_t;
  97 typedef unsigned short  u_int16_t;
  98 #endif
  99 #endif
 100
 101 /*
 102  * Extended asyncmap - allows any character to be escaped.
 103  */
 104 typedef u_int32_t       ext_accm[8];
 105
 106 /*
 107  * What to do with network protocol (NP) packets.
 108  */
 109 enum NPmode {
 110     NPMODE_PASS,                /* pass the packet through */
 111     NPMODE_DROP,                /* silently drop the packet */
 112     NPMODE_ERROR,               /* return an error */
 113     NPMODE_QUEUE                /* save it up for later. */
 114 };
 115
 116 /*
 117  * Statistics.
 118  */
 119 struct pppstat  {
 120     unsigned int ppp_ibytes;    /* bytes received */
 121     unsigned int ppp_ipackets;  /* packets received */
 122     unsigned int ppp_ierrors;   /* receive errors */
 123     unsigned int ppp_obytes;    /* bytes sent */
 124     unsigned int ppp_opackets;  /* packets sent */
 125     unsigned int ppp_oerrors;   /* transmit errors */
 126 };
 127
 128 struct vjstat {
 129     unsigned int vjs_packets;   /* outbound packets */
 130     unsigned int vjs_compressed; /* outbound compressed packets */
 131     unsigned int vjs_searches;  /* searches for connection state */
 132     unsigned int vjs_misses;    /* times couldn't find conn. state */
 133     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
 134     unsigned int vjs_compressedin; /* inbound compressed packets */
 135     unsigned int vjs_errorin;   /* inbound unknown type packets */
 136     unsigned int vjs_tossed;    /* inbound packets tossed because of error */
 137 };
 138
 139 struct ppp_stats {
 140     struct pppstat p;           /* basic PPP statistics */
 141     struct vjstat vj;           /* VJ header compression statistics */
 142 };
 143
 144 struct compstat {
 145     unsigned int unc_bytes;     /* total uncompressed bytes */
 146     unsigned int unc_packets;   /* total uncompressed packets */
 147     unsigned int comp_bytes;    /* compressed bytes */
 148     unsigned int comp_packets;  /* compressed packets */
 149     unsigned int inc_bytes;     /* incompressible bytes */
 150     unsigned int inc_packets;   /* incompressible packets */
 151     unsigned int ratio;         /* recent compression ratio << 8 */
 152 };
 153
 154 struct ppp_comp_stats {
 155     struct compstat c;          /* packet compression statistics */
 156     struct compstat d;          /* packet decompression statistics */
 157 };
 158
 159 /*
 160  * The following structure records the time in seconds since
 161  * the last NP packet was sent or received.
 162  */
 163 struct ppp_idle {
 164     time_t xmit_idle;           /* time since last NP packet sent */
 165     time_t recv_idle;           /* time since last NP packet received */
 166 };
 167
 168 #ifndef __P
 169 #ifdef __STDC__
 170 #define __P(x)  x
 171 #else
 172 #define __P(x)  ()
 173 #endif
 174 #endif
 175
 176 #endif /* _PPP_DEFS_H_ */