19 lines
658 B
Groff
19 lines
658 B
Groff
|
.TH "nvme_mi_admin_format_nvm" 9 "nvme_mi_admin_format_nvm" "October 2022" "libnvme API manual" LINUX
|
||
|
|
.SH NAME
|
||
|
|
nvme_mi_admin_format_nvm \- Format NVMe namespace
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.B "int" nvme_mi_admin_format_nvm
|
||
|
|
.BI "(nvme_mi_ctrl_t ctrl " ","
|
||
|
|
.BI "struct nvme_format_nvm_args *args " ");"
|
||
|
|
.SH ARGUMENTS
|
||
|
|
.IP "ctrl" 12
|
||
|
|
Controller to send command to
|
||
|
|
.IP "args" 12
|
||
|
|
Format NVM command arguments
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
Perform a low-level format to set the LBA data & metadata size. May destroy
|
||
|
|
data & metadata on the specified namespaces
|
||
|
|
.SH "RETURN"
|
||
|
|
The nvme command status if a response was received (see
|
||
|
|
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
|