MdePkg/Library/UefiDevicePathLib/DevicePathToText.c File Reference


Functions

CHAR16 *EFIAPI UefiDevicePathLibCatPrint (IN OUT POOL_PRINT *Str, IN CHAR16 *Fmt,...)
VOID DevPathToTextPci (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextPccard (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextMemMap (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextVendor (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextController (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextBmc (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextAcpi (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextAcpiEx (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextAcpiAdr (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextAtapi (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextScsi (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextFibre (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextFibreEx (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextSasEx (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextNVMe (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextUfs (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextSd (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToText1394 (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextUsb (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextUsbWWID (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextLogicalUnit (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextUsbClass (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextSata (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextI2O (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextMacAddr (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID CatNetworkProtocol (IN OUT POOL_PRINT *Str, IN UINT16 Protocol)
VOID CatIPv4Address (IN OUT POOL_PRINT *Str, IN EFI_IPv4_ADDRESS *Address)
VOID CatIPv6Address (IN OUT POOL_PRINT *Str, IN EFI_IPv6_ADDRESS *Address)
VOID DevPathToTextIPv4 (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextIPv6 (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextInfiniBand (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextUart (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextiSCSI (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextVlan (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextBluetooth (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextWiFi (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextUri (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextHardDrive (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextCDROM (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextFilePath (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextMediaProtocol (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextFv (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextFvFile (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathRelativeOffsetRange (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextRamDisk (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextBBS (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextEndInstance (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
VOID DevPathToTextNodeGeneric (IN OUT POOL_PRINT *Str, IN VOID *DevPath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
CHAR16 *EFIAPI UefiDevicePathLibConvertDeviceNodeToText (IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)
CHAR16 *EFIAPI UefiDevicePathLibConvertDevicePathToText (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN BOOLEAN DisplayOnly, IN BOOLEAN AllowShortcuts)

Variables

GLOBAL_REMOVE_IF_UNREFERENCED
const
DEVICE_PATH_TO_TEXT_GENERIC_TABLE 
mUefiDevicePathLibToTextTableGeneric []
GLOBAL_REMOVE_IF_UNREFERENCED
const
DEVICE_PATH_TO_TEXT_TABLE 
mUefiDevicePathLibToTextTable []

Detailed Description

DevicePathToText protocol as defined in the UEFI 2.0 specification.

(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

VOID CatIPv4Address ( IN OUT POOL_PRINT Str,
IN EFI_IPv4_ADDRESS Address 
)

Converts IP v4 address to its text representation.

Parameters:
Str The string representative of input device.
Address The IP v4 address.

References UefiDevicePathLibCatPrint().

Referenced by DevPathToTextIPv4().

VOID CatIPv6Address ( IN OUT POOL_PRINT Str,
IN EFI_IPv6_ADDRESS Address 
)

Converts IP v6 address to its text representation.

Parameters:
Str The string representative of input device.
Address The IP v6 address.

References UefiDevicePathLibCatPrint().

Referenced by DevPathToTextIPv6().

VOID CatNetworkProtocol ( IN OUT POOL_PRINT Str,
IN UINT16  Protocol 
)

Converts network protocol string to its text representation.

Parameters:
Str The string representative of input device.
Protocol The network protocol ID.

References RFC_1700_TCP_PROTOCOL, RFC_1700_UDP_PROTOCOL, and UefiDevicePathLibCatPrint().

Referenced by DevPathToTextIPv4(), and DevPathToTextIPv6().

VOID DevPathRelativeOffsetRange ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Relative Offset device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH::EndingOffset, MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH::StartingOffset, and UefiDevicePathLibCatPrint().

VOID DevPathToText1394 ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a 1394 device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References F1394_DEVICE_PATH::Guid, and UefiDevicePathLibCatPrint().

VOID DevPathToTextAcpi ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a ACPI device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References EISA_ID_TO_NUM, ACPI_HID_DEVICE_PATH::HID, PNP_EISA_ID_CONST, PNP_EISA_ID_MASK, UefiDevicePathLibCatPrint(), and ACPI_HID_DEVICE_PATH::UID.

VOID DevPathToTextAcpiAdr ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a ACPI address device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References ACPI_ADR_DEVICE_PATH::ADR, DevicePathNodeLength(), and UefiDevicePathLibCatPrint().

VOID DevPathToTextAcpiEx ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a ACPI extended HID device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References AsciiStrLen(), UefiDevicePathLibCatPrint(), and UnicodeSPrint().

VOID DevPathToTextAtapi ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a ATAPI device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References ATAPI_DEVICE_PATH::Lun, ATAPI_DEVICE_PATH::PrimarySecondary, ATAPI_DEVICE_PATH::SlaveMaster, and UefiDevicePathLibCatPrint().

VOID DevPathToTextBBS ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a BIOS Boot Specification device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References BBS_TYPE_CDROM, BBS_TYPE_EMBEDDED_NETWORK, BBS_TYPE_FLOPPY, BBS_TYPE_HARDDRIVE, BBS_TYPE_PCMCIA, BBS_TYPE_USB, BBS_BBS_DEVICE_PATH::DeviceType, NULL, BBS_BBS_DEVICE_PATH::StatusFlag, BBS_BBS_DEVICE_PATH::String, Type, and UefiDevicePathLibCatPrint().

VOID DevPathToTextBluetooth ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Bluetooth device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References BLUETOOTH_ADDRESS::Address, BLUETOOTH_DEVICE_PATH::BD_ADDR, and UefiDevicePathLibCatPrint().

VOID DevPathToTextBmc ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a BMC device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References BMC_DEVICE_PATH::BaseAddress, BMC_DEVICE_PATH::InterfaceType, ReadUnaligned64(), and UefiDevicePathLibCatPrint().

VOID DevPathToTextCDROM ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a CDROM device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References CDROM_DEVICE_PATH::BootEntry, CDROM_DEVICE_PATH::PartitionSize, CDROM_DEVICE_PATH::PartitionStart, and UefiDevicePathLibCatPrint().

VOID DevPathToTextController ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Controller device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References CONTROLLER_DEVICE_PATH::ControllerNumber, and UefiDevicePathLibCatPrint().

VOID DevPathToTextEndInstance ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts an End-of-Device-Path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References UefiDevicePathLibCatPrint().

Referenced by UefiDevicePathLibConvertDevicePathToText().

VOID DevPathToTextFibre ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Fibre device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References FIBRECHANNEL_DEVICE_PATH::Lun, UefiDevicePathLibCatPrint(), and FIBRECHANNEL_DEVICE_PATH::WWN.

VOID DevPathToTextFibreEx ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a FibreEx device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References FIBRECHANNELEX_DEVICE_PATH::Lun, UefiDevicePathLibCatPrint(), and FIBRECHANNELEX_DEVICE_PATH::WWN.

VOID DevPathToTextFilePath ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a File device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References FILEPATH_DEVICE_PATH::PathName, and UefiDevicePathLibCatPrint().

VOID DevPathToTextFv ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Firmware Volume device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References MEDIA_FW_VOL_DEVICE_PATH::FvName, and UefiDevicePathLibCatPrint().

VOID DevPathToTextFvFile ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Firmware Volume File device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References MEDIA_FW_VOL_FILEPATH_DEVICE_PATH::FvFileName, and UefiDevicePathLibCatPrint().

VOID DevPathToTextHardDrive ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Hard drive device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References HARDDRIVE_DEVICE_PATH::PartitionNumber, HARDDRIVE_DEVICE_PATH::PartitionSize, HARDDRIVE_DEVICE_PATH::PartitionStart, HARDDRIVE_DEVICE_PATH::Signature, SIGNATURE_TYPE_GUID, SIGNATURE_TYPE_MBR, HARDDRIVE_DEVICE_PATH::SignatureType, and UefiDevicePathLibCatPrint().

VOID DevPathToTextI2O ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a I20 device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References I2O_DEVICE_PATH::Tid, and UefiDevicePathLibCatPrint().

VOID DevPathToTextInfiniBand ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts an Infini Band device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References INFINIBAND_DEVICE_PATH::DeviceId, INFINIBAND_DEVICE_PATH::PortGid, INFINIBAND_DEVICE_PATH::ResourceFlags, INFINIBAND_DEVICE_PATH::ServiceId, INFINIBAND_DEVICE_PATH::TargetPortId, and UefiDevicePathLibCatPrint().

VOID DevPathToTextIPv4 ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a IPv4 device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References CatIPv4Address(), CatNetworkProtocol(), DevicePathNodeLength(), IPv4_DEVICE_PATH::GatewayIpAddress, IPv4_DEVICE_PATH::LocalIpAddress, IPv4_DEVICE_PATH::Protocol, IPv4_DEVICE_PATH::RemoteIpAddress, IPv4_DEVICE_PATH::StaticIpAddress, IPv4_DEVICE_PATH::SubnetMask, and UefiDevicePathLibCatPrint().

VOID DevPathToTextIPv6 ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a IPv6 device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References CatIPv6Address(), CatNetworkProtocol(), DevicePathNodeLength(), IPv6_DEVICE_PATH::GatewayIpAddress, IPv6_DEVICE_PATH::IpAddressOrigin, IPv6_DEVICE_PATH::LocalIpAddress, IPv6_DEVICE_PATH::PrefixLength, IPv6_DEVICE_PATH::Protocol, IPv6_DEVICE_PATH::RemoteIpAddress, and UefiDevicePathLibCatPrint().

VOID DevPathToTextiSCSI ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts an iSCSI device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References ISCSI_DEVICE_PATH_WITH_NAME::LoginOption, ISCSI_DEVICE_PATH_WITH_NAME::Lun, ISCSI_DEVICE_PATH_WITH_NAME::NetworkProtocol, ISCSI_DEVICE_PATH_WITH_NAME::TargetName, ISCSI_DEVICE_PATH_WITH_NAME::TargetPortalGroupTag, and UefiDevicePathLibCatPrint().

VOID DevPathToTextLogicalUnit ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Logic Unit device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References DEVICE_LOGICAL_UNIT_DEVICE_PATH::Lun, and UefiDevicePathLibCatPrint().

VOID DevPathToTextMacAddr ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a MAC address device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References EFI_MAC_ADDRESS::Addr, MAC_ADDR_DEVICE_PATH::IfType, MAC_ADDR_DEVICE_PATH::MacAddress, and UefiDevicePathLibCatPrint().

VOID DevPathToTextMediaProtocol ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Media protocol device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References MEDIA_PROTOCOL_DEVICE_PATH::Protocol, and UefiDevicePathLibCatPrint().

VOID DevPathToTextMemMap ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Memory Map device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References MEMMAP_DEVICE_PATH::EndingAddress, MEMMAP_DEVICE_PATH::MemoryType, MEMMAP_DEVICE_PATH::StartingAddress, and UefiDevicePathLibCatPrint().

VOID DevPathToTextNodeGeneric ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts an unknown device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References DevicePathNodeLength(), DevicePathSubType(), DevicePathType(), mUefiDevicePathLibToTextTableGeneric, NULL, DEVICE_PATH_TO_TEXT_GENERIC_TABLE::Text, Type, and UefiDevicePathLibCatPrint().

Referenced by UefiDevicePathLibConvertDeviceNodeToText(), and UefiDevicePathLibConvertDevicePathToText().

VOID DevPathToTextNVMe ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a NVM Express Namespace device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References NVME_NAMESPACE_DEVICE_PATH::NamespaceId, NVME_NAMESPACE_DEVICE_PATH::NamespaceUuid, and UefiDevicePathLibCatPrint().

VOID DevPathToTextPccard ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a PC Card device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References PCCARD_DEVICE_PATH::FunctionNumber, and UefiDevicePathLibCatPrint().

VOID DevPathToTextPci ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a PCI device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References PCI_DEVICE_PATH::Device, PCI_DEVICE_PATH::Function, and UefiDevicePathLibCatPrint().

VOID DevPathToTextRamDisk ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Ram Disk device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References CompareGuid(), MEDIA_RAM_DISK_DEVICE_PATH::EndingAddr, gEfiPersistentVirtualCdGuid, gEfiPersistentVirtualDiskGuid, gEfiVirtualCdGuid, gEfiVirtualDiskGuid, MEDIA_RAM_DISK_DEVICE_PATH::Instance, LShiftU64(), MEDIA_RAM_DISK_DEVICE_PATH::StartingAddr, MEDIA_RAM_DISK_DEVICE_PATH::TypeGuid, and UefiDevicePathLibCatPrint().

VOID DevPathToTextSasEx ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Sas Ex device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References BIT4, BIT5, BIT6, BIT7, SASEX_DEVICE_PATH::DeviceTopology, SASEX_DEVICE_PATH::Lun, SASEX_DEVICE_PATH::RelativeTargetPort, SASEX_DEVICE_PATH::SasAddress, and UefiDevicePathLibCatPrint().

VOID DevPathToTextSata ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a SATA device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References SATA_DEVICE_PATH::HBAPortNumber, SATA_DEVICE_PATH::Lun, SATA_DEVICE_PATH::PortMultiplierPortNumber, and UefiDevicePathLibCatPrint().

VOID DevPathToTextScsi ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a SCSI device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References SCSI_DEVICE_PATH::Lun, SCSI_DEVICE_PATH::Pun, and UefiDevicePathLibCatPrint().

VOID DevPathToTextSd ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a SD (Secure Digital) device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References SD_DEVICE_PATH::SlotNumber, and UefiDevicePathLibCatPrint().

VOID DevPathToTextUart ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a UART device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References UART_DEVICE_PATH::BaudRate, UART_DEVICE_PATH::DataBits, UART_DEVICE_PATH::Parity, Parity, UART_DEVICE_PATH::StopBits, and UefiDevicePathLibCatPrint().

VOID DevPathToTextUfs ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a UFS device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References UFS_DEVICE_PATH::Lun, UFS_DEVICE_PATH::Pun, and UefiDevicePathLibCatPrint().

VOID DevPathToTextUri ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a URI device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References AllocatePool(), ASSERT, CopyMem(), DevicePathNodeLength(), FreePool(), NULL, UefiDevicePathLibCatPrint(), and URI_DEVICE_PATH::Uri.

VOID DevPathToTextUsb ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a USB device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References USB_DEVICE_PATH::InterfaceNumber, USB_DEVICE_PATH::ParentPortNumber, and UefiDevicePathLibCatPrint().

VOID DevPathToTextUsbClass ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a USB class device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References USB_CLASS_DEVICE_PATH::DeviceClass, USB_CLASS_DEVICE_PATH::DeviceProtocol, USB_CLASS_DEVICE_PATH::DeviceSubClass, FALSE, USB_CLASS_DEVICE_PATH::ProductId, TRUE, UefiDevicePathLibCatPrint(), USB_CLASS_AUDIO, USB_CLASS_CDCCONTROL, USB_CLASS_CDCDATA, USB_CLASS_DIAGNOSTIC, USB_CLASS_HID, USB_CLASS_HUB, USB_CLASS_IMAGE, USB_CLASS_MASS_STORAGE, USB_CLASS_PRINTER, USB_CLASS_RESERVE, USB_CLASS_SMART_CARD, USB_CLASS_VIDEO, USB_CLASS_WIRELESS, USB_SUBCLASS_FW_UPDATE, USB_SUBCLASS_IRDA_BRIDGE, USB_SUBCLASS_TEST, and USB_CLASS_DEVICE_PATH::VendorId.

VOID DevPathToTextUsbWWID ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a USB WWID device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References AllocateCopyPool(), ASSERT, DevicePathNodeLength(), USB_WWID_DEVICE_PATH::InterfaceNumber, NULL, USB_WWID_DEVICE_PATH::ProductId, UefiDevicePathLibCatPrint(), and USB_WWID_DEVICE_PATH::VendorId.

VOID DevPathToTextVendor ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Vendor device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References BIT4, BIT5, BIT6, BIT7, CompareGuid(), DevicePathNodeLength(), DevicePathType(), gEfiDebugPortProtocolGuid, gEfiPcAnsiGuid, gEfiSasDevicePathGuid, gEfiUartDevicePathGuid, gEfiVT100Guid, gEfiVT100PlusGuid, gEfiVTUTF8Guid, VENDOR_DEVICE_PATH::Guid, HARDWARE_DEVICE_PATH, VENDOR_DEVICE_PATH::Header, MEDIA_DEVICE_PATH, MESSAGING_DEVICE_PATH, Reserved, Type, and UefiDevicePathLibCatPrint().

VOID DevPathToTextVlan ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a VLAN device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References UefiDevicePathLibCatPrint(), and VLAN_DEVICE_PATH::VlanId.

VOID DevPathToTextWiFi ( IN OUT POOL_PRINT Str,
IN VOID *  DevPath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a Wi-Fi device path structure to its string representative.

Parameters:
Str The string representative of input device.
DevPath The input device path structure.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.

References CopyMem(), WIFI_DEVICE_PATH::SSId, and UefiDevicePathLibCatPrint().

CHAR16* EFIAPI UefiDevicePathLibCatPrint ( IN OUT POOL_PRINT Str,
IN CHAR16 Fmt,
  ... 
)

Concatenates a formatted unicode string to allocated pool. The caller must free the resulting buffer.

Parameters:
Str Tracks the allocated pool, size in use, and amount of pool allocated.
Fmt The format string
... Variable arguments based on the format string.
Returns:
Allocated buffer with the formatted string printed in it. The caller must free the allocated buffer. The buffer allocation is not packed.

References ASSERT, NULL, ReallocatePool(), SPrintLength(), UnicodeVSPrint(), VA_END, and VA_START.

Referenced by CatIPv4Address(), CatIPv6Address(), CatNetworkProtocol(), DevPathRelativeOffsetRange(), DevPathToText1394(), DevPathToTextAcpi(), DevPathToTextAcpiAdr(), DevPathToTextAcpiEx(), DevPathToTextAtapi(), DevPathToTextBBS(), DevPathToTextBluetooth(), DevPathToTextBmc(), DevPathToTextCDROM(), DevPathToTextController(), DevPathToTextEndInstance(), DevPathToTextFibre(), DevPathToTextFibreEx(), DevPathToTextFilePath(), DevPathToTextFv(), DevPathToTextFvFile(), DevPathToTextHardDrive(), DevPathToTextI2O(), DevPathToTextInfiniBand(), DevPathToTextIPv4(), DevPathToTextIPv6(), DevPathToTextiSCSI(), DevPathToTextLogicalUnit(), DevPathToTextMacAddr(), DevPathToTextMediaProtocol(), DevPathToTextMemMap(), DevPathToTextNodeGeneric(), DevPathToTextNVMe(), DevPathToTextPccard(), DevPathToTextPci(), DevPathToTextRamDisk(), DevPathToTextSasEx(), DevPathToTextSata(), DevPathToTextScsi(), DevPathToTextSd(), DevPathToTextUart(), DevPathToTextUfs(), DevPathToTextUri(), DevPathToTextUsb(), DevPathToTextUsbClass(), DevPathToTextUsbWWID(), DevPathToTextVendor(), DevPathToTextVlan(), DevPathToTextWiFi(), and UefiDevicePathLibConvertDevicePathToText().

CHAR16* EFIAPI UefiDevicePathLibConvertDeviceNodeToText ( IN CONST EFI_DEVICE_PATH_PROTOCOL DeviceNode,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a device node to its string representation.

Parameters:
DeviceNode A Pointer to the device node to be converted.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.
Returns:
A pointer to the allocated text representation of the device node or NULL if DeviceNode is NULL or there was insufficient memory.

References ASSERT, DevicePathSubType(), DevicePathType(), DevPathToTextNodeGeneric(), DEVICE_PATH_TO_TEXT_TABLE::Function, mUefiDevicePathLibToTextTable, NULL, POOL_PRINT::Str, Type, VOID, and ZeroMem().

Referenced by ConvertDeviceNodeToText().

CHAR16* EFIAPI UefiDevicePathLibConvertDevicePathToText ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath,
IN BOOLEAN  DisplayOnly,
IN BOOLEAN  AllowShortcuts 
)

Converts a device path to its text representation.

Parameters:
DevicePath A Pointer to the device to be converted.
DisplayOnly If DisplayOnly is TRUE, then the shorter text representation of the display node is used, where applicable. If DisplayOnly is FALSE, then the longer text representation of the display node is used.
AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text representation for a device node can be used, where applicable.
Returns:
A pointer to the allocated text representation of the device path or NULL if DeviceNode is NULL or there was insufficient memory.

References AllocateCopyPool(), AllocateZeroPool(), POOL_PRINT::Count, DevicePathNodeLength(), DevicePathSubType(), DevicePathType(), DevPathToTextEndInstance(), DevPathToTextNodeGeneric(), FreePool(), DEVICE_PATH_TO_TEXT_TABLE::Function, IsDevicePathEnd(), mUefiDevicePathLibToTextTable, NextDevicePathNode(), NULL, POOL_PRINT::Str, DEVICE_PATH_TO_TEXT_TABLE::SubType, DEVICE_PATH_TO_TEXT_TABLE::Type, UefiDevicePathLibCatPrint(), and ZeroMem().

Referenced by ConvertDevicePathToText().


Variable Documentation

GLOBAL_REMOVE_IF_UNREFERENCED const DEVICE_PATH_TO_TEXT_TABLE mUefiDevicePathLibToTextTable[]

Initial value:

 {
  {HARDWARE_DEVICE_PATH,  L"HardwarePath"   },
  {ACPI_DEVICE_PATH,      L"AcpiPath"       },
  {MESSAGING_DEVICE_PATH, L"Msg"            },
  {MEDIA_DEVICE_PATH,     L"MediaPath"      },
  {BBS_DEVICE_PATH,       L"BbsPath"        },
  {0, NULL}
}

Referenced by DevPathToTextNodeGeneric().


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1