share/man/man4/ciss.4

   1 .\" $FreeBSD$
   2 .\" Written by Tom Rhodes
   3 .\" This file is in the public domain.
   4 .\"
   5 .Dd January 26, 2012
   6 .Dt CISS 4
   7 .Os
   8 .Sh NAME
   9 .Nm ciss
  10 .Nd Common Interface for SCSI-3 Support driver
  11 .Sh SYNOPSIS
  12 To compile this driver into the kernel,
  13 place the following lines in your
  14 kernel configuration file:
  15 .Bd -ragged -offset indent
  16 .Cd "device scbus"
  17 .Cd "device ciss"
  18 .Ed
  19 .Pp
  20 Alternatively, to load the driver as a
  21 module at boot time, place the following line in
  22 .Xr loader.conf 5 :
  23 .Bd -literal -offset indent
  24 ciss_load="YES"
  25 .Ed
  26 .Sh DESCRIPTION
  27 The
  28 .Nm
  29 driver claims to provide a common interface between generic SCSI
  30 transports and intelligent host adapters.
  31 .Pp
  32 The
  33 .Nm
  34 driver supports
  35 .Em CISS
  36 as defined in the document entitled
  37 .%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" ,
  38 dated 2000/11/27, produced by Compaq Computer Corporation.
  39 .Pp
  40 We provide a shim layer between the
  41 .Nm
  42 interface and
  43 .Xr CAM 4 ,
  44 offloading most of the queueing and being-a-disk chores onto CAM.
  45 Entry to the driver is via the PCI bus attachment
  46 .Fn ciss_probe ,
  47 .Fn ciss_attach ,
  48 etc.\& and via the CAM interface
  49 .Fn ciss_cam_action ,
  50 and
  51 .Fn ciss_cam_poll .
  52 The Compaq
  53 .Nm
  54 adapters require faked responses to get reasonable
  55 behavior out of them.
  56 In addition, the
  57 .Nm
  58 command set is by no means adequate to support the functionality
  59 of a RAID controller,
  60 and thus the supported Compaq adapters utilize portions of the
  61 control protocol from earlier Compaq adapter families.
  62 .Pp
  63 Currently
  64 .Nm
  65 supports the
  66 .Dq simple
  67 and
  68 .Dq performant
  69 transport layer.
  70 .Pp
  71 Non-disk devices (such as internal DATs and devices
  72 attached to the external SCSI bus) are supported as normal CAM devices
  73 provided that they are exported by the controller firmware and are not
  74 marked as being masked.
  75 Masked devices can be exposed by setting the
  76 .Va hw.ciss.expose_hidden_physical
  77 tunable to non-zero at boot time.
  78 Direct Access devices (such as disk
  79 drives) are only exposed as
  80 .Xr pass 4
  81 devices.
  82 Hot-insertion and removal of devices is supported and notification messages
  83 will be reported to the console and logs.
  84 .Pp
  85 The problem which adapter freezes with the message
  86 .Dq ADAPTER HEARTBEAT FAILED
  87 might be solved by updating the firmware and/or setting the
  88 .Va hw.ciss.nop_message_heartbeat
  89 tunable to non-zero at boot time.
  90 .Sh HARDWARE
  91 Controllers supported by the
  92 .Nm
  93 driver include:
  94 .Pp
  95 .Bl -bullet -compact
  96 .It
  97 Compaq Smart Array 5300 (simple mode only)
  98 .It
  99 Compaq Smart Array 532
 100 .It
 101 Compaq Smart Array 5i
 102 .It
 103 HP Smart Array 5312
 104 .It
 105 HP Smart Array 6i
 106 .It
 107 HP Smart Array 641
 108 .It
 109 HP Smart Array 642
 110 .It
 111 HP Smart Array 6400
 112 .It
 113 HP Smart Array 6400 EM
 114 .It
 115 HP Smart Array E200
 116 .It
 117 HP Smart Array E200i
 118 .It
 119 HP Smart Array P212
 120 .It
 121 HP Smart Array P220i
 122 .It
 123 HP Smart Array P222
 124 .It
 125 HP Smart Array P230i
 126 .It
 127 HP Smart Array P400
 128 .It
 129 HP Smart Array P400i
 130 .It
 131 HP Smart Array P410
 132 .It
 133 HP Smart Array P410i
 134 .It
 135 HP Smart Array P411
 136 .It
 137 HP Smart Array P420
 138 .It
 139 HP Smart Array P420i
 140 .It
 141 HP Smart Array P421
 142 .It
 143 HP Smart Array P430
 144 .It
 145 HP Smart Array P430i
 146 .It
 147 HP Smart Array P431
 148 .It
 149 HP Smart Array P530
 150 .It
 151 HP Smart Array P531
 152 .It
 153 HP Smart Array P600
 154 .It
 155 HP Smart Array P721m
 156 .It
 157 HP Smart Array P731m
 158 .It
 159 HP Smart Array P800
 160 .It
 161 HP Smart Array P812
 162 .It
 163 HP Smart Array P830
 164 .It
 165 HP Smart Array P830i
 166 .It
 167 HP Modular Smart Array 20 (MSA20)
 168 .It
 169 HP Modular Smart Array 500 (MSA500)
 170 .El
 171 .Sh SEE ALSO
 172 .Xr cam 4 ,
 173 .Xr pass 4 ,
 174 .Xr xpt 4 ,
 175 .Xr loader.conf 5 ,
 176 .Xr camcontrol 8
 177 .Rs
 178 .%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1"
 179 .%D 2000/11/27
 180 .%Q "Compaq Computer Corporation"
 181 .Re
 182 .Sh AUTHORS
 183 .An -nosplit
 184 The
 185 .Nm
 186 driver was written by
 187 .An Mike Smith Aq msmith@FreeBSD.org .
 188 .Pp
 189 This manual page is based on his comments and was written by
 190 .An Tom Rhodes Aq trhodes@FreeBSD.org .