summaryrefslogtreecommitdiff
path: root/usr/src/man/man7d/nvme.7d
diff options
context:
space:
mode:
authorPatrick Mooney <patrick.f.mooney@gmail.com>2015-09-16 14:55:15 +0000
committerPatrick Mooney <patrick.f.mooney@gmail.com>2015-09-16 14:55:15 +0000
commit31a74c182cf2b5150a704786c53c053fd31b4c6d (patch)
tree5eb53f7e1729ae4bf03e842ae3333e511b1a588d /usr/src/man/man7d/nvme.7d
parenta845c808b8c12dd241b837bd48ae775b26d458fe (diff)
parent39fd84a866206a99cbb6b6e63e0c38a367aaa88e (diff)
downloadillumos-joyent-31a74c182cf2b5150a704786c53c053fd31b4c6d.tar.gz
[illumos-gate merge]
commit 39fd84a866206a99cbb6b6e63e0c38a367aaa88e 6119 mptsas doesn't handle timeouts in mptsas_get_sata_guid() commit 6d532798b6559eb98b586fd17725d8093f3b9ade 6168 strlcpy() does not return s1 commit 3c9168fa8e9c30d55b3aa2fde74bd7da46df53f5 4053 Add NVME Driver Support to Illumos commit b08923d6c9c63a4f4b647b84d9454d8124fcedd7 6210 ping can misreport ICMP latency 6211 want warnings in the face of long running name lookups for ping 6212 Want sub-second ping interval support 6213 clean up warnings in ping commit 0d045c0d0cb001d79480ee33be28514e847f8612 6209 libc mutexes break kernel writers hearts Conflicts: usr/src/cmd/cmd-inet/usr.sbin/ping/Makefile usr/src/cmd/cmd-inet/usr.sbin/ping/ping.c usr/src/lib/libc/port/threads/assfail.c usr/src/uts/common/Makefile.files usr/src/uts/common/Makefile.rules usr/src/uts/common/io/scsi/adapters/mpt_sas/mptsas.c usr/src/uts/common/sys/scsi/adapters/mpt_sas/mptsas_var.h
Diffstat (limited to 'usr/src/man/man7d/nvme.7d')
-rw-r--r--usr/src/man/man7d/nvme.7d95
1 files changed, 95 insertions, 0 deletions
diff --git a/usr/src/man/man7d/nvme.7d b/usr/src/man/man7d/nvme.7d
new file mode 100644
index 0000000000..7742fc22f6
--- /dev/null
+++ b/usr/src/man/man7d/nvme.7d
@@ -0,0 +1,95 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
+.\"
+.Dd July 20, 2015
+.Dt NVME 7D
+.Os
+.Sh NAME
+.Nm nvme
+.Nd Intel NVMe compliant storage driver
+.Sh DESCRIPTION
+The
+.Nm
+driver uses the
+.Xr blkdev 7D
+framework to provide access to
+.Tn Intel
+NVMe compliant solid-state storage devices.
+.Lp
+NVMe devices supporting multiple namespaces will present each
+namespace as its own
+.Xr blkdev 7D
+instance in the system.
+.
+.Sh CONFIGURATION
+The
+.Nm
+driver can be configured by defining properties in the \fBnvme.conf\fR
+file. The parameters are considered an unstable interface, subject to
+change without notice. The following properties are currently
+supported:
+.Bl -tag -width Va
+.It Va strict-version
+This can be set to 0 to allow
+.Nm
+to attach to devices supporting newer version of the NVMe
+specification. The default value is 1, limiting
+.Nm
+to work with devices up to specification version 1.0.
+.It Va ignore-unknown-vendor-status
+This can be set to 1 to allow
+.Nm
+to continue operating even if it receives an unknown vendor command
+status.
+.It Va admin-queue-len
+This is the number of entries in the admin command queue. Legal values
+are between 16 and 4096, the default value is 256.
+.It Va io-queue-len
+This is the number of entries in each I/O command queue. Legal values
+are between 16 and 65536, the default value is 1024.
+.It Va async-event-limit
+This is the maximum number of asynchronous event requests issued by
+the driver. Asynchronous events are used to report error conditions.
+The driver will never use more asynchronous events than this value, or
+what the hardware supports if it is less, or what 1/10th of the admin
+queue length if it is less.
+.El
+.
+.Sh FILES
+.Bl -tag -compact -width Pa
+.It Pa /dev/dsk/cntnd0sn
+Block device minor nodes.
+.It Pa /dev/rdsk/cntnd0sn
+Raw block device minor nodes.
+.El
+.Lp
+In the device minor nodes, the following substitutions may occur:
+.Bl -tag -offset indent -width Va
+.It Va cn
+A controller number, typically one for each
+.Nm
+device found. Controller numbers are dynamically assigned by the
+system.
+.It Va tn
+The target number, this corresponds to the namespace ID used by the
+hardware. Namespace ID 0 is reserved, hence target numbers start with
+1.
+.It Va sn
+This is the
+.Em slice
+number, representing a subset of the disk. See
+.Xr dkio 7I .
+.El
+.
+.Sh SEE ALSO
+.Xr blkdev 7D