1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
2 .\" All rights reserved.
4 .\" Subject to the following obligations and disclaimer of warranty, use and
5 .\" redistribution of this software, in source or object code forms, with or
6 .\" without modifications are expressly permitted by Whistle Communications;
7 .\" provided, however, that:
8 .\" 1. Any and all reproductions of the source or object code must include the
9 .\" copyright notice above and the following disclaimer of warranties; and
10 .\" 2. No rights are granted, in any manner or form, to use Whistle
11 .\" Communications, Inc. trademarks, including the mark "WHISTLE
12 .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as
13 .\" such appears in the above copyright notice or in the software.
15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
34 .\" $Whistle: ng_lmi.8,v 1.4 1999/01/25 23:46:27 archie Exp $
41 .Nd frame relay LMI protocol netgraph node type
48 node type performs the frame relay LMI protocol.
50 the ITU Annex A, ANSI Annex D, and Group-of-four LMI types.
51 It also supports auto-detection of the LMI type.
53 To enable a specific LMI type, connect the corresponding hook
58 to DLCI 0 or 1023 of a
61 Typically, Annex A and Annex D live on DLCI 0 while Group-of-four
64 To enable LMI type auto-detection, connect the
66 hook to DLCI 0 and the
69 The node will attempt to automatically determine
70 which LMI type is running at the switch, and go into that mode.
72 Only one fixed LMI type, or auto-detection, can be active at any given time.
75 .Dv NGM_LMI_GET_STATUS
76 control message can be used at any time to query the current status
77 of the LMI protocol and each DLCI channel.
78 This node also supports the
82 This node type supports the following hooks:
83 .Bl -tag -width ".Va auto1023"
87 ANSI Annex D LMI hook.
89 Group-of-four LMI hook.
91 Auto-detection hook for DLCI 0.
93 Auto-detection hook for DLCI 1023.
96 This node type supports the generic control messages, plus the following:
98 .It Dv NGM_LMI_GET_STATUS
99 This command returns status information in a
100 .Dv "struct nglmistat" :
101 .Bd -literal -offset 4n
102 #define NGM_LMI_STAT_ARYSIZE (1024/8)
105 u_char proto[12]; /* Active proto (same as hook name) */
106 u_char hook[12]; /* Active hook */
107 u_char fixed; /* If set to fixed LMI mode */
108 u_char autod; /* If currently auto-detecting */
109 u_char seen[NGM_LMI_STAT_ARYSIZE]; /* DLCIs ever seen */
110 u_char up[NGM_LMI_STAT_ARYSIZE]; /* DLCIs currently up */
113 .It Dv NGM_TEXT_STATUS
114 This generic message returns is a human-readable version of the node status.
117 This node shuts down upon receipt of a
119 control message, or when all hooks have been disconnected.
122 .Xr ng_frame_relay 4 ,
125 .%T "ANSI T1.617-1991 Annex D"
128 .%T "ITU-T Q.933 Digital Subscriber Signaling System No. 1 - Signaling Specification for Frame Mode Basic Call Control, Annex A"
133 node type was implemented in
136 .An Julian Elischer Aq Mt julian@FreeBSD.org