Skip to content

Commit 4fea83d

Browse files
dwsusedwsuse
committed
doc: Regenerate all docs for v1.5
Signed-off-by: Daniel Wagner <[email protected]>
1 parent ce40bea commit 4fea83d

803 files changed

Lines changed: 5029 additions & 761 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
author = 'Keith Busch <[email protected]>'
1313
master_doc = 'index'
1414

15-
release = '1.4'
15+
release = '1.5'
1616

1717

1818
# -- General configuration ---------------------------------------------------

‎doc/config-schema.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@
5959
"type": "array",
6060
"items": { "$ref": "#/$defs/port" }
6161
},
62+
"application": {
63+
"description": "Program managing this subsystem",
64+
"type": "string"
65+
},
6266
"required": [ "nqn" ]
6367
}
6468
},

‎doc/man/nbft_control.2‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
.TH "libnvme" 9 "struct nbft_control" "June 2023" "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.

‎doc/man/nbft_control_flags.2‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.TH "libnvme" 9 "enum nbft_control_flags" "June 2023" "API Manual" LINUX
2+
.SH NAME
3+
enum nbft_control_flags \- Control Descriptor Flags
4+
.SH SYNOPSIS
5+
enum nbft_control_flags {
6+
.br
7+
.BI " NBFT_CONTROL_VALID"
8+
9+
};
10+
.SH Constants
11+
.IP "NBFT_CONTROL_VALID" 12
12+
Block Valid: indicates that the structure is valid.

‎doc/man/nbft_desc_type.2‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
.TH "libnvme" 9 "enum nbft_desc_type" "June 2023" "API Manual" LINUX
2+
.SH NAME
3+
enum nbft_desc_type \- NBFT Elements - Descriptor Types (Figure 5)
4+
.SH SYNOPSIS
5+
enum nbft_desc_type {
6+
.br
7+
.BI " NBFT_DESC_HEADER"
8+
,
9+
.br
10+
.br
11+
.BI " NBFT_DESC_CONTROL"
12+
,
13+
.br
14+
.br
15+
.BI " NBFT_DESC_HOST"
16+
,
17+
.br
18+
.br
19+
.BI " NBFT_DESC_HFI"
20+
,
21+
.br
22+
.br
23+
.BI " NBFT_DESC_SSNS"
24+
,
25+
.br
26+
.br
27+
.BI " NBFT_DESC_SECURITY"
28+
,
29+
.br
30+
.br
31+
.BI " NBFT_DESC_DISCOVERY"
32+
,
33+
.br
34+
.br
35+
.BI " NBFT_DESC_HFI_TRINFO"
36+
,
37+
.br
38+
.br
39+
.BI " NBFT_DESC_RESERVED_8"
40+
,
41+
.br
42+
.br
43+
.BI " NBFT_DESC_SSNS_EXT_INFO"
44+
45+
};
46+
.SH Constants
47+
.IP "NBFT_DESC_HEADER" 12
48+
Header: an ACPI structure header with some additional
49+
NBFT specific info.
50+
.IP "NBFT_DESC_CONTROL" 12
51+
Control Descriptor: indicates the location of host,
52+
HFI, SSNS, security, and discovery descriptors.
53+
.IP "NBFT_DESC_HOST" 12
54+
Host Descriptor: host information.
55+
.IP "NBFT_DESC_HFI" 12
56+
HFI Descriptor: an indexable table of HFI Descriptors,
57+
one for each fabric interface on the host.
58+
.IP "NBFT_DESC_SSNS" 12
59+
Subsystem Namespace Descriptor: an indexable table
60+
of SSNS Descriptors.
61+
.IP "NBFT_DESC_SECURITY" 12
62+
Security Descriptor: an indexable table of Security
63+
descriptors.
64+
.IP "NBFT_DESC_DISCOVERY" 12
65+
Discovery Descriptor: an indexable table of Discovery
66+
Descriptors.
67+
.IP "NBFT_DESC_HFI_TRINFO" 12
68+
HFI Transport Descriptor: indicated by an HFI Descriptor,
69+
corresponds to a specific transport for a single HFI.
70+
.IP "NBFT_DESC_RESERVED_8" 12
71+
Reserved.
72+
.IP "NBFT_DESC_SSNS_EXT_INFO" 12
73+
SSNS Extended Info Descriptor: indicated by an SSNS
74+
Descriptor if required.

