xref: /titanic_53/usr/src/man/man7d/nvme.7d (revision 3c9168fa8e9c30d55b3aa2fde74bd7da46df53f5)
1*3c9168faSHans Rosenfeld.\"
2*3c9168faSHans Rosenfeld.\" This file and its contents are supplied under the terms of the
3*3c9168faSHans Rosenfeld.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*3c9168faSHans Rosenfeld.\" You may only use this file in accordance with the terms of version
5*3c9168faSHans Rosenfeld.\" 1.0 of the CDDL.
6*3c9168faSHans Rosenfeld.\"
7*3c9168faSHans Rosenfeld.\" A full copy of the text of the CDDL should have accompanied this
8*3c9168faSHans Rosenfeld.\" source.  A copy of the CDDL is also available via the Internet at
9*3c9168faSHans Rosenfeld.\" http://www.illumos.org/license/CDDL.
10*3c9168faSHans Rosenfeld.\"
11*3c9168faSHans Rosenfeld.\"
12*3c9168faSHans Rosenfeld.\" Copyright 2015 Nexenta Systems, Inc.  All rights reserved.
13*3c9168faSHans Rosenfeld.\"
14*3c9168faSHans Rosenfeld.Dd July 20, 2015
15*3c9168faSHans Rosenfeld.Dt NVME 7D
16*3c9168faSHans Rosenfeld.Os
17*3c9168faSHans Rosenfeld.Sh NAME
18*3c9168faSHans Rosenfeld.Nm nvme
19*3c9168faSHans Rosenfeld.Nd Intel NVMe compliant storage driver
20*3c9168faSHans Rosenfeld.Sh DESCRIPTION
21*3c9168faSHans RosenfeldThe
22*3c9168faSHans Rosenfeld.Nm
23*3c9168faSHans Rosenfelddriver uses the
24*3c9168faSHans Rosenfeld.Xr blkdev 7D
25*3c9168faSHans Rosenfeldframework to provide access to
26*3c9168faSHans Rosenfeld.Tn Intel
27*3c9168faSHans RosenfeldNVMe compliant solid-state storage devices.
28*3c9168faSHans Rosenfeld.Lp
29*3c9168faSHans RosenfeldNVMe devices supporting multiple namespaces will present each
30*3c9168faSHans Rosenfeldnamespace as its own
31*3c9168faSHans Rosenfeld.Xr blkdev 7D
32*3c9168faSHans Rosenfeldinstance in the system.
33*3c9168faSHans Rosenfeld.
34*3c9168faSHans Rosenfeld.Sh CONFIGURATION
35*3c9168faSHans RosenfeldThe
36*3c9168faSHans Rosenfeld.Nm
37*3c9168faSHans Rosenfelddriver can be configured by defining properties in the \fBnvme.conf\fR
38*3c9168faSHans Rosenfeldfile. The parameters are considered an unstable interface, subject to
39*3c9168faSHans Rosenfeldchange without notice. The following properties are currently
40*3c9168faSHans Rosenfeldsupported:
41*3c9168faSHans Rosenfeld.Bl -tag -width Va
42*3c9168faSHans Rosenfeld.It Va strict-version
43*3c9168faSHans RosenfeldThis can be set to 0 to allow
44*3c9168faSHans Rosenfeld.Nm
45*3c9168faSHans Rosenfeldto attach to devices supporting newer version of the NVMe
46*3c9168faSHans Rosenfeldspecification. The default value is 1, limiting
47*3c9168faSHans Rosenfeld.Nm
48*3c9168faSHans Rosenfeldto work with devices up to specification version 1.0.
49*3c9168faSHans Rosenfeld.It Va ignore-unknown-vendor-status
50*3c9168faSHans RosenfeldThis can be set to 1 to allow
51*3c9168faSHans Rosenfeld.Nm
52*3c9168faSHans Rosenfeldto continue operating even if it receives an unknown vendor command
53*3c9168faSHans Rosenfeldstatus.
54*3c9168faSHans Rosenfeld.It Va admin-queue-len
55*3c9168faSHans RosenfeldThis is the number of entries in the admin command queue. Legal values
56*3c9168faSHans Rosenfeldare between 16 and 4096, the default value is 256.
57*3c9168faSHans Rosenfeld.It Va io-queue-len
58*3c9168faSHans RosenfeldThis is the number of entries in each I/O command queue. Legal values
59*3c9168faSHans Rosenfeldare between 16 and 65536, the default value is 1024.
60*3c9168faSHans Rosenfeld.It Va async-event-limit
61*3c9168faSHans RosenfeldThis is the maximum number of asynchronous event requests issued by
62*3c9168faSHans Rosenfeldthe driver. Asynchronous events are used to report error conditions.
63*3c9168faSHans RosenfeldThe driver will never use more asynchronous events than this value, or
64*3c9168faSHans Rosenfeldwhat the hardware supports if it is less, or what 1/10th of the admin
65*3c9168faSHans Rosenfeldqueue length if it is less.
66*3c9168faSHans Rosenfeld.El
67*3c9168faSHans Rosenfeld.
68*3c9168faSHans Rosenfeld.Sh FILES
69*3c9168faSHans Rosenfeld.Bl -tag -compact -width Pa
70*3c9168faSHans Rosenfeld.It Pa /dev/dsk/cntnd0sn
71*3c9168faSHans RosenfeldBlock device minor nodes.
72*3c9168faSHans Rosenfeld.It Pa /dev/rdsk/cntnd0sn
73*3c9168faSHans RosenfeldRaw block device minor nodes.
74*3c9168faSHans Rosenfeld.El
75*3c9168faSHans Rosenfeld.Lp
76*3c9168faSHans RosenfeldIn the device minor nodes, the following substitutions may occur:
77*3c9168faSHans Rosenfeld.Bl -tag -offset indent -width Va
78*3c9168faSHans Rosenfeld.It Va cn
79*3c9168faSHans RosenfeldA controller number, typically one for each
80*3c9168faSHans Rosenfeld.Nm
81*3c9168faSHans Rosenfelddevice found. Controller numbers are dynamically assigned by the
82*3c9168faSHans Rosenfeldsystem.
83*3c9168faSHans Rosenfeld.It Va tn
84*3c9168faSHans RosenfeldThe target number, this corresponds to the namespace ID used by the
85*3c9168faSHans Rosenfeldhardware. Namespace ID 0 is reserved, hence target numbers start with
86*3c9168faSHans Rosenfeld1.
87*3c9168faSHans Rosenfeld.It Va sn
88*3c9168faSHans RosenfeldThis is the
89*3c9168faSHans Rosenfeld.Em slice
90*3c9168faSHans Rosenfeldnumber, representing a subset of the disk.  See
91*3c9168faSHans Rosenfeld.Xr dkio 7I .
92*3c9168faSHans Rosenfeld.El
93*3c9168faSHans Rosenfeld.
94*3c9168faSHans Rosenfeld.Sh SEE ALSO
95*3c9168faSHans Rosenfeld.Xr blkdev 7D
96