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.\" 125f836503SHans Rosenfeld.\" Copyright 2016 Nexenta Systems, Inc. All rights reserved. 13788c47fcSHans Rosenfeld.\" 145f836503SHans 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 3753475f71SHans Rosenfelddriver can be configured by defining properties in the 3853475f71SHans Rosenfeld.Pa nvme.conf 3953475f71SHans Rosenfeldfile. 4053475f71SHans RosenfeldThe parameters are considered an unstable interface, subject to 4153475f71SHans Rosenfeldchange without notice. 4253475f71SHans RosenfeldThe following properties are currently supported: 43788c47fcSHans Rosenfeld.Bl -tag -width Va 44788c47fcSHans Rosenfeld.It Va strict-version 45788c47fcSHans RosenfeldThis can be set to 0 to allow 46788c47fcSHans Rosenfeld.Nm 47788c47fcSHans Rosenfeldto attach to devices supporting newer version of the NVMe 4853475f71SHans Rosenfeldspecification. 4953475f71SHans RosenfeldThe default value is 1, limiting 50788c47fcSHans Rosenfeld.Nm 51788c47fcSHans Rosenfeldto work with devices up to specification version 1.0. 52788c47fcSHans Rosenfeld.It Va ignore-unknown-vendor-status 53788c47fcSHans RosenfeldThis can be set to 1 to allow 54788c47fcSHans Rosenfeld.Nm 55788c47fcSHans Rosenfeldto continue operating even if it receives an unknown vendor command 56788c47fcSHans Rosenfeldstatus. 57788c47fcSHans Rosenfeld.It Va admin-queue-len 5853475f71SHans RosenfeldThis is the number of entries in the admin command queue. 5953475f71SHans RosenfeldLegal values are between 16 and 4096, the default value is 256. 60788c47fcSHans Rosenfeld.It Va io-queue-len 6153475f71SHans RosenfeldThis is the number of entries in each I/O command queue. 6253475f71SHans RosenfeldLegal values are between 16 and 65536, the default value is 1024. 63788c47fcSHans Rosenfeld.It Va async-event-limit 64788c47fcSHans RosenfeldThis is the maximum number of asynchronous event requests issued by 6553475f71SHans Rosenfeldthe driver. 6653475f71SHans RosenfeldAsynchronous events are used to report error conditions. 67788c47fcSHans RosenfeldThe driver will never use more asynchronous events than this value, or 6853475f71SHans Rosenfeldwhat the hardware supports if it is less, or 1/10th of the admin queue 6953475f71SHans Rosenfeldlength if it is less. 705f836503SHans Rosenfeld.It Va volatile-write-cache-enable 715f836503SHans RosenfeldThis property can be set to 0 to disable the volatile write cache, if 725f836503SHans Rosenfeldthe hardware supports it. 735f836503SHans RosenfeldThe default setting is 1, which enables the volatile write cache. 74*9974ca0cSHans Rosenfeld.It Va min-phys-block-size 75*9974ca0cSHans RosenfeldThis is the minimum physical block size that is reported to 76*9974ca0cSHans Rosenfeld.Xr blkdev 7d . 77*9974ca0cSHans RosenfeldThis value must be a power of 2 greater than or equal to 512. 78*9974ca0cSHans RosenfeldIf the device reports a best block size larger than what is 79*9974ca0cSHans Rosenfeldspecified here the driver will ignore the value specified here. 80788c47fcSHans Rosenfeld.El 81788c47fcSHans Rosenfeld. 82788c47fcSHans Rosenfeld.Sh FILES 83788c47fcSHans Rosenfeld.Bl -tag -compact -width Pa 84788c47fcSHans Rosenfeld.It Pa /dev/dsk/cntnd0sn 85788c47fcSHans RosenfeldBlock device minor nodes. 86788c47fcSHans Rosenfeld.It Pa /dev/rdsk/cntnd0sn 87788c47fcSHans RosenfeldRaw block device minor nodes. 88788c47fcSHans Rosenfeld.El 89788c47fcSHans Rosenfeld.Lp 90788c47fcSHans RosenfeldIn the device minor nodes, the following substitutions may occur: 91788c47fcSHans Rosenfeld.Bl -tag -offset indent -width Va 92788c47fcSHans Rosenfeld.It Va cn 93788c47fcSHans RosenfeldA controller number, typically one for each 94788c47fcSHans Rosenfeld.Nm 9553475f71SHans Rosenfelddevice found. 9653475f71SHans RosenfeldController numbers are dynamically assigned by the system. 97788c47fcSHans Rosenfeld.It Va tn 98788c47fcSHans RosenfeldThe target number, this corresponds to the namespace ID used by the 9953475f71SHans Rosenfeldhardware. 10053475f71SHans RosenfeldNamespace ID 0 is reserved, hence target numbers start with 1. 101788c47fcSHans Rosenfeld.It Va sn 102788c47fcSHans RosenfeldThis is the 103788c47fcSHans Rosenfeld.Em slice 10453475f71SHans Rosenfeldnumber, representing a subset of the disk. 10553475f71SHans RosenfeldSee 106788c47fcSHans Rosenfeld.Xr dkio 7I . 107788c47fcSHans Rosenfeld.El 108788c47fcSHans Rosenfeld. 109788c47fcSHans Rosenfeld.Sh SEE ALSO 110788c47fcSHans Rosenfeld.Xr blkdev 7D 111