Configuration Namespace Registry

TO REGISTER A NEW NAMESPACE ENTRY

This is an industry registry of vendor-specific namespace names for purposes of platform configuration. It is envisioned that the main namespace (x-UEFI-ns) will suffice for the common configuration elements in any given system, however it is imaginable that different platforms will have their own implementation-specific extensions that they may want to expose within their own namespace, yet be able to leverage the underlying configuration infrastructure provided by UEFI firmware implementations. This namespace registry aims to ensure fair, orderly, consistent and conflict-free naming of keywords.  

It should also be noted that that new entries added to the namespace are intended for common use across multiple industry members. It is expected that any new entries into the namespace are such that they would be expected to be used by more than any single industry member.

This list is voluntary and minimally administered. Participation in the Registry or use of this information is at your own risk.

Send a request to the UEFI Specification Workgroup Chairperson.  All requests are subject to Work Group approval based on the objectives noted above.

All Registry Entries Are Optional
The keywords that are defined in the UEFI namespace registry are optional. Any given platform may expose some, none, or all of what is defined within the registry. In fact, it is fully expected that many platforms may expose some of the keyword settings in this namespace and likely expose additional keywords that are specific to an OEM or IHV.

Click here for a detailed description of the Change and Special Instructions.

 

Board Settings

Keyword DataType UsageType Description
FirmwardVendor Buffer ReadOnly

The vendor name of the platform’s firmware. Must be the same as the FirmwareVendor value in the EFI System Table. CHAR16 Variable[]
UEFIVersion Numeric:4 ReadOnly The UEFI specification version to which this platform complies.

Complies with the EFI System Table Header’s revision. Upper 16 bits referring to the major revision value, and bottom 16 bits being the minor revision.
ProjectVersion Buffer ReadOnly The Firmware Vendor’s project version of the firmware image.
CHAR16 Variable[]
BoardId Buffer ReadOnly

Name of the motherboard.
CHAR16 Variable[]
FabId Numeric ReadOnly Identifier tag for the Fab location

 

CPU Settings

Keyword DataType UsageType Description
 
CpuName:# Buffer ReadOnly Name of the CPU.
CHAR16 Variable[]
CpuFrequency:# Numeric ReadOnly Numeric value of the CPU frequency in hertz.
CpuID:# Numeric ReadOnly The numeric ID of the CPU.
CpuStepping:# Numeric ReadOnly Stepping value of the CPU
CPUPerformanceMode Numberic:1 ReadWrite The performance state the firmware will set before OS handoff.
• 0 – Max Performance
• 1 – Max Power Savings
• 2 – Balanced Performance
• 3 – Balanced Power
 

 

Chipset Settings

Keyword DataType UsageType Description
 
ChipsetName Buffer ReadOnly Name of the Chipset.
• CHAR16 Variable[]
ChipsetId Buffer ReadOnly The Chipset SKU ID.
• CHAR16 Variable[]
ChipsetStepping Numeric ReadOnly Stepping revision of the chipset
LanPhyRev:# Numeric ReadOnly Revision of the LAN PHY.
LanEnable:# Numeric:1 ReadWrite Enable or disable the network device.
• 1 – Enable the network device
• 0 – Disable the network device
UEFILanEnable:# Numeric:1 ReadWrite Enable or disable UEFI Network support for the network device.
• 1 – Enable the UEFI network support
• 0 – Disable the UEFI network support
SATAEnable:# Numeric:1 ReadWrite Enable or disable the SATA controller.
• 1 – Enable the SATA controller
• 0 – Disable the SATA controller
SATAMode:# Numeric:1 ReadWrite Determine how SATA controller operates.
• 0 - IDE
• 1 – AHCI
SATAPortEnable:# Numeric:1 ReadWrite Enable or disable the SATA port.
• 1 – Enable the SATA port
• 0 – Disable the SATA port
SATAPortHotplugEnable:# Numeric:1 ReadWrite Designates this port as hot pluggable.
• 1 – Define this port to be hot pluggable
• 0 – Define this port to not be hot pluggable
SATAPortSpinupEnable:# Numeric:1 ReadWrite Designate whether the device attached to this port should be spun up during boot.
• 1 – This port will be part of a staggered spin up.
• 0 – This port is not part of a staggered spin up. If no ports are enabled for spin up, then all drives will spin up during boot.

 

Power Settings

 

AcpiSleepState Numberic:1 ReadWrite

The highest ACPI sleep state the system will enter when the suspend button is pressed.

