Add prototypes; implement sys_cleanup; ccp_test provides more info;
[ppp.git] / linux / if_ppp.h
1 /*      $Id: if_ppp.h,v 1.3 1995/06/12 11:36:50 paulus Exp $    */
2
3 /*
4  * if_ppp.h - Point-to-Point Protocol definitions.
5  *
6  * Copyright (c) 1989 Carnegie Mellon University.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms are permitted
10  * provided that the above copyright notice and this paragraph are
11  * duplicated in all such forms and that any documentation,
12  * advertising materials, and other materials related to such
13  * distribution and use acknowledge that the software was developed
14  * by Carnegie Mellon University.  The name of the
15  * University may not be used to endorse or promote products derived
16  * from this software without specific prior written permission.
17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
19  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
20  *
21  */
22
23 /*
24  *  ==PPPVERSION 2.1.3==
25  *
26  *  NOTE TO MAINTAINERS:
27  *     If you modify this file at all, increment the last number above.
28  *     ppp.c is shipped with a PPP distribution as well as with the kernel;
29  *     if everyone increases the PPPVERSION number above, then scripts
30  *     can do the right thing when deciding whether to install a new ppp.c
31  *     file.  Don't change the format of that line otherwise, so the
32  *     installation script can recognize it.
33  */
34
35 #ifndef _IF_PPP_H_
36 #define _IF_PPP_H_
37
38 /*
39  * Packet sizes
40  */
41
42 #define PPP_MTU         1500    /* Default MTU (size of Info field) */
43 #define PPP_MAXMRU      65000   /* Largest MRU we allow */
44 #define PPP_VERSION     "2.2.0"
45 #define PPP_MAGIC       0x5002  /* Magic value for the ppp structure */
46 #define PROTO_IPX       0x002b  /* protocol numbers */
47
48 /*
49  * Bit definitions for flags.
50  */
51
52 #define SC_COMP_PROT    0x00000001      /* protocol compression (output) */
53 #define SC_COMP_AC      0x00000002      /* header compression (output) */
54 #define SC_COMP_TCP     0x00000004      /* TCP (VJ) compression (output) */
55 #define SC_NO_TCP_CCID  0x00000008      /* disable VJ connection-id comp. */
56 #define SC_REJ_COMP_AC  0x00000010      /* reject adrs/ctrl comp. on input */
57 #define SC_REJ_COMP_TCP 0x00000020      /* reject TCP (VJ) comp. on input */
58 #define SC_CCP_OPEN     0x00000040      /* Look at CCP packets */
59 #define SC_CCP_UP       0x00000080      /* May send/recv compressed packets */
60 #define SC_ENABLE_IP    0x00000100      /* IP packets may be exchanged */
61 #define SC_COMP_RUN     0x00001000      /* compressor has been inited */
62 #define SC_DECOMP_RUN   0x00002000      /* decompressor has been inited */
63 #define SC_DEBUG        0x00010000      /* enable debug messages */
64 #define SC_LOG_INPKT    0x00020000      /* log contents of good pkts recvd */
65 #define SC_LOG_OUTPKT   0x00040000      /* log contents of pkts sent */
66 #define SC_LOG_RAWIN    0x00080000      /* log all chars received */
67 #define SC_LOG_FLUSH    0x00100000      /* log all chars flushed */
68 #define SC_MASK         0x0fE0ffff      /* bits that user can change */
69
70 /* state bits */
71 #define SC_ESCAPED      0x80000000      /* saw a PPP_ESCAPE */
72 #define SC_FLUSH        0x40000000      /* flush input until next PPP_FLAG */
73 #define SC_VJ_RESET     0x20000000      /* Need to reset the VJ decompressor */
74 #define SC_XMIT_BUSY    0x10000000      /* ppp_write_wakeup is active */
75 #define SC_RCV_ODDP     0x08000000      /* have rcvd char with odd parity */
76 #define SC_RCV_EVNP     0x04000000      /* have rcvd char with even parity */
77 #define SC_RCV_B7_1     0x02000000      /* have rcvd char with bit 7 = 1 */
78 #define SC_RCV_B7_0     0x01000000      /* have rcvd char with bit 7 = 0 */
79 #define SC_DC_FERROR    0x00800000      /* fatal decomp error detected */
80 #define SC_DC_ERROR     0x00400000      /* non-fatal decomp error detected */
81
82 /*
83  * Ioctl definitions.
84  */
85
86 struct npioctl {
87     int         protocol;       /* PPP procotol, e.g. PPP_IP */
88     enum NPmode mode;
89 };
90
91 /* Structure describing a CCP configuration option, for PPPIOCSCOMPRESS */
92 struct ppp_option_data {
93         u_char  *ptr;
94         u_int   length;
95         int     transmit;
96 };
97
98 struct ifpppstatsreq {
99     char ifr__name[IFNAMSIZ];           /* Name of the device */
100     struct ppp_stats *stats_ptr;        /* Pointer to stats buffer */
101     struct ppp_stats stats;             /* statistic information */
102 };
103
104 /*
105  * Ioctl definitions.
106  */
107
108 #define PPPIOCGFLAGS    _IOR('t', 90, int)      /* get configuration flags */
109 #define PPPIOCSFLAGS    _IOW('t', 89, int)      /* set configuration flags */
110 #define PPPIOCGASYNCMAP _IOR('t', 88, int)      /* get async map */
111 #define PPPIOCSASYNCMAP _IOW('t', 87, int)      /* set async map */
112 #define PPPIOCGUNIT     _IOR('t', 86, int)      /* get ppp unit number */
113 #define PPPIOCGRASYNCMAP _IOR('t', 85, int)     /* get receive async map */
114 #define PPPIOCSRASYNCMAP _IOW('t', 84, int)     /* set receive async map */
115 #define PPPIOCGMRU      _IOR('t', 83, int)      /* get max receive unit */
116 #define PPPIOCSMRU      _IOW('t', 82, int)      /* set max receive unit */
117 #define PPPIOCSMAXCID   _IOW('t', 81, int)      /* set VJ max slot ID */
118 #define PPPIOCGXASYNCMAP _IOR('t', 80, ext_accm) /* get extended ACCM */
119 #define PPPIOCSXASYNCMAP _IOW('t', 79, ext_accm) /* set extended ACCM */
120 #define PPPIOCXFERUNIT  _IO('t', 78)            /* transfer PPP unit */
121 #define PPPIOCSCOMPRESS _IOW('t', 77, struct ppp_option_data)
122 #define PPPIOCGNPMODE   _IOWR('t', 76, struct npioctl) /* get NP mode */
123 #define PPPIOCSNPMODE   _IOW('t', 75, struct npioctl)  /* set NP mode */
124
125 #define PPPIOCGDEBUG    _IOR('t', 65, int)      /* Read debug level */
126 #define PPPIOCSDEBUG    _IOW('t', 64, int)      /* Set debug level */
127 #define PPPIOCGTIME     _IOR('t', 63, struct ppp_ddinfo) /* Read time info */
128
129 #define SIOCGPPPSTATS   (SIOCDEVPRIVATE + 0)
130 #define SIOCGPPPVER     (SIOCDEVPRIVATE + 1)
131
132 #if !defined(ifr_mtu)
133 #define ifr_mtu ifr_ifru.ifru_metric
134 #endif
135
136 #endif /* _IF_PPP_H_ */