xref: /freebsd/share/man/man4/ctl.4 (revision 3f0164abf32b9b761e0a2cb4bdca3a8b84f156d4)
1.\" Copyright (c) 2013 Edward Tomasz Napierala
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.Dd April 2, 2013
27.Dt CTL 4
28.Os
29.Sh NAME
30.Nm ctl
31.Nd CAM Target Layer
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following line in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device ctl"
38.Ed
39.Pp
40Alternatively, to load the driver as a
41module at boot time, place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44ctl_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49subsystem provides SCSI disk and processor emulation.
50It supports features such as:
51.Pp
52.Bl -bullet -compact
53.It
54Disk and processor device emulation
55.It
56Tagged queueing
57.It
58SCSI task attribute support (ordered, head of queue, simple tags)
59.It
60SCSI implicit command ordering support.
61.It
62Full task management support (abort, LUN reset, target reset, etc.)
63.It
64Support for multiple ports
65.It
66Support for multiple simultaneous initiators
67.It
68Support for multiple simultaneous backing stores
69.It
70Persistent reservation support
71.It
72Mode sense/select support
73.It
74Error injection support
75.It
76All I/O handled in-kernel, no userland context switch overhead
77.El
78.Sh SEE ALSO
79.Xr ctladm 8 ,
80.Xr ctlstat 8
81.Sh HISTORY
82The
83.Nm
84subsystem first appeared in
85.Fx 9.1 .
86.Sh AUTHORS
87The
88.Nm
89subsystem was written by
90.An Kenneth Merry Aq ken@FreeBSD.org .
91