| nvme.4 (262887) | nvme.4 (265575) |
|---|---|
| 1.\" | 1.\" |
| 2.\" Copyright (c) 2012-2013 Intel Corporation | 2.\" Copyright (c) 2012-2014 Intel Corporation |
| 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions, and the following disclaimer, 10.\" without modification. --- 15 unchanged lines hidden (view full) --- 26.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGES. 29.\" 30.\" nvme driver man page. 31.\" 32.\" Author: Jim Harris <jimharris@FreeBSD.org> 33.\" | 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions, and the following disclaimer, 10.\" without modification. --- 15 unchanged lines hidden (view full) --- 26.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGES. 29.\" 30.\" nvme driver man page. 31.\" 32.\" Author: Jim Harris <jimharris@FreeBSD.org> 33.\" |
| 34.\" $FreeBSD: stable/10/share/man/man4/nvme.4 262887 2014-03-07 12:20:01Z brueffer $ | 34.\" $FreeBSD: stable/10/share/man/man4/nvme.4 265575 2014-05-07 17:17:16Z jimharris $ |
| 35.\" | 35.\" |
| 36.Dd July 9, 2013 | 36.Dd March 18, 2014 |
| 37.Dt NVME 4 38.Os 39.Sh NAME 40.Nm nvme 41.Nd NVM Express core driver 42.Sh SYNOPSIS 43To compile this driver into your kernel, 44place the following line in your kernel configuration file: --- 4 unchanged lines hidden (view full) --- 49Or, to load the driver as a module at boot, place the following line in 50.Xr loader.conf 5 : 51.Bd -literal -offset indent 52nvme_load="YES" 53.Ed 54.Pp 55Most users will also want to enable 56.Xr nvd 4 | 37.Dt NVME 4 38.Os 39.Sh NAME 40.Nm nvme 41.Nd NVM Express core driver 42.Sh SYNOPSIS 43To compile this driver into your kernel, 44place the following line in your kernel configuration file: --- 4 unchanged lines hidden (view full) --- 49Or, to load the driver as a module at boot, place the following line in 50.Xr loader.conf 5 : 51.Bd -literal -offset indent 52nvme_load="YES" 53.Ed 54.Pp 55Most users will also want to enable 56.Xr nvd 4 |
| 57to surface NVM Express namespaces as disk devices. | 57to surface NVM Express namespaces as disk devices which can be 58partitioned. |
| 58Note that in NVM Express terms, a namespace is roughly equivalent to a 59SCSI LUN. 60.Sh DESCRIPTION 61The 62.Nm 63driver provides support for NVM Express (NVMe) controllers, such as: 64.Bl -bullet 65.It 66Hardware initialization 67.It 68Per-CPU IO queue pairs 69.It 70API for registering NVMe namespace consumers such as 71.Xr nvd 4 72.It 73API for submitting NVM commands to namespaces 74.It 75Ioctls for controller and namespace configuration and management | 59Note that in NVM Express terms, a namespace is roughly equivalent to a 60SCSI LUN. 61.Sh DESCRIPTION 62The 63.Nm 64driver provides support for NVM Express (NVMe) controllers, such as: 65.Bl -bullet 66.It 67Hardware initialization 68.It 69Per-CPU IO queue pairs 70.It 71API for registering NVMe namespace consumers such as 72.Xr nvd 4 73.It 74API for submitting NVM commands to namespaces 75.It 76Ioctls for controller and namespace configuration and management |
| 77.El |
|
| 76.Pp | 78.Pp |
| 79The |
|
| 77.Nm | 80.Nm |
| 78creates controller devices in the format | 81driver creates controller device nodes in the format |
| 79.Pa /dev/nvmeX | 82.Pa /dev/nvmeX |
| 80and namespace devices in | 83and namespace device nodes in |
| 81the format 82.Pa /dev/nvmeXnsY . 83Note that the NVM Express specification starts numbering namespaces at 1, 84not 0, and this driver follows that convention. 85.El 86.Sh CONFIGURATION 87By default, 88.Nm --- 81 unchanged lines hidden --- | 84the format 85.Pa /dev/nvmeXnsY . 86Note that the NVM Express specification starts numbering namespaces at 1, 87not 0, and this driver follows that convention. 88.El 89.Sh CONFIGURATION 90By default, 91.Nm --- 81 unchanged lines hidden --- |