projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| d1f95000 | 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 | |
| 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_FROM_TEXT_PROTOCOL_H__\r | |
| 17 | #define __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__\r | |
| 18 | \r | |
| 19 | #include <Protocol/DevicePath.h>\r | |
| 20 | \r | |
| 21 | //\r | |
| 22 | // Device Path From Text protocol\r | |
| 23 | //\r | |
| 24 | #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID \\r | |
| 25 | { \\r | |
| 26 | 0x5c99a21, 0xc70f, 0x4ad2, {0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e } \\r | |
| 27 | }\r | |
| 28 | \r | |
| 29 | /**\r | |
| 30 | Convert text to the binary representation of a device node.\r | |
| 31 | \r | |
| 32 | @param TextDeviceNode TextDeviceNode points to the text representation of a device\r | |
| 33 | node. Conversion starts with the first character and continues\r | |
| 34 | until the first non-device node character.\r | |
| 35 | \r | |
| 36 | @retval a_pointer Pointer to the EFI device node.\r | |
| 37 | @retval NULL if TextDeviceNode is NULL or there was insufficient memory.\r | |
| 38 | \r | |
| 39 | **/\r | |
| 40 | typedef\r | |
| 41 | EFI_DEVICE_PATH_PROTOCOL*\r | |
| 8b13229b | 42 | (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(\r |
| d1f95000 | 43 | IN CONST CHAR16 *TextDeviceNode\r |
| 44 | )\r | |
| 45 | ; \r | |
| 46 | \r | |
| 47 | \r | |
| 48 | /**\r | |
| 49 | Convert text to the binary representation of a device node.\r | |
| 50 | \r | |
| 51 | @param TextDeviceNode TextDevicePath points to the text representation of a device\r | |
| 52 | path. Conversion starts with the first character and continues\r | |
| 53 | until the first non-device path character.\r | |
| 54 | \r | |
| 55 | @retval a_pointer Pointer to the allocated device path.\r | |
| 56 | @retval NULL if TextDeviceNode is NULL or there was insufficient memory.\r | |
| 57 | \r | |
| 58 | **/\r | |
| 59 | typedef\r | |
| 60 | EFI_DEVICE_PATH_PROTOCOL*\r | |
| 8b13229b | 61 | (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(\r |
| d1f95000 | 62 | IN CONST CHAR16 *TextDevicePath\r |
| 63 | )\r | |
| 64 | ; \r | |
| 4ca9b6c4 LG |
65 | \r |
| 66 | /**\r | |
| 67 | @par Protocol Description:\r | |
| 68 | This protocol converts text to device paths and device nodes.\r | |
| 69 | \r | |
| 70 | @param ConvertTextToDeviceNode\r | |
| 71 | Convert text to a device node.\r | |
| 72 | \r | |
| 73 | @param ConvertTextToDevicePath\r | |
| 74 | Convert text to a device path\r | |
| d1f95000 | 75 | \r |
| 4ca9b6c4 | 76 | **/ \r |
| d1f95000 | 77 | typedef struct {\r |
| 78 | EFI_DEVICE_PATH_FROM_TEXT_NODE ConvertTextToDeviceNode;\r | |
| 79 | EFI_DEVICE_PATH_FROM_TEXT_PATH ConvertTextToDevicePath;\r | |
| 80 | } EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;\r | |
| 81 | \r | |
| 82 | extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;\r | |
| 83 | \r | |
| 84 | #endif\r |