MdePkg/Include/Protocol/DevicePathFromText.h

   1 /** @file
   2   EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL as defined in UEFI 2.0.
   3   This protocol provides service to convert text to device paths and device nodes.
   4
   5   Copyright (c) 2006, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__
  17 #define __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__
  18
  19 #include <Protocol/DevicePath.h>
  20
  21 //
  22 // Device Path From Text protocol
  23 //
  24 #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID \
  25   { \
  26     0x5c99a21, 0xc70f, 0x4ad2, {0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e  } \
  27   }
  28
  29 /**
  30   Convert text to the binary representation of a device node.
  31
  32   @param  TextDeviceNode TextDeviceNode points to the text representation of a device
  33                          node. Conversion starts with the first character and continues
  34                          until the first non-device node character.
  35
  36   @retval a_pointer      Pointer to the EFI device node.
  37   @retval NULL           if TextDeviceNode is NULL or there was insufficient memory.
  38
  39 **/
  40 typedef
  41 EFI_DEVICE_PATH_PROTOCOL*
  42 (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(
  43   IN CONST CHAR16                 *TextDeviceNode
  44   )
  45 ;
  46
  47
  48 /**
  49   Convert text to the binary representation of a device node.
  50
  51   @param  TextDeviceNode TextDevicePath points to the text representation of a device
  52                          path. Conversion starts with the first character and continues
  53                          until the first non-device path character.
  54
  55   @retval a_pointer      Pointer to the allocated device path.
  56   @retval NULL           if TextDeviceNode is NULL or there was insufficient memory.
  57
  58 **/
  59 typedef
  60 EFI_DEVICE_PATH_PROTOCOL*
  61 (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(
  62   IN CONST CHAR16                 *TextDevicePath
  63   )
  64 ;
  65
  66 typedef struct {
  67   EFI_DEVICE_PATH_FROM_TEXT_NODE  ConvertTextToDeviceNode;
  68   EFI_DEVICE_PATH_FROM_TEXT_PATH  ConvertTextToDevicePath;
  69 } EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;
  70
  71 extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;
  72
  73 #endif