The device path protocol as defined in UEFI 2.0. More...

#include <ipxe/efi/Guid/PcAnsi.h>
#include <ipxe/efi/IndustryStandard/Bluetooth.h>
#include <ipxe/efi/IndustryStandard/Acpi60.h>

Data Structures
struct	EFI_DEVICE_PATH_PROTOCOL
	This protocol can be used on any device handle to obtain generic path/location information concerning the physical device or logical device. More...

struct	PCI_DEVICE_PATH
	PCI Device Path. More...

struct	PCCARD_DEVICE_PATH
	PCCARD Device Path. More...

struct	MEMMAP_DEVICE_PATH
	Memory Mapped Device Path. More...

struct	VENDOR_DEVICE_PATH
	The Vendor Device Path allows the creation of vendor-defined Device Paths. More...

struct	CONTROLLER_DEVICE_PATH
	Controller Device Path. More...

struct	BMC_DEVICE_PATH
	BMC Device Path. More...

struct	ACPI_HID_DEVICE_PATH

struct	ACPI_EXTENDED_HID_DEVICE_PATH

struct	ACPI_ADR_DEVICE_PATH
	The _ADR device path is used to contain video output device attributes to support the Graphics Output Protocol. More...

struct	ACPI_NVDIMM_DEVICE_PATH

struct	ATAPI_DEVICE_PATH

struct	SCSI_DEVICE_PATH

struct	FIBRECHANNEL_DEVICE_PATH

struct	FIBRECHANNELEX_DEVICE_PATH

struct	F1394_DEVICE_PATH

struct	USB_DEVICE_PATH

struct	USB_CLASS_DEVICE_PATH

struct	USB_WWID_DEVICE_PATH
	This device path describes a USB device using its serial number. More...

struct	DEVICE_LOGICAL_UNIT_DEVICE_PATH

struct	SATA_DEVICE_PATH

struct	I2O_DEVICE_PATH

struct	MAC_ADDR_DEVICE_PATH

struct	IPv4_DEVICE_PATH

struct	IPv6_DEVICE_PATH

struct	INFINIBAND_DEVICE_PATH

struct	UART_DEVICE_PATH

struct	NVDIMM_NAMESPACE_DEVICE_PATH

struct	UART_FLOW_CONTROL_DEVICE_PATH
	A new device path node is defined to declare flow control characteristics. More...

struct	SAS_DEVICE_PATH
	Serial Attached SCSI (SAS) Device Path. More...

struct	SASEX_DEVICE_PATH

struct	NVME_NAMESPACE_DEVICE_PATH

struct	NVME_OF_NAMESPACE_DEVICE_PATH

struct	DNS_DEVICE_PATH

struct	URI_DEVICE_PATH

struct	UFS_DEVICE_PATH

struct	SD_DEVICE_PATH

struct	EMMC_DEVICE_PATH

struct	ISCSI_DEVICE_PATH

struct	VLAN_DEVICE_PATH

struct	BLUETOOTH_DEVICE_PATH

struct	WIFI_DEVICE_PATH

struct	BLUETOOTH_LE_DEVICE_PATH

struct	HARDDRIVE_DEVICE_PATH
	The Hard Drive Media Device Path is used to represent a partition on a hard drive. More...

struct	CDROM_DEVICE_PATH
	The CD-ROM Media Device Path is used to define a system partition that exists on a CD-ROM. More...

struct	FILEPATH_DEVICE_PATH

struct	MEDIA_PROTOCOL_DEVICE_PATH
	The Media Protocol Device Path is used to denote the protocol that is being used in a device path at the location of the path specified. More...

struct	MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
	This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware file. More...

struct	MEDIA_FW_VOL_DEVICE_PATH
	This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware volume. More...

struct	MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH
	Used to describe the offset range of media relative. More...

struct	MEDIA_RAM_DISK_DEVICE_PATH
	Used to describe the ram disk device path. More...

struct	BBS_BBS_DEVICE_PATH
	This Device Path is used to describe the booting of non-EFI-aware operating systems. More...

union	EFI_DEV_PATH
	Union of all possible Device Paths and pointers to Device Paths. More...

union	EFI_DEV_PATH_PTR

Macros
#define	EFI_DEVICE_PATH_PROTOCOL_GUID
	Device Path protocol. More...

