gitweb.dragonflybsd.org Git - dragonfly.git/blame

Commit	Line	Data
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	12	To compile this driver into the kernel,
	13	place the following lines in your
	14	kernel configuration file:
	15	.Bd -ragged -offset indent
984263bc MD	16	.Cd "device scbus"
984263bc MD	17	.Cd "device ciss"
a8416dcf SW	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
984263bc MD	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 ,
a8416dcf	48	etc.\& and via the CAM interface
984263bc MD	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
9cf9a798 SW	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 drives) are only exposed as
	82	.Xr pass 4
	83	devices.
	84	Hot-insertion and removal of devices is supported but a bus
	85	rescan might be necessary.
984263bc	86	.Pp
a8416dcf SW	87	The problem which adapter freezes with the message
	88	.Dq ADAPTER HEARTBEAT FAILED
	89	might be solved by updating the firmware and/or setting the
	90	.Va hw.ciss.nop_message_heartbeat
	91	tunable to non-zero at boot time.
b44c39e5 SW	92	.Sh LOADER TUNABLES
	93	In addition to
	94	.Va hw.ciss.nop_message_heartbeat ,
	95	the
	96	.Nm
	97	driver supports a number of loader tunables:
	98	.Bl -tag -width indent
	99	.It Va hw.ciss.expose_hidden_physical
	100	This tunable controls whether physical devices that are marked hidden
	101	by the firmware should be exposed anyways.
	102	The default is 0 (to not expose hidden physical devices).
	103	.It Va hw.ciss.force_transport
	104	This tunable forces a particular transport to be used.
	105	Values are 0 (use hardware specific default), 1 (forces simple transport)
	106	and 2 (forces performant transport).
	107	The default is 0 (to let the driver decide based on hardware).
	108	.It Va hw.ciss.force_interrupt
	109	This tunable forces a particular interrupt delivery method to be used.
	110	Values are 0 (use hardware specific default), 1 (forces INTx) and
	111	2 (forces MSI).
	112	The default is 0 (to let the driver decide based on hardware).
	113	.El
a8416dcf SW	114	.Sh HARDWARE
	115	Controllers supported by the
	116	.Nm
	117	driver include:
984263bc	118	.Pp
a8416dcf	119	.Bl -bullet -compact
984263bc MD	120	.It
	121	Compaq Smart Array 5300
	122	.It
	123	Compaq Smart Array 532
	124	.It
	125	Compaq Smart Array 5i
9cf9a798 SW	126	.It
	127	HP Smart Array 5312
	128	.It
	129	HP Smart Array 6i
	130	.It
	131	HP Smart Array 641
	132	.It
	133	HP Smart Array 642
	134	.It
	135	HP Smart Array 6400
	136	.It
	137	HP Smart Array 6400 EM
	138	.It
	139	HP Smart Array E200
	140	.It
	141	HP Smart Array E200i
	142	.It
	143	HP Smart Array P212
	144	.It
a8416dcf SW	145	HP Smart Array P220i
	146	.It
	147	HP Smart Array P222
	148	.It
9cf9a798 SW	149	HP Smart Array P400
	150	.It
	151	HP Smart Array P400i
	152	.It
	153	HP Smart Array P410
	154	.It
	155	HP Smart Array P410i
	156	.It
	157	HP Smart Array P411
	158	.It
a8416dcf SW	159	HP Smart Array P420
	160	.It
	161	HP Smart Array P420i
	162	.It
	163	HP Smart Array P421
	164	.It
9cf9a798 SW	165	HP Smart Array P600
9cf9a798 SW	166	.It
a8416dcf SW	167	HP Smart Array P721m
a8416dcf SW	168	.It
9cf9a798 SW	169	HP Smart Array P800
	170	.It
	171	HP Smart Array P812
	172	.It
	173	HP Modular Smart Array 20 (MSA20)
	174	.It
	175	HP 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
	190	The
	191	.Nm
	192	driver was written by
b2a6f486	193	.An Mike Smith Aq Mt msmith@FreeBSD.org .
984263bc MD	194	.Pp
984263bc MD	195	This manual page is based on his comments and was written by
b2a6f486	196	.An Tom Rhodes Aq Mt trhodes@FreeBSD.org .