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 |
|
iSCSIAttemptName:# | Buffer | ReadOnly | Human readable descriptive name for this iSCSI boot attempt configuration
|
iSCSIBootEnable:# | Numeric:1 | ReadWrite | Enables or Disables iSCSI Boot for a selected iSCSI boot attempt
|
iSCSIIpAddressType:# | Numeric:1 | ReadWrite | The iSCSI IP Address type. If set to Auto, IPv4 will be attempted first, followed by IPv6.
|
iSCSIConnectRetry:# | Numeric:1 | ReadWrite | Number of times to retry the iSCSI connection.
|
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.
|
iSCSIInitiatorInfoViaDHCP:# | Numeric:1 | ReadWrite | Configure iSCSI Initiator information from DHCP
|
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.
“192.168.0.1” |
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.
“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.
“192.168.0.1” |
iSCSITargetInfoViaDHCP:# | Numeric:1 | ReadWrite | Configure iSCSI Target information via DHCP
|
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.
|
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.
|
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.
“4752-3A4F-6b7e-2F99” |
iSCSIAuthenticationMethod:# | Numeric:1 | ReadWrite | The iSCSI connection authentication method. This can be None (for no security), or CHAP for Challenge Handshake Authentication Protocol (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.
|
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.
|
iSCSIChapSecret:# | Buffer | Write | The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.
|
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.
|
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.
|
iSCSIMacAddr | Buffer | ReadWrite | The MAC address selected for the iSCSI Attempt.
“8C:DC:D4:31:3C:7D” |
iSCSIAddAttempts | Buffer | ReadWrite |
“attempt:2 attempt:1 attempt:3” |
iSCSIDeleteAttempts | Buffer | ReadWrite |
“attempt:2 attempt:1 attempt:3” |
iSCSIAttemptOrder | Buffer | ReadWrite |
|
iSCSIDisplayAttemptList | Buffer | ReadOnly |
|
WIFI Settings
KEYWORD | DATATYPE | USAGETYPE | DESCRIPTION |
---|---|---|---|
WifiMacList | Buffer | ReadOnly |
|
WifiCurrentMac | Buffer | ReadWrite |
|
WifiConnectedNetwork | Buffer | ReadOnly |
|
WifiScannedNetworkList | Buffer | ReadOnly |
|
WifiScannedNetworkSSId:# | Buffer | ReadOnly |
|
WifiScannedNetworkSecurityType:# | Numeric | ReadOnly |
|
WifiScannedNetworkStrenth:# | Numeric | ReadOnly |
|
WifiConnectNetworkPassword:# | Buffer | ReadWrite |
|
WifiConnectNetworkAction:# | Numeric | ReadWrite |
|
WifiDisconnection Action | Numeric | ReadWrite |
|
WifiSavedNetworkList | Buffer | ReadWrite |
|
WIfiSaveNetworkSSId:# | Buffer | ReadWrite |
|
WifiSaveNetworkSecurityType:# | Numeric | ReadWrite |
|
WifiSaveNetworkPassword:# | Buffer | ReadWrite |
|
WIfiSaveNetworkAutoConnect:# | Numeric | ReadWrite |
|
WifiSaveNetworkScanAnyway:# | Numeric | ReadWrite |
|
WifiSaveNetworkAction:# | Numeric | ReadWrite |
|
WifiDeleteNetworkAction:# | Numeric | ReadWrite |
|
Click here for a detailed description of the Change and Special Instructions.