1libnvme(9)                        API Manual                        libnvme(9)
2
3
4

NAME

6       struct nbft_discovery - Discovery Descriptor (Figure 24)
7

SYNOPSIS

9       struct nbft_discovery {
10           __u8 structure_id;
11           __u8 flags;
12           __u8 index;
13           __u8 hfi_index;
14           __u8 sec_index;
15           __u8 reserved1;
16           struct nbft_heap_obj discovery_ctrl_addr_obj;
17           struct nbft_heap_obj discovery_ctrl_nqn_obj;
18           __u8 reserved2[14];
19        };
20
21

Members

23       structure_id
24                   Structure  ID: This field shall be set to 6h (i.e., Discov‐
25                   ery Descriptor; #NBFT_DESC_DISCOVERY).
26
27       flags       Discovery Descriptor Flags, see enum nbft_discovery_flags.
28
29       index       Discovery Descriptor Index: This field indicates the number
30                   of  this  Discovery  Descriptor in the Discovery Descriptor
31                   List.
32
33       hfi_index   HFI Descriptor Index: This field indicates the value of the
34                   HFI Descriptor Index field of the HFI Descriptor associated
35                   with this Discovery Descriptor. If multiple  HFIs  share  a
36                   common  Discovery  controller, there shall be multiple Dis‐
37                   covery Descriptor entries with one per HFI.
38
39       sec_index   Security Profile Descriptor Index: This field indicates the
40                   value of the Security Profile Descriptor Index field of the
41                   Security Descriptor associated with this Discovery Descrip‐
42                   tor.
43
44       reserved1   Reserved.
45
46       discovery_ctrl_addr_obj
47                   Discovery  Controller  Address  Heap Object Reference: This
48                   field indicates the location and size of a heap object con‐
49                   taining  a URI which indicates an NVMe Discovery controller
50                   associated with this Discovery Descriptor.  If  this  field
51                   is cleared to 0h, then no URI is specified.
52
53       discovery_ctrl_nqn_obj
54                   Discovery Controller NQN Heap Object Reference: If set to a
55                   non-zero value, this field indicates the location and  size
56                   of  a  heap  object containing an NVMe Discovery controller
57                   NQN. If the NVMe Discovery controller  referenced  by  this
58                   record  requires  secure  authentication  with a well known
59                   Subsystem NQN, this field indicates the unique NQN for that
60                   NVMe  Discovery controller. This record is involved format‐
61                   ted as an NQN string. If this field is cleared to 0h,  then
62                   this  field is reserved and the OS shall use the well known
63                   discovery NQN for this record.
64
65       reserved2   Reserved.
66
67
68
69October 2023                 struct nbft_discovery                  libnvme(9)
Impressum