#define	DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID
	Device Path guid definition for backward-compatible with EFI1.1. More...

#define	HARDWARE_DEVICE_PATH 0x01
	Hardware Device Paths. More...

#define	HW_PCI_DP 0x01
	PCI Device Path SubType. More...

#define	HW_PCCARD_DP 0x02
	PCCARD Device Path SubType. More...

#define	HW_MEMMAP_DP 0x03
	Memory Mapped Device Path SubType. More...

#define	HW_VENDOR_DP 0x04
	Hardware Vendor Device Path SubType. More...

#define	HW_CONTROLLER_DP 0x05
	Controller Device Path SubType. More...

#define	HW_BMC_DP 0x06
	BMC Device Path SubType. More...

#define	ACPI_DEVICE_PATH 0x02
	ACPI Device Paths. More...

#define	ACPI_DP 0x01
	ACPI Device Path SubType. More...

#define	ACPI_EXTENDED_DP 0x02
	Expanded ACPI Device Path SubType. More...

#define	PNP_EISA_ID_CONST 0x41d0

#define	EISA_ID(_Name, _Num) ((UINT32)((_Name) \| (_Num) << 16))

#define	EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))

#define	EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))

#define	PNP_EISA_ID_MASK 0xffff

#define	EISA_ID_TO_NUM(_Id) ((_Id) >> 16)

#define	ACPI_ADR_DP 0x03
	ACPI _ADR Device Path SubType. More...

#define	ACPI_NVDIMM_DP 0x04
	ACPI NVDIMM Device Path SubType. More...

#define	ACPI_ADR_DISPLAY_TYPE_OTHER 0

#define	ACPI_ADR_DISPLAY_TYPE_VGA 1

#define	ACPI_ADR_DISPLAY_TYPE_TV 2

#define	ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL 3

#define	ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL 4

#define	ACPI_DISPLAY_ADR(_DeviceIdScheme, _HeadId, _NonVgaOutput, _BiosCanDetect, _VendorInfo, _Type, _Port, _Index)

#define	MESSAGING_DEVICE_PATH 0x03
	Messaging Device Paths. More...

#define	MSG_ATAPI_DP 0x01
	ATAPI Device Path SubType. More...

#define	MSG_SCSI_DP 0x02
	SCSI Device Path SubType. More...

#define	MSG_FIBRECHANNEL_DP 0x03
	Fibre Channel SubType. More...

#define	MSG_FIBRECHANNELEX_DP 0x15
	Fibre Channel Ex SubType. More...

#define	MSG_1394_DP 0x04
	1394 Device Path SubType More...

#define	MSG_USB_DP 0x05
	USB Device Path SubType. More...

#define	MSG_USB_CLASS_DP 0x0f
	USB Class Device Path SubType. More...

#define	MSG_USB_WWID_DP 0x10
	USB WWID Device Path SubType. More...

#define	MSG_DEVICE_LOGICAL_UNIT_DP 0x11
	Device Logical Unit SubType. More...

#define	MSG_SATA_DP 0x12
	SATA Device Path SubType. More...

#define	SATA_HBA_DIRECT_CONNECT_FLAG 0x8000
	Flag for if the device is directly connected to the HBA. More...

#define	MSG_I2O_DP 0x06
	I2O Device Path SubType. More...

#define	MSG_MAC_ADDR_DP 0x0b
	MAC Address Device Path SubType. More...

#define	MSG_IPv4_DP 0x0c
	IPv4 Device Path SubType. More...

#define	MSG_IPv6_DP 0x0d
	IPv6 Device Path SubType. More...

#define	MSG_INFINIBAND_DP 0x09
	InfiniBand Device Path SubType. More...

#define	INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01

#define	INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02

#define	INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04

#define	INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08

#define	INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10

#define	MSG_UART_DP 0x0e
	UART Device Path SubType. More...

#define	NVDIMM_NAMESPACE_DP 0x20
	NVDIMM Namespace Device Path SubType. More...

#define	MSG_VENDOR_DP 0x0a

#define	DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID

#define	DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID

#define	DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID

#define	DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID

#define	UART_FLOW_CONTROL_HARDWARE 0x00000001

#define	UART_FLOW_CONTROL_XON_XOFF 0x00000010

