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>
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 $
43 .Nd Cisco HDLC protocol netgraph node type
46 .In netgraph/cisco/ng_cisco.h
50 node type performs encapsulation and de-encapsulation of packets
51 using the Cisco HDLC protocol. This is a fairly simple
52 protocol for the transmission of packets across
53 high speed synchronous lines. Each packet is prepended with
54 an Ethertype, indicating the protocol. There is also a
62 hook should connect to the synchronous line. On the other side
69 hooks, which transmit and receive raw IP, IPv6, AppleTalk, and IPX packets,
70 respectively. Typically these hooks would connect to the corresponding
75 In order to function properly for IP traffic, the node must be informed
76 of the local IP address and netmask setting. This is because the protocol
79 packet which we must be prepared to answer.
80 There are two ways to accomplish this, manually and automatically.
82 Whenever such an inquire packet is received, the node sends a
83 .Dv NGM_CISCO_GET_IPADDR
84 control message to the peer node connected to the
87 If the peer responds, then that response is used. This is the automatic method.
89 If the peer does not respond, the node falls back on its cached value
90 for the IP address and netmask. This cached value can be set at any time
92 .Dv NGM_CISCO_SET_IPADDR
93 message, and this is the manual method.
97 hook is connected to the
101 node, as is usually the case, then configuration is automatic as the
104 .Dv NGM_CISCO_GET_IPADDR
107 This node type supports the following hooks:
108 .Bl -tag -width foobarbazio
110 The connection to the synchronous line.
121 This node type supports the generic control messages, plus the following:
123 .It Dv NGM_CISCO_SET_IPADDR
124 This command takes an array of two
126 arguments. The first is the IP address of the corresponding interface
127 and the second is the netmask.
128 .It Dv NGM_CISCO_GET_IPADDR
129 This command returns the IP configuration in the same format used by
130 .Dv NGM_CISCO_SET_IPADDR .
133 by this node type to the
135 peer whenever an IP address inquiry packet is received.
136 .It Dv NGM_CISCO_GET_STATUS
138 .Dv "struct ngciscostat" :
139 .Bd -literal -offset 4n
141 u_int32_t seq_retries; /* # unack'd retries */
142 u_int32_t keepalive_period; /* in seconds */
147 This node shuts down upon receipt of a
149 control message, or when all hooks have been disconnected.
156 .%T "Requirements for an Internet Standard Point-to-Point Protocol"
161 is a trademark of Cisco Systems, Inc.
165 node type was implemented in
168 .An Julian Elischer Aq Mt julian@FreeBSD.org
169 .An Archie Cobbs Aq Mt archie@FreeBSD.org
171 Not all of the functionality has been implemented. For example,
172 the node does not support querying the remote end for its IP address