1e3e90193SJim Harris.\" 2aeae6079SJim Harris.\" Copyright (c) 2012-2016 Intel Corporation 3e3e90193SJim Harris.\" All rights reserved. 4e3e90193SJim Harris.\" 5e3e90193SJim Harris.\" Redistribution and use in source and binary forms, with or without 6e3e90193SJim Harris.\" modification, are permitted provided that the following conditions 7e3e90193SJim Harris.\" are met: 8e3e90193SJim Harris.\" 1. Redistributions of source code must retain the above copyright 9e3e90193SJim Harris.\" notice, this list of conditions, and the following disclaimer, 10e3e90193SJim Harris.\" without modification. 11e3e90193SJim Harris.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer 12e3e90193SJim Harris.\" substantially similar to the "NO WARRANTY" disclaimer below 13e3e90193SJim Harris.\" ("Disclaimer") and any redistribution must be conditioned upon 14e3e90193SJim Harris.\" including a substantially similar Disclaimer requirement for further 15e3e90193SJim Harris.\" binary redistribution. 16e3e90193SJim Harris.\" 17e3e90193SJim Harris.\" NO WARRANTY 18e3e90193SJim Harris.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19e3e90193SJim Harris.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20e3e90193SJim Harris.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 21e3e90193SJim Harris.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22e3e90193SJim Harris.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23e3e90193SJim Harris.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24e3e90193SJim Harris.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25e3e90193SJim Harris.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26e3e90193SJim Harris.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27e3e90193SJim Harris.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28e3e90193SJim Harris.\" POSSIBILITY OF SUCH DAMAGES. 29e3e90193SJim Harris.\" 30e3e90193SJim Harris.\" nvd driver man page. 31e3e90193SJim Harris.\" 32e3e90193SJim Harris.\" Author: Jim Harris <jimharris@FreeBSD.org> 33e3e90193SJim Harris.\" 34*bc97490aSConrad Meyer.Dd May 18, 2019 35e3e90193SJim Harris.Dt NVD 4 36e3e90193SJim Harris.Os 37e3e90193SJim Harris.Sh NAME 38e3e90193SJim Harris.Nm nvd 39e3e90193SJim Harris.Nd NVM Express disk driver 40e3e90193SJim Harris.Sh SYNOPSIS 41e3e90193SJim HarrisTo compile this driver into your kernel, 42e3e90193SJim Harrisplace the following lines in your kernel configuration file: 43e3e90193SJim Harris.Bd -ragged -offset indent 44e3e90193SJim Harris.Cd "device nvme" 45e3e90193SJim Harris.Cd "device nvd" 46e3e90193SJim Harris.Ed 47e3e90193SJim Harris.Pp 48e3e90193SJim HarrisOr, to load the driver as a module at boot, place the following lines in 49e3e90193SJim Harris.Xr loader.conf 5 : 50e3e90193SJim Harris.Bd -literal -offset indent 51e3e90193SJim Harrisnvme_load="YES" 52e3e90193SJim Harrisnvd_load="YES" 53e3e90193SJim Harris.Ed 54e3e90193SJim Harris.Sh DESCRIPTION 55e3e90193SJim HarrisThe 56e3e90193SJim Harris.Nm 57e3e90193SJim Harrisdriver exposes NVM Express (NVMe) namespaces as disks to the kernel disk 58e3e90193SJim Harrisstorage API. 59e3e90193SJim HarrisIt depends on the 60e3e90193SJim Harris.Xr nvme 4 61e3e90193SJim Harrisdriver for notification of existing NVMe namespaces and submission of NVM 62e3e90193SJim HarrisI/O commands. 638f3616caSJim Harris.Pp 648f3616caSJim HarrisDevice nodes from the 658f3616caSJim Harris.Nm 668f3616caSJim Harrisdriver will have the format /dev/nvdX and are 678f3616caSJim Harris.Xr GEOM 4 688f3616caSJim Harrisdisks which can be partitioned by 698f3616caSJim Harris.Xr geom 8 . 708f3616caSJim HarrisNote that device nodes from the 718f3616caSJim Harris.Xr nvme 4 728f3616caSJim Harrisdriver are not 738f3616caSJim Harris.Xr GEOM 4 748f3616caSJim Harrisdisks and cannot be partitioned. 75aeae6079SJim Harris.Sh CONFIGURATION 76aeae6079SJim HarrisThe 77aeae6079SJim Harris.Nm 7825972509SEdward Tomasz Napieraladriver defines a system-wide maximum delete size for NVMe devices. 7925972509SEdward Tomasz NapieralaThe default is 1GB. 8025972509SEdward Tomasz NapieralaTo select a different value, set the following tunable in 81aeae6079SJim Harris.Xr loader.conf 5 : 82aeae6079SJim Harris.Bd -literal -offset indent 83aeae6079SJim Harrishw.nvd.delete_max=<delete size in bytes> 84aeae6079SJim Harris.Ed 85e3e90193SJim Harris.Sh SEE ALSO 868f3616caSJim Harris.Xr GEOM 4 , 87*bc97490aSConrad Meyer.Xr nda 4 , 88e3e90193SJim Harris.Xr nvme 4 , 898f3616caSJim Harris.Xr geom 8 , 90e3e90193SJim Harris.Xr nvmecontrol 8 , 9178c7e17bSChristian Brueffer.Xr disk 9 921cb02270SJim Harris.Sh HISTORY 931cb02270SJim HarrisThe 941cb02270SJim Harris.Nm 951cb02270SJim Harrisdriver first appeared in 961cb02270SJim Harris.Fx 9.2 . 97e3e90193SJim Harris.Sh AUTHORS 98e3e90193SJim Harris.An -nosplit 99e3e90193SJim HarrisThe 100e3e90193SJim Harris.Nm 101e3e90193SJim Harrisdriver was developed by Intel and originally written by 1026c899950SBaptiste Daroussin.An Jim Harris Aq Mt jimharris@FreeBSD.org , 103e3e90193SJim Harriswith contributions from Joe Golio at EMC. 104e3e90193SJim Harris.Pp 105e3e90193SJim HarrisThis man page was written by 1066c899950SBaptiste Daroussin.An Jim Harris Aq Mt jimharris@FreeBSD.org . 107