| 1 |
.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
enum nvme_id_ctrl_fna \- This field indicates attributes for the Format NVM command. |
| 4 |
.SH SYNOPSIS |
| 5 |
enum nvme_id_ctrl_fna { |
| 6 |
.br |
| 7 |
.BI " NVME_CTRL_FNA_FMT_ALL_NS_SHIFT" |
| 8 |
, |
| 9 |
.br |
| 10 |
.br |
| 11 |
.BI " NVME_CTRL_FNA_SEC_ALL_NS_SHIFT" |
| 12 |
, |
| 13 |
.br |
| 14 |
.br |
| 15 |
.BI " NVME_CTRL_FNA_CES_SHIFT" |
| 16 |
, |
| 17 |
.br |
| 18 |
.br |
| 19 |
.BI " NVME_CTRL_FNA_NSID_ALL_F_SHIFT" |
| 20 |
, |
| 21 |
.br |
| 22 |
.br |
| 23 |
.BI " NVME_CTRL_FNA_FMT_ALL_NS_MASK" |
| 24 |
, |
| 25 |
.br |
| 26 |
.br |
| 27 |
.BI " NVME_CTRL_FNA_SEC_ALL_NS_MASK" |
| 28 |
, |
| 29 |
.br |
| 30 |
.br |
| 31 |
.BI " NVME_CTRL_FNA_CES_MASK" |
| 32 |
, |
| 33 |
.br |
| 34 |
.br |
| 35 |
.BI " NVME_CTRL_FNA_NSID_ALL_F_MASK" |
| 36 |
, |
| 37 |
.br |
| 38 |
.br |
| 39 |
.BI " NVME_CTRL_FNA_FMT_ALL_NAMESPACES" |
| 40 |
, |
| 41 |
.br |
| 42 |
.br |
| 43 |
.BI " NVME_CTRL_FNA_SEC_ALL_NAMESPACES" |
| 44 |
, |
| 45 |
.br |
| 46 |
.br |
| 47 |
.BI " NVME_CTRL_FNA_CRYPTO_ERASE" |
| 48 |
, |
| 49 |
.br |
| 50 |
.br |
| 51 |
.BI " NVME_CTRL_FNA_NSID_FFFFFFFF" |
| 52 |
|
| 53 |
}; |
| 54 |
.SH Constants |
| 55 |
.IP "NVME_CTRL_FNA_FMT_ALL_NS_SHIFT" 12 |
| 56 |
Shift amount to get the format applied to all namespaces |
| 57 |
.IP "NVME_CTRL_FNA_SEC_ALL_NS_SHIFT" 12 |
| 58 |
Shift amount to get the secure erase applied to all namespaces |
| 59 |
.IP "NVME_CTRL_FNA_CES_SHIFT" 12 |
| 60 |
Shift amount to get the cryptographic erase supported |
| 61 |
.IP "NVME_CTRL_FNA_NSID_ALL_F_SHIFT" 12 |
| 62 |
Shift amount to get the format supported an NSID FFFFFFFFh |
| 63 |
.IP "NVME_CTRL_FNA_FMT_ALL_NS_MASK" 12 |
| 64 |
Mask to get the format applied to all namespaces |
| 65 |
.IP "NVME_CTRL_FNA_SEC_ALL_NS_MASK" 12 |
| 66 |
Mask to get the secure erase applied to all namespaces |
| 67 |
.IP "NVME_CTRL_FNA_CES_MASK" 12 |
| 68 |
Mask to get the cryptographic erase supported |
| 69 |
.IP "NVME_CTRL_FNA_NSID_ALL_F_MASK" 12 |
| 70 |
Mask to get the format supported an NSID FFFFFFFFh |
| 71 |
.IP "NVME_CTRL_FNA_FMT_ALL_NAMESPACES" 12 |
| 72 |
If set, then all namespaces in an NVM |
| 73 |
subsystem shall be configured with the |
| 74 |
same attributes and a format (excluding |
| 75 |
secure erase) of any namespace results in |
| 76 |
a format of all namespaces in an NVM |
| 77 |
subsystem. If cleared, then the |
| 78 |
controller supports format on a per |
| 79 |
namespace basis. |
| 80 |
.IP "NVME_CTRL_FNA_SEC_ALL_NAMESPACES" 12 |
| 81 |
If set, then any secure erase performed |
| 82 |
as part of a format operation results in |
| 83 |
a secure erase of all namespaces in the |
| 84 |
NVM subsystem. If cleared, then any |
| 85 |
secure erase performed as part of a |
| 86 |
format results in a secure erase of the |
| 87 |
particular namespace specified. |
| 88 |
.IP "NVME_CTRL_FNA_CRYPTO_ERASE" 12 |
| 89 |
If set, then cryptographic erase is |
| 90 |
supported. If cleared, then cryptographic |
| 91 |
erase is not supported. |
| 92 |
.IP "NVME_CTRL_FNA_NSID_FFFFFFFF" 12 |
| 93 |
If set, then format does not support |
| 94 |
nsid value set to FFFFFFFFh. If cleared, |
| 95 |
format supports nsid value set to |
| 96 |
FFFFFFFFh. |