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