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 only supports the
  66 .Dq simple
  67 transport layer over PCI.
  68 This interface (ab)uses the I2O register set (specifically the post
  69 queues) to exchange commands with the adapter.
  70 Other interfaces are available, but we are not supposed to know about them,
  71 and it is dubious whether they would provide major performance improvements
  72 except under extreme load.
  73 .Pp
  74 Non-disk devices (such as internal DATs and devices
  75 attached to the external SCSI bus) are supported as normal CAM devices
  76 provided that they are exported by the controller firmware and are not
  77 marked as being masked.
  78 Masked devices can be exposed by setting the
  79 .Va hw.ciss.expose_hidden_physical
  80 tunable to non-zero at boot time.
  81 Direct Access devices (such as disk
  82 drives) are only exposed as
  83 .Xr pass 4
  84 devices.
  85 Hot-insertion and removal of devices is supported but a bus
  86 rescan might be necessary.
  87 .Pp
  88 The problem which adapter freezes with the message
  89 .Dq ADAPTER HEARTBEAT FAILED
  90 might be solved by updating the firmware and/or setting the
  91 .Va hw.ciss.nop_message_heartbeat
  92 tunable to non-zero at boot time.
  93 .Sh HARDWARE
  94 Controllers supported by the
  95 .Nm
  96 driver include:
  97 .Pp
  98 .Bl -bullet -compact
  99 .It
 100 Compaq Smart Array 5300
 101 .It
 102 Compaq Smart Array 532
 103 .It
 104 Compaq Smart Array 5i
 105 .It
 106 HP Smart Array 5312
 107 .It
 108 HP Smart Array 6i
 109 .It
 110 HP Smart Array 641
 111 .It
 112 HP Smart Array 642
 113 .It
 114 HP Smart Array 6400
 115 .It
 116 HP Smart Array 6400 EM
 117 .It
 118 HP Smart Array E200
 119 .It
 120 HP Smart Array E200i
 121 .It
 122 HP Smart Array P212
 123 .It
 124 HP Smart Array P220i
 125 .It
 126 HP Smart Array P222
 127 .It
 128 HP Smart Array P400
 129 .It
 130 HP Smart Array P400i
 131 .It
 132 HP Smart Array P410
 133 .It
 134 HP Smart Array P410i
 135 .It
 136 HP Smart Array P411
 137 .It
 138 HP Smart Array P420
 139 .It
 140 HP Smart Array P420i
 141 .It
 142 HP Smart Array P421
 143 .It
 144 HP Smart Array P600
 145 .It
 146 HP Smart Array P721m
 147 .It
 148 HP Smart Array P800
 149 .It
 150 HP Smart Array P812
 151 .It
 152 HP Modular Smart Array 20 (MSA20)
 153 .It
 154 HP Modular Smart Array 500 (MSA500)
 155 .El
 156 .Sh SEE ALSO
 157 .Xr cam 4 ,
 158 .Xr pass 4 ,
 159 .Xr xpt 4 ,
 160 .Xr loader.conf 5 ,
 161 .Xr camcontrol 8
 162 .Rs
 163 .%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1"
 164 .%D 2000/11/27
 165 .%Q "Compaq Computer Corporation"
 166 .Re
 167 .Sh AUTHORS
 168 .An -nosplit
 169 The
 170 .Nm
 171 driver was written by
 172 .An Mike Smith Aq msmith@FreeBSD.org .
 173 .Pp
 174 This manual page is based on his comments and was written by
 175 .An Tom Rhodes Aq trhodes@FreeBSD.org .