bsd/net/ppp_defs.h

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