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