projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 3eb9473e | 1 | /*++\r |
| 2 | \r | |
| f57387d5 HT |
3 | Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r |
| 4 | This program and the accompanying materials \r | |
| 3eb9473e | 5 | are licensed and made available under the terms and conditions of the BSD License \r |
| 6 | which accompanies this distribution. The full text of the license may be found at \r | |
| 7 | http://opensource.org/licenses/bsd-license.php \r | |
| 8 | \r | |
| 9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
| 11 | \r | |
| 12 | Module Name:\r | |
| 13 | \r | |
| 14 | DevicePathToText.h\r | |
| 15 | \r | |
| 16 | Abstract:\r | |
| 17 | \r | |
| 18 | --*/\r | |
| 19 | \r | |
| 20 | \r | |
| 21 | #ifndef _DEVICE_PATH_TO_TEXT_PROTOCOL_H_\r | |
| 22 | #define _DEVICE_PATH_TO_TEXT_PROTOCOL_H_\r | |
| 23 | \r | |
| 24 | //\r | |
| 25 | // Device Path To Text protocol\r | |
| 26 | //\r | |
| 27 | #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \\r | |
| 28 | { \\r | |
| 7ccf38a3 | 29 | 0x8b843e20, 0x8132, 0x4852, {0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c} \\r |
| 3eb9473e | 30 | }\r |
| 31 | \r | |
| 32 | typedef\r | |
| 33 | CHAR16*\r | |
| 34 | (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_NODE) (\r | |
| 35 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode,\r | |
| 36 | IN BOOLEAN DisplayOnly,\r | |
| 37 | IN BOOLEAN AllowShortcuts\r | |
| 38 | )\r | |
| 39 | /*++\r | |
| 40 | \r | |
| 41 | Routine Description:\r | |
| 42 | Convert a device node to its text representation.\r | |
| 43 | \r | |
| 44 | Arguments:\r | |
| 45 | DeviceNode - Points to the device node to be converted.\r | |
| 46 | DisplayOnly - If DisplayOnly is TRUE, then the shorter text representation\r | |
| 47 | of the display node is used, where applicable. If DisplayOnly\r | |
| 48 | is FALSE, then the longer text representation of the display node\r | |
| 49 | is used.\r | |
| 50 | AllowShortcuts - If AllowShortcuts is TRUE, then the shortcut forms of text\r | |
| 51 | representation for a device node can be used, where applicable.\r | |
| 52 | \r | |
| 53 | Returns:\r | |
| 54 | A pointer - a pointer to the allocated text representation of the device node.\r | |
| 55 | NULL - if DeviceNode is NULL or there was insufficient memory.\r | |
| 56 | \r | |
| 57 | --*/\r | |
| 58 | ; \r | |
| 59 | \r | |
| 60 | typedef\r | |
| 61 | CHAR16*\r | |
| 62 | (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_PATH) (\r | |
| 63 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
| 64 | IN BOOLEAN DisplayOnly,\r | |
| 65 | IN BOOLEAN AllowShortcuts\r | |
| 66 | )\r | |
| 67 | /*++\r | |
| 68 | \r | |
| 69 | Routine Description:\r | |
| 70 | Convert a device path to its text representation.\r | |
| 71 | \r | |
| 72 | Arguments:\r | |
| 73 | DeviceNode - Points to the device path to be converted.\r | |
| 74 | DisplayOnly - If DisplayOnly is TRUE, then the shorter text representation\r | |
| 75 | of the display node is used, where applicable. If DisplayOnly\r | |
| 76 | is FALSE, then the longer text representation of the display node\r | |
| 77 | is used.\r | |
| 78 | AllowShortcuts - If AllowShortcuts is TRUE, then the shortcut forms of text\r | |
| 79 | representation for a device node can be used, where applicable.\r | |
| 80 | \r | |
| 81 | Returns:\r | |
| 82 | A pointer - a pointer to the allocated text representation of the device path.\r | |
| 83 | NULL - if DeviceNode is NULL or there was insufficient memory.\r | |
| 84 | \r | |
| 85 | --*/\r | |
| 86 | ;\r | |
| 87 | \r | |
| 88 | typedef struct {\r | |
| 89 | EFI_DEVICE_PATH_TO_TEXT_NODE ConvertDeviceNodeToText;\r | |
| 90 | EFI_DEVICE_PATH_TO_TEXT_PATH ConvertDevicePathToText;\r | |
| 91 | } EFI_DEVICE_PATH_TO_TEXT_PROTOCOL;\r | |
| 92 | \r | |
| 93 | extern EFI_GUID gEfiDevicePathToTextProtocolGuid;\r | |
| 94 | \r | |
| 95 | #endif\r |