0 - Suspend Disabled

1 - SI (CPU Stop Clock)

2 - S3 (Suspend to RAM)

3 - S4 (Suspend to Disk)

 

iSCSI Boot Settings

Keyword DataType UsageType Description
iSCSIInitiatorName: Buffer ReadWrite
  • The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI Initiator. Only IQN format is accepted. EUI format is not supported.
  • CHAR8 InitiatorName[]
  • Example: “iqn.1986-03.com.hp:init.sn-123456”
iSCSIAttemptName:# Buffer ReadOnly Human readable descriptive name for this iSCSI boot attempt configuration
  • CHAR8 AttemptName[]
  • Example: “iSCSI Attempt 1”
iSCSIBootEnable:# Numeric:1 ReadWrite Enables or Disables iSCSI Boot for a selected iSCSI boot attempt
  • 0 – iSCSI Boot Disabled
  • 1 – iSCSI Boot Enabled
  • 2 – iSCSI Boot Enabled for MPIO (Multi Path I/O)
iSCSIIpAddressType:# Numeric:1 ReadWrite The iSCSI IP Address type. If set to Auto, IPv4 will be attempted first, followed by IPv6.
  • 0 = IPv4
  • 1 = IPv6
  • 2 = Auto
iSCSIConnectRetry:# Numeric:1 ReadWrite Number of times to retry the iSCSI connection.
  • 0 = no retry  
  • 1 – 255 = number of retries
iSCSIConnectTimeout:# Numeric:2 ReadWrite The iSCSI connection timeout value in milliseconds.
iSCSIISID:# Buffer ReadWrite The iSCSI ISID in 6-byte OUI-format. Default value are derived from MAC address. Only last 3 bytes are configurable.
  • CHAR8 IsId[]
  • Example: A default ISID of 0ABBCCDDEEFF can be changed to 0ABBCCF07901 by setting this keyword to “F07901” or “0ABBCCF07901”.
iSCSIInitiatorInfoViaDHCP:# Numeric:1 ReadWrite Configure iSCSI Initiator information from DHCP
  • 1 –iSCSI Initiator DHCP Config Enabled
  • 0 –iSCSI Initiator DHCP Config Disabled
iSCSIInitiatorIpAddress:# Buffer ReadWrite The IP Address of the iSCSI Initiator, if not configured via DHCP. The address needs to be an IPv4 or IPv6 address, depending on the IP Address Type.
  • CHAR8 InitiatorIp[]
  • Example:

“192.168.0.1”
“2001:4898:000A:1005:95A6:EE6C:BED3:4859”

iSCSIInitiatorNetmask:#

iSCSIInitiatorNetMask

Buffer

Typdef struc {

Int x

Int y

Int z

Int f

}

ReadWrite

 The subnet mask of the iSCSI Initiator, if not configured via DHCP. The address needs to be an IPv4.
  • CHAR8 Netmask[]
  • Example:

“255.255.255.0”
iSCSIInitiatorGateway:# Buffer

ReadWrite

 The gateway address of the iSCSI Initiator, if not configured via DHCP. The address needs to be an IPv4 or IPv6 address, depending on the IP Address Type.
  • CHAR8 Gateway[]
  • Example:

“192.168.0.1”
“2001:4898:000A:1005:95A6:EE6C:BED3:4859”
iSCSITargetInfoViaDHCP:# Numeric:1 ReadWrite Configure iSCSI Target information via DHCP
  • 1 – DHCP iSCSI Target Config Enabled
  • 0 – DHCP iSCSI Target Config Disabled
iSCSITargetName:# Buffer ReadWrite The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target, if not obtained from DHCP. Only IQN format is accepted. EUI format is not supported.
  • CHAR8 TargetName[]
  • Example: “iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target”
iSCSITargetIpAddress:# Buffer ReadWrite The IP Address of the iSCSI Target, if not obtained from DHCP. The address needs to be an IPv4 or IPv6 address, depending on the IP Address Type.
  • CHAR8 TargetIp[]
iSCSITargetTcpPort:# Numeric:2 ReadWrite The iSCSI Target TCP Port number, if not obtained from DHCP.
iSCSILUN:# Buffer ReadWrite The iSCSI boot target logical unit number (LUN), if not obtained from DHCP. LUN number is formatted as XXXX-XXXX-XXXX-XXXX, where X is a hexadecimal digit.
  • CHAR8 Lun[]
  • Examples:

