share/man/man4/ips.4

   1 .\"
   2 .\" Copyright (c) 2003 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 .Dd August 7, 2009
  27 .Dt IPS 4
  28 .Os
  29 .Sh NAME
  30 .Nm ips
  31 .Nd IBM/Adaptec ServeRAID controller driver
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device pci"
  38 .Cd "device scbus"
  39 .Cd "device ips"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 ips_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver claims to support the
  52 .Tn IBM
  53 (now Adaptec) ServeRAID series
  54 .Tn SCSI
  55 controller cards.
  56 .Pp
  57 These cards come with a built in configuration utility stored in
  58 the firmware known as the
  59 .Tn ISPR .
  60 This utility is accessed with the
  61 .Aq Em Ctrl+I
  62 key combination during the initial card
  63 .Tn POST .
  64 .Pp
  65 It is highly recommended that this utility be used to configure the card
  66 before attempting to diagnose the below error messages.
  67 .Pp
  68 In some cases, the
  69 .Nm
  70 driver can have difficulties attaching during
  71 the system initialization period.
  72 To avoid these difficulties, set the
  73 .Va hw.ips.0.disable
  74 tunable to 1.
  75 It will prevent the driver from attaching.
  76 .Sh HARDWARE
  77 Controllers supported by the
  78 .Nm
  79 driver include:
  80 .Pp
  81 .Bl -bullet -compact
  82 .It
  83 IBM ServeRAID 3H
  84 .It
  85 ServeRAID 4L/4M/4H
  86 .It
  87 ServeRAID Series 5
  88 .It
  89 ServeRAID 6i/6M
  90 .It
  91 ServeRAID 7t/7k/7M
  92 .El
  93 .Pp
  94 Newer ServeRAID controllers are supported by the
  95 .Xr aac 4
  96 or
  97 .Xr mfi 4
  98 driver.
  99 .Sh DIAGNOSTICS
 100 Several error codes may be shown when the card initializes the
 101 .Tn IBM
 102 .Tn ISPR
 103 utility and are independent of
 104 .Fx .
 105 .Bl -diag
 106 .It ips%d: failed to get adapter configuration data from device
 107 .It ips%d: failed to get drive configuration data from device
 108 .Pp
 109 Unable to obtain adapter or drive configuration.
 110 .It ips%d iobuf error
 111 .Pp
 112 A buffer input/output error has occurred.
 113 .Bq Er ENXIO
 114 .El
 115 .Ss General adapter errors :
 116 .Bl -diag
 117 .It Attaching bus failed
 118 .Pp
 119 This message is undocumented.
 120 .It WARNING: command timeout. Adapter is in toaster mode, resetting
 121 .Pp
 122 A command timeout has caused the adapter to be reset.
 123 .It AIEE! adapter reset failed, giving up and going home! Have a nice day
 124 .Pp
 125 An error occurred while attempting to reset the adapter.
 126 .It unable to get adapter configuration
 127 .It unable to get drive configuration
 128 .Pp
 129 There was an error when attempting to get configuration information.
 130 .It Adapter error during initialization.
 131 .It adapter initialization failed
 132 .Pp
 133 There was an error while attempting to initialize the adapter.
 134 .It adapter failed config check
 135 .It adapter clear failed
 136 .Pp
 137 There was an error while checking the adapter.
 138 .It device is disabled
 139 .Pp
 140 The adapter is disabled.
 141 .It resource allocation failed
 142 .It irq allocation failed
 143 .It irq setup failed
 144 .Pp
 145 The driver was unable to allocate resources for the device.
 146 .El
 147 .Ss Error messages due to DMA :
 148 .Bl -diag
 149 .It can't alloc command dma tag
 150 .It can't alloc SG dma tag
 151 .It can't alloc dma tag for statue queue
 152 .It dmamap failed
 153 .Pp
 154 Failure to map or allocate DMA resources.
 155 .El
 156 .Ss Cache, buffer, and command errors :
 157 .Bl -diag
 158 .It failed to initialize command buffers
 159 .It no mem for command slots!
 160 .Pp
 161 The
 162 .Nm
 163 driver will return
 164 .Bq Er ENOMEM
 165 in such cases.
 166 .It ERROR: unable to get a command! can't flush cache!
 167 .It ERROR: cache flush command failed!
 168 .It ERROR: unable to get a command! can't update nvram
 169 .It ERROR: nvram update command failed!
 170 .It ERROR: unable to get a command! can't sync cache!
 171 .It ERROR: cache sync command failed!
 172 .It ERROR: unable to get a command! can't sync cache!
 173 .It ERROR: etable command failed!
 174 .El
 175 .Sh COMPATIBILITY
 176 Unlike many of the other
 177 .Tn SCSI
 178 devices in
 179 .Fx ,
 180 the
 181 .Nm
 182 driver does not use the
 183 .Xr cam 4
 184 .Tn SCSI
 185 subsystem.
 186 .Sh SEE ALSO
 187 .Xr aac 4 ,
 188 .Xr ch 4 ,
 189 .Xr da 4 ,
 190 .Xr mfi 4 ,
 191 .Xr sysctl 8
 192 .Sh AUTHORS
 193 The
 194 .Nm
 195 driver was written by
 196 .An -nosplit
 197 .An David Jefferys
 198 and
 199 .An Scott Long Aq Mt scottl@FreeBSD.org .
 200 .Pp
 201 This manual page was written by
 202 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org .