xref: /titanic_44/usr/src/man/man7d/nvme.7d (revision 5f8365034b4150f5dc58aa9b87734963c581760f)
1788c47fcSHans Rosenfeld.\"
2788c47fcSHans Rosenfeld.\" This file and its contents are supplied under the terms of the
3788c47fcSHans Rosenfeld.\" Common Development and Distribution License ("CDDL"), version 1.0.
4788c47fcSHans Rosenfeld.\" You may only use this file in accordance with the terms of version
5788c47fcSHans Rosenfeld.\" 1.0 of the CDDL.
6788c47fcSHans Rosenfeld.\"
7788c47fcSHans Rosenfeld.\" A full copy of the text of the CDDL should have accompanied this
8788c47fcSHans Rosenfeld.\" source.  A copy of the CDDL is also available via the Internet at
9788c47fcSHans Rosenfeld.\" http://www.illumos.org/license/CDDL.
10788c47fcSHans Rosenfeld.\"
11788c47fcSHans Rosenfeld.\"
12*5f836503SHans Rosenfeld.\" Copyright 2016 Nexenta Systems, Inc.  All rights reserved.
13788c47fcSHans Rosenfeld.\"
14*5f836503SHans Rosenfeld.Dd May 13, 2016
15788c47fcSHans Rosenfeld.Dt NVME 7D
16788c47fcSHans Rosenfeld.Os
17788c47fcSHans Rosenfeld.Sh NAME
18788c47fcSHans Rosenfeld.Nm nvme
19788c47fcSHans Rosenfeld.Nd Intel NVMe compliant storage driver
20788c47fcSHans Rosenfeld.Sh DESCRIPTION
21788c47fcSHans RosenfeldThe
22788c47fcSHans Rosenfeld.Nm
23788c47fcSHans Rosenfelddriver uses the
24788c47fcSHans Rosenfeld.Xr blkdev 7D
25788c47fcSHans Rosenfeldframework to provide access to
26788c47fcSHans Rosenfeld.Tn Intel
27788c47fcSHans RosenfeldNVMe compliant solid-state storage devices.
28788c47fcSHans Rosenfeld.Lp
29788c47fcSHans RosenfeldNVMe devices supporting multiple namespaces will present each
30788c47fcSHans Rosenfeldnamespace as its own
31788c47fcSHans Rosenfeld.Xr blkdev 7D
32788c47fcSHans Rosenfeldinstance in the system.
33788c47fcSHans Rosenfeld.
34788c47fcSHans Rosenfeld.Sh CONFIGURATION
35788c47fcSHans RosenfeldThe
36788c47fcSHans Rosenfeld.Nm
37788c47fcSHans Rosenfelddriver can be configured by defining properties in the \fBnvme.conf\fR
38788c47fcSHans Rosenfeldfile. The parameters are considered an unstable interface, subject to
39788c47fcSHans Rosenfeldchange without notice. The following properties are currently
40788c47fcSHans Rosenfeldsupported:
41788c47fcSHans Rosenfeld.Bl -tag -width Va
42788c47fcSHans Rosenfeld.It Va strict-version
43788c47fcSHans RosenfeldThis can be set to 0 to allow
44788c47fcSHans Rosenfeld.Nm
45788c47fcSHans Rosenfeldto attach to devices supporting newer version of the NVMe
46788c47fcSHans Rosenfeldspecification. The default value is 1, limiting
47788c47fcSHans Rosenfeld.Nm
48788c47fcSHans Rosenfeldto work with devices up to specification version 1.0.
49788c47fcSHans Rosenfeld.It Va ignore-unknown-vendor-status
50788c47fcSHans RosenfeldThis can be set to 1 to allow
51788c47fcSHans Rosenfeld.Nm
52788c47fcSHans Rosenfeldto continue operating even if it receives an unknown vendor command
53788c47fcSHans Rosenfeldstatus.
54788c47fcSHans Rosenfeld.It Va admin-queue-len
55788c47fcSHans RosenfeldThis is the number of entries in the admin command queue. Legal values
56788c47fcSHans Rosenfeldare between 16 and 4096, the default value is 256.
57788c47fcSHans Rosenfeld.It Va io-queue-len
58788c47fcSHans RosenfeldThis is the number of entries in each I/O command queue. Legal values
59788c47fcSHans Rosenfeldare between 16 and 65536, the default value is 1024.
60788c47fcSHans Rosenfeld.It Va async-event-limit
61788c47fcSHans RosenfeldThis is the maximum number of asynchronous event requests issued by
62788c47fcSHans Rosenfeldthe driver. Asynchronous events are used to report error conditions.
63788c47fcSHans RosenfeldThe driver will never use more asynchronous events than this value, or
64788c47fcSHans Rosenfeldwhat the hardware supports if it is less, or what 1/10th of the admin
65788c47fcSHans Rosenfeldqueue length if it is less.
66*5f836503SHans Rosenfeld.It Va volatile-write-cache-enable
67*5f836503SHans RosenfeldThis property can be set to 0 to disable the volatile write cache, if
68*5f836503SHans Rosenfeldthe hardware supports it.
69*5f836503SHans RosenfeldThe default setting is 1, which enables the volatile write cache.
70788c47fcSHans Rosenfeld.El
71788c47fcSHans Rosenfeld.
72788c47fcSHans Rosenfeld.Sh FILES
73788c47fcSHans Rosenfeld.Bl -tag -compact -width Pa
74788c47fcSHans Rosenfeld.It Pa /dev/dsk/cntnd0sn
75788c47fcSHans RosenfeldBlock device minor nodes.
76788c47fcSHans Rosenfeld.It Pa /dev/rdsk/cntnd0sn
77788c47fcSHans RosenfeldRaw block device minor nodes.
78788c47fcSHans Rosenfeld.El
79788c47fcSHans Rosenfeld.Lp
80788c47fcSHans RosenfeldIn the device minor nodes, the following substitutions may occur:
81788c47fcSHans Rosenfeld.Bl -tag -offset indent -width Va
82788c47fcSHans Rosenfeld.It Va cn
83788c47fcSHans RosenfeldA controller number, typically one for each
84788c47fcSHans Rosenfeld.Nm
85788c47fcSHans Rosenfelddevice found. Controller numbers are dynamically assigned by the
86788c47fcSHans Rosenfeldsystem.
87788c47fcSHans Rosenfeld.It Va tn
88788c47fcSHans RosenfeldThe target number, this corresponds to the namespace ID used by the
89788c47fcSHans Rosenfeldhardware. Namespace ID 0 is reserved, hence target numbers start with
90788c47fcSHans Rosenfeld1.
91788c47fcSHans Rosenfeld.It Va sn
92788c47fcSHans RosenfeldThis is the
93788c47fcSHans Rosenfeld.Em slice
94788c47fcSHans Rosenfeldnumber, representing a subset of the disk.  See
95788c47fcSHans Rosenfeld.Xr dkio 7I .
96788c47fcSHans Rosenfeld.El
97788c47fcSHans Rosenfeld.
98788c47fcSHans Rosenfeld.Sh SEE ALSO
99788c47fcSHans Rosenfeld.Xr blkdev 7D
100