Merge from vendor branch DIFFUTILS:
[dragonfly.git] / sys / dev / usbmisc / udbp / udbp.h
1 /*
2  * Copyright (c) 1996-2000 Whistle Communications, Inc.
3  * All rights reserved.
4  *
5  * Subject to the following obligations and disclaimer of warranty, use and
6  * redistribution of this software, in source or object code forms, with or
7  * without modifications are expressly permitted by Whistle Communications;
8  * provided, however, that:
9  * 1. Any and all reproductions of the source or object code must include the
10  *    copyright notice above and the following disclaimer of warranties; and
11  * 2. No rights are granted, in any manner or form, to use Whistle
12  *    Communications, Inc. trademarks, including the mark "WHISTLE
13  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
14  *    such appears in the above copyright notice or in the software.
15  *
16  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
17  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
18  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
19  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
21  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
22  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
23  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
24  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
25  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
26  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
27  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
32  * OF SUCH DAMAGE.
33  *
34  * This file was derived from src/sys/netgraph/ng_sample.h, revision 1.1
35  * written by Julian Elischer, Whistle Communications.
36  *
37  * $FreeBSD: src/sys/dev/usb/udbp.h,v 1.3 2003/07/04 01:50:38 jmg Exp $
38  * $DragonFly: src/sys/dev/usbmisc/udbp/Attic/udbp.h,v 1.1 2003/12/30 01:01:46 dillon Exp $
39  */
40
41 #ifndef _NETGRAPH_UDBP_H_
42 #define _NETGRAPH_UDBP_H_
43
44 /* Node type name. This should be unique among all netgraph node types */
45 #define NG_UDBP_NODE_TYPE       "udbp"
46
47 /* Node type cookie. Should also be unique. This value MUST change whenever
48    an incompatible change is made to this header file, to insure consistency.
49    The de facto method for generating cookies is to take the output of the
50    date command: date -u +'%s' */
51 #define NGM_UDBP_COOKIE         944609300
52
53
54 #define NG_UDBP_HOOK_NAME       "data"
55
56 /* Netgraph commands understood by this node type */
57 enum {
58         NGM_UDBP_SET_FLAG = 1,
59         NGM_UDBP_GET_STATUS,
60 };
61
62 /* This structure is returned by the NGM_UDBP_GET_STATUS command */
63 struct ngudbpstat {
64         u_int   packets_in;     /* packets in from downstream */
65         u_int   packets_out;    /* packets out towards downstream */
66 };
67
68 /*
69  * This is used to define the 'parse type' for a struct ngudbpstat, which
70  * is bascially a description of how to convert a binary struct ngudbpstat
71  * to an ASCII string and back.  See ng_parse.h for more info.
72  *
73  * This needs to be kept in sync with the above structure definition
74  */
75 #define NG_UDBP_STATS_TYPE_INFO {                               \
76           { "packets_in",       &ng_parse_int32_type    },      \
77           { "packets_out",      &ng_parse_int32_type    },      \
78           { NULL },                                             \
79 }
80
81 #endif /* _NETGRAPH_UDBP_H_ */