share/man/man4/esh.4

   1 .\"     $NetBSD: esh.4,v 1.9 2001/09/19 00:49:58 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Kevin Lahey of the Numerical Aerospace Simulation Facility,
   8 .\" NASA Ames Research Center.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 .\" POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd January 28, 1998
  32 .Dt ESH 4
  33 .Os
  34 .Sh NAME
  35 .Nm esh
  36 .Nd RoadRunner-based HIPPI interfaces device driver
  37 .Sh SYNOPSIS
  38 .Cd "esh* at pci? dev ? function ?"
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 device driver supports the Essential Communications RoadRunner-based
  43 HIPPI interfaces.  With some modifications, the driver could be
  44 made to support the Gigabit Ethernet card based on the same chip.
  45 .Pp
  46 The driver supports both a normal network interface and a raw
  47 HIPPI Framing Protocol (HIPPI-FP) device.
  48 The HIPPI-FP interface is accessed via the
  49 .Pa /dev/esh Ns Sy N/ulp Ns Sy N
  50 set of devices.  There are 255 available Upper Layer Protocols
  51 in FP;  these are selectable via the various device entries.
  52 .Pp
  53 HIPPI is an 800-megabit/sec networking technology which supports
  54 extremely large packet sizes.  In order to efficiently use this
  55 network, the kernel should be configured with extra mbufs, and
  56 the default socket buffer size should be increased to at least
  57 192KB, regardless of the expected bandwidth-delay product of the
  58 network.
  59 .Pp
  60 HIPPI ARP is not widely used, and the
  61 .Nx
  62 stack does not support it
  63 (yet).  In order to define the mappings between IP addresses and
  64 ifields (the HIPPI MAC addresses), the administrator must make
  65 link-layer entries in the routing table using the
  66 .Xr route 8
  67 command:
  68 .Bd -unfilled -offset indent
  69 route add -interface 129.99.154.101 -llinfo -link esh0:3.0.0.65
  70 .Ed
  71 .\" .Sh OPTIONS
  72 .Sh MEDIA SELECTION
  73 Media selection is not yet supported for this device.
  74 .\" .Sh DIAGNOSTICS
  75 .Sh SEE ALSO
  76 .Xr intro 4 ,
  77 .Xr pci 4 ,
  78 .Xr eshconfig 8 ,
  79 .Xr ifconfig 8 ,
  80 .Xr route 8
  81 .Sh BUGS
  82 The card must be tuned for proper and efficient DMA operation.
  83 The appropriate values vary based on the system.
  84 The
  85 .Xr eshconfig 8
  86 program is used for this.