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