xref: /freebsd/share/man/man4/ng_rfc1490.4 (revision 069ac184)
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_rfc1490.8,v 1.4 1999/01/25 23:46:27 archie Exp $
35.\"
36.Dd January 19, 1999
37.Dt NG_RFC1490 4
38.Os
39.Sh NAME
40.Nm ng_rfc1490
41.Nd RFC 1490 netgraph node type
42.Sh SYNOPSIS
43.In netgraph/ng_rfc1490.h
44.Sh DESCRIPTION
45The
46.Nm rfc1490
47node type performs protocol encapsulation, de-encapsulation, and
48multiplexing according to RFC 1490 (which has since been updated by RFC 2427).
49This particular type of encapsulation is often used on top of frame relay
50DLCI channels.
51.Pp
52The
53.Dv downstream
54hook is used to transmit and receive encapsulated frames.
55On the other side of the node, the
56.Dv inet
57and
58.Dv ppp
59hooks are used to transmit and receive raw IP frames and PPP frames,
60respectively.
61PPP frames are transmitted and received according to
62RFC 1973; in particular, frames appearing on the
63.Dv ppp
64hook begin with the PPP protocol number.
65The
66.Dv ethernet
67hook can be used to transmit and receive Ethernet frames (without a
68checksum) in RFC 1490's bridging format.
69.Pp
70Typically the
71.Dv inet
72hook is connected to the
73.Dv inet
74hook of an
75.Xr ng_iface 4
76node.
77.Sh HOOKS
78This node type supports the following hooks:
79.Bl -tag -width ".Va downstream"
80.It Va downstream
81Connects to the RFC 1490 peer entity.
82.It Va ethernet
83Transmits and receives bridged raw Ethernet frames, without a checksum.
84.It Va inet
85Transmits and receives raw IP frames.
86.It Va ppp
87Transmits and receives PPP frames.
88.El
89.Sh CONTROL MESSAGES
90This node type supports the generic control messages, plus the following:
91.Bl -tag -width foo
92.It Dv NGM_RFC1490_SET_ENCAP Pq Ic setencap
93This command sets encapsulation method for the node.
94The desired method must be passed as a string message argument,
95and must be one of the following supported encapsulation modes:
96.Bl -tag -width ".Qq Li ietf-snap"
97.It Qq Li ietf-ip
98IP packets are sent using simple RFC1490/2427 encapsulation.
99.It Qq Li ietf-snap
100IP packets are sent inside SNAP frames.
101Also conforms to RFC1490/2427.
102.It Qq Li cisco
103IP packets are sent and received using proprietary Cisco encapsulation
104method.
105.El
106.It Dv NGM_RFC1490_GET_ENCAP Pq Ic getencap
107This command returns current encapsulation method on the node.
108.El
109.Sh SHUTDOWN
110This node shuts down upon receipt of a
111.Dv NGM_SHUTDOWN
112control message, or when all hooks have been disconnected.
113.Sh SEE ALSO
114.Xr netgraph 4 ,
115.Xr ng_frame_relay 4 ,
116.Xr ng_iface 4 ,
117.Xr ngctl 8
118.Rs
119.%A C. Brown
120.%A A. Malis
121.%T "Multiprotocol Interconnect over Frame Relay"
122.%O RFC 2427
123.Re
124.Rs
125.%A W. Simpson
126.%T "PPP in Frame Relay"
127.%O RFC 1973
128.Re
129.Pp
130.Pa http://www.cisco.com/warp/public/121/frf8modes.pdf
131.Sh HISTORY
132The
133.Nm
134node type was implemented in
135.Fx 4.0 .
136.Sh AUTHORS
137.An Julian Elischer Aq Mt julian@FreeBSD.org
138.Sh BUGS
139Not all of RFC 1490 is implemented.
140