xref: /titanic_52/usr/src/uts/common/net/pppio.h (revision 1a7c1b724419d3cb5fa6eea75123c6b2060ba31b)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * pppio.h - ioctl and other misc. definitions for STREAMS modules.
24  *
25  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
26  * Use is subject to license terms.
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  * $Id: pppio.h,v 1.8 1996/08/28 06:36:51 paulus Exp $
52  */
53 
54 #ifndef __PPPIO_H
55 #define	__PPPIO_H
56 
57 #pragma ident	"%Z%%M%	%I%	%E% SMI"
58 
59 #ifdef	__cplusplus
60 extern "C" {
61 #endif
62 
63 #define	_PPPIO(n)	(('p' << 8) + (n))
64 
65 #define	PPPIO_NEWPPA	_PPPIO(130)	/* allocate a new PPP unit */
66 #define	PPPIO_GETSTAT	_PPPIO(131)	/* get PPP statistics */
67 #define	PPPIO_GETCSTAT	_PPPIO(132)	/* get PPP compression stats */
68 #define	PPPIO_MTU	_PPPIO(133)	/* set max transmission unit */
69 #define	PPPIO_MRU	_PPPIO(134)	/* set max receive unit */
70 #define	PPPIO_CFLAGS	_PPPIO(135)	/* set/clear/get compression flags */
71 #define	PPPIO_XCOMP	_PPPIO(136)	/* alloc transmit compressor */
72 #define	PPPIO_RCOMP	_PPPIO(137)	/* alloc receive decompressor */
73 #define	PPPIO_XACCM	_PPPIO(138)	/* set transmit asyncmap */
74 #define	PPPIO_RACCM	_PPPIO(139)	/* set receive asyncmap */
75 #define	PPPIO_VJINIT	_PPPIO(140)	/* initialize VJ comp/decomp */
76 #define	PPPIO_ATTACH	_PPPIO(141)	/* attach to a ppa (without putmsg) */
77 #define	PPPIO_LASTMOD	_PPPIO(142)	/* mark last ppp module */
78 #define	PPPIO_GCLEAN	_PPPIO(143)	/* get 8-bit-clean flags */
79 #define	PPPIO_DEBUG	_PPPIO(144)	/* request debug information */
80 #define	PPPIO_BIND	_PPPIO(145)	/* bind to SAP */
81 #define	PPPIO_NPMODE	_PPPIO(146)	/* set mode for handling data pkts */
82 #define	PPPIO_GIDLE	_PPPIO(147)	/* get time since last data pkt */
83 #define	PPPIO_PASSFILT	_PPPIO(148)	/* set filter for packets to pass */
84 #define	PPPIO_ACTIVEFILT _PPPIO(149)	/* set filter for "link active" pkts */
85 #define	PPPIO_USETIMESTAMP _PPPIO(150)	/* enable packet time-stamp */
86 #define	PPPIO_DETACH	_PPPIO(151)	/* detach from a ppa (w/o putmsg ) */
87 #define	PPPIO_XFCS	_PPPIO(152)	/* set transmit FCS type */
88 #define	PPPIO_RFCS	_PPPIO(153)	/* set receive FCS type */
89 #define	PPPIO_COMPLEV	_PPPIO(154)	/* set compression effort level */
90 #define	PPPIO_GTYPE	_PPPIO(155)	/* get existing driver type */
91 #define	PPPIO_MUX	_PPPIO(156)	/* multiplexed frame */
92 #define	PPPIO_GETSTAT64	_PPPIO(157)	/* get PPP 64-bit statistics */
93 #define	PPPIO_BLOCKNP	_PPPIO(158)	/* block pkts with proto np in kernel */
94 #define	PPPIO_UNBLOCKNP	_PPPIO(159)	/* unblock pkts with proto np */
95 
96 /* Values for PPPIO_MUX FLAGS */
97 #define	X_MUXMASK	0x10		/* transmit muxed frame option */
98 #define	R_MUXMASK	0x20		/* receive muxed frame option */
99 
100 /*
101  * Values for PPPIO_CFLAGS.  Data sent in is u_int32_t val[2], where
102  * result is newflags = val[0] | (oldflags & ~val[1]).  Returned data
103  * is a single u_int32_t, containing the current flags.
104  */
105 #define	COMP_AC		0x1		/* compress address/control */
106 #define	DECOMP_AC	0x2		/* decompress address/control */
107 #define	COMP_PROT	0x4		/* compress PPP protocol */
108 #define	DECOMP_PROT	0x8		/* decompress PPP protocol */
109 
110 #define	COMP_VJC	0x10		/* compress TCP/IP headers */
111 #define	COMP_VJCCID	0x20		/* compress connection ID as well */
112 #define	DECOMP_VJC	0x40		/* decompress TCP/IP headers */
113 #define	DECOMP_VJCCID	0x80		/* accept compressed connection ID */
114 
115 #define	CCP_ISOPEN	0x100		/* look at CCP packets */
116 #define	CCP_ISUP	0x200		/* do packet comp/decomp */
117 #define	CCP_ERROR	0x400		/* (status) error in packet decomp */
118 #define	CCP_FATALERROR	0x800		/* (status) fatal error ditto */
119 #define	CCP_COMP_RUN	0x1000		/* (status) seen CCP ack sent */
120 #define	CCP_DECOMP_RUN	0x2000		/* (status) seen CCP ack rcvd */
121 
122 
123 /*
124  * Values for PPPIO_XFCS/PPPIO_RFCS.  (Note that we don't support
125  * simultaneous use of 16 bit and 32 bit CRCs.)
126  */
127 #define	PPPFCS_16	0		/* The default, usually; CRC-16 */
128 #define	PPPFCS_32	1		/* CRC-32 */
129 #define	PPPFCS_NONE	2		/* No CRC */
130 
131 /*
132  * Values for 8-bit-clean flags.
133  */
134 #define	RCV_B7_0	1		/* have rcvd char with bit 7 = 0 */
135 #define	RCV_B7_1	2		/* have rcvd char with bit 7 = 1 */
136 #define	RCV_EVNP	4		/* have rcvd char with even parity */
137 #define	RCV_ODDP	8		/* have rcvd char with odd parity */
138 
139 /*
140  * Values for the first byte of M_CTL messages passed between
141  * PPP modules.
142  */
143 #define	PPPCTL_OERROR	0xe0		/* output error [up] */
144 #define	PPPCTL_IERROR	0xe1		/* input error (e.g. FCS) [up] */
145 #define	PPPCTL_MTU	0xe2		/* set MTU [down] */
146 #define	PPPCTL_MRU	0xe3		/* set MRU [down] */
147 #define	PPPCTL_UNIT	0xe4		/* note PPP unit number [down] */
148 
149 /*
150  * Values for the u_int32_t argument to PPPIO_DEBUG.
151  */
152 #define	PPPDBG_DUMP	0x10000		/* print out debug info now */
153 #define	PPPDBG_LOG	0x100		/* log various things */
154 #define	PPPDBG_DRIVER	0		/* identifies ppp driver as target */
155 #define	PPPDBG_IF	1		/* identifies ppp network i/f target */
156 #define	PPPDBG_COMP	2		/* identifies ppp compression target */
157 #define	PPPDBG_AHDLC	3		/* identifies ppp async hdlc target */
158 
159 /*
160  * Values for the u_int32_t return from PPPIO_GTYPE.  Only lastmod
161  * should respond.  Current modules return PPPTYP_AHDLC (async
162  * module), PPPTYP_HC (compression module) and PPPTYP_MUX (PPP
163  * interface driver).
164  */
165 #define	PPPTYP_HDLC	0		/* raw HDLC I/O; no PPP handling */
166 #define	PPPTYP_AHDLC	1		/* async HDLC; has [XR]ACCM */
167 #define	PPPTYP_HC	2		/* HDLC with ACFC and PFC support */
168 #define	PPPTYP_AHC	3		/* async with ACFC and PFC */
169 #define	PPPTYP_MUX	4		/* multiplexor */
170 
171 #ifdef SOL2
172 /* Officially allocated module numbers */
173 #define	PPP_MOD_ID	2101	/* PPP multiplexor */
174 #define	COMP_MOD_ID	2102	/* Data and header compression */
175 #define	AHDLC_MOD_ID	2103	/* Asynchronous HDLC-like encapsulation */
176 #define	TUN_MOD_ID	2104	/* Tunneling protocols */
177 #define	MP_MOD_ID	2105	/* Multilink PPP */
178 #define	PPP_DRV_NAME	"sppp"
179 #define	AHDLC_MOD_NAME	"spppasyn"
180 #define	COMP_MOD_NAME	"spppcomp"
181 #define	TUN_MOD_NAME	"sppptun"
182 #define	MP_MOD_NAME	"spppmp"
183 #else
184 #define	PPP_MOD_ID	0xb1a6
185 #define	COMP_MOD_ID	0xbadf
186 #define	AHDLC_MOD_ID	0x7d23
187 #define	PPP_DRV_NAME	"ppp"
188 #define	AHDLC_MOD_NAME	"ppp_ahdl"
189 #define	COMP_MOD_NAME	"ppp_comp"
190 #endif
191 #define	PPP_DEV_NAME	"/dev/" PPP_DRV_NAME
192 
193 #ifdef	__cplusplus
194 }
195 #endif
196 
197 #endif /* __PPPIO_H */
198