xref: /illumos-gate/usr/src/man/man4d/vioscsi.4d (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2022 RackTop Systems, Inc.
13.\"
14.Dd June 17, 2022
15.Dt VIOSCSI 4D
16.Os
17.Sh NAME
18.Nm vioscsi
19.Nd virtio SCSI driver
20.Sh DESCRIPTION
21The
22.Nm
23driver provides a virtual SCSI transport, allowing
24access to
25.Xr virtio 4D
26based SCSI targets and logical units.
27The driver supports the following capabilities:
28.Bl -dash
29.It
30Dynamic hot-plug (if supported by the host)
31.It
32Honors packet timeouts specified in
33.Xr scsi_pkt 9S
34.It
35Reset of target or logical unit via
36.Xr scsi_reset 9F
37.It
38Abort for individual commands via
39.Xr scsi_abort 9F
40.It
41Command queueing (both tagged and untagged)
42.It
43Honors per logical unit queue depth from device
44.It
45Up to 255 targets, and 16384 logical units per PCI function
46.El
47.Pp
48The
49.Nm
50driver is based on
51.Xr iport 9 ,
52and uses a single iport per PCI function,
53with a unit-address of "iport0".
54Children of the iport use a unit-address with the
55format "target,lun", where both target and lun are
56presented as hexadecimal values.
57.Sh NOTES
58The
59.Nm
60driver may be slightly less efficient than
61.Xr vioblk 4D ,
62but it may support use as boot media, as well
63as attachments to SCSI pass-through devices, which
64may include devices such as tape drives via
65.Xr st 4D
66and enclosures via
67.Xr ses 4D .
68.Sh ARCHITECTURE
69The
70.Nm
71driver is only supported on
72.Sy x86 .
73.Sh FILES
74.Bl -tag -width Pa
75.It Pa /kernel/drv/amd64/vioscsi
76x86 device driver.
77.El
78.Sh SEE ALSO
79.Xr sd 4D ,
80.Xr ses 4D ,
81.Xr st 4D ,
82.Xr vioblk 4D ,
83.Xr virtio 4D ,
84.Xr iport 9 ,
85.Xr scsi_abort 9F ,
86.Xr scsi_reset 9F ,
87.Xr scsi_pkt 9S
88.Rs
89.%T Virtual I/O Device (VIRTIO) Version 1.1
90.%D April, 2019
91.%U https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html
92.Re
93