Nt32Pkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Nt32Pkg / WinNtGopDxe / WinNtGopDriver.c

/** @file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
Module Name:\r
\r
  WinNtGopDriver.c\r
\r
Abstract:\r
\r
  This file implements the UEFI Device Driver model requirements for GOP\r
\r
  GOP is short hand for Graphics Output Protocol.\r
\r
\r
**/\r
#include "WinNtGop.h"\r
\r
EFI_STATUS\r
FreeNotifyList (\r
  IN OUT LIST_ENTRY           *ListHead\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
  ListHead   - The list head\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Free the notify list successfully\r
  EFI_INVALID_PARAMETER - ListHead is invalid.\r
\r
--*/\r
{\r
  WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY *NotifyNode;\r
\r
  if (ListHead == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  while (!IsListEmpty (ListHead)) {\r
    NotifyNode = CR (\r
                   ListHead->ForwardLink, \r
                   WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY, \r
                   NotifyEntry, \r
                   WIN_NT_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE\r
                   );\r
    RemoveEntryList (ListHead->ForwardLink);\r
    gBS->FreePool (NotifyNode);\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding = {\r
  WinNtGopDriverBindingSupported,\r
  WinNtGopDriverBindingStart,\r
  WinNtGopDriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  The user Entry Point for module WinNtGop. The user code starts with this function.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
  \r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeWinNtGop(\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS              Status;\r
\r
  //\r
  // Install driver model protocol(s).\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gWinNtGopDriverBinding,\r
             ImageHandle,\r
             &gWinNtGopComponentName,\r
             &gWinNtGopComponentName2\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
\r
  return Status;\r
}\r
\r
/**\r
\r
\r
  @return None\r
\r
**/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    Handle - add argument and description to function comment\r
// TODO:    RemainingDevicePath - add argument and description to function comment\r
EFI_STATUS\r
EFIAPI\r
WinNtGopDriverBindingSupported (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL     *This,\r
  IN  EFI_HANDLE                      Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL        *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_WIN_NT_IO_PROTOCOL  *WinNtIo;\r
\r
  //\r
  // Open the IO Abstraction(s) needed to perform the supported test\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Handle,\r
                  &gEfiWinNtIoProtocolGuid,\r
                  (VOID **) &WinNtIo,\r
                  This->DriverBindingHandle,\r
                  Handle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = WinNtGopSupported (WinNtIo);\r
\r
  //\r
  // Close the I/O Abstraction(s) used to perform the supported test\r
  //\r
  gBS->CloseProtocol (\r
        Handle,\r
        &gEfiWinNtIoProtocolGuid,\r
        This->DriverBindingHandle,\r
        Handle\r
        );\r
\r
  return Status;\r
}\r
\r
\r
/**\r
\r
\r
  @return None\r
\r
**/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    Handle - add argument and description to function comment\r
// TODO:    RemainingDevicePath - add argument and description to function comment\r
// TODO:    EFI_UNSUPPORTED - add return value to function comment\r
EFI_STATUS\r
EFIAPI\r
WinNtGopDriverBindingStart (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL     *This,\r
  IN  EFI_HANDLE                      Handle,\r
  IN  EFI_DEVICE_PATH_PROTOCOL        *RemainingDevicePath\r
  )\r
{\r
  EFI_WIN_NT_IO_PROTOCOL  *WinNtIo;\r
  EFI_STATUS              Status;\r
  GOP_PRIVATE_DATA        *Private;\r
\r
  //\r
  // Grab the protocols we need\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Handle,\r
                  &gEfiWinNtIoProtocolGuid,\r
                  (VOID **) &WinNtIo,\r
                  This->DriverBindingHandle,\r
                  Handle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Allocate Private context data for SGO inteface.\r
  //\r
  Private = NULL;\r
  Private = AllocatePool (sizeof (GOP_PRIVATE_DATA));\r
  if (Private == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
  //\r
  // Set up context record\r
  //\r
  Private->Signature            = GOP_PRIVATE_DATA_SIGNATURE;\r
  Private->Handle               = Handle;\r
  Private->WinNtThunk           = WinNtIo->WinNtThunk;\r
\r
  Private->ControllerNameTable  = NULL;\r
\r
  AddUnicodeString2 (\r
    "eng",\r
    gWinNtGopComponentName.SupportedLanguages,\r
    &Private->ControllerNameTable,\r
    WinNtIo->EnvString,\r
    TRUE\r
    );\r
  AddUnicodeString2 (\r
    "en",\r
    gWinNtGopComponentName2.SupportedLanguages,\r
    &Private->ControllerNameTable,\r
    WinNtIo->EnvString,\r
    FALSE\r
    );\r
\r
\r
  Private->WindowName = WinNtIo->EnvString;\r
\r
  Status              = WinNtGopConstructor (Private);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
  //\r
  // Publish the Gop interface to the world\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Private->Handle,\r
                  &gEfiGraphicsOutputProtocolGuid,\r
                  &Private->GraphicsOutput,\r
                  &gEfiSimpleTextInProtocolGuid,\r
                  &Private->SimpleTextIn,\r
                  &gEfiSimpleTextInputExProtocolGuid,\r
                  &Private->SimpleTextInEx,\r
                  NULL\r
                  );\r
\r
Done:\r
  if (EFI_ERROR (Status)) {\r
\r
    gBS->CloseProtocol (\r
          Handle,\r
          &gEfiWinNtIoProtocolGuid,\r
          This->DriverBindingHandle,\r
          Handle\r
          );\r
\r
    if (Private != NULL) {\r
      //\r
      // On Error Free back private data\r
      //\r
      if (Private->ControllerNameTable != NULL) {\r
        FreeUnicodeStringTable (Private->ControllerNameTable);\r
      }\r
\r
      if (Private->SimpleTextIn.WaitForKey != NULL) {\r
        gBS->CloseEvent (Private->SimpleTextIn.WaitForKey);\r
      }\r
      if (Private->SimpleTextInEx.WaitForKeyEx != NULL) {\r
        gBS->CloseEvent (Private->SimpleTextInEx.WaitForKeyEx);\r
      }\r
      FreeNotifyList (&Private->NotifyList);\r
      FreePool (Private);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
\r
\r
  @return None\r
\r
**/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    Handle - add argument and description to function comment\r
// TODO:    NumberOfChildren - add argument and description to function comment\r
// TODO:    ChildHandleBuffer - add argument and description to function comment\r
// TODO:    EFI_NOT_STARTED - add return value to function comment\r
// TODO:    EFI_DEVICE_ERROR - add return value to function comment\r
EFI_STATUS\r
EFIAPI\r
WinNtGopDriverBindingStop (\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_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
  EFI_STATUS                   Status;\r
  GOP_PRIVATE_DATA             *Private;\r
\r
  Status = gBS->OpenProtocol (\r
                  Handle,\r
                  &gEfiGraphicsOutputProtocolGuid,\r
                  (VOID **) &GraphicsOutput,\r
                  This->DriverBindingHandle,\r
                  Handle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // If the GOP interface does not exist the driver is not started\r
    //\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  //\r
  // Get our private context information\r
  //\r
  Private = GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput);\r
\r
  //\r
  // Remove the SGO interface from the system\r
  //\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  Private->Handle,\r
                  &gEfiGraphicsOutputProtocolGuid,\r
                  &Private->GraphicsOutput,\r
                  &gEfiSimpleTextInProtocolGuid,\r
                  &Private->SimpleTextIn,\r
                  &gEfiSimpleTextInputExProtocolGuid,\r
                  &Private->SimpleTextInEx,\r
                  NULL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Shutdown the hardware\r
    //\r
    Status = WinNtGopDestructor (Private);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    gBS->CloseProtocol (\r
          Handle,\r
          &gEfiWinNtIoProtocolGuid,\r
          This->DriverBindingHandle,\r
          Handle\r
          );\r
\r
    //\r
    // Free our instance data\r
    //\r
    FreeUnicodeStringTable (Private->ControllerNameTable);\r
    Status = gBS->CloseEvent (Private->SimpleTextIn.WaitForKey);\r
    ASSERT_EFI_ERROR (Status);\r
    Status = gBS->CloseEvent (Private->SimpleTextInEx.WaitForKeyEx);\r
    ASSERT_EFI_ERROR (Status);\r
    FreeNotifyList (&Private->NotifyList);\r
\r
    gBS->FreePool (Private);\r
\r
  }\r
\r
  return Status;\r
}\r
\r