#define	DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID

#define	MSG_SASEX_DP 0x16
	Serial Attached SCSI (SAS) Ex Device Path SubType. More...

#define	MSG_NVME_NAMESPACE_DP 0x17
	NvmExpress Namespace Device Path SubType. More...

#define	MSG_NVME_OF_NAMESPACE_DP 0x22
	NVMe over Fabric (NVMe-oF) Namespace Device Path SubType. More...

#define	MSG_DNS_DP 0x1F
	DNS Device Path SubType. More...

#define	MSG_URI_DP 0x18
	Uniform Resource Identifiers (URI) Device Path SubType. More...

#define	MSG_UFS_DP 0x19
	Universal Flash Storage (UFS) Device Path SubType. More...

#define	MSG_SD_DP 0x1A
	SD (Secure Digital) Device Path SubType. More...

#define	MSG_EMMC_DP 0x1D
	EMMC (Embedded MMC) Device Path SubType. More...

#define	MSG_ISCSI_DP 0x13
	iSCSI Device Path SubType More...

#define	ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000

#define	ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002

#define	ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000

#define	ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008

#define	ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000

#define	ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000

#define	ISCSI_LOGIN_OPTION_CHAP_BI 0x0000

#define	ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000

#define	MSG_VLAN_DP 0x14
	VLAN Device Path SubType. More...

#define	MSG_BLUETOOTH_DP 0x1b
	Bluetooth Device Path SubType. More...

#define	MSG_WIFI_DP 0x1C
	Wi-Fi Device Path SubType. More...

#define	MSG_BLUETOOTH_LE_DP 0x1E
	Bluetooth LE Device Path SubType. More...

#define	MEDIA_DEVICE_PATH 0x04

#define	MEDIA_HARDDRIVE_DP 0x01
	Hard Drive Media Device Path SubType. More...

#define	MBR_TYPE_PCAT 0x01

#define	MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02

#define	NO_DISK_SIGNATURE 0x00

#define	SIGNATURE_TYPE_MBR 0x01

#define	SIGNATURE_TYPE_GUID 0x02

#define	MEDIA_CDROM_DP 0x02
	CD-ROM Media Device Path SubType. More...

#define	MEDIA_VENDOR_DP 0x03
	Media vendor device path subtype. More...

#define	MEDIA_FILEPATH_DP 0x04
	File Path Media Device Path SubType. More...

#define	SIZE_OF_FILEPATH_DEVICE_PATH OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)

#define	MEDIA_PROTOCOL_DP 0x05
	Media Protocol Device Path SubType. More...

#define	MEDIA_PIWG_FW_FILE_DP 0x06
	PIWG Firmware File SubType. More...

#define	MEDIA_PIWG_FW_VOL_DP 0x07
	PIWG Firmware Volume Device Path SubType. More...

#define	MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08
	Media relative offset range device path. More...

#define	EFI_VIRTUAL_DISK_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_VOLATILE
	This GUID defines a RAM Disk supporting a raw disk format in volatile memory. More...

#define	EFI_VIRTUAL_CD_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_VOLATILE
	This GUID defines a RAM Disk supporting an ISO image in volatile memory. More...

#define	EFI_PERSISTENT_VIRTUAL_DISK_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_PERSISTENT
	This GUID defines a RAM Disk supporting a raw disk format in persistent memory. More...

#define	EFI_PERSISTENT_VIRTUAL_CD_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_PERSISTENT
	This GUID defines a RAM Disk supporting an ISO image in persistent memory. More...

#define	MEDIA_RAM_DISK_DP 0x09
	Media ram disk device path. More...

#define	BBS_DEVICE_PATH 0x05
	BIOS Boot Specification Device Path. More...

#define	BBS_BBS_DP 0x01
	BIOS Boot Specification Device Path SubType. More...

#define	BBS_TYPE_FLOPPY 0x01

#define	BBS_TYPE_HARDDRIVE 0x02

#define	BBS_TYPE_CDROM 0x03

#define	BBS_TYPE_PCMCIA 0x04

#define	BBS_TYPE_USB 0x05

#define	BBS_TYPE_EMBEDDED_NETWORK 0x06

#define	BBS_TYPE_BEV 0x80

#define	BBS_TYPE_UNKNOWN 0xFF

