The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/modules/netgraph/lmi/ng_lmi.4

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: a1a80472eaac690ed3560816ad773d82


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.