xref: /titanic_52/usr/src/man/man7d/nvme.7d (revision 56b82ca86b4cef01d1cd3a61ead0ec2cca5a1047)
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 2015 Nexenta Systems, Inc.  All rights reserved.
13.\"
14.Dd July 20, 2015
15.Dt NVME 7D
16.Os
17.Sh NAME
18.Nm nvme
19.Nd Intel NVMe compliant storage driver
20.Sh DESCRIPTION
21The
22.Nm
23driver uses the
24.Xr blkdev 7D
25framework to provide access to
26.Tn Intel
27NVMe compliant solid-state storage devices.
28.Lp
29NVMe devices supporting multiple namespaces will present each
30namespace as its own
31.Xr blkdev 7D
32instance in the system.
33.
34.Sh CONFIGURATION
35The
36.Nm
37driver can be configured by defining properties in the \fBnvme.conf\fR
38file. The parameters are considered an unstable interface, subject to
39change without notice. The following properties are currently
40supported:
41.Bl -tag -width Va
42.It Va strict-version
43This can be set to 0 to allow
44.Nm
45to attach to devices supporting newer version of the NVMe
46specification. The default value is 1, limiting
47.Nm
48to work with devices up to specification version 1.0.
49.It Va ignore-unknown-vendor-status
50This can be set to 1 to allow
51.Nm
52to continue operating even if it receives an unknown vendor command
53status.
54.It Va admin-queue-len
55This is the number of entries in the admin command queue. Legal values
56are between 16 and 4096, the default value is 256.
57.It Va io-queue-len
58This is the number of entries in each I/O command queue. Legal values
59are between 16 and 65536, the default value is 1024.
60.It Va async-event-limit
61This is the maximum number of asynchronous event requests issued by
62the driver. Asynchronous events are used to report error conditions.
63The driver will never use more asynchronous events than this value, or
64what the hardware supports if it is less, or what 1/10th of the admin
65queue length if it is less.
66.El
67.
68.Sh FILES
69.Bl -tag -compact -width Pa
70.It Pa /dev/dsk/cntnd0sn
71Block device minor nodes.
72.It Pa /dev/rdsk/cntnd0sn
73Raw block device minor nodes.
74.El
75.Lp
76In the device minor nodes, the following substitutions may occur:
77.Bl -tag -offset indent -width Va
78.It Va cn
79A controller number, typically one for each
80.Nm
81device found. Controller numbers are dynamically assigned by the
82system.
83.It Va tn
84The target number, this corresponds to the namespace ID used by the
85hardware. Namespace ID 0 is reserved, hence target numbers start with
861.
87.It Va sn
88This is the
89.Em slice
90number, representing a subset of the disk.  See
91.Xr dkio 7I .
92.El
93.
94.Sh SEE ALSO
95.Xr blkdev 7D
96