1libnvme(9) API Manual libnvme(9)
2
6 enum nbft_ssns_flags - Subsystem and Namespace Specific Flags Field
7 (Figure 16)
8
10 enum nbft_ssns_flags {
11 NBFT_SSNS_VALID ,
12 NBFT_SSNS_NON_BOOTABLE_ENTRY ,
13 NBFT_SSNS_USE_SECURITY_FIELD ,
14 NBFT_SSNS_DHCP_ROOT_PATH_OVERRIDE ,
15 NBFT_SSNS_EXTENDED_INFO_IN_USE ,
16 NBFT_SSNS_SEPARATE_DISCOVERY_CTRL ,
17 NBFT_SSNS_DISCOVERED_NAMESPACE ,
18 NBFT_SSNS_UNAVAIL_NAMESPACE_MASK ,
19 NBFT_SSNS_UNAVAIL_NAMESPACE_NOTIND ,
20 NBFT_SSNS_UNAVAIL_NAMESPACE_AVAIL ,
21 NBFT_SSNS_UNAVAIL_NAMESPACE_UNAVAIL
22 };
24
26 NBFT_SSNS_VALID
27 Descriptor Valid: If set to 1h, then this descriptor is
28 valid. If cleared to 0h, then this descriptor is not valid.
29 A host that supports NVMe-oF Boot, but does not currently
30 have a remote Subsystem and Namespace assigned may clear
31 this bit to 0h.
32 NBFT_SSNS_NON_BOOTABLE_ENTRY
34 Non-bootable Entry Flag: If set to 1h, this flag indicates
35 that this SSNS Descriptor contains a namespace of adminis‐
36 trative purpose to the boot process, but the pre-OS may not
37 have established connectivity to or evaluated the contents
38 of this Descriptor. Such namespaces may contain supplemen‐
39 tal data deemed relevant by the Administrator as part of
40 the pre-OS to OS hand off. This may include properties such
41 as a UEFI device path that may not have been created for
42 this namespace. This means an OS runtime may still require
43 the contents of such a namespace to complete later stages
44 of boot. If cleared to 0h, then this namespace did not have
45 any special administrative intent.
46 NBFT_SSNS_USE_SECURITY_FIELD
48 Use Security Flag: If set to 1h, then there is a Security
49 Profile Descriptor associated with this SSNS record and the
50 Security Profile Descriptor Index field is valid. If
51 cleared to 0h, then there is no Security Profile Descriptor
52 associated with this SSNS record and the Security Profile
53 Descriptor Index field is not valid.
54 NBFT_SSNS_DHCP_ROOT_PATH_OVERRIDE
56 DHCP Root-Path Override Flag: If set to 1h, then this SSNS
57 descriptor was populated by consuming the DHCP Root-Path on
58 this interface. If cleared to 0h, then the DHCP Root-Path
59 was not used in populating the SSNS descriptor.
60 NBFT_SSNS_EXTENDED_INFO_IN_USE
62 SSNS Extended Info In-use Flag: If set to 1h, then the SSNS
63 Extended Information Offset field and the SSNS Extended In‐
64 formation Length field are valid. This flag, if set to 1h,
65 indicates that a Subsystem and Namespace Extended Informa‐
66 tion Descriptor corresponding to this descriptor is
67 present.
68 NBFT_SSNS_SEPARATE_DISCOVERY_CTRL
70 Separate Discovery Controller Flag: If set to 1h, then the
71 Discovery controller associated with this volume is on a
72 different transport address than the specified in the Sub‐
73 system Transport Address Heap Object Reference. If cleared
74 to 0h, then the Discovery controller is the same as the
75 Subsystem Transport Address Heap Object Reference.
76 NBFT_SSNS_DISCOVERED_NAMESPACE
78 Discovered Namespace Flag: If set to 1h, then this name‐
79 space was acquired through discovery. If cleared to 0h,
80 then this namespace was explicitly configured in the sys‐
81 tem.
82 NBFT_SSNS_UNAVAIL_NAMESPACE_MASK
84 Mask to get Unavailable Namespace Flag: This field indi‐
85 cates the availability of the namespace at a specific point
86 in time. Such use is only a hint and its use does not guar‐
87 antee the availability of that referenced namespace at any
88 future point in time.
89 NBFT_SSNS_UNAVAIL_NAMESPACE_NOTIND
91 Not Indicated by Driver: No information is provided.
92 NBFT_SSNS_UNAVAIL_NAMESPACE_AVAIL
94 Available: A referenced namespace described by this flag
95 was previously accessible by the pre-OS driver.
96 NBFT_SSNS_UNAVAIL_NAMESPACE_UNAVAIL
98 Unavailable: This namespace was administratively configured
99 but unattempted, unavailable or inaccessible when estab‐
100 lishing connectivity by the pre-OS driver.
101April 2023 enum nbft_ssns_flags libnvme(9)