]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
2 | EFI_DEVICE_PATH_TO_TEXT_PROTOCOL as defined in UEFI 2.0. \r | |
3 | This protocol provides service to convert device nodes and paths to text.\r | |
4 | \r | |
4ca9b6c4 | 5 | Copyright (c) 2006 - 2008, Intel Corporation \r |
d1f95000 | 6 | All rights reserved. This program and the accompanying materials \r |
7 | are licensed and made available under the terms and conditions of the BSD License \r | |
8 | which accompanies this distribution. The full text of the license may be found at \r | |
9 | http://opensource.org/licenses/bsd-license.php \r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
13 | \r | |
d1f95000 | 14 | **/\r |
15 | \r | |
16 | #ifndef __DEVICE_PATH_TO_TEXT_PROTOCOL_H__\r | |
17 | #define __DEVICE_PATH_TO_TEXT_PROTOCOL_H__\r | |
18 | \r | |
99e8ed21 | 19 | ///\r |
20 | /// Device Path To Text protocol\r | |
21 | ///\r | |
d1f95000 | 22 | #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \\r |
23 | { \\r | |
24 | 0x8b843e20, 0x8132, 0x4852, {0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c } \\r | |
25 | }\r | |
26 | \r | |
27 | /**\r | |
28 | Convert a device node to its text representation.\r | |
29 | \r | |
30 | @param DeviceNode Points to the device node to be converted.\r | |
31 | @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation\r | |
32 | of the display node is used, where applicable. If DisplayOnly\r | |
33 | is FALSE, then the longer text representation of the display node\r | |
34 | is used.\r | |
35 | @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text\r | |
36 | representation for a device node can be used, where applicable.\r | |
37 | \r | |
38 | @retval a_pointer a pointer to the allocated text representation of the device node data\r | |
39 | @retval NULL if DeviceNode is NULL or there was insufficient memory.\r | |
40 | \r | |
41 | **/\r | |
42 | typedef\r | |
43 | CHAR16*\r | |
8b13229b | 44 | (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_NODE)(\r |
d1f95000 | 45 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode,\r |
46 | IN BOOLEAN DisplayOnly,\r | |
47 | IN BOOLEAN AllowShortcuts\r | |
ed66e1bc | 48 | ); \r |
d1f95000 | 49 | \r |
50 | /**\r | |
51 | Convert a device path to its text representation.\r | |
52 | \r | |
53 | @param DevicePath Points to the device path to be converted.\r | |
54 | @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation\r | |
55 | of the display node is used, where applicable. If DisplayOnly\r | |
56 | is FALSE, then the longer text representation of the display node\r | |
57 | is used. \r | |
58 | @param AllowShortcuts The AllowShortcuts is FALSE, then the shortcut forms of\r | |
59 | text representation for a device node cannot be used.\r | |
60 | \r | |
61 | @retval a_pointer a pointer to the allocated text representation of the device node.\r | |
62 | @retval NULL if DevicePath is NULL or there was insufficient memory.\r | |
63 | \r | |
64 | **/\r | |
65 | typedef\r | |
66 | CHAR16*\r | |
8b13229b | 67 | (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_PATH)(\r |
d1f95000 | 68 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
69 | IN BOOLEAN DisplayOnly,\r | |
70 | IN BOOLEAN AllowShortcuts\r | |
ed66e1bc | 71 | ); \r |
d1f95000 | 72 | \r |
44717a39 | 73 | ///\r |
74 | /// This protocol converts device paths and device nodes to text.\r | |
75 | ///\r | |
d1f95000 | 76 | typedef struct {\r |
77 | EFI_DEVICE_PATH_TO_TEXT_NODE ConvertDeviceNodeToText;\r | |
78 | EFI_DEVICE_PATH_TO_TEXT_PATH ConvertDevicePathToText;\r | |
79 | } EFI_DEVICE_PATH_TO_TEXT_PROTOCOL;\r | |
80 | \r | |
81 | extern EFI_GUID gEfiDevicePathToTextProtocolGuid;\r | |
82 | \r | |
83 | #endif\r | |
84 | \r | |
85 | \r |