xref: /dragonfly/share/man/man4/ng_rfc1490.4 (revision 984263bc)
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_rfc1490.4,v 1.11.2.1 2001/12/21 09:00:51 ru Exp $
36.\" $Whistle: ng_rfc1490.8,v 1.4 1999/01/25 23:46:27 archie Exp $
37.\"
38.Dd January 19, 1999
39.Dt NG_RFC1490 4
40.Os
41.Sh NAME
42.Nm ng_rfc1490
43.Nd RFC 1490 netgraph node type
44.Sh SYNOPSIS
45.In netgraph/ng_rfc1490.h
46.Sh DESCRIPTION
47The
48.Nm rfc1490
49node type performs protocol encapsulation, de-encapsulation, and
50multiplexing according to RFC 1490 (which has since been updated by RFC 2427).
51This particular type of encapsulation is often used on top of frame relay
52DLCI channels.
53.Pp
54The
55.Dv downstream
56hook is used to transmit and receive encapsulated frames. On the other
57side of the node, the
58.Dv inet
59and
60.Dv ppp
61hooks are used to transmit and receive raw IP frames and PPP frames,
62respectively. PPP frames are transmitted and received according to
63RFC 1973; in particular, frames appearing on the
64.Dv ppp
65hook begin with the PPP protocol number.
66.Pp
67Typically the
68.Dv inet
69hook is connected to the
70.Dv inet
71hook of an
72.Xr ng_iface 4
73node.
74.Sh HOOKS
75This node type supports the following hooks:
76.Pp
77.Bl -tag -width foobarbazum
78.It Dv downstream
79Connects to the RFC 1490 peer entity.
80.It Dv inet
81Transmits and receives raw IP frames.
82.It Dv ppp
83Transmits and receives PPP frames.
84.El
85.Sh CONTROL MESSAGES
86This node type only supports the generic control messages.
87.Sh SHUTDOWN
88This node shuts down upon receipt of a
89.Dv NGM_SHUTDOWN
90control message, or when all hooks have been disconnected.
91.Sh BUGS
92Not all of RFC 1490 is implemented.
93.Sh SEE ALSO
94.Xr netgraph 4 ,
95.Xr ng_frame_relay 4 ,
96.Xr ng_iface 4 ,
97.Xr ngctl 8
98.Rs
99.%A C. Brown
100.%A A. Malis
101.%T "Multiprotocol Interconnect over Frame Relay"
102.%O RFC 2427
103.Re
104.Rs
105.%A W. Simpson
106.%T "PPP in Frame Relay"
107.%O RFC 1973
108.Re
109.Sh HISTORY
110The
111.Nm
112node type was implemented in
113.Fx 4.0 .
114.Sh AUTHORS
115.An Julian Elischer Aq julian@FreeBSD.org
116