Changeset View
Changeset View
Standalone View
Standalone View
head/share/man/man4/nvdimm.4
| Show All 21 Lines | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd August 23, 2019 | .Dd September 5, 2019 | ||||
| .Dt NVDIMM 4 | .Dt NVDIMM 4 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm nvdimm | .Nm nvdimm | ||||
| .Nd ACPI NVDIMM driver | .Nd ACPI NVDIMM driver | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| To load the driver as a module at boot, place the following line in | To load the driver as a module at boot, place the following line in | ||||
| .Xr loader.conf 5 : | .Xr loader.conf 5 : | ||||
| Show All 31 Lines | |||||
| .Xr read 2 , | .Xr read 2 , | ||||
| .Xr write 2 , | .Xr write 2 , | ||||
| or | or | ||||
| .Xr mmap 2 | .Xr mmap 2 | ||||
| the device. | the device. | ||||
| .Pp | .Pp | ||||
| Also, for each SPA, the geom provider | Also, for each SPA, the geom provider | ||||
| .Pa spaNNN | .Pa spaNNN | ||||
| is created, which can be used to create a conventional filesystem (e.g. | is created, which can be used to create a conventional filesystem (e.g., | ||||
| by | by | ||||
| .Xr newfs 8 ) | .Xr newfs 8 ) | ||||
| and | and | ||||
| .Xr mount 8 | .Xr mount 8 | ||||
| it as any storage volume. | it as any storage volume. | ||||
| Content accessible by | Content accessible by | ||||
| .Pa /dev/nvdimm_spaNNN | .Pa /dev/nvdimm_spaNNN | ||||
| and | and | ||||
| .Pa /dev/spaNNN | .Pa /dev/spaNNN | ||||
| is coherent. | is coherent. | ||||
| .Pp | |||||
| The | |||||
| .Nm | |||||
| driver has support for reading NVDIMM namespaces (if supported by your | |||||
| hardware and already configured by some other mechanism, e.g., a BIOS | |||||
| configuration screen). | |||||
| The driver will provide a | |||||
| .Pa /dev/nvdimm_spaNNNnsMMM | |||||
| device node and | |||||
| .Pa spaNNNnsMMM | |||||
| geom provider for each namespace in a SPA, which behave analogously to their | |||||
| full-SPA cousins described above. | |||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr ACPI 4 , | .Xr ACPI 4 , | ||||
| .Xr GEOM 4 , | .Xr GEOM 4 , | ||||
| .Xr geom 8 , | .Xr geom 8 , | ||||
| .Xr mount 8 , | .Xr mount 8 , | ||||
| .Xr newfs 8 , | .Xr newfs 8 , | ||||
| .Xr disk 9 | .Xr disk 9 | ||||
| .Sh HISTORY | .Sh HISTORY | ||||
| Show All 26 Lines | |||||