xref: /openbsd-src/share/man/man4/nvme.4 (revision 9119eb3a9696e45c028c4e2ed1fc85e2d96b3608)
1.\"	$OpenBSD: nvme.4,v 1.4 2024/09/26 06:10:34 jmc Exp $
2.\"
3.\" Copyright (c) 2016 David Gwynne <dlg@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: September 26 2024 $
18.Dt NVME 4
19.Os
20.Sh NAME
21.Nm nvme
22.Nd Non-Volatile Memory Host Controller Interface
23.Sh SYNOPSIS
24.Cd "nvme* at pci?"
25.Cd "nvme* at aplns?                # arm64"
26.Sh DESCRIPTION
27The
28.Nm
29driver provides support for NVMe, or NVM Express,
30storage controllers conforming to the
31Non-Volatile Memory Host Controller Interface specification.
32.Pp
33Although the NVMe specification provides its own command set, the
34.Nm
35driver provides access to the storage via a SCSI translation layer.
36.Pp
37Sensor values are made available through the
38.Va hw.sensors
39.Xr sysctl 8
40interface.
41.Sh SEE ALSO
42.Xr aplns 4 ,
43.Xr intro 4 ,
44.Xr pci 4 ,
45.Xr scsi 4
46.Sh HISTORY
47The
48.Nm
49driver first appeared in
50.Ox 6.0 .
51.Sh AUTHORS
52.An -nosplit
53The
54.Nm
55driver was written by
56.An David Gwynne Aq Mt dlg@openbsd.org .
57