ng_async.h revision 97685 
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@freebsd.org>
38 *
39 * $FreeBSD: head/sys/netgraph/ng_async.h 97685 2002-05-31 23:48:03Z archie $
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	886473717
49
50/* Hook names */
51#define NG_ASYNC_HOOK_SYNC	"sync"	/* Sync frames */
52#define NG_ASYNC_HOOK_ASYNC	"async"	/* Async-encoded frames */
53
54/* Maximum receive size bounds (for both sync and async sides) */
55#define NG_ASYNC_MIN_MRU	1
56#define NG_ASYNC_MAX_MRU	8192
57#define NG_ASYNC_DEFAULT_MRU	1600
58
59/* Frame statistics */
60struct ng_async_stat {
61	u_int32_t	syncOctets;
62	u_int32_t	syncFrames;
63	u_int32_t	syncOverflows;
64	u_int32_t	asyncOctets;
65	u_int32_t	asyncFrames;
66	u_int32_t	asyncRunts;
67	u_int32_t	asyncOverflows;
68	u_int32_t	asyncBadCheckSums;
69};
70
71/* Keep this in sync with the above structure definition */
72#define NG_ASYNC_STATS_TYPE_INFO	{			\
73	  { "syncOctets",	&ng_parse_uint32_type	},	\
74	  { "syncFrames",	&ng_parse_uint32_type	},	\
75	  { "syncOverflows",	&ng_parse_uint32_type	},	\
76	  { "asyncOctets",	&ng_parse_uint32_type	},	\
77	  { "asyncFrames",	&ng_parse_uint32_type	},	\
78	  { "asyncRunts",	&ng_parse_uint32_type	},	\
79	  { "asyncOverflows",	&ng_parse_uint32_type	},	\
80	  { "asyncBadCheckSums",&ng_parse_uint32_type	},	\
81	  { NULL }						\
82}
83
84/* Configuration for this node */
85struct ng_async_cfg {
86	u_char		enabled;	/* Turn encoding on/off */
87	u_int16_t	amru;		/* Max receive async frame length */
88	u_int16_t	smru;		/* Max receive sync frame length */
89	u_int32_t	accm;		/* ACCM encoding */
90};
91
92/* Keep this in sync with the above structure definition */
93#define NG_ASYNC_CONFIG_TYPE_INFO	{			\
94	  { "enabled",		&ng_parse_int8_type	},	\
95	  { "amru",		&ng_parse_uint16_type	},	\
96	  { "smru",		&ng_parse_uint16_type	},	\
97	  { "accm",		&ng_parse_hint32_type	},	\
98	  { NULL }						\
99}
100
101/* Commands */
102enum {
103	NGM_ASYNC_CMD_GET_STATS = 1,	/* returns struct ng_async_stat */
104	NGM_ASYNC_CMD_CLR_STATS,
105	NGM_ASYNC_CMD_SET_CONFIG,	/* takes struct ng_async_cfg */
106	NGM_ASYNC_CMD_GET_CONFIG,	/* returns struct ng_async_cfg */
107};
108
109#endif /* _NETGRAPH_ASYNC_H_ */
110