Home | History | Annotate | Line # | Download | only in net
      1 /*	$NetBSD: ppp_defs.h,v 1.15 2025/11/24 08:04:28 nia Exp $	*/
      2 /*	Id: ppp_defs.h,v 1.11 1997/04/30 05:46:24 paulus Exp 	*/
      3 
      4 /*
      5  * ppp_defs.h - PPP definitions.
      6  *
      7  * Copyright (c) 1989-2002 Paul Mackerras. All rights reserved.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  *
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  *
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in
     18  *    the documentation and/or other materials provided with the
     19  *    distribution.
     20  *
     21  * 3. The name(s) of the authors of this software must not be used to
     22  *    endorse or promote products derived from this software without
     23  *    prior written permission.
     24  *
     25  * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
     26  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
     27  * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
     28  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     29  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
     30  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
     31  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     32  */
     33 
     34 #ifndef _NET_PPP_DEFS_H_
     35 #define _NET_PPP_DEFS_H_
     36 
     37 /*
     38  * The basic PPP frame.
     39  */
     40 #define PPP_HDRLEN	4	/* octets for standard ppp header */
     41 #define PPP_FCSLEN	2	/* octets for FCS */
     42 
     43 /*
     44  * Packet sizes
     45  *
     46  * Note - lcp shouldn't be allowed to negotiate stuff outside these
     47  *	  limits.  See lcp.h in the pppd directory.
     48  * (XXX - these constants should simply be shared by lcp.c instead
     49  *	  of living in lcp.h)
     50  */
     51 #define	PPP_MTU		1500	/* Default MTU (size of Info field) */
     52 #define PPP_MAXMTU	65535 - (PPP_HDRLEN + PPP_FCSLEN)
     53 #define PPP_MINMTU	64
     54 #define PPP_MRU		1500	/* default MRU = max length of info field */
     55 #define PPP_MAXMRU	65000	/* Largest MRU we allow */
     56 #define PPP_MINMRU	128
     57 
     58 #define PPP_ADDRESS(p)	(((const u_char *)(p))[0])
     59 #define PPP_CONTROL(p)	(((const u_char *)(p))[1])
     60 #define PPP_PROTOCOL(p)	\
     61     ((((const u_char *)(p))[2] << 8) + ((const u_char *)(p))[3])
     62 
     63 /*
     64  * Significant octet values.
     65  */
     66 #define	PPP_ALLSTATIONS	0xff	/* All-Stations broadcast address */
     67 #define	PPP_UI		0x03	/* Unnumbered Information */
     68 #define	PPP_FLAG	0x7e	/* Flag Sequence */
     69 #define	PPP_ESCAPE	0x7d	/* Asynchronous Control Escape */
     70 #define	PPP_TRANS	0x20	/* Asynchronous transparency modifier */
     71 
     72 /*
     73  * Protocol field values.
     74  */
     75 #define PPP_IP		0x0021		/* Internet Protocol */
     76 #define PPP_ISO		0x0023		/* ISO OSI Protocol */
     77 #define PPP_XNS		0x0025		/* Xerox NS Protocol */
     78 #define PPP_AT		0x0029		/* AppleTalk Protocol */
     79 #define PPP_IPX		0x002b		/* IPX protocol */
     80 #define	PPP_VJC_COMP	0x002d		/* VJ compressed TCP */
     81 #define	PPP_VJC_UNCOMP	0x002f		/* VJ uncompressed TCP */
     82 #define PPP_MP		0x003d		/* Multilink PPP Fragment */
     83 #define PPP_IPV6	0x0057		/* Internet Protocol Version 6 */
     84 #define PPP_COMP	0x00fd		/* compressed packet */
     85 #define PPP_IPCP	0x8021		/* IP Control Protocol */
     86 #define PPP_ATCP	0x8029		/* AppleTalk Control Protocol */
     87 #define PPP_IPXCP	0x802b		/* IPX Control Protocol */
     88 #define PPP_IPV6CP	0x8057		/* IPv6 Control Protocol */
     89 #define PPP_CCP		0x80fd		/* Compression Control Protocol */
     90 #define PPP_ECP		0x8053		/* Encryption 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		/* Crypto Handshake Auth. Protocol */
     95 #define PPP_CBCP	0xc029		/* Callback Control Protocol */
     96 #define PPP_EAP		0xc227		/* Extensible Authentication Protocol */
     97 
     98 /*
     99  * Values for FCS calculations.
    100  */
    101 #define PPP_INITFCS	0xffff	/* Initial FCS value */
    102 #define PPP_GOODFCS	0xf0b8	/* Good final FCS value */
    103 #define PPP_FCS(fcs, c)	(((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])
    104 
    105 /*
    106  * Extended asyncmap - allows any character to be escaped.
    107  */
    108 typedef uint32_t	ext_accm[8];
    109 
    110 /*
    111  * What to do with network protocol (NP) packets.
    112  */
    113 enum NPmode {
    114     NPMODE_PASS,		/* pass the packet through */
    115     NPMODE_DROP,		/* silently drop the packet */
    116     NPMODE_ERROR,		/* return an error */
    117     NPMODE_QUEUE		/* save it up for later. */
    118 };
    119 
    120 /*
    121  * Statistics.
    122  */
    123 struct pppstat	{
    124     unsigned int ppp_ibytes;	/* bytes received */
    125     unsigned int ppp_ipackets;	/* packets received */
    126     unsigned int ppp_ierrors;	/* receive errors */
    127     unsigned int ppp_obytes;	/* bytes sent */
    128     unsigned int ppp_opackets;	/* packets sent */
    129     unsigned int ppp_oerrors;	/* transmit errors */
    130 };
    131 
    132 struct vjstat {
    133     unsigned int vjs_packets;	/* outbound packets */
    134     unsigned int vjs_compressed; /* outbound compressed packets */
    135     unsigned int vjs_searches;	/* searches for connection state */
    136     unsigned int vjs_misses;	/* times couldn't find conn. state */
    137     unsigned int vjs_uncompressedin; /* inbound uncompressed packets */
    138     unsigned int vjs_compressedin; /* inbound compressed packets */
    139     unsigned int vjs_errorin;	/* inbound unknown type packets */
    140     unsigned int vjs_tossed;	/* inbound packets tossed because of error */
    141 };
    142 
    143 struct ppp_stats {
    144     struct pppstat p;		/* basic PPP statistics */
    145     struct vjstat vj;		/* VJ header compression statistics */
    146 };
    147 
    148 struct compstat {
    149     unsigned int unc_bytes;	/* total uncompressed bytes */
    150     unsigned int unc_packets;	/* total uncompressed packets */
    151     unsigned int comp_bytes;	/* compressed bytes */
    152     unsigned int comp_packets;	/* compressed packets */
    153     unsigned int inc_bytes;	/* incompressible bytes */
    154     unsigned int inc_packets;	/* incompressible packets */
    155     unsigned int ratio;		/* recent compression ratio << 8 */
    156 };
    157 
    158 struct ppp_comp_stats {
    159     struct compstat c;		/* packet compression statistics */
    160     struct compstat d;		/* packet decompression statistics */
    161 };
    162 
    163 /*
    164  * The following structure records the time in seconds since
    165  * the last NP packet was sent or received.
    166  */
    167 struct ppp_idle {
    168     time_t xmit_idle;		/* time since last NP packet sent */
    169     time_t recv_idle;		/* time since last NP packet received */
    170 };
    171 
    172 #endif /* !_NET_PPP_DEFS_H_ */
    173