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
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.
12 .\" Copyright 2016 Nexenta Systems, Inc. All rights reserved.
13 .\" Copyright (c) 2018, Joyent, Inc.
20 .Nd Intel NVMe compliant storage driver
26 framework to provide access to
28 NVMe compliant solid-state storage devices.
30 NVMe devices supporting multiple namespaces will present each
33 instance in the system.
38 driver can be configured by defining properties in the
41 The parameters are considered an unstable interface, subject to
42 change without notice.
43 The following properties are currently supported:
46 This can be set to 0 to allow
48 to attach to devices supporting newer version of the NVMe
50 The default value is 1, limiting
52 to work with devices that support major version 1.
53 .It Va ignore-unknown-vendor-status
54 This can be set to 1 to allow
56 to continue operating even if it receives an unknown vendor command
58 .It Va admin-queue-len
59 This is the number of entries in the admin command queue.
60 Legal values are between 16 and 4096, the default value is 256.
62 This is the number of entries in each I/O command queue.
63 Legal values are between 16 and 65536, the default value is 1024.
64 .It Va async-event-limit
65 This is the maximum number of asynchronous event requests issued by
67 Asynchronous events are used to report error conditions.
68 The driver will never use more asynchronous events than this value, or
69 what the hardware supports if it is less, or 1/10th of the admin queue
71 .It Va volatile-write-cache-enable
72 This property can be set to 0 to disable the volatile write cache, if
73 the hardware supports it.
74 The default setting is 1, which enables the volatile write cache.
75 .It Va min-phys-block-size
76 This is the minimum physical block size that is reported to
78 This value must be a power of 2 greater than or equal to 512.
79 If the device reports a best block size larger than what is
80 specified here the driver will ignore the value specified here.
84 .Bl -tag -compact -width Pa
85 .It Pa /dev/dsk/cntnd0sn
86 Block device minor nodes.
87 .It Pa /dev/rdsk/cntnd0sn
88 Raw block device minor nodes.
91 In the device minor nodes, the following substitutions may occur:
92 .Bl -tag -offset indent -width Va
94 A controller number, typically one for each
97 Controller numbers are dynamically assigned by the system.
100 This is the namespace EUI64 if available, or the namespace ID used by
102 Namespace ID 0 is reserved, hence target numbers start with 1.
106 number, representing a subset of the disk.