Adjust directory structures.

[mirror_edk2.git] / MdeModulePkg / Universal / Console / ConPlatformDxe / ConPlatform.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
    ConPlatform.h\r
    \r
Abstract:\r
\r
--*/\r
\r
#ifndef CON_MANAGE_H_\r
#define CON_MANAGE_H_\r
\r
#include <Uefi.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Guid/GlobalVariable.h>\r
#include <Guid/ConsoleInDevice.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Guid/HotPlugDevice.h>\r
#include <Guid/StandardErrorDevice.h>\r
#include <Guid/ConsoleOutDevice.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
//\r
// Driver Binding Externs\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL gConPlatformTextInDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL gConPlatformComponentName;\r
extern EFI_DRIVER_BINDING_PROTOCOL gConPlatformTextOutDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL gConPlatformComponentName;\r
\r
#define VarConsoleInpDev  L"ConInDev"\r
#define VarConsoleInp     L"ConIn"\r
#define VarConsoleOutDev  L"ConOutDev"\r
#define VarConsoleOut     L"ConOut"\r
#define VarErrorOutDev    L"ErrOutDev"\r
#define VarErrorOut       L"ErrOut"\r
\r
typedef enum {\r
  CHECK,\r
  APPEND,\r
  DELETE\r
} CONPLATFORM_VAR_OPERATION;\r
\r
EFI_STATUS\r
ConPlatformDriverBindingSupported (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath,\r
  IN  EFI_GUID                     *ProtocolGuid\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ConPlatformTextInDriverBindingSupported (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ConPlatformTextOutDriverBindingSupported (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ConPlatformTextInDriverBindingStart (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  IN  EFI_HANDLE                    Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ConPlatformTextOutDriverBindingStart (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  IN  EFI_HANDLE                    Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ConPlatformTextInDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Handle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ConPlatformTextOutDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Handle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer\r
  );\r
\r
VOID\r
ConPlatformUnInstallProtocol (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Handle,\r
  IN  EFI_GUID                     *ProtocolGuid\r
  );\r
\r
VOID *\r
ConPlatformGetVariable (\r
  IN  CHAR16              *Name\r
  );\r
\r
EFI_STATUS\r
ConPlatformMatchDevicePaths (\r
  IN  EFI_DEVICE_PATH_PROTOCOL  * Multi,\r
  IN  EFI_DEVICE_PATH_PROTOCOL  * Single,\r
  IN  EFI_DEVICE_PATH_PROTOCOL  **NewDevicePath OPTIONAL,\r
  IN  BOOLEAN                   Delete\r
  );\r
\r
EFI_STATUS\r
ConPlatformUpdateDeviceVariable (\r
  IN  CHAR16                    *VariableName,\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
  IN  CONPLATFORM_VAR_OPERATION Operation\r
  );\r
\r
BOOLEAN\r
IsHotPlugDevice (\r
  EFI_HANDLE    DriverBindingHandle,\r
  EFI_HANDLE    ControllerHandle\r
  );\r
\r
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
ConPlatformComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
ConPlatformComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
#endif\r