#define	END_DEVICE_PATH_TYPE 0x7f

#define	END_ENTIRE_DEVICE_PATH_SUBTYPE 0xFF

#define	END_INSTANCE_DEVICE_PATH_SUBTYPE 0x01

Typedefs
typedef EFI_DEVICE_PATH_PROTOCOL	EFI_DEVICE_PATH
	Device Path protocol definition for backward-compatible with EFI1.1. More...

typedef VENDOR_DEVICE_PATH	VENDOR_DEFINED_DEVICE_PATH

Functions
	FILE_LICENCE (BSD2_PATENT)

Variables
EFI_GUID	gEfiVirtualDiskGuid

EFI_GUID	gEfiVirtualCdGuid

EFI_GUID	gEfiPersistentVirtualDiskGuid

EFI_GUID	gEfiPersistentVirtualCdGuid

EFI_GUID	gEfiDevicePathProtocolGuid

Detailed Description

The device path protocol as defined in UEFI 2.0.

The device path represents a programmatic path to a device, from a software point of view. The path must persist from boot to boot, so it can not contain things like PCI bus numbers that change from boot to boot.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DevicePath.h.

Macro Definition Documentation

◆ EFI_DEVICE_PATH_PROTOCOL_GUID

#define EFI_DEVICE_PATH_PROTOCOL_GUID

Value:

{ \
    0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }

Device Path protocol.

Definition at line 25 of file DevicePath.h.

◆ DEVICE_PATH_PROTOCOL

#define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID

Device Path guid definition for backward-compatible with EFI1.1.

Definition at line 33 of file DevicePath.h.

◆ HARDWARE_DEVICE_PATH

#define HARDWARE_DEVICE_PATH 0x01

Hardware Device Paths.

Definition at line 70 of file DevicePath.h.

◆ HW_PCI_DP

#define HW_PCI_DP 0x01

PCI Device Path SubType.

Definition at line 75 of file DevicePath.h.

◆ HW_PCCARD_DP

#define HW_PCCARD_DP 0x02

PCCARD Device Path SubType.

Definition at line 95 of file DevicePath.h.

◆ HW_MEMMAP_DP

#define HW_MEMMAP_DP 0x03

Memory Mapped Device Path SubType.

Definition at line 111 of file DevicePath.h.

◆ HW_VENDOR_DP

#define HW_VENDOR_DP 0x04

Hardware Vendor Device Path SubType.

Definition at line 135 of file DevicePath.h.

◆ HW_CONTROLLER_DP

#define HW_CONTROLLER_DP 0x05

Controller Device Path SubType.

Definition at line 156 of file DevicePath.h.

◆ HW_BMC_DP

#define HW_BMC_DP 0x06

BMC Device Path SubType.

Definition at line 172 of file DevicePath.h.

◆ ACPI_DEVICE_PATH

#define ACPI_DEVICE_PATH 0x02

ACPI Device Paths.

Definition at line 192 of file DevicePath.h.

◆ ACPI_DP

#define ACPI_DP 0x01

ACPI Device Path SubType.

Definition at line 197 of file DevicePath.h.

◆ ACPI_EXTENDED_DP

#define ACPI_EXTENDED_DP 0x02

Expanded ACPI Device Path SubType.

Definition at line 219 of file DevicePath.h.

◆ PNP_EISA_ID_CONST

#define PNP_EISA_ID_CONST 0x41d0

Definition at line 255 of file DevicePath.h.

◆ EISA_ID

#define EISA_ID	(	_Name,
		_Num
	)	((UINT32)((_Name) \| (_Num) << 16))

Definition at line 256 of file DevicePath.h.

◆ EISA_PNP_ID

#define EISA_PNP_ID ( _PNPId ) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))

Definition at line 257 of file DevicePath.h.

◆ EFI_PNP_ID

#define EFI_PNP_ID ( _PNPId ) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))

Definition at line 258 of file DevicePath.h.

◆ PNP_EISA_ID_MASK

#define PNP_EISA_ID_MASK 0xffff

Definition at line 260 of file DevicePath.h.

◆ EISA_ID_TO_NUM

#define EISA_ID_TO_NUM ( _Id ) ((_Id) >> 16)

Definition at line 261 of file DevicePath.h.

◆ ACPI_ADR_DP

