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