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 .Cd device scbus
  36 .Cd device esp
  37 .Sh HARDWARE
  38 The
  39 .Nm
  40 driver provides support for the
  41 .Tn Qlogic
  42 FAS216 and FAS408
  43 .Tn SCSI
  44 controller chips found in a wide variety of systems and peripheral boards.
  45 This includes the
  46 .Tn Qlogic
  47 .Tn SCSI
  48 cards found in most
  49 .Tn Sun
  50 .Tn Ultra 1e
  51 and
  52 .Tn Ultra 2
  53 machines.
  54 .Pp
  55 For
  56 .Tn Qlogic
  57 .Tn PCI
  58 .Tn SCSI
  59 host adapters, the
  60 .Xr isp 4
  61 driver should be used in place of the
  62 .Nm
  63 driver.
  64 .Sh IMPLEMENTATION NOTES
  65 During the boot sequence, the
  66 .Nm
  67 driver
  68 searches the linked list for LUN info by LUN ID.
  69 At this point the driver will attach on that instance,
  70 and then attempt to attach every sub-device.
  71 .Pp
  72 There are at least 4 variations of the
  73 configuration 3 register.
  74 A second config register must be loaded to inquire the chip revision,
  75 otherwise the
  76 .Fn ncr53c9x_reset
  77 function will not set the defaults correctly.
  78 .Pp
  79 The drive attach routine attempts to set the appropriate
  80 bit to put the chip into Fast
  81 .Tn SCSI
  82 mode so that it does not
  83 have to be figured out each time.
  84 This will then be stored in the
  85 .Tn NCR
  86 registers for later use.
  87 .Pp
  88 The
  89 .Nm
  90 driver makes use of the
  91 .Tn LSI
  92 64854
  93 .Tn DMA
  94 engine which contains three independent
  95 channels designed to interface with
  96 an NCR539X
  97 .Tn SCSI
  98 controller;
  99 an AM7990 Ethernet controller;
 100 and certain types of parallel port hardware.
 101 As such this driver may eventually replace the
 102 .Xr amd 4
 103 driver for network hardware.
 104 .Sh DIAGNOSTICS
 105 The following driver specific error messages
 106 may be reported:
 107 .Bl -diag
 108 .It "esp: cannot map %d segments"
 109 The device was unable to map segments while mapping the
 110 .Tn SCSI
 111 devices in
 112 .Tn DMA
 113 mode.
 114 .It "unknown variant %d, devices not attached"
 115 An unknown version of the card was found and devices will
 116 not be attached.
 117 .It "Unhandled function code %d"
 118 The device returned a function code which the driver is
 119 unable to handle, most likely during negotiation.
 120 .It "esp:%d:%d: selection failed %d left in FIFO"
 121 The target left the command phase prematurely.
 122 If a command did not reach the device then it will
 123 be reported as shown above.
 124 .It "invalid state: %d"
 125 The device has reached an invalid state.
 126 .El
 127 .Sh SEE ALSO
 128 .Xr amd 4 ,
 129 .Xr isp 4 ,
 130 .Xr scbus 4 ,
 131 .Xr camcontrol 8
 132 .Pp
 133 .Bl -item -compact
 134 .It
 135 .Pa http://www.qlc.com/
 136 .It
 137 .Pa http://www.sun.com/
 138 .El
 139 .Sh HISTORY
 140 The
 141 .Nm
 142 driver was written for
 143 .Nx
 144 by
 145 .An Eric S. Hvozda .
 146 The
 147 .Nm
 148 driver was then ported to
 149 .Fx 5.3
 150 by
 151 .An Scott Long Aq scottl@FreeBSD.org .
 152 .Sh AUTHORS
 153 This manual page was written by
 154 .An Tom Rhodes Aq trhodes@FreeBSD.org
 155 instead of porting the original from
 156 .Nx .
 157 .Sh BUGS
 158 The
 159 .Nm
 160 driver includes the sbus front-end but lacks the
 161 .Tn PCI
 162 front-end.
 163 Thus it can only support the
 164 .Tn FEPS/FAS366
 165 .Tn SCSI
 166 found in
 167 .Tn Sun
 168 .Tn Ultra 1e
 169 and
 170 .Tn Ultra 2
 171 machines at this time.
 172 .Pp
 173 This driver should eventually replace the
 174 .Xr amd 4
 175 driver, but that requires porting the
 176 .Tn PCI
 177 front-end mentioned above.