svn commit: r327055 - head/share/man/man4

Thu Dec 21 04:23:02 UTC 2017

Author: imp
Date: Thu Dec 21 04:23:00 2017
New Revision: 327055
URL: https://svnweb.freebsd.org/changeset/base/327055

Log:
  Provide a nda man page. Add cross referneces. Bump dates.
  Also, CAM is a storage subsystem, not a SCSI/ATA one these days.
  
  Sponsored by: Netflix

Added:
  head/share/man/man4/nda.4   (contents, props changed)
Modified:
  head/share/man/man4/Makefile
  head/share/man/man4/ada.4
  head/share/man/man4/da.4
  head/share/man/man4/pci.4
  head/share/man/man4/scsi.4

Modified: head/share/man/man4/Makefile
==============================================================================

--- head/share/man/man4/Makefile	Thu Dec 21 04:21:59 2017	(r327054)
+++ head/share/man/man4/Makefile	Thu Dec 21 04:23:00 2017	(r327055)
@@ -382,6 +382,7 @@ MAN=	aac.4 \
 	${_ntb_hw_intel.4} \
 	${_ntb_hw_plx.4} \
 	${_ntb_transport.4} \
+	${_nda.4} \
 	${_if_ntb.4} \
 	null.4 \
 	numa.4 \
@@ -808,6 +809,7 @@ _if_wpi.4=	if_wpi.4
 _ipmi.4=	ipmi.4
 _io.4=		io.4
 _linux.4=	linux.4
+_nda.4=		nda.4
 _ndis.4=	ndis.4
 _nfe.4=		nfe.4
 _nfsmb.4=	nfsmb.4

Modified: head/share/man/man4/ada.4
==============================================================================
--- head/share/man/man4/ada.4	Thu Dec 21 04:21:59 2017	(r327054)
+++ head/share/man/man4/ada.4	Thu Dec 21 04:23:00 2017	(r327055)
@@ -25,7 +25,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd June 19, 2015
+.Dd December 20, 2017
 .Dt ADA 4
 .Os
 .Sh NAME
@@ -157,6 +157,7 @@ ATA device nodes
 .Xr cam 4 ,
 .Xr da 4 ,
 .Xr mvs 4 ,
+.Xr nda 4 ,
 .Xr siis 4
 .Sh HISTORY
 The

Modified: head/share/man/man4/da.4
==============================================================================
--- head/share/man/man4/da.4	Thu Dec 21 04:21:59 2017	(r327054)
+++ head/share/man/man4/da.4	Thu Dec 21 04:23:00 2017	(r327055)
@@ -25,7 +25,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd October 11, 2015
+.Dd December 20, 2017
 .Dt DA 4
 .Os
 .Sh NAME
@@ -214,6 +214,7 @@ None.
 .Xr ada 4 ,
 .Xr cam 4 ,
 .Xr geom 4 ,
+.Xr nda 4 ,
 .Xr gpart 8
 .Sh HISTORY
 The

Added: head/share/man/man4/nda.4
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man4/nda.4	Thu Dec 21 04:23:00 2017	(r327055)
@@ -0,0 +1,87 @@
+.\" Copyright (c) 2017 Netflix, Inc
+.\" 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.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, 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 DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd December 20, 2017
+.Dt NDA 4
+.Os
+.Sh NAME
+.Nm nda
+.Nd NVMe Direct Access device driver
+.Sh SYNOPSIS
+.Cd device nvme
+.Cd device scbus
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for direct access devices, implementing the
+.Tn NVMe
+command protocol, that are attached to the system through a host adapter
+supported by the CAM subsystem.
+.Sh SYSCTL VARIABLES
+The following variables are available as both
+.Xr sysctl 8
+variables and
+.Xr loader 8
+tunables:
+.Bl -tag -width 12
+.It Va kern.cam.nda.sort_io_queue
+.Pp
+This variable determines whether the software queued entries are
+sorted in LBA order or not.
+Sorting is almost always a waste of time.
+The default is to not sort.
+.El
+.Pp
+The following report per-device settings, and are read-only unless
+otherwise indicated. Replace
+.Va N
+with the device unit number.
+.Bl -tag -width 12
+.It Va kern.cam.nda.N.rotating
+.Pp
+This variable reports whether the storage volume is spinning or
+flash.
+It's value is hard coded to 0 indicating flash.
+.It Va kern.cam.nda.N.unmapped_io
+This variable reports whether the
+.Nm
+driver accepts unmapped I/O for this unit.
+.Sh FILES
+.Bl -tag -width ".Pa /dev/nda*" -compact
+.It Pa /dev/nda*
+NVMe storage device nodes
+.El
+.Sh SEE ALSO
+.Xr nvme 4 ,
+.Xr nvd 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Fx 12.0 .
+.Sh AUTHORS
+.An Warner Losh Aq Mt imp at FreeBSD.org

Modified: head/share/man/man4/pci.4
==============================================================================
--- head/share/man/man4/pci.4	Thu Dec 21 04:21:59 2017	(r327054)
+++ head/share/man/man4/pci.4	Thu Dec 21 04:23:00 2017	(r327055)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd September 8, 2016
+.Dd December 20, 2017
 .Dt PCI 4
 .Os
 .Sh NAME

Modified: head/share/man/man4/scsi.4
==============================================================================
--- head/share/man/man4/scsi.4	Thu Dec 21 04:21:59 2017	(r327054)
+++ head/share/man/man4/scsi.4	Thu Dec 21 04:23:00 2017	(r327055)
@@ -24,12 +24,12 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD$
-.Dd January 15, 2017
+.Dd December 20, 2017
 .Dt CAM 4
 .Os
 .Sh NAME
 .Nm CAM
-.Nd Common Access Method SCSI/ATA subsystem
+.Nd Common Access Method Storage subsystem
 .Sh SYNOPSIS
 .Cd "device scbus"
 .Cd "device ada"
@@ -353,6 +353,7 @@ for details.
 .Xr cd 4 ,
 .Xr ch 4 ,
 .Xr da 4 ,
+.Xr nda 4 ,
 .Xr nvme 4 ,
 .Xr pass 4 ,
 .Xr pt 4 ,
