d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
9931326750
freebsd-skq/share/man/man4/nvd.4

109 lines
3.1 KiB
Groff
Raw Normal View History

Add man pages for nvme(4) and nvd(4). Sponsored by: Intel Reviewed by: joel
2012-10-10 21:38:17 +00:00
.\"
nvd: add hw.nvd.delete_max tunable The NVMe specification does not define a maximum or optimal delete size, so technically max delete size is min(full size of namespace, 2^32 - 1 LBAs). A single delete operation for a multi-TB NVMe namespace though may take much longer to complete than the nvme(4) I/O timeout period. So choose a sensible default here that is still suitably large to minimize the number of overall delete operations. This also fixes possible uint32_t overflow on initial TRIM operation for zpool create operations for NVMe namespaces with >4G LBAs. MFC after: 3 days Sponsored by: Intel
2016-01-28 23:15:14 +00:00
.\" Copyright (c) 2012-2016 Intel Corporation
Add man pages for nvme(4) and nvd(4). Sponsored by: Intel Reviewed by: joel
2012-10-10 21:38:17 +00:00
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions, and the following disclaimer,
.\" without modification.
.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
.\" substantially similar to the "NO WARRANTY" disclaimer below
.\" ("Disclaimer") and any redistribution must be conditioned upon
.\" including a substantially similar Disclaimer requirement for further
.\" binary redistribution.
.\"
.\" NO WARRANTY
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGES.
.\"
.\" nvd driver man page.
.\"
.\" Author: Jim Harris <jimharris@FreeBSD.org>
.\"
.\" $FreeBSD$
.\"
nvd.4: Reference nda(4) Fix a totally minor typo in nvme.4 while here.
2019-05-19 06:01:11 +00:00
.Dd May 18, 2019
Add man pages for nvme(4) and nvd(4). Sponsored by: Intel Reviewed by: joel
2012-10-10 21:38:17 +00:00
.Dt NVD 4
.Os
.Sh NAME
.Nm nvd
.Nd NVM Express disk driver
.Sh SYNOPSIS
To compile this driver into your kernel,
place the following lines in your kernel configuration file:
.Bd -ragged -offset indent
.Cd "device nvme"
.Cd "device nvd"
.Ed
.Pp
Or, to load the driver as a module at boot, place the following lines in
.Xr loader.conf 5 :
.Bd -literal -offset indent
nvme_load="YES"
nvd_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver exposes NVM Express (NVMe) namespaces as disks to the kernel disk
storage API.
It depends on the
.Xr nvme 4
driver for notification of existing NVMe namespaces and submission of NVM
I/O commands.
Update nvme(4) and nvd(4) man pages to clarify the differences between their respective device nodes. Sponsored by: Intel MFC after: 3 days
2014-03-18 15:43:42 +00:00
.Pp
Device nodes from the
.Nm
driver will have the format /dev/nvdX and are
.Xr GEOM 4
disks which can be partitioned by
.Xr geom 8 .
Note that device nodes from the
.Xr nvme 4
driver are not
.Xr GEOM 4
disks and cannot be partitioned.
nvd: add hw.nvd.delete_max tunable The NVMe specification does not define a maximum or optimal delete size, so technically max delete size is min(full size of namespace, 2^32 - 1 LBAs). A single delete operation for a multi-TB NVMe namespace though may take much longer to complete than the nvme(4) I/O timeout period. So choose a sensible default here that is still suitably large to minimize the number of overall delete operations. This also fixes possible uint32_t overflow on initial TRIM operation for zpool create operations for NVMe namespaces with >4G LBAs. MFC after: 3 days Sponsored by: Intel
2016-01-28 23:15:14 +00:00
.Sh CONFIGURATION
The
.Nm
Fix a bunch of "sentence not on new line" warnings from igor(1). MFC after: 1 month
2016-06-08 08:50:35 +00:00
driver defines a system-wide maximum delete size for NVMe devices.
The default is 1GB.
To select a different value, set the following tunable in
nvd: add hw.nvd.delete_max tunable The NVMe specification does not define a maximum or optimal delete size, so technically max delete size is min(full size of namespace, 2^32 - 1 LBAs). A single delete operation for a multi-TB NVMe namespace though may take much longer to complete than the nvme(4) I/O timeout period. So choose a sensible default here that is still suitably large to minimize the number of overall delete operations. This also fixes possible uint32_t overflow on initial TRIM operation for zpool create operations for NVMe namespaces with >4G LBAs. MFC after: 3 days Sponsored by: Intel
2016-01-28 23:15:14 +00:00
.Xr loader.conf 5 :
.Bd -literal -offset indent
hw.nvd.delete_max=<delete size in bytes>
.Ed
Add man pages for nvme(4) and nvd(4). Sponsored by: Intel Reviewed by: joel
2012-10-10 21:38:17 +00:00
.Sh SEE ALSO
Update nvme(4) and nvd(4) man pages to clarify the differences between their respective device nodes. Sponsored by: Intel MFC after: 3 days
2014-03-18 15:43:42 +00:00
.Xr GEOM 4 ,
nvd.4: Reference nda(4) Fix a totally minor typo in nvme.4 while here.
2019-05-19 06:01:11 +00:00
.Xr nda 4 ,
Add man pages for nvme(4) and nvd(4). Sponsored by: Intel Reviewed by: joel
2012-10-10 21:38:17 +00:00
.Xr nvme 4 ,
Update nvme(4) and nvd(4) man pages to clarify the differences between their respective device nodes. Sponsored by: Intel MFC after: 3 days
2014-03-18 15:43:42 +00:00
.Xr geom 8 ,
Remove whitespace.
2012-10-12 06:16:51 +00:00
.Xr nvmecontrol 8 ,
mdoc cleanup. MFC after: 1 week
2014-02-28 15:55:35 +00:00
.Xr disk 9
Update nvme(4) and nvd(4) to reflect recent work and upcoming inclusion in 9.2 release. Sponsored by: Intel MFC after: 3 days
2013-07-09 21:21:29 +00:00
.Sh HISTORY
The
.Nm
driver first appeared in
mdoc: fix several uses of the Fx macro to point to actual releases. Found by: make manlint
2014-01-28 21:40:10 +00:00
.Fx 9.2 .
Add man pages for nvme(4) and nvd(4). Sponsored by: Intel Reviewed by: joel
2012-10-10 21:38:17 +00:00
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was developed by Intel and originally written by
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-26 21:46:14 +00:00
.An Jim Harris Aq Mt jimharris@FreeBSD.org ,
Add man pages for nvme(4) and nvd(4). Sponsored by: Intel Reviewed by: joel
2012-10-10 21:38:17 +00:00
with contributions from Joe Golio at EMC.
.Pp
This man page was written by
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-26 21:46:14 +00:00
.An Jim Harris Aq Mt jimharris@FreeBSD.org .
Reference in New Issue Copy Permalink