“4752-3A4F-6b7e-2F99”
“6734-9-156f-127”
“4186-9”
iSCSIAuthenticationMethod:# Numeric:1 ReadWrite The iSCSI connection authentication method. This can be None (for no security), or CHAP for Challenge Handshake Authentication Protocol (CHAP).
  • 0 = None
  • 1 = CHAP
iSCSIChapType:# Numeric:1 ReadWrite The CHAP authentication type. If configured to One way, the target will authenticate the initiator. If configured to 'Mutual', both the initiator and target will authenticate each other. This is applicable only when the Authentication Method is set to CHAP.
  • 0 = One Way
  • 1 = Mutual
iSCSIChapUsername:# Buffer ReadWrite User name for CHAP authentication from the initiator to the target. This is applicable only when the Authentication Method is set to CHAP.
  • CHAR8 ChapName[]
  • Example: "Alice"
iSCSIChapSecret:# Buffer Write The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.
  • CHAR8 ChapSecret[]
iSCSIReverseChapUsername:# Buffer ReadWrite User Name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
  • CHAR8 ReverseChapName[]
iSCSIReverseChapSecret:# Buffer Write The password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
  • CHAR8 ReverseChapSecret[]
iSCSIMacAddr Buffer ReadWrite The MAC address selected for the iSCSI Attempt.
  • CHAR8 AttemptMac[]
  • Example:

“8C:DC:D4:31:3C:7D”
“8C:DC:D4:31:3C:7D\0001”
iSCSIAddAttempts Buffer ReadWrite
  • The List of iSCSI boot attempt which will be added.
  • CHAR8   ISCSIAddAttemptList []
  • Example: “attempt:1 attempt:2”

                “attempt:2 attempt:1 attempt:3”
iSCSIDeleteAttempts Buffer ReadWrite
  • The List of iSCSI boot attempt which will be deleted.
  • CHAR8   ISCSIDeleteAttemptList []
  • Example: “attempt:1 attempt:2”

          “attempt:2 attempt:1 attempt:3”
iSCSIAttemptOrder Buffer ReadWrite
  • The new order of iSCSI boot attempts.
  • CHAR8   AttemptOrder[]
  • Example: “attempt:1 attempt:2 attempt:3”
iSCSIDisplayAttemptList Buffer ReadOnly
  • Get the current attempt list information
  • CHAR8 ISCSIDisplayAttemptList []
  • Example: “attempt:1 attempt:2 attempt:3”

 

WIFI Settings

Keyword Datatype usagetype description
WifiMacList Buffer ReadOnly
  • The current available MAC address list specified as a whitespace-separated list which contains no more than 8 elements. The MAC address follows the format: XX-XX-XX-XX-XX-XX, and each ‘X’ represents a hex number.
  • CHAR8      MacList[143]
  • Example:    “00-21-5D-02-93-AE  00-55-3A-01-22-AC”
WifiCurrentMac Buffer ReadWrite
  • The current selected MAC address which follows the format XX-XX-XX-XX-XX-XX.
  • CHAR8      CurrentMac[17]
  • Example:    “00-21-5D-02-93-AE”
WifiConnectedNetwork Buffer ReadOnly
  • The current connected wireless network which is identified by SSID and security type with a format as “SSID SecurityType”, separated by whitespace. The format of SSID and SecurityType can be referred from other keywords. String “null” means no networks are currently connected.
  • CHAR8      CurrentNetwork[36]
  • Example:    “labWlan 0”
  • Example:    “null”
WifiScannedNetworkList Buffer ReadOnly
  • A whitespace-separated list of current available wireless networks. This list contains no more than 16 networks, and each network is represented by its’ network index. The network index is a unique UINT32 integer as the network’s identifier, and starts from 1.
  • CHAR8      ScannedNetworkList[175]
  • Example:    “19 20 5 27 28 15 12 3”
WifiScannedNetworkSSId:# Buffer ReadOnly
  • The SSID of an available wireless network. The length is less than or equal to 32 octets. The placeholder “#” needs to be replaced by this network’s network index.
  • CHAR8      ScannedSSId[32]
  • Example:    “labWlan”
WifiScannedNetworkSecurityType:# Numeric ReadOnly
  • The security type of an available wireless network, and is represented by an UINT8integer. The placeholder “#” needs to be replaced by this network’s network index.
  • 0     OPEN
  • 1     WPAEnterprise
  • 2     WPAPersonal
  • 3     WPA2Enterprise
  • 4     WPA2Personal
  • 5     WEP
  • 6     Unsupported
