xref: /freebsd/share/man/man4/ng_frame_relay.4 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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_frame_relay.8,v 1.4 1999/01/25 23:46:26 archie Exp $
35.\"
36.Dd January 19, 1999
37.Dt NG_FRAME_RELAY 4
38.Os
39.Sh NAME
40.Nm ng_frame_relay
41.Nd frame relay netgraph node type
42.Sh SYNOPSIS
43.In netgraph/ng_frame_relay.h
44.Sh DESCRIPTION
45The
46.Nm frame_relay
47node type performs encapsulation, de-encapsulation, and multiplexing
48of packets using the frame relay protocol.
49It supports up to 1024 DLCI's.
50The LMI protocol is handled by a separate node type (see
51.Xr ng_lmi 4 ) .
52.Pp
53The
54.Dv downstream
55hook should be connected to the synchronous line, i.e., the switch.
56Then hooks
57.Dv dlci0 ,
58.Dv dlci1 ,
59through
60.Dv dlci1023
61are available to connect to each of the DLCI channels.
62.Sh HOOKS
63This node type supports the following hooks:
64.Bl -tag -width ".Va downstream"
65.It Va downstream
66The connection to the synchronous line.
67.It Va dlciX
68Here X is a decimal number from 0 to 1023.
69This hook corresponds
70to the DLCI X frame relay virtual channel.
71.El
72.Sh CONTROL MESSAGES
73This node type supports only the generic control messages.
74.Sh SHUTDOWN
75This node shuts down upon receipt of a
76.Dv NGM_SHUTDOWN
77control message, or when all hooks have been disconnected.
78.Sh SEE ALSO
79.Xr netgraph 4 ,
80.Xr ng_lmi 4 ,
81.Xr ngctl 8
82.Sh HISTORY
83The
84.Nm
85node type was implemented in
86.Fx 4.0 .
87.Sh AUTHORS
88.An Julian Elischer Aq Mt julian@FreeBSD.org
89.Sh BUGS
90Technically, frames on DLCI X should not be transmitted to the switch
91until the LMI protocol entity on both ends has configured DLCI X as active.
92The
93.Nm
94node type ignores this restriction, and will always pass data received
95on a DLCI hook to
96.Dv downstream .
97Instead, it should query the LMI node first.
98