| 1 |
.TH "libnvme" 9 "struct nbft_ssns" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nbft_ssns \- Subsystem Namespace (SSNS) Descriptor (Figure 15) |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nbft_ssns { |
| 6 |
.br |
| 7 |
.BI " __u8 structure_id;" |
| 8 |
.br |
| 9 |
.BI " __le16 index;" |
| 10 |
.br |
| 11 |
.BI " __le16 flags;" |
| 12 |
.br |
| 13 |
.BI " __u8 trtype;" |
| 14 |
.br |
| 15 |
.BI " __le16 trflags;" |
| 16 |
.br |
| 17 |
.BI " __u8 primary_discovery_ctrl_index;" |
| 18 |
.br |
| 19 |
.BI " __u8 reserved1;" |
| 20 |
.br |
| 21 |
.BI " struct nbft_heap_obj subsys_traddr_obj;" |
| 22 |
.br |
| 23 |
.BI " struct nbft_heap_obj subsys_trsvcid_obj;" |
| 24 |
.br |
| 25 |
.BI " __le16 subsys_port_id;" |
| 26 |
.br |
| 27 |
.BI " __le32 nsid;" |
| 28 |
.br |
| 29 |
.BI " __u8 nidt;" |
| 30 |
.br |
| 31 |
.BI " __u8 nid[16];" |
| 32 |
.br |
| 33 |
.BI " __u8 security_desc_index;" |
| 34 |
.br |
| 35 |
.BI " __u8 primary_hfi_desc_index;" |
| 36 |
.br |
| 37 |
.BI " __u8 reserved2;" |
| 38 |
.br |
| 39 |
.BI " struct nbft_heap_obj secondary_hfi_assoc_obj;" |
| 40 |
.br |
| 41 |
.BI " struct nbft_heap_obj subsys_ns_nqn_obj;" |
| 42 |
.br |
| 43 |
.BI " struct nbft_heap_obj ssns_extended_info_desc_obj;" |
| 44 |
.br |
| 45 |
.BI " __u8 reserved3[62];" |
| 46 |
.br |
| 47 |
.BI " |
| 48 |
}; |
| 49 |
.br |
| 50 |
|
| 51 |
.SH Members |
| 52 |
.IP "structure_id" 12 |
| 53 |
Structure ID: This field shall be set to 4h |
| 54 |
(i.e., SSNS; #NBFT_DESC_SSNS). |
| 55 |
.IP "index" 12 |
| 56 |
SSNS Descriptor Index: This field indicates the number |
| 57 |
of this Subsystem Namespace Descriptor in the |
| 58 |
Subsystem Namespace Descriptor List. |
| 59 |
.IP "flags" 12 |
| 60 |
SSNS Flags, see \fIenum nbft_ssns_flags\fP. |
| 61 |
.IP "trtype" 12 |
| 62 |
Transport Type, see \fIenum nbft_trtype\fP. |
| 63 |
.IP "trflags" 12 |
| 64 |
Transport Specific Flags, see \fIenum nbft_ssns_trflags\fP. |
| 65 |
.IP "primary_discovery_ctrl_index" 12 |
| 66 |
Primary Discovery Controller Index: The Discovery |
| 67 |
Descriptor Index field of the Discovery Descriptor |
| 68 |
(see \fIstruct nbft_discovery\fP) that is associated with |
| 69 |
this SSNS Descriptor. If a Discovery controller was |
| 70 |
used to establish this record this value shall |
| 71 |
be set to a non-zero value. If this namespace was |
| 72 |
associated with multiple Discovery controllers, |
| 73 |
those Discovery controllers shall have records |
| 74 |
in the Discovery Descriptor to facilitate multi-path |
| 75 |
rediscovery as required. If no Discovery controller |
| 76 |
was utilized to inform this namespace record, |
| 77 |
this field shall be cleared to 0h. |
| 78 |
.IP "reserved1" 12 |
| 79 |
Reserved. |
| 80 |
.IP "subsys_traddr_obj" 12 |
| 81 |
Subsystem Transport Address Heap Object Reference: |
| 82 |
This field indicates the location and size of a heap |
| 83 |
object containing the Subsystem Transport Address. |
| 84 |
For IP based transports types, shall be an IP Address. |
| 85 |
.IP "subsys_trsvcid_obj" 12 |
| 86 |
Subsystem Transport Service Identifier Heap Object Reference: |
| 87 |
This field indicates the location and size of a heap |
| 88 |
object containing an array of bytes indicating |
| 89 |
the Subsystem Transport Service Identifier. |
| 90 |
See \fIenum nbft_trtype\fP. |
| 91 |
.IP "subsys_port_id" 12 |
| 92 |
Subsystem Port ID: Port in the NVM subsystem |
| 93 |
associated with this transport address used by |
| 94 |
the pre-OS driver. |
| 95 |
.IP "nsid" 12 |
| 96 |
Namespace ID: This field indicates the namespace |
| 97 |
identifier (NSID) of the namespace indicated by |
| 98 |
this descriptor. This field shall be cleared to 0h |
| 99 |
if not specified by the user. If this value is cleared |
| 100 |
to 0h, then consumers of the NBFT shall rely |
| 101 |
on the NID. |
| 102 |
.IP "nidt" 12 |
| 103 |
Namespace Identifier Type (NIDT): This field |
| 104 |
contains the value of the Namespace Identifier Type (NIDT) |
| 105 |
field in the Namespace Identification Descriptor |
| 106 |
for the namespace indicated by this descriptor. |
| 107 |
If a namespace supports multiple NIDT entries |
| 108 |
for uniqueness, the order of preference is NIDT field |
| 109 |
value of 3h (i.e., UUID) before 2h (i.e., NSGUID), |
| 110 |
and 2h before 1h (i.e., EUI-64). |
| 111 |
.IP "nid" 12 |
| 112 |
Namespace Identifier (NID): This field contains |
| 113 |
the value of the Namespace Identifier (NID) field |
| 114 |
in the Namespace Identification Descriptor for |
| 115 |
the namespace indicated by this descriptor. |
| 116 |
.IP "security_desc_index" 12 |
| 117 |
Security Profile Descriptor Index: If the Use Security |
| 118 |
Flag bit in the SSNS Flags field is set to 1h, then |
| 119 |
this field indicates the value of the Security Profile |
| 120 |
Descriptor Index field of the Security Profile |
| 121 |
Descriptor (see \fIstruct nbft_security\fP) associated |
| 122 |
with this namespace. If the Use Security Flag bit |
| 123 |
is cleared to 0h, then no Security Profile Descriptor |
| 124 |
is associated with this namespace and this field |
| 125 |
is reserved. |
| 126 |
.IP "primary_hfi_desc_index" 12 |
| 127 |
Primary HFI Descriptor Index: This field indicates |
| 128 |
the value of the HFI Descriptor Index field of the |
| 129 |
HFI Descriptor (see \fIstruct nbft_hfi\fP) for the |
| 130 |
interface associated with this namespace. If multiple |
| 131 |
HFIs are associated with this record, subsequent |
| 132 |
interfaces should be populated in the Secondary |
| 133 |
HFI Associations field. |
| 134 |
.IP "reserved2" 12 |
| 135 |
Reserved. |
| 136 |
.IP "secondary_hfi_assoc_obj" 12 |
| 137 |
Secondary HFI Associations Heap Object Reference: |
| 138 |
If this field is set to a non-zero value, then |
| 139 |
this field indicates an array of bytes, in which |
| 140 |
each byte contains the value of the HFI Descriptor |
| 141 |
Index field of an HFI Descriptor in the HFI Descriptor |
| 142 |
List. If this field is cleared to 0h, then no |
| 143 |
secondary HFI associations are specified. |
| 144 |
.IP "subsys_ns_nqn_obj" 12 |
| 145 |
Subsystem and Namespace NQN Heap Object Reference: |
| 146 |
This field indicates the location and size of |
| 147 |
a heap object containing the Subsystem and Namespace NQN. |
| 148 |
.IP "ssns_extended_info_desc_obj" 12 |
| 149 |
SSNS Extended Information Descriptor Heap Object |
| 150 |
Reference: If the SSNS Extended Info In-use Flag |
| 151 |
bit is set to 1h, then this field indicates the |
| 152 |
offset in bytes of a heap object containing an |
| 153 |
SSNS Extended Information Descriptor |
| 154 |
(see \fIstruct nbft_ssns_ext_info\fP) heap object |
| 155 |
from byte offset 0h of the NBFT Table Header. |
| 156 |
If the SSNS Extended Info In-use Flag bit is cleared |
| 157 |
to 0h, then this field is reserved. |
| 158 |
.IP "reserved3" 12 |
| 159 |
Reserved. |