#define ACPI_ADR_DP 0x03

ACPI _ADR Device Path SubType.

Definition at line 266 of file DevicePath.h.

◆ ACPI_NVDIMM_DP

#define ACPI_NVDIMM_DP 0x04

ACPI NVDIMM Device Path SubType.

Definition at line 289 of file DevicePath.h.

◆ ACPI_ADR_DISPLAY_TYPE_OTHER

#define ACPI_ADR_DISPLAY_TYPE_OTHER 0

Definition at line 301 of file DevicePath.h.

◆ ACPI_ADR_DISPLAY_TYPE_VGA

#define ACPI_ADR_DISPLAY_TYPE_VGA 1

Definition at line 302 of file DevicePath.h.

◆ ACPI_ADR_DISPLAY_TYPE_TV

#define ACPI_ADR_DISPLAY_TYPE_TV 2

Definition at line 303 of file DevicePath.h.

◆ ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL

#define ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL 3

Definition at line 304 of file DevicePath.h.

◆ ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL

#define ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL 4

Definition at line 305 of file DevicePath.h.

◆ ACPI_DISPLAY_ADR

#define ACPI_DISPLAY_ADR	(	_DeviceIdScheme,
		_HeadId,
		_NonVgaOutput,
		_BiosCanDetect,
		_VendorInfo,
		_Type,
		_Port,
		_Index
	)

Value:

((UINT32)(  ((UINT32)((_DeviceIdScheme) & 0x1) << 31) |  \
                      (((_HeadId)                 & 0x7) << 18) |  \
                      (((_NonVgaOutput)           & 0x1) << 17) |  \
                      (((_BiosCanDetect)          & 0x1) << 16) |  \
                      (((_VendorInfo)             & 0xf) << 12) |  \
                      (((_Type)                   & 0xf) << 8)  |  \
                      (((_Port)                   & 0xf) << 4)  |  \
                       ((_Index)                  & 0xf) ))

Definition at line 307 of file DevicePath.h.

◆ MESSAGING_DEVICE_PATH

#define MESSAGING_DEVICE_PATH 0x03

Messaging Device Paths.

This Device Path is used to describe the connection of devices outside the resource domain of the system. This Device Path can describe physical messaging information like SCSI ID, or abstract information like networking protocol IP addresses.

Definition at line 323 of file DevicePath.h.

◆ MSG_ATAPI_DP

#define MSG_ATAPI_DP 0x01

ATAPI Device Path SubType.

Definition at line 328 of file DevicePath.h.

◆ MSG_SCSI_DP

#define MSG_SCSI_DP 0x02

SCSI Device Path SubType.

Definition at line 348 of file DevicePath.h.

◆ MSG_FIBRECHANNEL_DP

#define MSG_FIBRECHANNEL_DP 0x03

Fibre Channel SubType.

Definition at line 364 of file DevicePath.h.

◆ MSG_FIBRECHANNELEX_DP

#define MSG_FIBRECHANNELEX_DP 0x15

Fibre Channel Ex SubType.

Definition at line 384 of file DevicePath.h.

◆ MSG_1394_DP

#define MSG_1394_DP 0x04

1394 Device Path SubType

Definition at line 404 of file DevicePath.h.

◆ MSG_USB_DP

#define MSG_USB_DP 0x05

USB Device Path SubType.

Definition at line 420 of file DevicePath.h.

◆ MSG_USB_CLASS_DP

#define MSG_USB_CLASS_DP 0x0f

USB Class Device Path SubType.

Definition at line 436 of file DevicePath.h.

◆ MSG_USB_WWID_DP

#define MSG_USB_WWID_DP 0x10

USB WWID Device Path SubType.

Definition at line 469 of file DevicePath.h.

◆ MSG_DEVICE_LOGICAL_UNIT_DP

#define MSG_DEVICE_LOGICAL_UNIT_DP 0x11

Device Logical Unit SubType.

Definition at line 500 of file DevicePath.h.

◆ MSG_SATA_DP

#define MSG_SATA_DP 0x12

SATA Device Path SubType.

Definition at line 512 of file DevicePath.h.

◆ SATA_HBA_DIRECT_CONNECT_FLAG

#define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000

Flag for if the device is directly connected to the HBA.

Definition at line 535 of file DevicePath.h.

