EdkCompatibilityPkg/Foundation/Efi/Protocol/DevicePathFromText/DevicePathFromText.h

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   DevicePathFromText.h
  15
  16 Abstract:
  17
  18 --*/
  19
  20 #ifndef _DEVICE_PATH_FROM_TEXT_PROTOCOL_H_
  21 #define _DEVICE_PATH_FROM_TEXT_PROTOCOL_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 typedef
  32 EFI_DEVICE_PATH_PROTOCOL*
  33 (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE) (
  34   IN CONST CHAR16                 *TextDeviceNode
  35   )
  36 /*++
  37
  38   Routine Description:
  39     Convert text to the binary representation of a device node.
  40
  41   Arguments:
  42     TextDeviceNode   -   TextDeviceNode points to the text representation of a device
  43                          node. Conversion starts with the first character and continues
  44                          until the first non-device node character.
  45
  46   Returns:
  47     A pointer        -   Pointer to the EFI device node.
  48     NULL             -   if TextDeviceNode is NULL or there was insufficient memory.
  49
  50 --*/
  51 ;
  52
  53 typedef
  54 EFI_DEVICE_PATH_PROTOCOL*
  55 (EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH) (
  56   IN CONST CHAR16                 *TextDevicePath
  57   )
  58 /*++
  59
  60   Routine Description:
  61     Convert text to the binary representation of a device path.
  62
  63   Arguments:
  64     TextDevicePath   -   TextDevicePath points to the text representation of a device
  65                          path. Conversion starts with the first character and continues
  66                          until the first non-device node character.
  67
  68   Returns:
  69     A pointer        -   Pointer to the allocated device path.
  70     NULL             -   if TextDeviceNode is NULL or there was insufficient memory.
  71
  72 --*/
  73 ;
  74
  75 typedef struct {
  76   EFI_DEVICE_PATH_FROM_TEXT_NODE  ConvertTextToDeviceNode;
  77   EFI_DEVICE_PATH_FROM_TEXT_PATH  ConvertTextToDevicePath;
  78 } EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;
  79
  80 extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;
  81
  82 #endif