xref: /freebsd/sys/netgraph/ng_async.h (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
1 
2 /*
3  * ng_async.h
4  *
5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
6  * All rights reserved.
7  *
8  * Subject to the following obligations and disclaimer of warranty, use and
9  * redistribution of this software, in source or object code forms, with or
10  * without modifications are expressly permitted by Whistle Communications;
11  * provided, however, that:
12  * 1. Any and all reproductions of the source or object code must include the
13  *    copyright notice above and the following disclaimer of warranties; and
14  * 2. No rights are granted, in any manner or form, to use Whistle
15  *    Communications, Inc. trademarks, including the mark "WHISTLE
16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17  *    such appears in the above copyright notice or in the software.
18  *
19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
35  * OF SUCH DAMAGE.
36  *
37  * Author: Archie Cobbs <archie@whistle.com>
38  *
39  * $FreeBSD$
40  * $Whistle: ng_async.h,v 1.5 1999/01/25 01:17:14 archie Exp $
41  */
42 
43 #ifndef _NETGRAPH_ASYNC_H_
44 #define _NETGRAPH_ASYNC_H_
45 
46 /* Type name and cookie */
47 #define NG_ASYNC_NODE_TYPE	"async"
48 #define NGM_ASYNC_COOKIE	886473715
49 
50 /* Hook names */
51 #define NG_ASYNC_HOOK_SYNC	"sync"	/* Normal encoding */
52 #define NG_ASYNC_HOOK_SYNC2	"sync2"	/* Full ACCM, no ACF comp. */
53 #define NG_ASYNC_HOOK_ASYNC	"async"	/* Normal decoding */
54 
55 /* Maximum receive size bounds (for both sync and async sides) */
56 #define NG_ASYNC_MIN_MRU	1
57 #define NG_ASYNC_MAX_MRU	8192
58 #define NG_ASYNC_DEFAULT_MRU	1600
59 
60 /* Frame statistics */
61 struct ng_async_stat {
62 	u_int32_t	syncOctets;
63 	u_int32_t	syncFrames;
64 	u_int32_t	syncOverflows;
65 	u_int32_t	asyncOctets;
66 	u_int32_t	asyncFrames;
67 	u_int32_t	asyncRunts;
68 	u_int32_t	asyncOverflows;
69 	u_int32_t	asyncBadCheckSums;
70 };
71 
72 /* Configuration for this node */
73 struct ng_async_cfg {
74 	u_char		enabled;	/* Turn encoding on/off */
75 	u_char		acfcomp;	/* Address/control field compression */
76 	u_int16_t	amru;		/* Max receive async frame length */
77 	u_int16_t	smru;		/* Max receive sync frame length */
78 	u_int32_t	accm;		/* ACCM encoding */
79 };
80 
81 /* Commands */
82 enum {
83 	NGM_ASYNC_CMD_GET_STATS = 1,	/* returns struct ng_async_stat */
84 	NGM_ASYNC_CMD_CLR_STATS,
85 	NGM_ASYNC_CMD_SET_CONFIG,	/* takes struct ng_async_cfg */
86 	NGM_ASYNC_CMD_GET_CONFIG,	/* returns struct ng_async_cfg */
87 };
88 
89 #endif /* _NETGRAPH_ASYNC_H_ */
90