‎doc/man/nbft_discovery.2‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
.TH "libnvme" 9 "struct nbft_discovery" "June 2023" "API Manual" LINUX
2+
.SH NAME
3+
struct nbft_discovery \- Discovery Descriptor (Figure 24)
4+
.SH SYNOPSIS
5+
struct nbft_discovery {
6+
.br
7+
.BI " __u8 structure_id;"
8+
.br
9+
.BI " __u8 flags;"
10+
.br
11+
.BI " __u8 index;"
12+
.br
13+
.BI " __u8 hfi_index;"
14+
.br
15+
.BI " __u8 sec_index;"
16+
.br
17+
.BI " __u8 reserved1;"
18+
.br
19+
.BI " struct nbft_heap_obj discovery_ctrl_addr_obj;"
20+
.br
21+
.BI " struct nbft_heap_obj discovery_ctrl_nqn_obj;"
22+
.br
23+
.BI " __u8 reserved2[14];"
24+
.br
25+
.BI "
26+
};
27+
.br
28+
29+
.SH Members
30+
.IP "structure_id" 12
31+
Structure ID: This field shall be set to 6h
32+
(i.e., Discovery Descriptor; #NBFT_DESC_DISCOVERY).
33+
.IP "flags" 12
34+
Discovery Descriptor Flags, see \fIenum nbft_discovery_flags\fP.
35+
.IP "index" 12
36+
Discovery Descriptor Index: This field indicates
37+
the number of this Discovery Descriptor in
38+
the Discovery Descriptor List.
39+
.IP "hfi_index" 12
40+
HFI Descriptor Index: This field indicates the value
41+
of the HFI Descriptor Index field of the HFI Descriptor
42+
associated with this Discovery Descriptor. If multiple
43+
HFIs share a common Discovery controller, there shall
44+
be multiple Discovery Descriptor entries with one per HFI.
45+
.IP "sec_index" 12
46+
Security Profile Descriptor Index: This field indicates
47+
the value of the Security Profile Descriptor Index
48+
field of the Security Descriptor associated with
49+
this Discovery Descriptor.
50+
.IP "reserved1" 12
51+
Reserved.
52+
.IP "discovery_ctrl_addr_obj" 12
53+
Discovery Controller Address Heap Object Reference:
54+
This field indicates the location and size of a heap
55+
object containing a URI which indicates an NVMe Discovery
56+
controller associated with this Discovery Descriptor.
57+
If this field is cleared to 0h, then no URI is specified.
58+
.IP "discovery_ctrl_nqn_obj" 12
59+
Discovery Controller NQN Heap Object Reference:
60+
If set to a non-zero value, this field indicates
61+
the location and size of a heap object containing
62+
an NVMe Discovery controller NQN. If the NVMe Discovery
63+
controller referenced by this record requires secure
64+
authentication with a well known Subsystem NQN, this
65+
field indicates the unique NQN for that NVMe Discovery
66+
controller. This record is involved formatted as an NQN
67+
string. If this field is cleared to 0h, then this
68+
field is reserved and the OS shall use the well
69+
known discovery NQN for this record.
70+
.IP "reserved2" 12
71+
Reserved.

‎doc/man/nbft_discovery_flags.2‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.TH "libnvme" 9 "enum nbft_discovery_flags" "June 2023" "API Manual" LINUX
2+
.SH NAME
3+
enum nbft_discovery_flags \- Discovery Descriptor Flags
4+
.SH SYNOPSIS
5+
enum nbft_discovery_flags {
6+
.br
7+
.BI " NBFT_DISCOVERY_VALID"
8+
9+
};
10+
.SH Constants
11+
.IP "NBFT_DISCOVERY_VALID" 12
12+
Descriptor Valid: if set to 1h, then this descriptor
13+
is valid. If cleared to 0h, then this descriptor
14+
is reserved.

0 commit comments

Comments
 (0)