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