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