f57387d54b
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10435 6f19259b-4bc3-4df7-8a09-765794883524
96 lines
3.4 KiB
C
96 lines
3.4 KiB
C
/*++
|
|
|
|
Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>
|
|
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.
|
|
|
|
Module Name:
|
|
|
|
DevicePathToText.h
|
|
|
|
Abstract:
|
|
|
|
--*/
|
|
|
|
|
|
#ifndef _DEVICE_PATH_TO_TEXT_PROTOCOL_H_
|
|
#define _DEVICE_PATH_TO_TEXT_PROTOCOL_H_
|
|
|
|
//
|
|
// Device Path To Text protocol
|
|
//
|
|
#define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
|
|
{ \
|
|
0x8b843e20, 0x8132, 0x4852, {0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c} \
|
|
}
|
|
|
|
typedef
|
|
CHAR16*
|
|
(EFIAPI *EFI_DEVICE_PATH_TO_TEXT_NODE) (
|
|
IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode,
|
|
IN BOOLEAN DisplayOnly,
|
|
IN BOOLEAN AllowShortcuts
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
Convert a device node to its text representation.
|
|
|
|
Arguments:
|
|
DeviceNode - Points 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 - a pointer to the allocated text representation of the device node.
|
|
NULL - if DeviceNode is NULL or there was insufficient memory.
|
|
|
|
--*/
|
|
;
|
|
|
|
typedef
|
|
CHAR16*
|
|
(EFIAPI *EFI_DEVICE_PATH_TO_TEXT_PATH) (
|
|
IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
|
|
IN BOOLEAN DisplayOnly,
|
|
IN BOOLEAN AllowShortcuts
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
Convert a device path to its text representation.
|
|
|
|
Arguments:
|
|
DeviceNode - Points to the device path 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 - a pointer to the allocated text representation of the device path.
|
|
NULL - if DeviceNode is NULL or there was insufficient memory.
|
|
|
|
--*/
|
|
;
|
|
|
|
typedef struct {
|
|
EFI_DEVICE_PATH_TO_TEXT_NODE ConvertDeviceNodeToText;
|
|
EFI_DEVICE_PATH_TO_TEXT_PATH ConvertDevicePathToText;
|
|
} EFI_DEVICE_PATH_TO_TEXT_PROTOCOL;
|
|
|
|
extern EFI_GUID gEfiDevicePathToTextProtocolGuid;
|
|
|
|
#endif
|