usr.sbin/eshconfig/eshconfig.8

   1 .\"     $NetBSD: eshconfig.8,v 1.7 2005/06/17 18:22:18 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 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 June 17, 2005
  32 .Dt ESHCONFIG 8
  33 .Os
  34 .Sh NAME
  35 .Nm eshconfig
  36 .Nd configure Essential Communications' HIPPI network interface
  37 .Sh SYNOPSIS
  38 .Nm eshconfig
  39 .Op Fl estx
  40 .Op Fl b Ar bytes
  41 .Op Fl c Ar bytes
  42 .Op Fl d Ar filename
  43 .Op Fl i Ar usecs
  44 .Op Fl m Ar bytes
  45 .Op Fl r Ar bytes
  46 .Op Fl u Ar filename
  47 .Op Fl w Ar bytes
  48 .Op Ar interface
  49 .Sh DESCRIPTION
  50 .Nm
  51 is used to configure device-specific parameters and download new firmware
  52 to the Essential Communications RoadRunner-based HIPPI network interface.
  53 The interface is very sensitive to the DMA performance characteristics
  54 of the host, and so requires careful tuning to achieve reasonable
  55 performance.
  56 In addition, firmware is likely to change frequently, which necessitates
  57 a reasonably easy way to update that firmware.
  58 .Pp
  59 Available operands for
  60 .Nm eshconfig :
  61 .Bl -tag -width Ds
  62 .It Fl b Ar bytes
  63 Adjust the burst size for read (by NIC of host memory) DMA.
  64 .It Fl c Ar bytes
  65 Adjust the burst size for write (by NIC of host memory) DMA.
  66 .It Fl d Ar filename
  67 Filename for file to download into NIC firmware.
  68 This must be a file in the standard Essential format, with :04 preceding
  69 every line, and a tag line at the end indicating the characteristics
  70 of the firmware file.
  71 .It Fl e
  72 Write data to EEPROM.
  73 Normally, setting tuning parameters will only persist until the
  74 system is rebooted.
  75 Setting this parameter ensures that the changes will be written to
  76 EEPROM.
  77 .It Fl i Ar usecs
  78 Interrupt delay in microseconds.
  79 .It Fl m Ar bytes
  80 Minimum number of bytes to DMA in one direction (read or write)
  81 before allowing a DMA in the other direction.
  82 Tuning this prevents one direction from dominating the flow of
  83 bytes, and artificially throttling the NIC.
  84 .It Fl r Ar bytes
  85 Bytes before DMA starts for read (from host to NIC).
  86 This controls how soon the DMA is triggered;  until this many bytes
  87 are requested, the DMA will not begin.
  88 .It Fl s
  89 Show statistics for the HIPPI NIC.
  90 Repeat the option to suppress non-zero statistics.
  91 .It Fl t
  92 Show current tuning parameters on the host.
  93 .It Fl u Ar filename
  94 Name of file to which the NIC firmware should be uploaded.
  95 Not currently supported.
  96 .It Fl w Ar bytes
  97 Number of bytes required before write (from NIC to host) DMA
  98 is started.
  99 Until this many bytes are ready to be written, the DMA will not start.
 100 .It Fl x
 101 Reset the NIC.
 102 This is necessary for the HIPPI-FP support, as
 103 .Xr ifconfig 8
 104 will no longer physically reset the NIC when the interfaces goes
 105 up and down.
 106 .El
 107 .Pp
 108 Only the super-user may modify the configuration of a network interface.
 109 .Sh DIAGNOSTICS
 110 Messages indicating the specified interface does not exist
 111 or the user is not privileged and
 112 tried to alter an interface's configuration.
 113 .Sh SEE ALSO
 114 .Xr esh 4 ,
 115 .Xr ifconfig 8
 116 .Sh HISTORY
 117 The
 118 .Nm
 119 command first appeared in
 120 .Nx 1.4 .