pppd/include/net/ppp_defs.h

   1 /*      $Id: ppp_defs.h,v 1.17 2002/12/06 09:49:15 paulus Exp $ */
   2
   3 /*
   4  * ppp_defs.h - PPP definitions.
   5  *
   6  * Copyright (c) 1984 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 #if defined(PPP_ADDRESS)
  42 #define USING_UAPI
  43 #endif
  44
  45 /*
  46  * The basic PPP frame.
  47  */
  48 #define PPP_HDRLEN      4       /* octets for standard ppp header */
  49 #define PPP_FCSLEN      2       /* octets for FCS */
  50
  51 /*
  52  * Packet sizes
  53  *
  54  * Note - lcp shouldn't be allowed to negotiate stuff outside these
  55  *        limits.  See lcp.h in the pppd directory.
  56  * (XXX - these constants should simply be shared by lcp.c instead
  57  *        of living in lcp.h)
  58  */
  59 #define PPP_MTU         1500    /* Default MTU (size of Info field) */
  60 #define PPP_MAXMTU      65535 - (PPP_HDRLEN + PPP_FCSLEN)
  61 #define PPP_MINMTU      64
  62 #define PPP_MRU         1500    /* default MRU = max length of info field */
  63 #define PPP_MAXMRU      65000   /* Largest MRU we allow */
  64 #define PPP_MINMRU      128
  65
  66 #if !defined(USING_UAPI)
  67 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
  68 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
  69 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
  70 #endif
  71
  72 /*
  73  * Significant octet values.
  74  */
  75 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
  76 #define PPP_UI          0x03    /* Unnumbered Information */
  77 #define PPP_FLAG        0x7e    /* Flag Sequence */
  78 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
  79 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
  80
  81 /*
  82  * Protocol field values.
  83  */
  84 #define PPP_IP          0x21    /* Internet Protocol */
  85 #define PPP_AT          0x29    /* AppleTalk Protocol */
  86 #define PPP_IPX         0x2b    /* IPX protocol */
  87 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
  88 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
  89 #define PPP_IPV6        0x57    /* Internet Protocol Version 6 */
  90 #define PPP_COMP        0xfd    /* compressed packet */
  91 #define PPP_IPCP        0x8021  /* IP Control Protocol */
  92 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
  93 #define PPP_IPXCP       0x802b  /* IPX Control Protocol */
  94 #define PPP_IPV6CP      0x8057  /* IPv6 Control Protocol */
  95 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
  96 #define PPP_ECP         0x8053  /* Encryption Control Protocol */
  97 #define PPP_LCP         0xc021  /* Link Control Protocol */
  98 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
  99 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
 100 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
 101 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
 102 #define PPP_EAP         0xc227  /* Extensible Authentication Protocol */
 103
 104 /*
 105  * Values for FCS calculations.
 106  */
 107 #define PPP_INITFCS     0xffff  /* Initial FCS value */
 108 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
 109 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
 110
 111 /*
 112  * A 32-bit unsigned integral type.
 113  */
 114
 115 #if !defined(__BIT_TYPES_DEFINED__) && !defined(_BITYPES) \
 116  && !defined(__FreeBSD__) && (NS_TARGET < 40)
 117 #ifdef  UINT32_T
 118 typedef UINT32_T        u_int32_t;
 119 #else
 120 typedef unsigned int    u_int32_t;
 121 typedef unsigned short  u_int16_t;
 122 #endif
 123 #endif
 124
 125 /*
 126  * Extended asyncmap - allows any character to be escaped.
 127  */
 128 typedef u_int32_t       ext_accm[8];
 129
 130 /*
 131  * What to do with network protocol (NP) packets.
 132  */
 133 #if defined(USING_UAPI)
 134 /* This stuff isn't in uapi. TODO: is there a newer pppd that doesn't use this? */
 135 #define ifr__name b.ifr_ifrn.ifrn_name
 136 #define stats_ptr b.ifr_ifru.ifru_data
 137 struct ifpppstatsreq {
 138    struct ifreq b;
 139    struct ppp_stats stats;
 140 };
 141 #else
 142 enum NPmode {
 143     NPMODE_PASS,                /* pass the packet through */
 144     NPMODE_DROP,                /* silently drop the packet */
 145     NPMODE_ERROR,               /* return an error */
 146     NPMODE_QUEUE                /* save it up for later. */
 147 };
 148
 149 /*
 150  * Statistics.
 151  */
 152 struct pppstat  {
 153     unsigned int ppp_ibytes;    /* bytes received */
 154     unsigned int ppp_ipackets;  /* packets received */
 155     unsigned int ppp_ierrors;   /* receive errors */
 156     unsigned int ppp_obytes;    /* bytes sent */
 157     unsigned int ppp_opackets;  /* packets sent */
 158     unsigned int ppp_oerrors;   /* transmit errors */
 159 };
 160
 161 struct vjstat {
 162     unsigned int vjs_packets;   /* outbound packets */
 163     unsigned int vjs_compressed; /* outbound compressed packets */
 164     unsigned int vjs_searches;  /* searches for connection state */
 165     unsigned int vjs_misses;    /* times couldn't find conn. state */
 166     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
 167     unsigned int vjs_compressedin; /* inbound compressed packets */
 168     unsigned int vjs_errorin;   /* inbound unknown type packets */
 169     unsigned int vjs_tossed;    /* inbound packets tossed because of error */
 170 };
 171
 172 struct ppp_stats {
 173     struct pppstat p;           /* basic PPP statistics */
 174     struct vjstat vj;           /* VJ header compression statistics */
 175 };
 176
 177 struct compstat {
 178     unsigned int unc_bytes;     /* total uncompressed bytes */
 179     unsigned int unc_packets;   /* total uncompressed packets */
 180     unsigned int comp_bytes;    /* compressed bytes */
 181     unsigned int comp_packets;  /* compressed packets */
 182     unsigned int inc_bytes;     /* incompressible bytes */
 183     unsigned int inc_packets;   /* incompressible packets */
 184     unsigned int ratio;         /* recent compression ratio << 8 */
 185 };
 186
 187 struct ppp_comp_stats {
 188     struct compstat c;          /* packet compression statistics */
 189     struct compstat d;          /* packet decompression statistics */
 190 };
 191
 192 /*
 193  * The following structure records the time in seconds since
 194  * the last NP packet was sent or received.
 195  */
 196 struct ppp_idle {
 197     time_t xmit_idle;           /* time since last NP packet sent */
 198     time_t recv_idle;           /* time since last NP packet received */
 199 };
 200
 201 #endif
 202
 203 #ifndef __P
 204 #ifdef __STDC__
 205 #define __P(x)  x
 206 #else
 207 #define __P(x)  ()
 208 #endif
 209 #endif
 210
 211 #endif /* _PPP_DEFS_H_ */