NAME

       struct nbft_control - NBFT Table - Control Descriptor (Figure 8)

SYNOPSIS

       struct nbft_control {
           __u8 structure_id;
           __u8 major_revision;
           __u8 minor_revision;
           __u8 reserved1;
           __le16 csl;
           __u8 flags;
           __u8 reserved2;
           struct nbft_heap_obj hdesc;
           __u8 hsv;
           __u8 reserved3;
           __le32 hfio;
           __le16 hfil;
           __u8 hfiv;
           __u8 num_hfi;
           __le32 ssnso;
           __le16 ssnsl;
           __u8 ssnsv;
           __u8 num_ssns;
           __le32 seco;
           __le16 secl;
           __u8 secv;
           __u8 num_sec;
           __le32 disco;
           __le16 discl;
           __u8 discv;
           __u8 num_disc;
           __u8 reserved4[16];
        };

Members

       structure_id
                   Structure  ID:  This  field  specifies the element (refer to enum nbft_desc_type). This field
                   shall be set to 1h (i.e., Control, #NBFT_DESC_CONTROL).

       major_revision
                   Major Revision: The major revision of the structure corresponding  to  the  Signature  field.
                   Larger  major  revision  numbers  should  not  be  assumed backward compatible to lower major
                   revision numbers with the same signature.

       minor_revision
                   Minor Revision: The minor revision of the structure corresponding to the signature field.  If
                   the  major  revision  numbers  are  the  same, any minor revision number differences shall be
                   backwards compatible with the same signature.

       reserved1   Reserved.

       csl         Control Structure Length (CSL): This field indicates the  length  in  bytes  of  the  Control
                   Descriptor.

       flags       Flags, see enum nbft_control_flags.

       reserved2   Reserved.

       hdesc       Host  Descriptor (HDESC): This field indicates the location and length of the Host Descriptor
                   (see struct nbft_host).

       hsv         Host Descriptor Version (HSV): This field indicates the version of the Host Descriptor.

       reserved3   Reserved.

       hfio        HFI Descriptor List Offset (HFIO): If this field is set to a non-zero value, then this  field
                   indicates  the offset in bytes of the HFI Descriptor List, if any, from byte offset 0h of the
                   NBFT Table Header. If the num_hfi field is cleared to 0h, then this field is reserved.

       hfil        HFI Descriptor Length  (HFIL):  This  field  indicates  the  length  in  bytes  of  each  HFI
                   Descriptor, if any. If the num_hfi field is cleared to 0h, then this field is reserved.

       hfiv        HFI Descriptor Version (HFIV): This field indicates the version of each HFI Descriptor.

       num_hfi     Number  of Host Fabric Interface Descriptors (NumHFI): This field indicates the number of HFI
                   Descriptors (see struct nbft_hfi) in the HFI Descriptor List, if any. If no  interfaces  have
                   been configured, then this field shall be cleared to 0h.

       ssnso       SSNS  Descriptor  List  Offset (SSNSO):: This field indicates the offset in bytes of the SSNS
                   Descriptor List, if any, from byte offset 0h of the NBFT Table Header. If the num_ssns  field
                   is cleared to 0h, then this field is reserved.

       ssnsl       SSNS  Descriptor  Length  (SSNSL):  This  field  indicates  the  length in bytes of each SSNS
                   Descriptor, if any. If the num_ssns field is cleared to 0h, then this field is reserved.

       ssnsv       SSNS Descriptor Version (SSNSV): This field indicates the version of the SSNS Descriptor.

       num_ssns    Number of Subsystem and Namespace Descriptors (NumSSNS): This field indicates the  number  of
                   Subsystem Namespace (SSNS) Descriptors (see struct nbft_ssns) in the SSNS Descriptor List, if
                   any.

       seco        Security  Profile  Descriptor List Offset (SECO): This field indicates the offset in bytes of
                   the Security Profile Descriptor List, if any, from byte offset 0h of the NBFT  Table  Header.
                   If the num_sec field is cleared to 0h, then this field is reserved.

       secl        Security  Profile  Descriptor Length (SECL): This field indicates the length in bytes of each
                   Security Profile Descriptor, if any.  If the num_sec field is cleared to 0h, then this  field
                   is reserved.

       secv        Security  Profile Descriptor Version (SECV): This field indicates the version of the Security
                   Profile Descriptor.

       num_sec     Number of Security Profile Descriptors (NumSec): This field indicates the number of  Security
                   Profile  Descriptors  (see  struct nbft_security), if any, in the Security Profile Descriptor
                   List.

       disco       Discovery Descriptor Offset (DISCO):  This  field  indicates  the  offset  in  bytes  of  the
                   Discovery  Descriptor  List,  if  any,  from  byte offset 0h of the NBFT Table Header. If the
                   num_disc field is cleared to 0h, then this field is reserved.

       discl       Discovery Descriptor Length (DISCL): This  field  indicates  the  length  in  bytes  of  each
                   Discovery  Descriptor,  if  any.   If the num_disc field is cleared to 0h, then this field is
                   reserved.

       discv       Discovery Descriptor Version (DISCV): This field  indicates  the  version  of  the  Discovery
                   Descriptor.

       num_disc    Number  of  Discovery  Descriptors  (NumDisc):  This  field indicates the number of Discovery
                   Descriptors (see struct nbft_discovery), if any, in the Discovery Descriptor List, if any.

       reserved4   Reserved.

February 2025                                  struct nbft_control                                    libnvme(2)