◆ MSG_I2O_DP

#define MSG_I2O_DP 0x06

I2O Device Path SubType.

Definition at line 540 of file DevicePath.h.

◆ MSG_MAC_ADDR_DP

#define MSG_MAC_ADDR_DP 0x0b

MAC Address Device Path SubType.

Definition at line 552 of file DevicePath.h.

◆ MSG_IPv4_DP

#define MSG_IPv4_DP 0x0c

IPv4 Device Path SubType.

Definition at line 568 of file DevicePath.h.

◆ MSG_IPv6_DP

#define MSG_IPv6_DP 0x0d

IPv6 Device Path SubType.

Definition at line 609 of file DevicePath.h.

◆ MSG_INFINIBAND_DP

#define MSG_INFINIBAND_DP 0x09

InfiniBand Device Path SubType.

Definition at line 653 of file DevicePath.h.

◆ INFINIBAND_RESOURCE_FLAG_IOC_SERVICE

#define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01

Definition at line 685 of file DevicePath.h.

◆ INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT

#define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02

Definition at line 686 of file DevicePath.h.

◆ INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL

#define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04

Definition at line 687 of file DevicePath.h.

◆ INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL

#define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08

Definition at line 688 of file DevicePath.h.

◆ INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL

#define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10

Definition at line 689 of file DevicePath.h.

◆ MSG_UART_DP

#define MSG_UART_DP 0x0e

UART Device Path SubType.

Definition at line 694 of file DevicePath.h.

◆ NVDIMM_NAMESPACE_DP

#define NVDIMM_NAMESPACE_DP 0x20

NVDIMM Namespace Device Path SubType.

Definition at line 734 of file DevicePath.h.

◆ MSG_VENDOR_DP

#define MSG_VENDOR_DP 0x0a

Definition at line 746 of file DevicePath.h.

◆ DEVICE_PATH_MESSAGING_PC_ANSI

#define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID

Definition at line 749 of file DevicePath.h.

◆ DEVICE_PATH_MESSAGING_VT_100

#define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID

Definition at line 750 of file DevicePath.h.

◆ DEVICE_PATH_MESSAGING_VT_100_PLUS

#define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID

Definition at line 751 of file DevicePath.h.

◆ DEVICE_PATH_MESSAGING_VT_UTF8

#define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID

Definition at line 752 of file DevicePath.h.

◆ UART_FLOW_CONTROL_HARDWARE

#define UART_FLOW_CONTROL_HARDWARE 0x00000001

Definition at line 773 of file DevicePath.h.

◆ UART_FLOW_CONTROL_XON_XOFF

#define UART_FLOW_CONTROL_XON_XOFF 0x00000010

Definition at line 774 of file DevicePath.h.

◆ DEVICE_PATH_MESSAGING_SAS

#define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID

Definition at line 776 of file DevicePath.h.

◆ MSG_SASEX_DP

#define MSG_SASEX_DP 0x16

Serial Attached SCSI (SAS) Ex Device Path SubType.

Definition at line 811 of file DevicePath.h.

◆ MSG_NVME_NAMESPACE_DP

#define MSG_NVME_NAMESPACE_DP 0x17

NvmExpress Namespace Device Path SubType.

Definition at line 835 of file DevicePath.h.

◆ MSG_NVME_OF_NAMESPACE_DP

#define MSG_NVME_OF_NAMESPACE_DP 0x22

NVMe over Fabric (NVMe-oF) Namespace Device Path SubType.

Definition at line 845 of file DevicePath.h.

◆ MSG_DNS_DP

#define MSG_DNS_DP 0x1F

DNS Device Path SubType.

Definition at line 865 of file DevicePath.h.

◆ MSG_URI_DP

#define MSG_URI_DP 0x18

Uniform Resource Identifiers (URI) Device Path SubType.

Definition at line 881 of file DevicePath.h.

◆ MSG_UFS_DP

#define MSG_UFS_DP 0x19

Universal Flash Storage (UFS) Device Path SubType.

Definition at line 893 of file DevicePath.h.

◆ MSG_SD_DP

#define MSG_SD_DP 0x1A

SD (Secure Digital) Device Path SubType.

Definition at line 909 of file DevicePath.h.

◆ MSG_EMMC_DP

