xref: /freebsd/share/man/man4/isci.4 (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
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.\" $FreeBSD$
35.\"
36.Dd January 23, 2012
37.Dt ISCI 4
38.Os
39.Sh NAME
40.Nm isci
41.Nd Intel C600 Serial Attached SCSI driver
42.Sh SYNOPSIS
43To compile this driver into your kernel,
44place the following lines in your kernel configuration file:
45.Bd -ragged -offset indent
46.Cd "device scbus"
47.Cd "device isci"
48.Ed
49.Pp
50Or, to load the driver as a module at boot, place the following line in
51.Xr loader.conf 5 :
52.Bd -literal -offset indent
53isci_load="YES"
54.Ed
55.Sh HARDWARE
56The
57.Nm
58driver provides support for Intel C600
59.Tn SAS
60controllers.
61.Sh CONFIGURATION
62To force legacy interrupts for all
63.Nm
64driver instances, set the following tunable value in
65.Xr loader.conf 5 :
66.Bd -literal -offset indent
67hw.isci.force_legacy_interrupts=1
68.Ed
69.Sh DEBUGGING
70To enable debugging prints from the
71.Nm
72driver, set the
73.Bd -literal -offset indent
74hw.isci.debug_level
75.Ed
76.Pp
77variable to a value between 1 and 4 in
78.Xr loader.conf 5 .
79.Pp
80The hardware layer in the
81.Nm
82driver has extensive logging capabilities
83which are disabled by default for performance reasons.
84These can be enabled by adding
85.Bd -literal -offset indent
86options ISCI_LOGGING
87.Ed
88.Pp
89to the kernel configuration file.
90.Sh SEE ALSO
91.Xr cd 4 ,
92.Xr ch 4 ,
93.Xr da 4 ,
94.Xr pci 4 ,
95.Xr sa 4 ,
96.Xr scsi 4
97.Sh HISTORY
98The
99.Nm
100driver first appeared in
101.Fx 8.3
102and 9.1.
103.Sh AUTHORS
104.An -nosplit
105The
106.Nm
107driver was developed by Intel and originally written by
108.An Jim Harris Aq jimharris@FreeBSD.org
109with contributions from Sohaib Ahsan and input from
110.An Scott Long Aq scottl@FreeBSD.org .
111.Pp
112This man page was written by
113.An Jim Harris Aq jimharris@FreeBSD.org .
114