]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdePkg/Include/Protocol/DevicePathFromText.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdePkg / Include / Protocol / DevicePathFromText.h
... / ...
CommitLineData
1/** @file\r
2 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL as defined in UEFI 2.0.\r
3 This protocol provides service to convert text to device paths and device nodes.\r
4\r
5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
7\r
8**/\r
9\r
10#ifndef __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__\r
11#define __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__\r
12\r
13///\r
14/// Device Path From Text protocol\r
15///\r
16#define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID \\r
17 { \\r
18 0x5c99a21, 0xc70f, 0x4ad2, {0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e } \\r
19 }\r
20\r
21/**\r
22 Convert text to the binary representation of a device node.\r
23\r
24 @param TextDeviceNode TextDeviceNode points to the text representation of a device\r
25 node. Conversion starts with the first character and continues\r
26 until the first non-device node character.\r
27\r
28 @retval a_pointer Pointer to the EFI device node.\r
29 @retval NULL if TextDeviceNode is NULL or there was insufficient memory.\r
30\r
31**/\r
32typedef\r
33EFI_DEVICE_PATH_PROTOCOL *\r
34(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(\r
35 IN CONST CHAR16 *TextDeviceNode\r
36 );\r
37\r
38/**\r
39 Convert text to the binary representation of a device node.\r
40\r
41 @param TextDeviceNode TextDevicePath points to the text representation of a device\r
42 path. Conversion starts with the first character and continues\r
43 until the first non-device path character.\r
44\r
45 @retval a_pointer Pointer to the allocated device path.\r
46 @retval NULL if TextDeviceNode is NULL or there was insufficient memory.\r
47\r
48**/\r
49typedef\r
50EFI_DEVICE_PATH_PROTOCOL *\r
51(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(\r
52 IN CONST CHAR16 *TextDevicePath\r
53 );\r
54\r
55///\r
56/// This protocol converts text to device paths and device nodes.\r
57///\r
58typedef struct {\r
59 EFI_DEVICE_PATH_FROM_TEXT_NODE ConvertTextToDeviceNode;\r
60 EFI_DEVICE_PATH_FROM_TEXT_PATH ConvertTextToDevicePath;\r
61} EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;\r
62\r
63extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;\r
64\r
65#endif\r