share/man/man4/esp.4

   1 .\"
   2 .\" Copyright (c) 2004 Tom Rhodes
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd September 18, 2005
  29 .Dt ESP 4
  30 .Os
  31 .Sh NAME
  32 .Nm esp
  33 .Nd Qlogic FEPS and FAS366 SCSI driver
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device scbus"
  40 .Cd "device esp"
  41 .Ed
  42 .Sh HARDWARE
  43 The
  44 .Nm
  45 driver provides support for the
  46 .Tn Qlogic
  47 FAS216 and FAS408
  48 .Tn SCSI
  49 controller chips found in a wide variety of systems and peripheral boards.
  50 This includes the
  51 .Tn Qlogic
  52 .Tn SCSI
  53 cards found in most
  54 .Tn Sun
  55 .Tn Ultra 1e
  56 and
  57 .Tn Ultra 2
  58 machines.
  59 .Pp
  60 For
  61 .Tn Qlogic
  62 .Tn PCI
  63 .Tn SCSI
  64 host adapters, the
  65 .Xr isp 4
  66 driver should be used in place of the
  67 .Nm
  68 driver.
  69 .Sh IMPLEMENTATION NOTES
  70 During the boot sequence, the
  71 .Nm
  72 driver
  73 searches the linked list for LUN info by LUN ID.
  74 At this point the driver will attach on that instance,
  75 and then attempt to attach every sub-device.
  76 .Pp
  77 There are at least 4 variations of the
  78 configuration 3 register.
  79 A second config register must be loaded to inquire the chip revision,
  80 otherwise the
  81 .Fn ncr53c9x_reset
  82 function will not set the defaults correctly.
  83 .Pp
  84 The drive attach routine attempts to set the appropriate
  85 bit to put the chip into Fast
  86 .Tn SCSI
  87 mode so that it does not
  88 have to be figured out each time.
  89 This will then be stored in the
  90 .Tn NCR
  91 registers for later use.
  92 .Pp
  93 The
  94 .Nm
  95 driver makes use of the
  96 .Tn LSI
  97 64854
  98 .Tn DMA
  99 engine which contains three independent
 100 channels designed to interface with
 101 an NCR539X
 102 .Tn SCSI
 103 controller;
 104 an AM7990 Ethernet controller;
 105 and certain types of parallel port hardware.
 106 As such this driver may eventually replace the
 107 .Xr amd 4
 108 driver for network hardware.
 109 .Sh DIAGNOSTICS
 110 The following driver specific error messages
 111 may be reported:
 112 .Bl -diag
 113 .It "esp: cannot map %d segments"
 114 The device was unable to map segments while mapping the
 115 .Tn SCSI
 116 devices in
 117 .Tn DMA
 118 mode.
 119 .It "unknown variant %d, devices not attached"
 120 An unknown version of the card was found and devices will
 121 not be attached.
 122 .It "Unhandled function code %d"
 123 The device returned a function code which the driver is
 124 unable to handle, most likely during negotiation.
 125 .It "esp:%d:%d: selection failed %d left in FIFO"
 126 The target left the command phase prematurely.
 127 If a command did not reach the device then it will
 128 be reported as shown above.
 129 .It "invalid state: %d"
 130 The device has reached an invalid state.
 131 .El
 132 .Sh SEE ALSO
 133 .Xr amd 4 ,
 134 .Xr isp 4 ,
 135 .Xr scbus 4 ,
 136 .Xr camcontrol 8
 137 .Pp
 138 .Bl -item -compact
 139 .It
 140 .Pa http://www.qlc.com/
 141 .It
 142 .Pa http://www.sun.com/
 143 .El
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 driver was written for
 148 .Nx
 149 by
 150 .An Eric S. Hvozda .
 151 The
 152 .Nm
 153 driver was then ported to
 154 .Fx 5.3
 155 by
 156 .An Scott Long Aq scottl@FreeBSD.org .
 157 .Sh AUTHORS
 158 This manual page was written by
 159 .An Tom Rhodes Aq trhodes@FreeBSD.org
 160 instead of porting the original from
 161 .Nx .
 162 .Sh BUGS
 163 The
 164 .Nm
 165 driver includes the sbus front-end but lacks the
 166 .Tn PCI
 167 front-end.
 168 Thus it can only support the
 169 .Tn FEPS/FAS366
 170 .Tn SCSI
 171 found in
 172 .Tn Sun
 173 .Tn Ultra 1e
 174 and
 175 .Tn Ultra 2
 176 machines at this time.
 177 .Pp
 178 This driver should eventually replace the
 179 .Xr amd 4
 180 driver, but that requires porting the
 181 .Tn PCI
 182 front-end mentioned above.