Debian Codegraph @

doc/man/nbft_control.2

raw
1 .TH "libnvme" 9 "struct nbft_control" "November 2025" "API Manual" LINUX
2 .SH NAME
3 struct nbft_control \- NBFT Table - Control Descriptor (Figure 8)
4 .SH SYNOPSIS
5 struct nbft_control {
6 .br
7 .BI " __u8 structure_id;"
8 .br
9 .BI " __u8 major_revision;"
10 .br
11 .BI " __u8 minor_revision;"
12 .br
13 .BI " __u8 reserved1;"
14 .br
15 .BI " __le16 csl;"
16 .br
17 .BI " __u8 flags;"
18 .br
19 .BI " __u8 reserved2;"
20 .br
21 .BI " struct nbft_heap_obj hdesc;"
22 .br
23 .BI " __u8 hsv;"
24 .br
25 .BI " __u8 reserved3;"
26 .br
27 .BI " __le32 hfio;"
28 .br
29 .BI " __le16 hfil;"
30 .br
31 .BI " __u8 hfiv;"
32 .br
33 .BI " __u8 num_hfi;"
34 .br
35 .BI " __le32 ssnso;"
36 .br
37 .BI " __le16 ssnsl;"
38 .br
39 .BI " __u8 ssnsv;"
40 .br
41 .BI " __u8 num_ssns;"
42 .br
43 .BI " __le32 seco;"
44 .br
45 .BI " __le16 secl;"
46 .br
47 .BI " __u8 secv;"
48 .br
49 .BI " __u8 num_sec;"
50 .br
51 .BI " __le32 disco;"
52 .br
53 .BI " __le16 discl;"
54 .br
55 .BI " __u8 discv;"
56 .br
57 .BI " __u8 num_disc;"
58 .br
59 .BI " __u8 reserved4[16];"
60 .br
61 .BI "
62 };
63 .br
64
65 .SH Members
66 .IP "structure_id" 12
67 Structure ID: This field specifies the element (refer to
68 \fIenum nbft_desc_type\fP). This field shall be set to 1h (i.e.,
69 Control, #NBFT_DESC_CONTROL).
70 .IP "major_revision" 12
71 Major Revision: The major revision of the structure corresponding
72 to the Signature field. Larger major revision numbers should
73 not be assumed backward compatible to lower major revision
74 numbers with the same signature.
75 .IP "minor_revision" 12
76 Minor Revision: The minor revision of the structure corresponding
77 to the signature field. If the major revision numbers are
78 the same, any minor revision number differences shall be backwards
79 compatible with the same signature.
80 .IP "reserved1" 12
81 Reserved.
82 .IP "csl" 12
83 Control Structure Length (CSL): This field indicates the length
84 in bytes of the Control Descriptor.
85 .IP "flags" 12
86 Flags, see \fIenum nbft_control_flags\fP.
87 .IP "reserved2" 12
88 Reserved.
89 .IP "hdesc" 12
90 Host Descriptor (HDESC): This field indicates the location
91 and length of the Host Descriptor (see \fIstruct nbft_host\fP).
92 .IP "hsv" 12
93 Host Descriptor Version (HSV): This field indicates the version
94 of the Host Descriptor.
95 .IP "reserved3" 12
96 Reserved.
97 .IP "hfio" 12
98 HFI Descriptor List Offset (HFIO): If this field is set to
99 a non-zero value, then this field indicates the offset in bytes
100 of the HFI Descriptor List, if any, from byte offset 0h of the
101 NBFT Table Header. If the \fInum_hfi\fP field is cleared to 0h,
102 then this field is reserved.
103 .IP "hfil" 12
104 HFI Descriptor Length (HFIL): This field indicates the length
105 in bytes of each HFI Descriptor, if any. If the \fInum_hfi\fP field
106 is cleared to 0h, then this field is reserved.
107 .IP "hfiv" 12
108 HFI Descriptor Version (HFIV): This field indicates the version
109 of each HFI Descriptor.
110 .IP "num_hfi" 12
111 Number of Host Fabric Interface Descriptors (NumHFI): This field
112 indicates the number of HFI Descriptors (see \fIstruct nbft_hfi\fP)
113 in the HFI Descriptor List, if any. If no interfaces have been
114 configured, then this field shall be cleared to 0h.
115 .IP "ssnso" 12
116 SSNS Descriptor List Offset (SSNSO):: This field indicates
117 the offset in bytes of the SSNS Descriptor List, if any, from
118 byte offset 0h of the NBFT Table Header. If the \fInum_ssns\fP field
119 is cleared to 0h, then this field is reserved.
120 .IP "ssnsl" 12
121 SSNS Descriptor Length (SSNSL): This field indicates the length
122 in bytes of each SSNS Descriptor, if any. If the \fInum_ssns\fP
123 field is cleared to 0h, then this field is reserved.
124 .IP "ssnsv" 12
125 SSNS Descriptor Version (SSNSV): This field indicates the version
126 of the SSNS Descriptor.
127 .IP "num_ssns" 12
128 Number of Subsystem and Namespace Descriptors (NumSSNS): This
129 field indicates the number of Subsystem Namespace (SSNS)
130 Descriptors (see \fIstruct nbft_ssns\fP) in the SSNS Descriptor List,
131 if any.
132 .IP "seco" 12
133 Security Profile Descriptor List Offset (SECO): This field
134 indicates the offset in bytes of the Security Profile Descriptor
135 List, if any, from byte offset 0h of the NBFT Table Header.
136 If the \fInum_sec\fP field is cleared to 0h, then this field
137 is reserved.
138 .IP "secl" 12
139 Security Profile Descriptor Length (SECL): This field indicates
140 the length in bytes of each Security Profile Descriptor, if any.
141 If the \fInum_sec\fP field is cleared to 0h, then this field
142 is reserved.
143 .IP "secv" 12
144 Security Profile Descriptor Version (SECV): This field indicates
145 the version of the Security Profile Descriptor.
146 .IP "num_sec" 12
147 Number of Security Profile Descriptors (NumSec): This field
148 indicates the number of Security Profile Descriptors
149 (see \fIstruct nbft_security\fP), if any, in the Security Profile
150 Descriptor List.
151 .IP "disco" 12
152 Discovery Descriptor Offset (DISCO): This field indicates
153 the offset in bytes of the Discovery Descriptor List, if any,
154 from byte offset 0h of the NBFT Table Header. If the \fInum_disc\fP
155 field is cleared to 0h, then this field is reserved.
156 .IP "discl" 12
157 Discovery Descriptor Length (DISCL): This field indicates
158 the length in bytes of each Discovery Descriptor, if any.
159 If the \fInum_disc\fP field is cleared to 0h, then this field
160 is reserved.
161 .IP "discv" 12
162 Discovery Descriptor Version (DISCV): This field indicates
163 the version of the Discovery Descriptor.
164 .IP "num_disc" 12
165 Number of Discovery Descriptors (NumDisc): This field indicates
166 the number of Discovery Descriptors (see \fIstruct nbft_discovery\fP),
167 if any, in the Discovery Descriptor List, if any.
168 .IP "reserved4" 12
169 Reserved.