MdePkg/Include/Protocol/DevicePathToText.h

   1 /** @file
   2   EFI_DEVICE_PATH_TO_TEXT_PROTOCOL as defined in UEFI 2.0.
   3   This protocol provides service to convert device nodes and paths to text.
   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_TO_TEXT_PROTOCOL_H__
  17 #define __DEVICE_PATH_TO_TEXT_PROTOCOL_H__
  18
  19 #include <Protocol/DevicePath.h>
  20
  21 //
  22 // Device Path To Text protocol
  23 //
  24 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
  25   { \
  26     0x8b843e20, 0x8132, 0x4852, {0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c } \
  27   }
  28
  29 /**
  30   Convert a device node to its text representation.
  31
  32   @param  DeviceNode     Points to the device node to be converted.
  33   @param  DisplayOnly    If DisplayOnly is TRUE, then the shorter text representation
  34                          of the display node is used, where applicable. If DisplayOnly
  35                          is FALSE, then the longer text representation of the display node
  36                          is used.
  37   @param  AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
  38                          representation for a device node can be used, where applicable.
  39
  40   @retval a_pointer      a pointer to the allocated text representation of the device node data
  41   @retval NULL           if DeviceNode is NULL or there was insufficient memory.
  42
  43 **/
  44 typedef
  45 CHAR16*
  46 (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_NODE) (
  47   IN CONST EFI_DEVICE_PATH_PROTOCOL   *DeviceNode,
  48   IN BOOLEAN                          DisplayOnly,
  49   IN BOOLEAN                          AllowShortcuts
  50   )
  51 ;
  52
  53 /**
  54   Convert a device path to its text representation.
  55
  56   @param  DevicePath     Points to the device path to be converted.
  57   @param  DisplayOnly    If DisplayOnly is TRUE, then the shorter text representation
  58                          of the display node is used, where applicable. If DisplayOnly
  59                          is FALSE, then the longer text representation of the display node
  60                          is used.
  61   @param  AllowShortcuts The AllowShortcuts is FALSE, then the shortcut forms of
  62                          text representation for a device node cannot be used.
  63
  64   @retval a_pointer      a pointer to the allocated text representation of the device node.
  65   @retval NULL           if DevicePath is NULL or there was insufficient memory.
  66
  67 **/
  68 typedef
  69 CHAR16*
  70 (EFIAPI *EFI_DEVICE_PATH_TO_TEXT_PATH) (
  71   IN CONST EFI_DEVICE_PATH_PROTOCOL   *DevicePath,
  72   IN BOOLEAN                          DisplayOnly,
  73   IN BOOLEAN                          AllowShortcuts
  74   )
  75 ;
  76
  77 typedef struct {
  78   EFI_DEVICE_PATH_TO_TEXT_NODE        ConvertDeviceNodeToText;
  79   EFI_DEVICE_PATH_TO_TEXT_PATH        ConvertDevicePathToText;
  80 } EFI_DEVICE_PATH_TO_TEXT_PROTOCOL;
  81
  82 extern EFI_GUID gEfiDevicePathToTextProtocolGuid;
  83
  84 #endif
  85
  86