plucky (2) nbft_ssns_flags.2.gz

NAME

       enum nbft_ssns_flags - Subsystem and Namespace Specific Flags Field (Figure 16)

SYNOPSIS

       enum nbft_ssns_flags {
           NBFT_SSNS_VALID ,
           NBFT_SSNS_NON_BOOTABLE_ENTRY ,
           NBFT_SSNS_USE_SECURITY_FIELD ,
           NBFT_SSNS_DHCP_ROOT_PATH_OVERRIDE ,
           NBFT_SSNS_EXTENDED_INFO_IN_USE ,
           NBFT_SSNS_SEPARATE_DISCOVERY_CTRL ,
           NBFT_SSNS_DISCOVERED_NAMESPACE ,
           NBFT_SSNS_UNAVAIL_NAMESPACE_MASK ,
           NBFT_SSNS_UNAVAIL_NAMESPACE_NOTIND ,
           NBFT_SSNS_UNAVAIL_NAMESPACE_AVAIL ,
           NBFT_SSNS_UNAVAIL_NAMESPACE_UNAVAIL

       };

Constants

       NBFT_SSNS_VALID
                   Descriptor  Valid:  If  set to 1h, then this descriptor is valid. If cleared to 0h, then this
                   descriptor is not valid. A host that supports NVMe-oF Boot, but does  not  currently  have  a
                   remote Subsystem and Namespace assigned may clear this bit to 0h.

       NBFT_SSNS_NON_BOOTABLE_ENTRY
                   Non-bootable Entry Flag: If set to 1h, this flag indicates that this SSNS Descriptor contains
                   a namespace of administrative purpose to the boot  process,  but  the  pre-OS  may  not  have
                   established connectivity to or evaluated the contents of this Descriptor. Such namespaces may
                   contain supplemental data deemed relevant by the Administrator as part of the  pre-OS  to  OS
                   hand  off.  This  may  include  properties  such as a UEFI device path that may not have been
                   created for this namespace. This means an OS runtime may still require the contents of such a
                   namespace  to  complete  later  stages of boot. If cleared to 0h, then this namespace did not
                   have any special administrative intent.

       NBFT_SSNS_USE_SECURITY_FIELD
                   Use Security Flag: If set to 1h, then there is a Security Profile Descriptor associated  with
                   this  SSNS record and the Security Profile Descriptor Index field is valid. If cleared to 0h,
                   then there is no Security Profile  Descriptor  associated  with  this  SSNS  record  and  the
                   Security Profile Descriptor Index field is not valid.

       NBFT_SSNS_DHCP_ROOT_PATH_OVERRIDE
                   DHCP  Root-Path  Override  Flag:  If  set  to  1h, then this SSNS descriptor was populated by
                   consuming the DHCP Root-Path on this interface. If cleared to 0h, then the DHCP Root-Path was
                   not used in populating the SSNS descriptor.

       NBFT_SSNS_EXTENDED_INFO_IN_USE
                   SSNS Extended Info In-use Flag: If set to 1h, then the SSNS Extended Information Offset field
                   and the SSNS Extended Information Length field are valid. This flag, if set to 1h,  indicates
                   that  a  Subsystem  and  Namespace  Extended  Information  Descriptor  corresponding  to this
                   descriptor is present.

       NBFT_SSNS_SEPARATE_DISCOVERY_CTRL
                   Separate Discovery Controller Flag: If set to 1h, then the  Discovery  controller  associated
                   with  this  volume  is  on  a different transport address than the specified in the Subsystem
                   Transport Address Heap Object Reference. If cleared to 0h, then the Discovery  controller  is
                   the same as the Subsystem Transport Address Heap Object Reference.

       NBFT_SSNS_DISCOVERED_NAMESPACE
                   Discovered  Namespace Flag: If set to 1h, then this namespace was acquired through discovery.
                   If cleared to 0h, then this namespace was explicitly configured in the system.

       NBFT_SSNS_UNAVAIL_NAMESPACE_MASK
                   Mask to get Unavailable  Namespace  Flag:  This  field  indicates  the  availability  of  the
                   namespace at a specific point in time. Such use is only a hint and its use does not guarantee
                   the availability of that referenced namespace at any future point in time.

       NBFT_SSNS_UNAVAIL_NAMESPACE_NOTIND
                   Not Indicated by Driver: No information is provided.

       NBFT_SSNS_UNAVAIL_NAMESPACE_AVAIL
                   Available: A referenced namespace described by this flag was  previously  accessible  by  the
                   pre-OS driver.

       NBFT_SSNS_UNAVAIL_NAMESPACE_UNAVAIL
                   Unavailable:  This  namespace was administratively configured but unattempted, unavailable or
                   inaccessible when establishing connectivity by the pre-OS driver.