]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Protocol/DevicePathFromText.h
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Include / Protocol / DevicePathFromText.h
CommitLineData
d1f95000 1/** @file\r
9095d37b 2 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL as defined in UEFI 2.0.\r
d1f95000 3 This protocol provides service to convert text to device paths and device nodes.\r
4\r
9095d37b 5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
9344f092 6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
d1f95000 7\r
d1f95000 8**/\r
9\r
10#ifndef __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__\r
11#define __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__\r
12\r
99e8ed21 13///\r
14/// Device Path From Text protocol\r
15///\r
d1f95000 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
8b13229b 34(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(\r
d1f95000 35 IN CONST CHAR16 *TextDeviceNode\r
9095d37b
LG
36 );\r
37\r
d1f95000 38\r
39/**\r
40 Convert text to the binary representation of a device node.\r
41\r
42 @param TextDeviceNode TextDevicePath points to the text representation of a device\r
43 path. Conversion starts with the first character and continues\r
44 until the first non-device path character.\r
45\r
46 @retval a_pointer Pointer to the allocated device path.\r
47 @retval NULL if TextDeviceNode is NULL or there was insufficient memory.\r
48\r
49**/\r
50typedef\r
51EFI_DEVICE_PATH_PROTOCOL*\r
8b13229b 52(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(\r
d1f95000 53 IN CONST CHAR16 *TextDevicePath\r
9095d37b 54 );\r
4ca9b6c4 55\r
44717a39 56///\r
57/// This protocol converts text to device paths and device nodes.\r
58///\r
d1f95000 59typedef struct {\r
60 EFI_DEVICE_PATH_FROM_TEXT_NODE ConvertTextToDeviceNode;\r
61 EFI_DEVICE_PATH_FROM_TEXT_PATH ConvertTextToDevicePath;\r
62} EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;\r
63\r
64extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;\r
65\r
66#endif\r