pppd: Add lcp-echo-adaptive option
[ppp.git] / include / net / if_ppp.h
1 /*      $Id: if_ppp.h,v 1.19 2002/12/06 09:49:15 paulus Exp $   */
2
3 /*
4  * if_ppp.h - Point-to-Point Protocol definitions.
5  *
6  * Copyright (c) 1984-2000 Carnegie Mellon University. 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 "Carnegie Mellon University" must not be used to
21  *    endorse or promote products derived from this software without
22  *    prior written permission. For permission or any legal
23  *    details, please contact
24  *      Office of Technology Transfer
25  *      Carnegie Mellon University
26  *      5000 Forbes Avenue
27  *      Pittsburgh, PA  15213-3890
28  *      (412) 268-4387, fax: (412) 268-7395
29  *      tech-transfer@andrew.cmu.edu
30  *
31  * 4. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by Computing Services
34  *     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
35  *
36  * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
37  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
38  * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
39  * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
40  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
41  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
42  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
43  */
44
45 #ifndef _IF_PPP_H_
46 #define _IF_PPP_H_
47
48 /*
49  * Bit definitions for flags.
50  */
51 #define SC_COMP_PROT    0x00000001      /* protocol compression (output) */
52 #define SC_COMP_AC      0x00000002      /* header compression (output) */
53 #define SC_COMP_TCP     0x00000004      /* TCP (VJ) compression (output) */
54 #define SC_NO_TCP_CCID  0x00000008      /* disable VJ connection-id comp. */
55 #define SC_REJ_COMP_AC  0x00000010      /* reject adrs/ctrl comp. on input */
56 #define SC_REJ_COMP_TCP 0x00000020      /* reject TCP (VJ) comp. on input */
57 #define SC_CCP_OPEN     0x00000040      /* Look at CCP packets */
58 #define SC_CCP_UP       0x00000080      /* May send/recv compressed packets */
59 #define SC_DEBUG        0x00010000      /* enable debug messages */
60 #define SC_LOG_INPKT    0x00020000      /* log contents of good pkts recvd */
61 #define SC_LOG_OUTPKT   0x00040000      /* log contents of pkts sent */
62 #define SC_LOG_RAWIN    0x00080000      /* log all chars received */
63 #define SC_LOG_FLUSH    0x00100000      /* log all chars flushed */
64 #define SC_RCV_B7_0     0x01000000      /* have rcvd char with bit 7 = 0 */
65 #define SC_RCV_B7_1     0x02000000      /* have rcvd char with bit 7 = 1 */
66 #define SC_RCV_EVNP     0x04000000      /* have rcvd char with even parity */
67 #define SC_RCV_ODDP     0x08000000      /* have rcvd char with odd parity */
68 #define SC_SYNC         0x00200000      /* use synchronous HDLC framing */
69 #define SC_MASK         0x0fff00ff      /* bits that user can change */
70
71 /*
72  * State bits in sc_flags, not changeable by user.
73  */
74 #define SC_TIMEOUT      0x00000400      /* timeout is currently pending */
75 #define SC_VJ_RESET     0x00000800      /* need to reset VJ decomp */
76 #define SC_COMP_RUN     0x00001000      /* compressor has been inited */
77 #define SC_DECOMP_RUN   0x00002000      /* decompressor has been inited */
78 #define SC_DC_ERROR     0x00004000      /* non-fatal decomp error detected */
79 #define SC_DC_FERROR    0x00008000      /* fatal decomp error detected */
80 #define SC_TBUSY        0x10000000      /* xmitter doesn't need a packet yet */
81 #define SC_PKTLOST      0x20000000      /* have lost or dropped a packet */
82 #define SC_FLUSH        0x40000000      /* flush input until next PPP_FLAG */
83 #define SC_ESCAPED      0x80000000      /* saw a PPP_ESCAPE */
84
85 /*
86  * Ioctl definitions.
87  */
88
89 struct npioctl {
90     int         protocol;       /* PPP procotol, e.g. PPP_IP */
91     enum NPmode mode;
92 };
93
94 /* Structure describing a CCP configuration option, for PPPIOCSCOMPRESS */
95 struct ppp_option_data {
96         u_char  *ptr;
97         u_int   length;
98         int     transmit;
99 };
100
101 struct ifpppstatsreq {
102     char ifr_name[IFNAMSIZ];
103     struct ppp_stats stats;
104 };
105
106 struct ifpppcstatsreq {
107     char ifr_name[IFNAMSIZ];
108     struct ppp_comp_stats stats;
109 };
110
111 /*
112  * Ioctl definitions.
113  */
114
115 #define PPPIOCGFLAGS    _IOR('t', 90, int)      /* get configuration flags */
116 #define PPPIOCSFLAGS    _IOW('t', 89, int)      /* set configuration flags */
117 #define PPPIOCGASYNCMAP _IOR('t', 88, int)      /* get async map */
118 #define PPPIOCSASYNCMAP _IOW('t', 87, int)      /* set async map */
119 #define PPPIOCGUNIT     _IOR('t', 86, int)      /* get ppp unit number */
120 #define PPPIOCGRASYNCMAP _IOR('t', 85, int)     /* get receive async map */
121 #define PPPIOCSRASYNCMAP _IOW('t', 84, int)     /* set receive async map */
122 #define PPPIOCGMRU      _IOR('t', 83, int)      /* get max receive unit */
123 #define PPPIOCSMRU      _IOW('t', 82, int)      /* set max receive unit */
124 #define PPPIOCSMAXCID   _IOW('t', 81, int)      /* set VJ max slot ID */
125 #define PPPIOCGXASYNCMAP _IOR('t', 80, ext_accm) /* get extended ACCM */
126 #define PPPIOCSXASYNCMAP _IOW('t', 79, ext_accm) /* set extended ACCM */
127 #define PPPIOCXFERUNIT  _IO('t', 78)            /* transfer PPP unit */
128 #define PPPIOCSCOMPRESS _IOW('t', 77, struct ppp_option_data)
129 #define PPPIOCGNPMODE   _IOWR('t', 76, struct npioctl) /* get NP mode */
130 #define PPPIOCSNPMODE   _IOW('t', 75, struct npioctl)  /* set NP mode */
131 #define PPPIOCGIDLE     _IOR('t', 74, struct ppp_idle) /* get idle time */
132 #ifdef PPP_FILTER
133 #define PPPIOCSPASS     _IOW('t', 71, struct bpf_program) /* set pass filter */
134 #define PPPIOCSACTIVE   _IOW('t', 70, struct bpf_program) /* set active filt */
135 #endif /* PPP_FILTER */
136
137 /* PPPIOC[GS]MTU are alternatives to SIOC[GS]IFMTU, used under Ultrix */
138 #define PPPIOCGMTU      _IOR('t', 73, int)      /* get interface MTU */
139 #define PPPIOCSMTU      _IOW('t', 72, int)      /* set interface MTU */
140
141 /*
142  * These two are interface ioctls so that pppstats can do them on
143  * a socket without having to open the serial device.
144  */
145 #define SIOCGPPPSTATS   _IOWR('i', 123, struct ifpppstatsreq)
146 #define SIOCGPPPCSTATS  _IOWR('i', 122, struct ifpppcstatsreq)
147
148 #if !defined(ifr_mtu)
149 #define ifr_mtu ifr_ifru.ifru_metric
150 #endif
151
152 #if (defined(_KERNEL) || defined(KERNEL)) && !defined(NeXT)
153 void pppattach __P((void));
154 void pppintr __P((void));
155 #endif
156 #endif /* _IF_PPP_H_ */