#define MSG_EMMC_DP 0x1D

EMMC (Embedded MMC) Device Path SubType.

Definition at line 918 of file DevicePath.h.

◆ MSG_ISCSI_DP

#define MSG_ISCSI_DP 0x13

iSCSI Device Path SubType

Definition at line 927 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST

#define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000

Definition at line 954 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C

#define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002

Definition at line 955 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_NO_DATA_DIGEST

#define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000

Definition at line 956 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C

#define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008

Definition at line 957 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP

#define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000

Definition at line 958 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_AUTHMETHOD_NON

#define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000

Definition at line 959 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_CHAP_BI

#define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000

Definition at line 960 of file DevicePath.h.

◆ ISCSI_LOGIN_OPTION_CHAP_UNI

#define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000

Definition at line 961 of file DevicePath.h.

◆ MSG_VLAN_DP

#define MSG_VLAN_DP 0x14

VLAN Device Path SubType.

Definition at line 966 of file DevicePath.h.

◆ MSG_BLUETOOTH_DP

#define MSG_BLUETOOTH_DP 0x1b

Bluetooth Device Path SubType.

Definition at line 978 of file DevicePath.h.

◆ MSG_WIFI_DP

#define MSG_WIFI_DP 0x1C

Wi-Fi Device Path SubType.

Definition at line 990 of file DevicePath.h.

◆ MSG_BLUETOOTH_LE_DP

#define MSG_BLUETOOTH_LE_DP 0x1E

Bluetooth LE Device Path SubType.

Definition at line 1002 of file DevicePath.h.

◆ MEDIA_DEVICE_PATH

#define MEDIA_DEVICE_PATH 0x04

Definition at line 1011 of file DevicePath.h.

◆ MEDIA_HARDDRIVE_DP

#define MEDIA_HARDDRIVE_DP 0x01

Hard Drive Media Device Path SubType.

Definition at line 1016 of file DevicePath.h.

◆ MBR_TYPE_PCAT

#define MBR_TYPE_PCAT 0x01

Definition at line 1061 of file DevicePath.h.

◆ MBR_TYPE_EFI_PARTITION_TABLE_HEADER

#define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02

Definition at line 1062 of file DevicePath.h.

◆ NO_DISK_SIGNATURE

#define NO_DISK_SIGNATURE 0x00

Definition at line 1064 of file DevicePath.h.

◆ SIGNATURE_TYPE_MBR

#define SIGNATURE_TYPE_MBR 0x01

Definition at line 1065 of file DevicePath.h.

◆ SIGNATURE_TYPE_GUID

#define SIGNATURE_TYPE_GUID 0x02

Definition at line 1066 of file DevicePath.h.

◆ MEDIA_CDROM_DP

#define MEDIA_CDROM_DP 0x02

CD-ROM Media Device Path SubType.

Definition at line 1071 of file DevicePath.h.

◆ MEDIA_VENDOR_DP

#define MEDIA_VENDOR_DP 0x03

Media vendor device path subtype.

Definition at line 1095 of file DevicePath.h.

◆ MEDIA_FILEPATH_DP

#define MEDIA_FILEPATH_DP 0x04

File Path Media Device Path SubType.

Definition at line 1100 of file DevicePath.h.

◆ SIZE_OF_FILEPATH_DEVICE_PATH

#define SIZE_OF_FILEPATH_DEVICE_PATH OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)

Definition at line 1109 of file DevicePath.h.

◆ MEDIA_PROTOCOL_DP

#define MEDIA_PROTOCOL_DP 0x05

Media Protocol Device Path SubType.

Definition at line 1114 of file DevicePath.h.

◆ MEDIA_PIWG_FW_FILE_DP

#define MEDIA_PIWG_FW_FILE_DP 0x06

PIWG Firmware File SubType.

Definition at line 1132 of file DevicePath.h.

◆ MEDIA_PIWG_FW_VOL_DP

#define MEDIA_PIWG_FW_VOL_DP 0x07

PIWG Firmware Volume Device Path SubType.

Definition at line 1148 of file DevicePath.h.

◆ MEDIA_RELATIVE_OFFSET_RANGE_DP

#define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08

Media relative offset range device path.

Definition at line 1164 of file DevicePath.h.

◆ EFI_VIRTUAL_DISK_GUID

