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