WifiScannedNetworkStrenth:# Numeric ReadOnly
  • The signal strength of an available wireless network. It is represented by an UINT8 integer , and the value is between 1 and 5 while 5 have the highest signal strength. The placeholder “#” needs to be replaced by this network’s network index.
  • UINT8      Strength
  • Example:    “3”
WifiConnectNetworkPassword:# Buffer ReadWrite
  • The password for a secured wireless network to be connected. It is an optional keyword and only need be configured if the password is not configured or configured wrongly in previous setting. The length is in the range of 6 to 20 octets. The placeholder “#” needs to be replaced by this network’s network index.
  • CHAR8      ConnectPassword [20]
  • Example:    “12345678”
WifiConnectNetworkAction:# Numeric

ReadWrite
  • Connect to the target network and get a returned status code. The placeholder “#” needs to be replaced by this network’s network index. The status codes are defined as an UINT8 integerr:
  • 0    Connect Success
  • 1    Network Not Found
  • 2    Connect Error
WifiDisconnection Action Numeric ReadWrite
  • Disconnect from the current connected network and get a returned status code. The status codes are defined as an UINT8 integer :
  • 0    Disconnect Success
  • 1    Disconnect Error
WifiSavedNetworkList Buffer ReadWrite
  • The current saved wireless network list which contains no more than 16 networks. Each network is represented by its’ network index and divided by whitespace. The order reflects priorities of saved networks. These priorities indicate which network is more preferred to be selected to connect when no networks are connected. Writing this keyword will update networks’ priorities.
  • CHAR8      SavedNetworkList[175]
  • Example:    “19 20 5 27 28 15 12 3”
WIfiSaveNetworkSSId:# Buffer ReadWrite
  • The SSID of a saved network or a new added network. The length is less than or equal to 32 octets. The placeholder “#” needs to be replaced by this network’s network index when updating a saved network, and 0 when adding a new network.
  • CHAR8     SaveSSId[32]
  • Example:   “labWlan”
WifiSaveNetworkSecurityType:# Numeric ReadWrite
  • The security type of a saved network or a new added network, and is represented by an UINT8 number. The placeholder “#” needs to be replaced by this network’s network index when updating a saved network, and 0 when adding a new network.
  • 0     OPEN
  • 1     WPAEnterprise
  • 2     WPAPersonal
  • 3     WPA2Enterprise
  • 4     WPA2Personal
  • 5     WEP
  • 6     Unsupported
WifiSaveNetworkPassword:# Buffer ReadWrite
  • The password of a saved secured network or a new added secured network. The length is in the range of 6 to 20 octets. The placeholder “#” needs to be replaced by this network’s network index when updating a saved network, and 0 when adding a new network.
  • CHAR8      SavedPassword [20]
  • Example:    “12345678”
WIfiSaveNetworkAutoConnect:# Numeric ReadWrite
  • The auto connect attribute for a saved network or a new added network. System will select a network from saved network list to connect automatically when no networks are connected. This attribute is to indicate if this network is allowed to be connected automatically. The placeholder “#” needs to be replaced by this network’s network index when updating a saved network, and 0 when adding a new network. The status codes are defined as an UINT8 number:
  • 0    Disable Auto Connect
  • 1    Enable Auto Connect
WifiSaveNetworkScanAnyway:# Numeric ReadWrite
  • The scan anyway attribute for a saved network or a new added network. System will request some specified hidden networks in scan process. This attribute is to indicate if this network needs to be requested when it is a hidden network. The placeholder “#” needs to be replaced by this network’s network index when updating a saved network, and 0 when adding a new network. The status codes are defined as an UINT8 number:
  • 0    Disable Scan Anyway
  • 1    Enable Scan Anyway
WifiSaveNetworkAction:# Numeric

ReadWrite
  • Update a saved network or add a new network to saved network list. The network details should be set through other keywords. The placeholder “#” needs to be replaced by this network’s network index when updating a saved network, and 0 when adding a new network. The status codes are defined as an UINT8 number:
  • 0    Save Network Success
  • 1    Save Network Error
WifiDeleteNetworkAction:# Numeric ReadWrite
  • Delete a saved wireless network and get a returned status code. The placeholder “#” needs to be replaced by this network’s network index. The status codes are defined as an UINT8 number:
  • 0    Delete Success
  • 1    Delete Error

Click here for a detailed description of the Change and Special Instructions.