Fix .In abuse and a wrong include path in three manual pages.
[dragonfly.git] / sys / netgraph / lmi / ng_lmi.h
1
2 /*
3  * ng_lmi.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: src/sys/netgraph/ng_lmi.h,v 1.1.4.1 2000/10/24 18:36:45 julian Exp $
40  * $DragonFly: src/sys/netgraph/lmi/ng_lmi.h,v 1.2 2003/06/17 04:28:50 dillon Exp $
41  * $Whistle: ng_lmi.h,v 1.9 1999/01/20 00:22:13 archie Exp $
42  */
43
44 #ifndef _NETGRAPH_LMI_H_
45 #define _NETGRAPH_LMI_H_
46
47 /* Node type name and magic cookie */
48 #define NG_LMI_NODE_TYPE                "lmi"
49 #define NGM_LMI_COOKIE                  867184133
50
51 /* My hook names */
52 #define NG_LMI_HOOK_DEBUG               "debug"
53 #define NG_LMI_HOOK_ANNEXA              "annexA"
54 #define NG_LMI_HOOK_ANNEXD              "annexD"
55 #define NG_LMI_HOOK_GROUPOF4            "group4"
56 #define NG_LMI_HOOK_AUTO0               "auto0"
57 #define NG_LMI_HOOK_AUTO1023            "auto1023"
58
59 /* Netgraph commands */
60 enum {
61         NGM_LMI_GET_STATUS = 1,
62 };
63
64 #define NGM_LMI_STAT_ARYSIZE            (1024/8)
65
66 struct nglmistat {
67         u_char  proto[12];      /* Active proto (same as hook name) */
68         u_char  hook[12];       /* Active hook */
69         u_char  fixed;          /* Set to fixed LMI mode */
70         u_char  autod;          /* Currently auto-detecting */
71         u_char  seen[NGM_LMI_STAT_ARYSIZE];     /* DLCIs ever seen */
72         u_char  up[NGM_LMI_STAT_ARYSIZE];       /* DLCIs currently up */
73 };
74
75 /* Some default values */
76 #define NG_LMI_KEEPALIVE_RATE           10      /* seconds per keepalive */
77 #define NG_LMI_POLL_RATE                3       /* faster when AUTO polling */
78 #define NG_LMI_SEQ_PER_FULL             5       /* keepalives per full status */
79 #define NG_LMI_LMI_PRIORITY             64      /* priority for LMI data */
80
81 #endif /* _NETGRAPH_LMI_H_ */