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