Debian Codegraph @

doc/man/nbft_ssns_flags.2

raw
1 .TH "libnvme" 9 "enum nbft_ssns_flags" "November 2025" "API Manual" LINUX
2 .SH NAME
3 enum nbft_ssns_flags \- Subsystem and Namespace Specific Flags Field (Figure 16)
4 .SH SYNOPSIS
5 enum nbft_ssns_flags {
6 .br
7 .BI " NBFT_SSNS_VALID"
8 ,
9 .br
10 .br
11 .BI " NBFT_SSNS_NON_BOOTABLE_ENTRY"
12 ,
13 .br
14 .br
15 .BI " NBFT_SSNS_USE_SECURITY_FIELD"
16 ,
17 .br
18 .br
19 .BI " NBFT_SSNS_DHCP_ROOT_PATH_OVERRIDE"
20 ,
21 .br
22 .br
23 .BI " NBFT_SSNS_EXTENDED_INFO_IN_USE"
24 ,
25 .br
26 .br
27 .BI " NBFT_SSNS_SEPARATE_DISCOVERY_CTRL"
28 ,
29 .br
30 .br
31 .BI " NBFT_SSNS_DISCOVERED_NAMESPACE"
32 ,
33 .br
34 .br
35 .BI " NBFT_SSNS_UNAVAIL_NAMESPACE_MASK"
36 ,
37 .br
38 .br
39 .BI " NBFT_SSNS_UNAVAIL_NAMESPACE_NOTIND"
40 ,
41 .br
42 .br
43 .BI " NBFT_SSNS_UNAVAIL_NAMESPACE_AVAIL"
44 ,
45 .br
46 .br
47 .BI " NBFT_SSNS_UNAVAIL_NAMESPACE_UNAVAIL"
48
49 };
50 .SH Constants
51 .IP "NBFT_SSNS_VALID" 12
52 Descriptor Valid: If set to 1h, then this descriptor
53 is valid. If cleared to 0h, then this descriptor
54 is not valid. A host that supports NVMe-oF Boot,
55 but does not currently have a remote Subsystem
56 and Namespace assigned may clear this bit to 0h.
57 .IP "NBFT_SSNS_NON_BOOTABLE_ENTRY" 12
58 Non-bootable Entry Flag: If set to 1h, this flag
59 indicates that this SSNS Descriptor contains
60 a namespace of administrative purpose to the boot
61 process, but the pre-OS may not have established
62 connectivity to or evaluated the contents of this
63 Descriptor. Such namespaces may contain supplemental
64 data deemed relevant by the Administrator as part
65 of the pre-OS to OS hand off. This may include
66 properties such as a UEFI device path that may
67 not have been created for this namespace. This means
68 an OS runtime may still require the contents
69 of such a namespace to complete later stages
70 of boot. If cleared to 0h, then this namespace did
71 not have any special administrative intent.
72 .IP "NBFT_SSNS_USE_SECURITY_FIELD" 12
73 Use Security Flag: If set to 1h, then there is
74 a Security Profile Descriptor associated with this
75 SSNS record and the Security Profile Descriptor Index
76 field is valid. If cleared to 0h, then there is
77 no Security Profile Descriptor associated with this
78 SSNS record and the Security Profile Descriptor Index
79 field is not valid.
80 .IP "NBFT_SSNS_DHCP_ROOT_PATH_OVERRIDE" 12
81 DHCP Root-Path Override Flag: If set to 1h, then
82 this SSNS descriptor was populated by consuming
83 the DHCP Root-Path on this interface. If cleared
84 to 0h, then the DHCP Root-Path was not used
85 in populating the SSNS descriptor.
86 .IP "NBFT_SSNS_EXTENDED_INFO_IN_USE" 12
87 SSNS Extended Info In-use Flag: If set to 1h,
88 then the SSNS Extended Information Offset field
89 and the SSNS Extended Information Length field
90 are valid. This flag, if set to 1h, indicates
91 that a Subsystem and Namespace Extended Information
92 Descriptor corresponding to this descriptor is present.
93 .IP "NBFT_SSNS_SEPARATE_DISCOVERY_CTRL" 12
94 Separate Discovery Controller Flag: If set to 1h,
95 then the Discovery controller associated with
96 this volume is on a different transport address
97 than the specified in the Subsystem Transport
98 Address Heap Object Reference. If cleared to 0h,
99 then the Discovery controller is the same as the
100 Subsystem Transport Address Heap Object Reference.
101 .IP "NBFT_SSNS_DISCOVERED_NAMESPACE" 12
102 Discovered Namespace Flag: If set to 1h, then
103 this namespace was acquired through discovery.
104 If cleared to 0h, then this namespace was
105 explicitly configured in the system.
106 .IP "NBFT_SSNS_UNAVAIL_NAMESPACE_MASK" 12
107 Mask to get Unavailable Namespace Flag: This
108 field indicates the availability of the namespace
109 at a specific point in time. Such use is only
110 a hint and its use does not guarantee the availability
111 of that referenced namespace at any future point in time.
112 .IP "NBFT_SSNS_UNAVAIL_NAMESPACE_NOTIND" 12
113 Not Indicated by Driver: No information is provided.
114 .IP "NBFT_SSNS_UNAVAIL_NAMESPACE_AVAIL" 12
115 Available: A referenced namespace described by this
116 flag was previously accessible by the pre-OS driver.
117 .IP "NBFT_SSNS_UNAVAIL_NAMESPACE_UNAVAIL" 12
118 Unavailable: This namespace was administratively
119 configured but unattempted, unavailable or
120 inaccessible when establishing connectivity
121 by the pre-OS driver.