1.\" Copyright (c) 1996-1999 Whistle Communications, Inc. 2.\" All rights reserved. 3.\" 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. 14.\" 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 31.\" OF SUCH DAMAGE. 32.\" 33.\" Author: Archie Cobbs <archie@FreeBSD.org> 34.\" $Whistle: ng_lmi.8,v 1.4 1999/01/25 23:46:27 archie Exp $ 35.\" 36.Dd November 13, 2012 37.Dt NG_LMI 4 38.Os 39.Sh NAME 40.Nm ng_lmi 41.Nd frame relay LMI protocol netgraph node type 42.Sh SYNOPSIS 43.In sys/types.h 44.In netgraph/ng_lmi.h 45.Sh DESCRIPTION 46The 47.Nm lmi 48node type performs the frame relay LMI protocol. 49It supports 50the ITU Annex A, ANSI Annex D, and Group-of-four LMI types. 51It also supports auto-detection of the LMI type. 52.Pp 53To enable a specific LMI type, connect the corresponding hook 54.Dv ( annexA , 55.Dv annexD , 56or 57.Dv group4 ")" 58to DLCI 0 or 1023 of a 59.Xr ng_frame_relay 4 60node. 61Typically, Annex A and Annex D live on DLCI 0 while Group-of-four 62lives on DLCI 1023. 63.Pp 64To enable LMI type auto-detection, connect the 65.Dv auto0 66hook to DLCI 0 and the 67.Dv auto1023 68hook to DLCI 1023. 69The node will attempt to automatically determine 70which LMI type is running at the switch, and go into that mode. 71.Pp 72Only one fixed LMI type, or auto-detection, can be active at any given time. 73.Pp 74The 75.Dv NGM_LMI_GET_STATUS 76control message can be used at any time to query the current status 77of the LMI protocol and each DLCI channel. 78This node also supports the 79.Dv NGM_TEXT_STATUS 80control message. 81.Sh HOOKS 82This node type supports the following hooks: 83.Bl -tag -width ".Va auto1023" 84.It Va annexA 85ITU Annex A LMI hook. 86.It Va annexD 87ANSI Annex D LMI hook. 88.It Va group4 89Group-of-four LMI hook. 90.It Va auto0 91Auto-detection hook for DLCI 0. 92.It Va auto1023 93Auto-detection hook for DLCI 1023. 94.El 95.Sh CONTROL MESSAGES 96This node type supports the generic control messages, plus the following: 97.Bl -tag -width foo 98.It Dv NGM_LMI_GET_STATUS 99This command returns status information in a 100.Dv "struct nglmistat" : 101.Bd -literal -offset 4n 102#define NGM_LMI_STAT_ARYSIZE (1024/8) 103 104struct nglmistat { 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 */ 111}; 112.Ed 113.It Dv NGM_TEXT_STATUS 114This generic message returns is a human-readable version of the node status. 115.El 116.Sh SHUTDOWN 117This node shuts down upon receipt of a 118.Dv NGM_SHUTDOWN 119control message, or when all hooks have been disconnected. 120.Sh SEE ALSO 121.Xr netgraph 4 , 122.Xr ng_frame_relay 4 , 123.Xr ngctl 8 124.Rs 125.%T "ANSI T1.617-1991 Annex D" 126.Re 127.Rs 128.%T "ITU-T Q.933 Digital Subscriber Signaling System No. 1 - Signaling Specification for Frame Mode Basic Call Control, Annex A" 129.Re 130.Sh HISTORY 131The 132.Nm 133node type was implemented in 134.Fx 4.0 . 135.Sh AUTHORS 136.An Julian Elischer Aq Mt julian@FreeBSD.org 137