xref: /freebsd/share/man/man4/isci.4 (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
1.\"
2.\" Copyright (c) 2012 Intel Corporation
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.\"    without modification.
11.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
12.\"    substantially similar to the "NO WARRANTY" disclaimer below
13.\"    ("Disclaimer") and any redistribution must be conditioned upon
14.\"    including a substantially similar Disclaimer requirement for further
15.\"    binary redistribution.
16.\"
17.\" NO WARRANTY
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGES.
29.\"
30.\" isci driver man page.
31.\"
32.\" Author: Jim Harris <jimharris@FreeBSD.org>
33.\"
34.Dd January 23, 2012
35.Dt ISCI 4
36.Os
37.Sh NAME
38.Nm isci
39.Nd Intel C600 Serial Attached SCSI driver
40.Sh SYNOPSIS
41To compile this driver into your kernel,
42place the following lines in your kernel configuration file:
43.Bd -ragged -offset indent
44.Cd "device scbus"
45.Cd "device isci"
46.Ed
47.Pp
48Or, to load the driver as a module at boot, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51isci_load="YES"
52.Ed
53.Sh HARDWARE
54The
55.Nm
56driver provides support for Intel C600
57.Tn SAS
58controllers.
59.Sh CONFIGURATION
60To force legacy interrupts for all
61.Nm
62driver instances, set the following tunable value in
63.Xr loader.conf 5 :
64.Bd -literal -offset indent
65hw.isci.force_legacy_interrupts=1
66.Ed
67.Sh DEBUGGING
68To enable debugging prints from the
69.Nm
70driver, set the
71.Bd -literal -offset indent
72hw.isci.debug_level
73.Ed
74.Pp
75variable to a value between 1 and 4 in
76.Xr loader.conf 5 .
77.Pp
78The hardware layer in the
79.Nm
80driver has extensive logging capabilities
81which are disabled by default for performance reasons.
82These can be enabled by adding
83.Bd -literal -offset indent
84options ISCI_LOGGING
85.Ed
86.Pp
87to the kernel configuration file.
88.Sh SEE ALSO
89.Xr cd 4 ,
90.Xr ch 4 ,
91.Xr da 4 ,
92.Xr pci 4 ,
93.Xr sa 4 ,
94.Xr scsi 4
95.Sh HISTORY
96The
97.Nm
98driver first appeared in
99.Fx 8.3
100and 9.1.
101.Sh AUTHORS
102.An -nosplit
103The
104.Nm
105driver was developed by Intel and originally written by
106.An Jim Harris Aq Mt jimharris@FreeBSD.org
107with contributions from
108.An Sohaib Ahsan
109and input from
110.An Scott Long Aq Mt scottl@FreeBSD.org .
111.Pp
112This man page was written by
113.An Jim Harris Aq Mt jimharris@FreeBSD.org .
114