xref: /freebsd/share/man/man4/ng_cisco.4 (revision fbad9e2d95b59d1c0403f04df62d6d7cb4ea7c4a)
14cf49a43SJulian Elischer.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
24cf49a43SJulian Elischer.\" All rights reserved.
34cf49a43SJulian Elischer.\"
44cf49a43SJulian Elischer.\" Subject to the following obligations and disclaimer of warranty, use and
54cf49a43SJulian Elischer.\" redistribution of this software, in source or object code forms, with or
64cf49a43SJulian Elischer.\" without modifications are expressly permitted by Whistle Communications;
74cf49a43SJulian Elischer.\" provided, however, that:
84cf49a43SJulian Elischer.\" 1. Any and all reproductions of the source or object code must include the
94cf49a43SJulian Elischer.\"    copyright notice above and the following disclaimer of warranties; and
104cf49a43SJulian Elischer.\" 2. No rights are granted, in any manner or form, to use Whistle
114cf49a43SJulian Elischer.\"    Communications, Inc. trademarks, including the mark "WHISTLE
124cf49a43SJulian Elischer.\"    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
134cf49a43SJulian Elischer.\"    such appears in the above copyright notice or in the software.
144cf49a43SJulian Elischer.\"
154cf49a43SJulian Elischer.\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
164cf49a43SJulian Elischer.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
174cf49a43SJulian Elischer.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
184cf49a43SJulian Elischer.\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
194cf49a43SJulian Elischer.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
204cf49a43SJulian Elischer.\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
214cf49a43SJulian Elischer.\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
224cf49a43SJulian Elischer.\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
234cf49a43SJulian Elischer.\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
244cf49a43SJulian Elischer.\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
254cf49a43SJulian Elischer.\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
264cf49a43SJulian Elischer.\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
274cf49a43SJulian Elischer.\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
284cf49a43SJulian Elischer.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
294cf49a43SJulian Elischer.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
304cf49a43SJulian Elischer.\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
314cf49a43SJulian Elischer.\" OF SUCH DAMAGE.
324cf49a43SJulian Elischer.\"
33eddc45e7SJeroen Ruigrok van der Werven.\" Author: Archie Cobbs <archie@FreeBSD.org>
344cf49a43SJulian Elischer.\"
354cf49a43SJulian Elischer.\" $FreeBSD$
364cf49a43SJulian Elischer.\" $Whistle: ng_cisco.8,v 1.5 1999/01/25 23:46:26 archie Exp $
374cf49a43SJulian Elischer.\"
384cf49a43SJulian Elischer.Dd January 19, 1999
39bec35b9aSArchie Cobbs.Dt NG_CISCO 4
403d45e180SRuslan Ermilov.Os
414cf49a43SJulian Elischer.Sh NAME
424cf49a43SJulian Elischer.Nm ng_cisco
434cf49a43SJulian Elischer.Nd Cisco HDLC protocol netgraph node type
444cf49a43SJulian Elischer.Sh SYNOPSIS
45fbad9e2dSRuslan Ermilov.In sys/types.h
4632eef9aeSRuslan Ermilov.In netinet/in.h
4732eef9aeSRuslan Ermilov.In netgraph/ng_cisco.h
484cf49a43SJulian Elischer.Sh DESCRIPTION
494cf49a43SJulian ElischerThe
504cf49a43SJulian Elischer.Nm cisco
514cf49a43SJulian Elischernode type performs encapsulation and de-encapsulation of packets
525203edcdSRuslan Ermilovusing the Cisco HDLC protocol.
535203edcdSRuslan ErmilovThis is a fairly simple
544cf49a43SJulian Elischerprotocol for the transmission of packets across
555203edcdSRuslan Ermilovhigh speed synchronous lines.
565203edcdSRuslan ErmilovEach packet is prepended with
575203edcdSRuslan Ermilovan Ethertype, indicating the protocol.
585203edcdSRuslan ErmilovThere is also a
5951291597SJulian Elischer.Dq keep alive
6051291597SJulian Elischerand an
6151291597SJulian Elischer.Dq inquire
6251291597SJulian Elischercapability.
634cf49a43SJulian Elischer.Pp
644cf49a43SJulian ElischerThe
654cf49a43SJulian Elischer.Dv downstream
665203edcdSRuslan Ermilovhook should connect to the synchronous line.
675203edcdSRuslan ErmilovOn the other side
684cf49a43SJulian Elischerof the node are the
694cf49a43SJulian Elischer.Dv inet ,
705feb7588SArchie Cobbs.Dv inet6 ,
714cf49a43SJulian Elischer.Dv atalk ,
724cf49a43SJulian Elischerand
734cf49a43SJulian Elischer.Dv ipx
745feb7588SArchie Cobbshooks, which transmit and receive raw IP, IPv6, AppleTalk, and IPX packets,
755203edcdSRuslan Ermilovrespectively.
765203edcdSRuslan ErmilovTypically these hooks would connect to the corresponding
774cf49a43SJulian Elischerhooks on an
78bec35b9aSArchie Cobbs.Xr ng_iface 4
794cf49a43SJulian Elischertype node.
804cf49a43SJulian Elischer.Sh IP Configuration
814cf49a43SJulian ElischerIn order to function properly for IP traffic, the node must be informed
825203edcdSRuslan Ermilovof the local IP address and netmask setting.
835203edcdSRuslan ErmilovThis is because the protocol
8451291597SJulian Elischerincludes an
8551291597SJulian Elischer.Dq inquire
8651291597SJulian Elischerpacket which we must be prepared to answer.
877f9d26bdSMike PritchardThere are two ways to accomplish this, manually and automatically.
884cf49a43SJulian Elischer.Pp
894cf49a43SJulian ElischerWhenever such an inquire packet is received, the node sends a
904cf49a43SJulian Elischer.Dv NGM_CISCO_GET_IPADDR
914cf49a43SJulian Elischercontrol message to the peer node connected to the
924cf49a43SJulian Elischer.Dv inet
934cf49a43SJulian Elischerhook (if any).
945203edcdSRuslan ErmilovIf the peer responds, then that response is used.
955203edcdSRuslan ErmilovThis is the automatic method.
964cf49a43SJulian Elischer.Pp
974cf49a43SJulian ElischerIf the peer does not respond, the node falls back on its cached value
985203edcdSRuslan Ermilovfor the IP address and netmask.
995203edcdSRuslan ErmilovThis cached value can be set at any time
1004cf49a43SJulian Elischerwith a
1014cf49a43SJulian Elischer.Dv NGM_CISCO_SET_IPADDR
1024cf49a43SJulian Elischermessage, and this is the manual method.
1034cf49a43SJulian Elischer.Pp
1044cf49a43SJulian ElischerIf the
1054cf49a43SJulian Elischer.Dv inet
1064cf49a43SJulian Elischerhook is connected to the
1074cf49a43SJulian Elischer.Dv inet
1084cf49a43SJulian Elischerhook of an
109bec35b9aSArchie Cobbs.Xr ng_iface 4
1104cf49a43SJulian Elischernode, as is usually the case, then configuration is automatic as the
111bec35b9aSArchie Cobbs.Xr ng_iface 4
1124cf49a43SJulian Elischerunderstands the
1134cf49a43SJulian Elischer.Dv NGM_CISCO_GET_IPADDR
1144cf49a43SJulian Elischermessage.
1154cf49a43SJulian Elischer.Sh HOOKS
1164cf49a43SJulian ElischerThis node type supports the following hooks:
1174cf49a43SJulian Elischer.Pp
1184cf49a43SJulian Elischer.Bl -tag -width foobarbazio
1194cf49a43SJulian Elischer.It Dv downstream
1204cf49a43SJulian ElischerThe connection to the synchronous line.
1214cf49a43SJulian Elischer.It Dv inet
1224cf49a43SJulian ElischerIP hook.
1235feb7588SArchie Cobbs.It Dv inet6
1245feb7588SArchie CobbsIPv6 hook.
1254cf49a43SJulian Elischer.It Dv atalk
1264cf49a43SJulian ElischerAppleTalk hook.
1274cf49a43SJulian Elischer.It Dv ipx
1284cf49a43SJulian ElischerIPX hook
1294cf49a43SJulian Elischer.El
1304cf49a43SJulian Elischer.Sh CONTROL MESSAGES
1314cf49a43SJulian ElischerThis node type supports the generic control messages, plus the following:
1324cf49a43SJulian Elischer.Bl -tag -width foo
1334cf49a43SJulian Elischer.It Dv NGM_CISCO_SET_IPADDR
1344cf49a43SJulian ElischerThis command takes an array of two
1354cf49a43SJulian Elischer.Dv "struct in_addr"
1365203edcdSRuslan Ermilovarguments.
1375203edcdSRuslan ErmilovThe first is the IP address of the corresponding interface
1384cf49a43SJulian Elischerand the second is the netmask.
1394cf49a43SJulian Elischer.It Dv NGM_CISCO_GET_IPADDR
1404cf49a43SJulian ElischerThis command returns the IP configuration in the same format used by
1414cf49a43SJulian Elischer.Dv NGM_CISCO_SET_IPADDR .
1424cf49a43SJulian ElischerThis command is also
1434cf49a43SJulian Elischer.Em sent
1444cf49a43SJulian Elischerby this node type to the
1454cf49a43SJulian Elischer.Dv inet
1464cf49a43SJulian Elischerpeer whenever an IP address inquiry packet is received.
1474cf49a43SJulian Elischer.It Dv NGM_CISCO_GET_STATUS
1484cf49a43SJulian ElischerReturns a
1494cf49a43SJulian Elischer.Dv "struct ngciscostat" :
1504cf49a43SJulian Elischer.Bd -literal -offset 4n
1514cf49a43SJulian Elischerstruct ngciscostat {
1524cf49a43SJulian Elischer  u_int32_t   seq_retries;       /* # unack'd retries */
1534cf49a43SJulian Elischer  u_int32_t   keepalive_period;  /* in seconds */
1544cf49a43SJulian Elischer};
1554cf49a43SJulian Elischer.Ed
1564cf49a43SJulian Elischer.El
1574cf49a43SJulian Elischer.Sh SHUTDOWN
1584cf49a43SJulian ElischerThis node shuts down upon receipt of a
1594cf49a43SJulian Elischer.Dv NGM_SHUTDOWN
1604cf49a43SJulian Elischercontrol message, or when all hooks have been disconnected.
1614cf49a43SJulian Elischer.Sh SEE ALSO
1624cf49a43SJulian Elischer.Xr netgraph 4 ,
163bec35b9aSArchie Cobbs.Xr ng_iface 4 ,
164bec35b9aSArchie Cobbs.Xr ngctl 8
1654cf49a43SJulian Elischer.Rs
1664cf49a43SJulian Elischer.%A D. Perkins
1674cf49a43SJulian Elischer.%T "Requirements for an Internet Standard Point-to-Point Protocol"
1684cf49a43SJulian Elischer.%O RFC 1547
1694cf49a43SJulian Elischer.Re
1704cf49a43SJulian Elischer.Sh LEGAL
17151291597SJulian Elischer.Tn Cisco
17251291597SJulian Elischeris a trademark of Cisco Systems, Inc.
17351291597SJulian Elischer.Sh HISTORY
17451291597SJulian ElischerThe
17551291597SJulian Elischer.Nm
17651291597SJulian Elischernode type was implemented in
17751291597SJulian Elischer.Fx 4.0 .
1784cf49a43SJulian Elischer.Sh AUTHORS
179eddc45e7SJeroen Ruigrok van der Werven.An Julian Elischer Aq julian@FreeBSD.org ,
180eddc45e7SJeroen Ruigrok van der Werven.An Archie Cobbs Aq archie@FreeBSD.org
1819cbda590SRuslan Ermilov.Sh BUGS
1829cbda590SRuslan ErmilovNot all of the functionality has been implemented.
1839cbda590SRuslan ErmilovFor example,
1849cbda590SRuslan Ermilovthe node does not support querying the remote end for its IP address
1859cbda590SRuslan Ermilovand netmask.
186