#define EFI_VIRTUAL_DISK_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_VOLATILE

This GUID defines a RAM Disk supporting a raw disk format in volatile memory.

Definition at line 1179 of file DevicePath.h.

◆ EFI_VIRTUAL_CD_GUID

#define EFI_VIRTUAL_CD_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_VOLATILE

This GUID defines a RAM Disk supporting an ISO image in volatile memory.

Definition at line 1186 of file DevicePath.h.

◆ EFI_PERSISTENT_VIRTUAL_DISK_GUID

#define EFI_PERSISTENT_VIRTUAL_DISK_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_PERSISTENT

This GUID defines a RAM Disk supporting a raw disk format in persistent memory.

Definition at line 1193 of file DevicePath.h.

◆ EFI_PERSISTENT_VIRTUAL_CD_GUID

#define EFI_PERSISTENT_VIRTUAL_CD_GUID EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_PERSISTENT

This GUID defines a RAM Disk supporting an ISO image in persistent memory.

Definition at line 1200 of file DevicePath.h.

◆ MEDIA_RAM_DISK_DP

#define MEDIA_RAM_DISK_DP 0x09

Media ram disk device path.

Definition at line 1207 of file DevicePath.h.

◆ BBS_DEVICE_PATH

#define BBS_DEVICE_PATH 0x05

BIOS Boot Specification Device Path.

Definition at line 1235 of file DevicePath.h.

◆ BBS_BBS_DP

#define BBS_BBS_DP 0x01

BIOS Boot Specification Device Path SubType.

Definition at line 1240 of file DevicePath.h.

◆ BBS_TYPE_FLOPPY

#define BBS_TYPE_FLOPPY 0x01

Definition at line 1264 of file DevicePath.h.

◆ BBS_TYPE_HARDDRIVE

#define BBS_TYPE_HARDDRIVE 0x02

Definition at line 1265 of file DevicePath.h.

◆ BBS_TYPE_CDROM

#define BBS_TYPE_CDROM 0x03

Definition at line 1266 of file DevicePath.h.

◆ BBS_TYPE_PCMCIA

#define BBS_TYPE_PCMCIA 0x04

Definition at line 1267 of file DevicePath.h.

◆ BBS_TYPE_USB

#define BBS_TYPE_USB 0x05

Definition at line 1268 of file DevicePath.h.

◆ BBS_TYPE_EMBEDDED_NETWORK

#define BBS_TYPE_EMBEDDED_NETWORK 0x06

Definition at line 1269 of file DevicePath.h.

◆ BBS_TYPE_BEV

#define BBS_TYPE_BEV 0x80

Definition at line 1270 of file DevicePath.h.

◆ BBS_TYPE_UNKNOWN

#define BBS_TYPE_UNKNOWN 0xFF

Definition at line 1271 of file DevicePath.h.

◆ END_DEVICE_PATH_TYPE

#define END_DEVICE_PATH_TYPE 0x7f

Definition at line 1393 of file DevicePath.h.

◆ END_ENTIRE_DEVICE_PATH_SUBTYPE

#define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xFF

Definition at line 1394 of file DevicePath.h.

◆ END_INSTANCE_DEVICE_PATH_SUBTYPE

#define END_INSTANCE_DEVICE_PATH_SUBTYPE 0x01

Definition at line 1395 of file DevicePath.h.

Typedef Documentation

◆ EFI_DEVICE_PATH

typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH

Device Path protocol definition for backward-compatible with EFI1.1.

Definition at line 65 of file DevicePath.h.

◆ VENDOR_DEFINED_DEVICE_PATH

typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH

Definition at line 747 of file DevicePath.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT )

Variable Documentation

◆ gEfiVirtualDiskGuid

EFI_GUID gEfiVirtualDiskGuid

◆ gEfiVirtualCdGuid

EFI_GUID gEfiVirtualCdGuid

◆ gEfiPersistentVirtualDiskGuid

EFI_GUID gEfiPersistentVirtualDiskGuid

◆ gEfiPersistentVirtualCdGuid

EFI_GUID gEfiPersistentVirtualCdGuid

◆ gEfiDevicePathProtocolGuid

EFI_GUID gEfiDevicePathProtocolGuid

Data Structures

Macros

Typedefs

Functions

Variables