bsd/net/ppp_defs.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * ppp_defs.h - PPP definitions.
  27  *
  28  * Copyright (c) 1994 The Australian National University.
  29  * All rights reserved.
  30  *
  31  * Permission to use, copy, modify, and distribute this software and its
  32  * documentation is hereby granted, provided that the above copyright
  33  * notice appears in all copies.  This software is provided without any
  34  * warranty, express or implied. The Australian National University
  35  * makes no representations about the suitability of this software for
  36  * any purpose.
  37  *
  38  * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
  39  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  40  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
  41  * THE AUSTRALIAN NATIONAL UNIVERSITY HAVE BEEN ADVISED OF THE POSSIBILITY
  42  * OF SUCH DAMAGE.
  43  *
  44  * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  45  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  46  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  47  * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
  48  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
  49  * OR MODIFICATIONS.
  50  *
  51  */
  52
  53 #ifndef _PPP_DEFS_H_
  54 #define _PPP_DEFS_H_
  55 #include <sys/appleapiopts.h>
  56
  57 /*
  58  * The basic PPP frame.
  59  */
  60 #define PPP_HDRLEN      4       /* octets for standard ppp header */
  61 #define PPP_FCSLEN      2       /* octets for FCS */
  62 #define PPP_MRU         1500    /* default MRU = max length of info field */
  63
  64 #define PPP_ADDRESS(p)  (((u_char *)(p))[0])
  65 #define PPP_CONTROL(p)  (((u_char *)(p))[1])
  66 #define PPP_PROTOCOL(p) ((((u_char *)(p))[2] << 8) + ((u_char *)(p))[3])
  67
  68 /*
  69  * Significant octet values.
  70  */
  71 #define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
  72 #define PPP_UI          0x03    /* Unnumbered Information */
  73 #define PPP_FLAG        0x7e    /* Flag Sequence */
  74 #define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
  75 #define PPP_TRANS       0x20    /* Asynchronous transparency modifier */
  76
  77 /*
  78  * Protocol field values.
  79  */
  80 #define PPP_IP          0x21    /* Internet Protocol */
  81 #define PPP_XNS         0x25    /* Xerox NS */
  82 #define PPP_AT          0x29    /* AppleTalk Protocol */
  83 #define PPP_IPX         0x2b    /* IPX Datagram (RFC1552) */
  84 #define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
  85 #define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
  86 #define PPP_COMP        0xfd    /* compressed packet */
  87 #define PPP_IPCP        0x8021  /* IP Control Protocol */
  88 #define PPP_ATCP        0x8029  /* AppleTalk Control Protocol */
  89 #define PPP_IPXCP       0x802b  /* IPX Control Protocol (RFC1552) */
  90 #define PPP_CCP         0x80fd  /* Compression Control Protocol */
  91 #define PPP_LCP         0xc021  /* Link Control Protocol */
  92 #define PPP_PAP         0xc023  /* Password Authentication Protocol */
  93 #define PPP_LQR         0xc025  /* Link Quality Report protocol */
  94 #define PPP_CHAP        0xc223  /* Cryptographic Handshake Auth. Protocol */
  95 #define PPP_CBCP        0xc029  /* Callback Control Protocol */
  96 #define PPP_IPV6        0x57    /* Internet Protocol version 6*/
  97 #define PPP_IPV6CP      0x8057  /* IPv6 Control Protocol */
  98
  99 /*
 100  * Values for FCS calculations.
 101  */
 102 #define PPP_INITFCS     0xffff  /* Initial FCS value */
 103 #define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
 104 #define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
 105
 106 /*
 107  * Extended asyncmap - allows any character to be escaped.
 108  */
 109 typedef u_int32_t       ext_accm[8];
 110
 111 /*
 112  * What to do with network protocol (NP) packets.
 113  */
 114 enum NPmode {
 115     NPMODE_PASS,                /* pass the packet through */
 116     NPMODE_DROP,                /* silently drop the packet */
 117     NPMODE_ERROR,               /* return an error */
 118     NPMODE_QUEUE                /* save it up for later. */
 119 };
 120
 121 /*
 122  * Statistics.
 123  */
 124 struct pppstat  {
 125     unsigned int ppp_ibytes;    /* bytes received */
 126     unsigned int ppp_ipackets;  /* packets received */
 127     unsigned int ppp_ierrors;   /* receive errors */
 128     unsigned int ppp_obytes;    /* bytes sent */
 129     unsigned int ppp_opackets;  /* packets sent */
 130     unsigned int ppp_oerrors;   /* transmit errors */
 131 };
 132
 133 struct vjstat {
 134     unsigned int vjs_packets;   /* outbound packets */
 135     unsigned int vjs_compressed; /* outbound compressed packets */
 136     unsigned int vjs_searches;  /* searches for connection state */
 137     unsigned int vjs_misses;    /* times couldn't find conn. state */
 138     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
 139     unsigned int vjs_compressedin; /* inbound compressed packets */
 140     unsigned int vjs_errorin;   /* inbound unknown type packets */
 141     unsigned int vjs_tossed;    /* inbound packets tossed because of error */
 142 };
 143
 144 struct ppp_stats {
 145     struct pppstat p;           /* basic PPP statistics */
 146     struct vjstat vj;           /* VJ header compression statistics */
 147 };
 148
 149 struct compstat {
 150     unsigned int unc_bytes;     /* total uncompressed bytes */
 151     unsigned int unc_packets;   /* total uncompressed packets */
 152     unsigned int comp_bytes;    /* compressed bytes */
 153     unsigned int comp_packets;  /* compressed packets */
 154     unsigned int inc_bytes;     /* incompressible bytes */
 155     unsigned int inc_packets;   /* incompressible packets */
 156     unsigned int ratio;         /* recent compression ratio << 8 */
 157 };
 158
 159 struct ppp_comp_stats {
 160     struct compstat c;          /* packet compression statistics */
 161     struct compstat d;          /* packet decompression statistics */
 162 };
 163
 164 /*
 165  * The following structure records the time in seconds since
 166  * the last NP packet was sent or received.
 167  */
 168 struct ppp_idle {
 169     time_t xmit_idle;           /* time since last NP packet sent */
 170     time_t recv_idle;           /* time since last NP packet received */
 171 };
 172
 173 #ifndef __P
 174 #ifdef __STDC__
 175 #define __P(x)  x
 176 #else
 177 #define __P(x)  ()
 178 #endif
 179 #endif
 180
 181 #endif /* _PPP_DEFS_H_ */