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 2016 Nexenta Systems, Inc.  All rights reserved.

  13 .\"
  14 .Dd Mar 30, 2017
  15 .Dt NVME 7D
  16 .Os
  17 .Sh NAME
  18 .Nm nvme
  19 .Nd Intel NVMe compliant storage driver
  20 .Sh DESCRIPTION
  21 The
  22 .Nm
  23 driver uses the
  24 .Xr blkdev 7D
  25 framework to provide access to
  26 .Tn Intel
  27 NVMe compliant solid-state storage devices.
  28 .Lp
  29 NVMe devices supporting multiple namespaces will present each
  30 namespace as its own
  31 .Xr blkdev 7D
  32 instance in the system.
  33 .
  34 .Sh CONFIGURATION
  35 The
  36 .Nm
  37 driver can be configured by defining properties in the
  38 .Pa nvme.conf
  39 file.
  40 The parameters are considered an unstable interface, subject to
  41 change without notice.
  42 The following properties are currently supported:
  43 .Bl -tag -width Va
  44 .It Va strict-version
  45 This can be set to 0 to allow
  46 .Nm
  47 to attach to devices supporting newer version of the NVMe
  48 specification.
  49 The default value is 1, limiting
  50 .Nm
  51 to work with devices up to specification version 1.2.
  52 .It Va ignore-unknown-vendor-status
  53 This can be set to 1 to allow
  54 .Nm
  55 to continue operating even if it receives an unknown vendor command
  56 status.
  57 .It Va admin-queue-len
  58 This is the number of entries in the admin command queue.
  59 Legal values are between 16 and 4096, the default value is 256.
  60 .It Va io-queue-len
  61 This is the number of entries in each I/O command queue.
  62 Legal values are between 16 and 65536, the default value is 1024.
  63 .It Va async-event-limit
  64 This is the maximum number of asynchronous event requests issued by
  65 the driver.
  66 Asynchronous events are used to report error conditions.
  67 The driver will never use more asynchronous events than this value, or
  68 what the hardware supports if it is less, or 1/10th of the admin queue
  69 length if it is less.
  70 .It Va volatile-write-cache-enable
  71 This property can be set to 0 to disable the volatile write cache, if

   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 2016 Nexenta Systems, Inc.  All rights reserved.
  13 .\" Copyright (c) 2018, Joyent, Inc.
  14 .\"
  15 .Dd July 31, 2018
  16 .Dt NVME 7D
  17 .Os
  18 .Sh NAME
  19 .Nm nvme
  20 .Nd Intel NVMe compliant storage driver
  21 .Sh DESCRIPTION
  22 The
  23 .Nm
  24 driver uses the
  25 .Xr blkdev 7D
  26 framework to provide access to
  27 Intel
  28 NVMe compliant solid-state storage devices.
  29 .Lp
  30 NVMe devices supporting multiple namespaces will present each
  31 namespace as its own
  32 .Xr blkdev 7D
  33 instance in the system.
  34 .
  35 .Sh CONFIGURATION
  36 The
  37 .Nm
  38 driver can be configured by defining properties in the
  39 .Pa nvme.conf
  40 file.
  41 The parameters are considered an unstable interface, subject to
  42 change without notice.
  43 The following properties are currently supported:
  44 .Bl -tag -width Va
  45 .It Va strict-version
  46 This can be set to 0 to allow
  47 .Nm
  48 to attach to devices supporting newer version of the NVMe
  49 specification.
  50 The default value is 1, limiting
  51 .Nm
  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
  55 .Nm
  56 to continue operating even if it receives an unknown vendor command
  57 status.
  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.
  61 .It Va io-queue-len
  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
  66 the driver.
  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
  70 length if it is less.
  71 .It Va volatile-write-cache-enable
  72 This property can be set to 0 to disable the volatile write cache, if