1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
2 .\" All rights reserved.
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.
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
33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
36 .\" $Whistle: ng_cisco.8,v 1.5 1999/01/25 23:46:26 archie Exp $
43 .Nd Cisco HDLC protocol netgraph node type
46 .In netgraph/ng_cisco.h
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.
65 hook should connect to the synchronous line.
73 hooks, which transmit and receive raw IP, IPv6, AppleTalk, and IPX packets,
75 Typically these hooks would connect to the corresponding
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
85 packet which we must be prepared to answer.
86 There are two ways to accomplish this, manually and automatically.
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
93 If the peer responds, then that response is used.
94 This is the automatic method.
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
100 .Dv NGM_CISCO_SET_IPADDR
101 message, and this is the manual method.
105 hook is connected to the
109 node, as is usually the case, then configuration is automatic as the
112 .Dv NGM_CISCO_GET_IPADDR
115 This node type supports the following hooks:
117 .Bl -tag -width foobarbazio
119 The connection to the synchronous line.
130 This node type supports the generic control messages, plus the following:
132 .It Dv NGM_CISCO_SET_IPADDR
133 This command takes an array of two
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 .
143 by this node type to the
145 peer whenever an IP address inquiry packet is received.
146 .It Dv NGM_CISCO_GET_STATUS
148 .Dv "struct ngciscostat" :
149 .Bd -literal -offset 4n
151 u_int32_t seq_retries; /* # unack'd retries */
152 u_int32_t keepalive_period; /* in seconds */
157 This node shuts down upon receipt of a
159 control message, or when all hooks have been disconnected.
161 Not all of the functionality has been implemented.
163 the node does not support querying the remote end for its IP address
171 .%T "Requirements for an Internet Standard Point-to-Point Protocol"
176 is a trademark of Cisco Systems, Inc.
180 node type was implemented in
183 .An Julian Elischer Aq julian@FreeBSD.org ,
184 .An Archie Cobbs Aq archie@FreeBSD.org