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