sys/net/ppp_defs.h

   1 /*
   2  * ppp_defs.h - PPP definitions.
   3  */
   4 /*-
   5  * Copyright (c) 1994 The Australian National University.
   6  * All rights reserved.
   7  *
   8  * Permission to use, copy, modify, and distribute this software and its
   9  * documentation is hereby granted, provided that the above copyright
  10  * notice appears in all copies.  This software is provided without any
  11  * warranty, express or implied. The Australian National University
  12  * makes no representations about the suitability of this software for
  13  * any purpose.
  14  *
  15  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
  16  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  17  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
  18  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
  19  * OF SUCH DAMAGE.
  20  *
  21  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  22  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  23  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  24  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
  25  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
  26  * OR MODIFICATIONS.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _PPP_DEFS_H_
  32 #define _PPP_DEFS_H_
  33
  34 #include <sys/_types.h>
  35
  36 /*
  37  * The basic PPP frame.
  38  */
  39 #define PPP_HDRLEN      4       /* octets for standard ppp header */
  40 #define PPP_FCSLEN      2       /* octets for FCS */
  41 #define PPP_MRU         1500    /* default MRU = max length of info field */
  42
  43 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
  44 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
  45 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
  46
  47 /*
  48  * Significant octet values.
  49  */
  50 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
  51 #define PPP_UI          0x03    /* Unnumbered Information */
  52 #define PPP_FLAG        0x7e    /* Flag Sequence */
  53 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
  54 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
  55
  56 /*
  57  * Protocol field values.
  58  */
  59 #define PPP_IP          0x21    /* Internet Protocol */
  60 #define PPP_XNS         0x25    /* Xerox NS */
  61 #define PPP_AT          0x29    /* AppleTalk Protocol */
  62 #define PPP_IPX         0x2b    /* IPX Datagram (RFC1552) */
  63 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
  64 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
  65 #define PPP_COMP        0xfd    /* compressed packet */
  66 #define PPP_IPCP        0x8021  /* IP Control Protocol */
  67 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
  68 #define PPP_IPXCP       0x802b  /* IPX Control Protocol (RFC1552) */
  69 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
  70 #define PPP_LCP         0xc021  /* Link Control Protocol */
  71 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
  72 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
  73 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
  74 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
  75 #define PPP_IPV6        0x57    /* Internet Protocol version 6*/
  76 #define PPP_IPV6CP      0x8057  /* IPv6 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 __uint32_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_ */