| 1 |
.TH "libnvme" 9 "enum nbft_host_flags" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
enum nbft_host_flags \- Host Flags |
| 4 |
.SH SYNOPSIS |
| 5 |
enum nbft_host_flags { |
| 6 |
.br |
| 7 |
.BI " NBFT_HOST_VALID" |
| 8 |
, |
| 9 |
.br |
| 10 |
.br |
| 11 |
.BI " NBFT_HOST_HOSTID_CONFIGURED" |
| 12 |
, |
| 13 |
.br |
| 14 |
.br |
| 15 |
.BI " NBFT_HOST_HOSTNQN_CONFIGURED" |
| 16 |
, |
| 17 |
.br |
| 18 |
.br |
| 19 |
.BI " NBFT_HOST_PRIMARY_ADMIN_MASK" |
| 20 |
, |
| 21 |
.br |
| 22 |
.br |
| 23 |
.BI " NBFT_HOST_PRIMARY_ADMIN_NOT_INDICATED" |
| 24 |
, |
| 25 |
.br |
| 26 |
.br |
| 27 |
.BI " NBFT_HOST_PRIMARY_ADMIN_UNSELECTED" |
| 28 |
, |
| 29 |
.br |
| 30 |
.br |
| 31 |
.BI " NBFT_HOST_PRIMARY_ADMIN_SELECTED" |
| 32 |
|
| 33 |
}; |
| 34 |
.SH Constants |
| 35 |
.IP "NBFT_HOST_VALID" 12 |
| 36 |
Descriptor Valid: If set to 1h, then this |
| 37 |
descriptor is valid. If cleared to 0h, then |
| 38 |
this descriptor is reserved. |
| 39 |
.IP "NBFT_HOST_HOSTID_CONFIGURED" 12 |
| 40 |
HostID Configured: If set to 1h, then the |
| 41 |
Host ID field contains an administratively-configured |
| 42 |
value. If cleared to 0h, then the Host ID |
| 43 |
field contains a driver default value. |
| 44 |
.IP "NBFT_HOST_HOSTNQN_CONFIGURED" 12 |
| 45 |
Host NQN Configured: If set to 1h, then the |
| 46 |
Host NQN indicated by the Host NQN Heap Object |
| 47 |
Reference field (\fIstruct nbft_host\fP.host_nqn) |
| 48 |
contains an administratively-configured value. |
| 49 |
If cleared to 0h, then the Host NQN indicated |
| 50 |
by the Host NQN Offset field contains a driver |
| 51 |
default value. |
| 52 |
.IP "NBFT_HOST_PRIMARY_ADMIN_MASK" 12 |
| 53 |
Mask to get Primary Administrative Host Descriptor: |
| 54 |
indicates whether the Host Descriptor in this |
| 55 |
NBFT was selected as the primary NBFT for |
| 56 |
administrative purposes of platform identity |
| 57 |
as a hint to the OS. If multiple NBFT tables |
| 58 |
are present, only one NBFT should be administratively |
| 59 |
selected. There is no enforcement mechanism |
| 60 |
for this to be coordinated between multiple NBFT |
| 61 |
tables, but this field should be set to Selected |
| 62 |
(#NBFT_HOST_PRIMARY_ADMIN_SELECTED) if |
| 63 |
more than one NBFT is present. |
| 64 |
.IP "NBFT_HOST_PRIMARY_ADMIN_NOT_INDICATED" 12 |
| 65 |
Not Indicated by Driver: The driver that created |
| 66 |
this NBFT provided no administrative priority |
| 67 |
hint for this NBFT. |
| 68 |
.IP "NBFT_HOST_PRIMARY_ADMIN_UNSELECTED" 12 |
| 69 |
Unselected: The driver that created this NBFT |
| 70 |
explicitly indicated that this NBFT should |
| 71 |
not be prioritized over any other NBFT. |
| 72 |
.IP "NBFT_HOST_PRIMARY_ADMIN_SELECTED" 12 |
| 73 |
Selected: The driver that created this NBFT |
| 74 |
explicitly indicated that this NBFT should |
| 75 |
be prioritized over any other NBFT. |