xref: /titanic_53/usr/src/man/man7d/nvme.7d (revision 998a9ab1a18e99747e6ec3da2b160e4cb61b86e0)
13c9168faSHans Rosenfeld.\"
23c9168faSHans Rosenfeld.\" This file and its contents are supplied under the terms of the
33c9168faSHans Rosenfeld.\" Common Development and Distribution License ("CDDL"), version 1.0.
43c9168faSHans Rosenfeld.\" You may only use this file in accordance with the terms of version
53c9168faSHans Rosenfeld.\" 1.0 of the CDDL.
63c9168faSHans Rosenfeld.\"
73c9168faSHans Rosenfeld.\" A full copy of the text of the CDDL should have accompanied this
83c9168faSHans Rosenfeld.\" source.  A copy of the CDDL is also available via the Internet at
93c9168faSHans Rosenfeld.\" http://www.illumos.org/license/CDDL.
103c9168faSHans Rosenfeld.\"
113c9168faSHans Rosenfeld.\"
12*998a9ab1SHans Rosenfeld.\" Copyright 2016 Nexenta Systems, Inc.  All rights reserved.
133c9168faSHans Rosenfeld.\"
14*998a9ab1SHans Rosenfeld.Dd May 13, 2016
153c9168faSHans Rosenfeld.Dt NVME 7D
163c9168faSHans Rosenfeld.Os
173c9168faSHans Rosenfeld.Sh NAME
183c9168faSHans Rosenfeld.Nm nvme
193c9168faSHans Rosenfeld.Nd Intel NVMe compliant storage driver
203c9168faSHans Rosenfeld.Sh DESCRIPTION
213c9168faSHans RosenfeldThe
223c9168faSHans Rosenfeld.Nm
233c9168faSHans Rosenfelddriver uses the
243c9168faSHans Rosenfeld.Xr blkdev 7D
253c9168faSHans Rosenfeldframework to provide access to
263c9168faSHans Rosenfeld.Tn Intel
273c9168faSHans RosenfeldNVMe compliant solid-state storage devices.
283c9168faSHans Rosenfeld.Lp
293c9168faSHans RosenfeldNVMe devices supporting multiple namespaces will present each
303c9168faSHans Rosenfeldnamespace as its own
313c9168faSHans Rosenfeld.Xr blkdev 7D
323c9168faSHans Rosenfeldinstance in the system.
333c9168faSHans Rosenfeld.
343c9168faSHans Rosenfeld.Sh CONFIGURATION
353c9168faSHans RosenfeldThe
363c9168faSHans Rosenfeld.Nm
373c9168faSHans Rosenfelddriver can be configured by defining properties in the \fBnvme.conf\fR
383c9168faSHans Rosenfeldfile. The parameters are considered an unstable interface, subject to
393c9168faSHans Rosenfeldchange without notice. The following properties are currently
403c9168faSHans Rosenfeldsupported:
413c9168faSHans Rosenfeld.Bl -tag -width Va
423c9168faSHans Rosenfeld.It Va strict-version
433c9168faSHans RosenfeldThis can be set to 0 to allow
443c9168faSHans Rosenfeld.Nm
453c9168faSHans Rosenfeldto attach to devices supporting newer version of the NVMe
463c9168faSHans Rosenfeldspecification. The default value is 1, limiting
473c9168faSHans Rosenfeld.Nm
483c9168faSHans Rosenfeldto work with devices up to specification version 1.0.
493c9168faSHans Rosenfeld.It Va ignore-unknown-vendor-status
503c9168faSHans RosenfeldThis can be set to 1 to allow
513c9168faSHans Rosenfeld.Nm
523c9168faSHans Rosenfeldto continue operating even if it receives an unknown vendor command
533c9168faSHans Rosenfeldstatus.
543c9168faSHans Rosenfeld.It Va admin-queue-len
553c9168faSHans RosenfeldThis is the number of entries in the admin command queue. Legal values
563c9168faSHans Rosenfeldare between 16 and 4096, the default value is 256.
573c9168faSHans Rosenfeld.It Va io-queue-len
583c9168faSHans RosenfeldThis is the number of entries in each I/O command queue. Legal values
593c9168faSHans Rosenfeldare between 16 and 65536, the default value is 1024.
603c9168faSHans Rosenfeld.It Va async-event-limit
613c9168faSHans RosenfeldThis is the maximum number of asynchronous event requests issued by
623c9168faSHans Rosenfeldthe driver. Asynchronous events are used to report error conditions.
633c9168faSHans RosenfeldThe driver will never use more asynchronous events than this value, or
643c9168faSHans Rosenfeldwhat the hardware supports if it is less, or what 1/10th of the admin
653c9168faSHans Rosenfeldqueue length if it is less.
66*998a9ab1SHans Rosenfeld.It Va volatile-write-cache-enable
67*998a9ab1SHans RosenfeldThis property can be set to 0 to disable the volatile write cache, if
68*998a9ab1SHans Rosenfeldthe hardware supports it.
69*998a9ab1SHans RosenfeldThe default setting is 1, which enables the volatile write cache.
703c9168faSHans Rosenfeld.El
713c9168faSHans Rosenfeld.
723c9168faSHans Rosenfeld.Sh FILES
733c9168faSHans Rosenfeld.Bl -tag -compact -width Pa
743c9168faSHans Rosenfeld.It Pa /dev/dsk/cntnd0sn
753c9168faSHans RosenfeldBlock device minor nodes.
763c9168faSHans Rosenfeld.It Pa /dev/rdsk/cntnd0sn
773c9168faSHans RosenfeldRaw block device minor nodes.
783c9168faSHans Rosenfeld.El
793c9168faSHans Rosenfeld.Lp
803c9168faSHans RosenfeldIn the device minor nodes, the following substitutions may occur:
813c9168faSHans Rosenfeld.Bl -tag -offset indent -width Va
823c9168faSHans Rosenfeld.It Va cn
833c9168faSHans RosenfeldA controller number, typically one for each
843c9168faSHans Rosenfeld.Nm
853c9168faSHans Rosenfelddevice found. Controller numbers are dynamically assigned by the
863c9168faSHans Rosenfeldsystem.
873c9168faSHans Rosenfeld.It Va tn
883c9168faSHans RosenfeldThe target number, this corresponds to the namespace ID used by the
893c9168faSHans Rosenfeldhardware. Namespace ID 0 is reserved, hence target numbers start with
903c9168faSHans Rosenfeld1.
913c9168faSHans Rosenfeld.It Va sn
923c9168faSHans RosenfeldThis is the
933c9168faSHans Rosenfeld.Em slice
943c9168faSHans Rosenfeldnumber, representing a subset of the disk.  See
953c9168faSHans Rosenfeld.Xr dkio 7I .
963c9168faSHans Rosenfeld.El
973c9168faSHans Rosenfeld.
983c9168faSHans Rosenfeld.Sh SEE ALSO
993c9168faSHans Rosenfeld.Xr blkdev 7D
100