Debian Codegraph @

doc/man/nbft_discovery.2

raw
1 .TH "libnvme" 9 "struct nbft_discovery" "November 2025" "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.