share/man/man4/ng_cisco.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: src/share/man/man4/ng_cisco.4,v 1.11.2.1 2001/12/21 09:00:51 ru Exp $
  36 .\" $Whistle: ng_cisco.8,v 1.5 1999/01/25 23:46:26 archie Exp $
  37 .\"
  38 .Dd January 19, 1999
  39 .Dt NG_CISCO 4
  40 .Os
  41 .Sh NAME
  42 .Nm ng_cisco
  43 .Nd Cisco HDLC protocol netgraph node type
  44 .Sh SYNOPSIS
  45 .In netinet/in.h
  46 .In netgraph/ng_cisco.h
  47 .Sh DESCRIPTION
  48 The
  49 .Nm cisco
  50 node type performs encapsulation and de-encapsulation of packets
  51 using the Cisco HDLC protocol. This is a fairly simple
  52 protocol for the transmission of packets across
  53 high speed synchronous lines. Each packet is prepended with
  54 an Ethertype, indicating the protocol. There is also a
  55 .Dq keep alive
  56 and an
  57 .Dq inquire
  58 capability.
  59 .Pp
  60 The
  61 .Dv downstream
  62 hook should connect to the synchronous line. On the other side
  63 of the node are the
  64 .Dv inet ,
  65 .Dv inet6 ,
  66 .Dv atalk ,
  67 and
  68 .Dv ipx
  69 hooks, which transmit and receive raw IP, IPv6, AppleTalk, and IPX packets,
  70 respectively.  Typically these hooks would connect to the corresponding
  71 hooks on an
  72 .Xr ng_iface 4
  73 type node.
  74 .Sh IP Configuration
  75 In order to function properly for IP traffic, the node must be informed
  76 of the local IP address and netmask setting.  This is because the protocol
  77 includes an
  78 .Dq inquire
  79 packet which we must be prepared to answer.
  80 There are two ways to accomplish this, manually and automatically.
  81 .Pp
  82 Whenever such an inquire packet is received, the node sends a
  83 .Dv NGM_CISCO_GET_IPADDR
  84 control message to the peer node connected to the
  85 .Dv inet
  86 hook (if any).
  87 If the peer responds, then that response is used. This is the automatic method.
  88 .Pp
  89 If the peer does not respond, the node falls back on its cached value
  90 for the IP address and netmask. This cached value can be set at any time
  91 with a
  92 .Dv NGM_CISCO_SET_IPADDR
  93 message, and this is the manual method.
  94 .Pp
  95 If the
  96 .Dv inet
  97 hook is connected to the
  98 .Dv inet
  99 hook of an
 100 .Xr ng_iface 4
 101 node, as is usually the case, then configuration is automatic as the
 102 .Xr ng_iface 4
 103 understands the
 104 .Dv NGM_CISCO_GET_IPADDR
 105 message.
 106 .Sh HOOKS
 107 This node type supports the following hooks:
 108 .Pp
 109 .Bl -tag -width foobarbazio
 110 .It Dv downstream
 111 The connection to the synchronous line.
 112 .It Dv inet
 113 IP hook.
 114 .It Dv inet6
 115 IPv6 hook.
 116 .It Dv atalk
 117 AppleTalk hook.
 118 .It Dv ipx
 119 IPX hook
 120 .El
 121 .Sh CONTROL MESSAGES
 122 This node type supports the generic control messages, plus the following:
 123 .Bl -tag -width foo
 124 .It Dv NGM_CISCO_SET_IPADDR
 125 This command takes an array of two
 126 .Dv "struct in_addr"
 127 arguments. The first is the IP address of the corresponding interface
 128 and the second is the netmask.
 129 .It Dv NGM_CISCO_GET_IPADDR
 130 This command returns the IP configuration in the same format used by
 131 .Dv NGM_CISCO_SET_IPADDR .
 132 This command is also
 133 .Em sent
 134 by this node type to the
 135 .Dv inet
 136 peer whenever an IP address inquiry packet is received.
 137 .It Dv NGM_CISCO_GET_STATUS
 138 Returns a
 139 .Dv "struct ngciscostat" :
 140 .Bd -literal -offset 4n
 141 struct ngciscostat {
 142   u_int32_t   seq_retries;       /* # unack'd retries */
 143   u_int32_t   keepalive_period;  /* in seconds */
 144 };
 145 .Ed
 146 .El
 147 .Sh SHUTDOWN
 148 This node shuts down upon receipt of a
 149 .Dv NGM_SHUTDOWN
 150 control message, or when all hooks have been disconnected.
 151 .Sh BUGS
 152 Not all of the functionality has been implemented. For example,
 153 the node does not support querying the remote end for its IP address
 154 and netmask.
 155 .Sh SEE ALSO
 156 .Xr netgraph 4 ,
 157 .Xr ng_iface 4 ,
 158 .Xr ngctl 8
 159 .Rs
 160 .%A D. Perkins
 161 .%T "Requirements for an Internet Standard Point-to-Point Protocol"
 162 .%O RFC 1547
 163 .Re
 164 .Sh LEGAL
 165 .Tn Cisco
 166 is a trademark of Cisco Systems, Inc.
 167 .Sh HISTORY
 168 The
 169 .Nm
 170 node type was implemented in
 171 .Fx 4.0 .
 172 .Sh AUTHORS
 173 .An Julian Elischer Aq julian@FreeBSD.org ,
 174 .An Archie Cobbs Aq archie@FreeBSD.org