PageRenderTime 14ms CodeModel.GetById 8ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/share/man/man4/ng_lmi.4

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