share/man/man4/ng_rfc1490.4

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