[mirror_edk2.git] / EdkNt32Pkg / Dxe / WinNtThunk / Bus / Uga / WinNtUgaScreen.c

/*++\r
\r
Copyright (c) 2006 - 2007, 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
    WinNtUgaScreen.c\r
\r
Abstract:\r
\r
  This file produces the graphics abstration of UGA. It is called by\r
  WinNtUgaDriver.c file which deals with the EFI 1.1 driver model.\r
  This file just does graphics.\r
\r
--*/\r
\r
#include "WinNtUga.h"\r
\r
EFI_WIN_NT_THUNK_PROTOCOL *mWinNt;\r
DWORD                     mTlsIndex         = TLS_OUT_OF_INDEXES;\r
DWORD                     mTlsIndexUseCount = 0;  // lets us know when we can free mTlsIndex.\r
static EFI_EVENT          mUgaScreenExitBootServicesEvent;\r
\r
EFI_STATUS\r
WinNtUgaStartWindow (\r
  IN  UGA_PRIVATE_DATA    *Private,\r
  IN  UINT32              HorizontalResolution,\r
  IN  UINT32              VerticalResolution,\r
  IN  UINT32              ColorDepth,\r
  IN  UINT32              RefreshRate\r
  );\r
\r
STATIC\r
VOID\r
EFIAPI\r
KillNtUgaThread (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
//\r
// UGA Protocol Member Functions\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtUgaGetMode (\r
  EFI_UGA_DRAW_PROTOCOL *This,\r
  UINT32                *HorizontalResolution,\r
  UINT32                *VerticalResolution,\r
  UINT32                *ColorDepth,\r
  UINT32                *RefreshRate\r
  )\r
/*++\r
\r
  Routine Description:\r
    Return the current video mode information.\r
\r
  Arguments:\r
    This                  - Protocol instance pointer.\r
    HorizontalResolution  - Current video horizontal resolution in pixels\r
    VerticalResolution    - Current video Vertical resolution in pixels\r
    ColorDepth            - Current video color depth in bits per pixel\r
    RefreshRate           - Current video refresh rate in Hz.\r
\r
  Returns:\r
    EFI_SUCCESS     - Mode information returned.\r
    EFI_NOT_STARTED - Video display is not initialized. Call SetMode ()\r
    EFI_INVALID_PARAMETER - One of the input args was NULL.\r
\r
--*/\r
// TODO:    ADD IN/OUT description here\r
{\r
  UGA_PRIVATE_DATA  *Private;\r
\r
  Private = UGA_DRAW_PRIVATE_DATA_FROM_THIS (This);\r
\r
  if (Private->HardwareNeedsStarting) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  if ((HorizontalResolution == NULL) ||\r
      (VerticalResolution   == NULL) ||\r
      (ColorDepth           == NULL) ||\r
      (RefreshRate          == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *HorizontalResolution = Private->HorizontalResolution;\r
  *VerticalResolution   = Private->VerticalResolution;\r
  *ColorDepth           = Private->ColorDepth;\r
  *RefreshRate          = Private->RefreshRate;\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtUgaSetMode (\r
  EFI_UGA_DRAW_PROTOCOL *This,\r
  UINT32                HorizontalResolution,\r
  UINT32                VerticalResolution,\r
  UINT32                ColorDepth,\r
  UINT32                RefreshRate\r
  )\r
/*++\r
\r
  Routine Description:\r
    Return the current video mode information.\r
\r
  Arguments:\r
    This                  - Protocol instance pointer.\r
    HorizontalResolution  - Current video horizontal resolution in pixels\r
    VerticalResolution    - Current video Vertical resolution in pixels\r
    ColorDepth            - Current video color depth in bits per pixel\r
    RefreshRate           - Current video refresh rate in Hz.\r
\r
  Returns:\r
    EFI_SUCCESS     - Mode information returned.\r
    EFI_NOT_STARTED - Video display is not initialized. Call SetMode ()\r
    EFI_INVALID_PARAMETER - One of the input args was NULL.\r
\r
--*/\r
// TODO:    EFI_DEVICE_ERROR - add return value to function comment\r
// TODO:    EFI_DEVICE_ERROR - add return value to function comment\r
// TODO:    ADD IN/OUT description here\r
{\r
  EFI_STATUS        Status;\r
  UGA_PRIVATE_DATA  *Private;\r
  EFI_UGA_PIXEL     Fill;\r
  EFI_UGA_PIXEL     *NewFillLine;\r
  RECT              Rect;\r
  UINTN             Size;\r
  UINTN             Width;\r
  UINTN             Height;\r
\r
  Private = UGA_DRAW_PRIVATE_DATA_FROM_THIS (This);\r
\r
  if (Private->HardwareNeedsStarting) {\r
    Status = WinNtUgaStartWindow (\r
              Private,\r
              HorizontalResolution,\r
              VerticalResolution,\r
              ColorDepth,\r
              RefreshRate\r
              );\r
    if (EFI_ERROR (Status)) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    Private->HardwareNeedsStarting = FALSE;\r
  } else {\r
    //\r
    // Change the resolution and resize of the window\r
    //\r
\r
    //\r
    // Free the old buffer. We do not save the content of the old buffer since the\r
    // screen is to be cleared anyway. Clearing the screen is required by the EFI spec.\r
    // See EFI spec chepter 10.5-EFI_UGA_DRAW_PROTOCOL.SetMode()\r
    //\r
    Private->WinNtThunk->HeapFree (Private->WinNtThunk->GetProcessHeap (), 0, Private->VirtualScreenInfo);\r
\r
    //\r
    // Allocate DIB frame buffer directly from NT for performance enhancement\r
    // This buffer is the virtual screen/frame buffer. This buffer is not the\r
    // same a a frame buffer. The first row of this buffer will be the bottom\r
    // line of the image. This is an artifact of the way we draw to the screen.\r
    //\r
    Size = HorizontalResolution * VerticalResolution * sizeof (RGBQUAD) + sizeof (BITMAPV4HEADER);\r
    Private->VirtualScreenInfo = Private->WinNtThunk->HeapAlloc (\r
                                                        Private->WinNtThunk->GetProcessHeap (),\r
                                                        HEAP_ZERO_MEMORY,\r
                                                        Size\r
                                                        );\r
\r
    //\r
    // Update the virtual screen info data structure\r
    //\r
    Private->VirtualScreenInfo->bV4Size           = sizeof (BITMAPV4HEADER);\r
    Private->VirtualScreenInfo->bV4Width          = HorizontalResolution;\r
    Private->VirtualScreenInfo->bV4Height         = VerticalResolution;\r
    Private->VirtualScreenInfo->bV4Planes         = 1;\r
    Private->VirtualScreenInfo->bV4BitCount       = 32;\r
    //\r
    // uncompressed\r
    //\r
    Private->VirtualScreenInfo->bV4V4Compression  = BI_RGB;\r
\r
    //\r
    // The rest of the allocated memory block is the virtual screen buffer\r
    //\r
    Private->VirtualScreen = (RGBQUAD *) (Private->VirtualScreenInfo + 1);\r
\r
    //\r
    // Use the AdjuctWindowRect fuction to calculate the real width and height\r
    // of the new window including the border and caption\r
    //\r
    Rect.left   = 0;\r
    Rect.top    = 0;\r
    Rect.right  = HorizontalResolution;\r
    Rect.bottom = VerticalResolution;\r
\r
    Private->WinNtThunk->AdjustWindowRect (&Rect, WS_OVERLAPPEDWINDOW, 0);\r
\r
    Width   = Rect.right - Rect.left;\r
    Height  = Rect.bottom - Rect.top;\r
\r
    //\r
    // Retrieve the original window position information\r
    //\r
    Private->WinNtThunk->GetWindowRect (Private->WindowHandle, &Rect);\r
\r
    //\r
    // Adjust the window size\r
    //\r
    Private->WinNtThunk->MoveWindow (Private->WindowHandle, Rect.left, Rect.top, Width, Height, TRUE);\r
\r
  }\r
\r
  NewFillLine = AllocatePool (sizeof (EFI_UGA_PIXEL) * HorizontalResolution);\r
  if (NewFillLine == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (Private->FillLine != NULL) {\r
    FreePool (Private->FillLine);\r
  }\r
\r
  Private->FillLine             = NewFillLine;\r
\r
  Private->HorizontalResolution = HorizontalResolution;\r
  Private->VerticalResolution   = VerticalResolution;\r
  Private->ColorDepth           = ColorDepth;\r
  Private->RefreshRate          = RefreshRate;\r
\r
  Fill.Red                      = 0x00;\r
  Fill.Green                    = 0x00;\r
  Fill.Blue                     = 0x00;\r
  This->Blt (\r
          This,\r
          &Fill,\r
          EfiUgaVideoFill,\r
          0,\r
          0,\r
          0,\r
          0,\r
          HorizontalResolution,\r
          VerticalResolution,\r
          HorizontalResolution * sizeof (EFI_UGA_PIXEL)\r
          );\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtUgaBlt (\r
  IN  EFI_UGA_DRAW_PROTOCOL                   *This,\r
  IN  EFI_UGA_PIXEL                           *BltBuffer, OPTIONAL\r
  IN  EFI_UGA_BLT_OPERATION                   BltOperation,\r
  IN  UINTN                                   SourceX,\r
  IN  UINTN                                   SourceY,\r
  IN  UINTN                                   DestinationX,\r
  IN  UINTN                                   DestinationY,\r
  IN  UINTN                                   Width,\r
  IN  UINTN                                   Height,\r
  IN  UINTN                                   Delta         OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
    Blt pixels from the rectangle (Width X Height) formed by the BltBuffer\r
    onto the graphics screen starting a location (X, Y). (0, 0) is defined as\r
    the upper left hand side of the screen. (X, Y) can be outside of the\r
    current screen geometry and the BltBuffer will be cliped when it is\r
    displayed. X and Y can be negative or positive. If Width or Height is\r
    bigger than the current video screen the image will be clipped.\r
\r
  Arguments:\r
    This          - Protocol instance pointer.\r
    X             - X location on graphics screen.\r
    Y             - Y location on the graphics screen.\r
    Width         - Width of BltBuffer.\r
    Height        - Hight of BltBuffer\r
    BltOperation  - Operation to perform on BltBuffer and video memory\r
    BltBuffer     - Buffer containing data to blt into video buffer. This\r
                    buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)\r
    SourceX       - If the BltOperation is a EfiCopyBlt this is the source\r
                    of the copy. For other BLT operations this argument is not\r
                    used.\r
    SourceX       - If the BltOperation is a EfiCopyBlt this is the source\r
                    of the copy. For other BLT operations this argument is not\r
                    used.\r
\r
  Returns:\r
    EFI_SUCCESS           - The palette is updated with PaletteArray.\r
    EFI_INVALID_PARAMETER - BltOperation is not valid.\r
    EFI_DEVICE_ERROR      - A hardware error occured writting to the video\r
                             buffer.\r
\r
--*/\r
// TODO:    SourceY - add argument and description to function comment\r
// TODO:    DestinationX - add argument and description to function comment\r
// TODO:    DestinationY - add argument and description to function comment\r
// TODO:    Delta - add argument and description to function comment\r
{\r
  UGA_PRIVATE_DATA  *Private;\r
  EFI_TPL           OriginalTPL;\r
  UINTN             DstY;\r
  UINTN             SrcY;\r
  RGBQUAD           *VScreen;\r
  RGBQUAD           *VScreenSrc;\r
  EFI_UGA_PIXEL     *Blt;\r
  UINTN             Index;\r
  RECT              Rect;\r
  EFI_UGA_PIXEL     *FillPixel;\r
\r
  Private = UGA_DRAW_PRIVATE_DATA_FROM_THIS (This);\r
\r
  if ((BltOperation < 0) || (BltOperation >= EfiUgaBltMax)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Width == 0 || Height == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  //\r
  // If Delta is zero, then the entire BltBuffer is being used, so Delta\r
  // is the number of bytes in each row of BltBuffer.  Since BltBuffer is Width pixels size,\r
  // the number of bytes in each row can be computed.\r
  //\r
  if (Delta == 0) {\r
    Delta = Width * sizeof (EFI_UGA_PIXEL);\r
  }\r
\r
  //\r
  // We need to fill the Virtual Screen buffer with the blt data.\r
  // The virtual screen is upside down, as the first row is the bootom row of\r
  // the image.\r
  //\r
\r
  if (BltOperation == EfiUgaVideoToBltBuffer) {\r
\r
    //\r
    // Video to BltBuffer: Source is Video, destination is BltBuffer\r
    //\r
    if (SourceY + Height > Private->VerticalResolution) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (SourceX + Width > Private->HorizontalResolution) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    //\r
    // We have to raise to TPL Notify, so we make an atomic write the frame buffer.\r
    // We would not want a timer based event (Cursor, ...) to come in while we are\r
    // doing this operation.\r
    //\r
    OriginalTPL = gBS->RaiseTPL (EFI_TPL_NOTIFY);\r
\r
    for (SrcY = SourceY, DstY = DestinationY; DstY < (Height + DestinationY); SrcY++, DstY++) {\r
      Blt = (EFI_UGA_PIXEL *) ((UINT8 *) BltBuffer + (DstY * Delta) + DestinationX * sizeof (EFI_UGA_PIXEL));\r
      VScreen = &Private->VirtualScreen[(Private->VerticalResolution - SrcY - 1) * Private->HorizontalResolution + SourceX];\r
      CopyMem (Blt, VScreen, sizeof (EFI_UGA_PIXEL) * Width);\r
    }\r
  } else {\r
    //\r
    // BltBuffer to Video: Source is BltBuffer, destination is Video\r
    //\r
    if (DestinationY + Height > Private->VerticalResolution) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (DestinationX + Width > Private->HorizontalResolution) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    //\r
    // We have to raise to TPL Notify, so we make an atomic write the frame buffer.\r
    // We would not want a timer based event (Cursor, ...) to come in while we are\r
    // doing this operation.\r
    //\r
    OriginalTPL = gBS->RaiseTPL (EFI_TPL_NOTIFY);\r
\r
    if (BltOperation == EfiUgaVideoFill) {\r
      FillPixel = BltBuffer;\r
      for (Index = 0; Index < Width; Index++) {\r
        Private->FillLine[Index] = *FillPixel;\r
      }\r
    }\r
\r
    for (Index = 0; Index < Height; Index++) {\r
      if (DestinationY <= SourceY) {\r
        SrcY  = SourceY + Index;\r
        DstY  = DestinationY + Index;\r
      } else {\r
        SrcY  = SourceY + Height - Index - 1;\r
        DstY  = DestinationY + Height - Index - 1;\r
      }\r
\r
      VScreen = &Private->VirtualScreen[(Private->VerticalResolution - DstY - 1) * Private->HorizontalResolution + DestinationX];\r
      switch (BltOperation) {\r
      case EfiUgaBltBufferToVideo:\r
        Blt = (EFI_UGA_PIXEL *) ((UINT8 *) BltBuffer + (SrcY * Delta) + SourceX * sizeof (EFI_UGA_PIXEL));\r
        CopyMem (VScreen, Blt, Width * sizeof (EFI_UGA_PIXEL));\r
        break;\r
\r
      case EfiUgaVideoToVideo:\r
        VScreenSrc = &Private->VirtualScreen[(Private->VerticalResolution - SrcY - 1) * Private->HorizontalResolution + SourceX];\r
        CopyMem (VScreen, VScreenSrc, Width * sizeof (EFI_UGA_PIXEL));\r
        break;\r
\r
      case EfiUgaVideoFill:\r
        CopyMem (VScreen, Private->FillLine, Width * sizeof (EFI_UGA_PIXEL));\r
        break;\r
      }\r
    }\r
  }\r
\r
  if (BltOperation != EfiUgaVideoToBltBuffer) {\r
    //\r
    // Mark the area we just blted as Invalid so WM_PAINT will update.\r
    //\r
    Rect.left   = DestinationX;\r
    Rect.top    = DestinationY;\r
    Rect.right  = DestinationX + Width;\r
    Rect.bottom = DestinationY + Height;\r
    Private->WinNtThunk->InvalidateRect (Private->WindowHandle, &Rect, FALSE);\r
\r
    //\r
    // Send the WM_PAINT message to the thread that is drawing the window. We\r
    // are in the main thread and the window drawing is in a child thread.\r
    // There is a child thread per window. We have no CriticalSection or Mutex\r
    // since we write the data and the other thread displays the data. While\r
    // we may miss some data for a short period of time this is no different than\r
    // a write combining on writes to a frame buffer.\r
    //\r
\r
    Private->WinNtThunk->UpdateWindow (Private->WindowHandle);\r
  }\r
\r
  gBS->RestoreTPL (OriginalTPL);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
//\r
// Construction and Destruction functions\r
//\r
\r
EFI_STATUS\r
WinNtUgaSupported (\r
  IN  EFI_WIN_NT_IO_PROTOCOL  *WinNtIo\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
// TODO:    WinNtIo - add argument and description to function comment\r
// TODO:    EFI_UNSUPPORTED - add return value to function comment\r
// TODO:    EFI_SUCCESS - add return value to function comment\r
{\r
  //\r
  // Check to see if the IO abstraction represents a device type we support.\r
  //\r
  // This would be replaced a check of PCI subsystem ID, etc.\r
  //\r
  if (!CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtUgaGuid)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
LRESULT\r
CALLBACK\r
WinNtUgaThreadWindowProc (\r
  IN  HWND    hwnd,\r
  IN  UINT    iMsg,\r
  IN  WPARAM  wParam,\r
  IN  LPARAM  lParam\r
  )\r
/*++\r
\r
Routine Description:\r
  Win32 Windows event handler.\r
\r
Arguments:\r
  See Win32 Book\r
\r
Returns:\r
  See Win32 Book\r
\r
--*/\r
// TODO:    hwnd - add argument and description to function comment\r
// TODO:    iMsg - add argument and description to function comment\r
// TODO:    wParam - add argument and description to function comment\r
// TODO:    lParam - add argument and description to function comment\r
{\r
  UGA_PRIVATE_DATA  *Private;\r
  UINTN             Size;\r
  HDC               Handle;\r
  PAINTSTRUCT       PaintStruct;\r
  LPARAM            Index;\r
  EFI_INPUT_KEY     Key;\r
\r
  //\r
  // BugBug - if there are two instances of this DLL in memory (such as is\r
  // the case for ERM), the correct instance of this function may not be called.\r
  // This also means that the address of the mTlsIndex value will be wrong, and\r
  // the value may be wrong too.\r
  //\r
\r
\r
  //\r
  // Use mTlsIndex global to get a Thread Local Storage version of Private.\r
  // This works since each Uga protocol has a unique Private data instance and\r
  // a unique thread.\r
  //\r
  Private = mWinNt->TlsGetValue (mTlsIndex);\r
  ASSERT (NULL != Private);\r
\r
  switch (iMsg) {\r
  case WM_CREATE:\r
    Size = Private->HorizontalResolution * Private->VerticalResolution * sizeof (RGBQUAD);\r
\r
    //\r
    // Allocate DIB frame buffer directly from NT for performance enhancement\r
    // This buffer is the virtual screen/frame buffer. This buffer is not the\r
    // same a a frame buffer. The first fow of this buffer will be the bottom\r
    // line of the image. This is an artifact of the way we draw to the screen.\r
    //\r
    Private->VirtualScreenInfo = Private->WinNtThunk->HeapAlloc (\r
                                                        Private->WinNtThunk->GetProcessHeap (),\r
                                                        HEAP_ZERO_MEMORY,\r
                                                        Size\r
                                                        );\r
\r
    Private->VirtualScreenInfo->bV4Size           = sizeof (BITMAPV4HEADER);\r
    Private->VirtualScreenInfo->bV4Width          = Private->HorizontalResolution;\r
    Private->VirtualScreenInfo->bV4Height         = Private->VerticalResolution;\r
    Private->VirtualScreenInfo->bV4Planes         = 1;\r
    Private->VirtualScreenInfo->bV4BitCount       = 32;\r
    //\r
    // uncompressed\r
    //\r
    Private->VirtualScreenInfo->bV4V4Compression  = BI_RGB;\r
    Private->VirtualScreen = (RGBQUAD *) (Private->VirtualScreenInfo + 1);\r
    return 0;\r
\r
  case WM_PAINT:\r
    //\r
    // I have not found a way to convert hwnd into a Private context. So for\r
    // now we use this API to convert hwnd to Private data.\r
    //\r
\r
    Handle = mWinNt->BeginPaint (hwnd, &PaintStruct);\r
\r
    mWinNt->SetDIBitsToDevice (\r
              Handle,                                     // Destination Device Context\r
              0,                                          // Destination X - 0\r
              0,                                          // Destination Y - 0\r
              Private->HorizontalResolution,              // Width\r
              Private->VerticalResolution,                // Height\r
              0,                                          // Source X\r
              0,                                          // Source Y\r
              0,                                          // DIB Start Scan Line\r
              Private->VerticalResolution,                // Number of scan lines\r
              Private->VirtualScreen,                     // Address of array of DIB bits\r
              (BITMAPINFO *) Private->VirtualScreenInfo,  // Address of structure with bitmap info\r
              DIB_RGB_COLORS                              // RGB or palette indexes\r
              );\r
\r
    mWinNt->EndPaint (hwnd, &PaintStruct);\r
    return 0;\r
\r
  //\r
  // F10 and the ALT key do not create a WM_KEYDOWN message, thus this special case\r
  //\r
  case WM_SYSKEYDOWN:\r
    Key.ScanCode = 0;\r
    switch (wParam) {\r
    case VK_F10:\r
      Key.ScanCode    = SCAN_F10;\r
      Key.UnicodeChar = 0;\r
      UgaPrivateAddQ (Private, Key);\r
      return 0;\r
    }\r
    break;\r
\r
  case WM_KEYDOWN:\r
    Key.ScanCode = 0;\r
    switch (wParam) {\r
    case VK_HOME:       Key.ScanCode = SCAN_HOME;       break;\r
    case VK_END:        Key.ScanCode = SCAN_END;        break;\r
    case VK_LEFT:       Key.ScanCode = SCAN_LEFT;       break;\r
    case VK_RIGHT:      Key.ScanCode = SCAN_RIGHT;      break;\r
    case VK_UP:         Key.ScanCode = SCAN_UP;         break;\r
    case VK_DOWN:       Key.ScanCode = SCAN_DOWN;       break;\r
    case VK_DELETE:     Key.ScanCode = SCAN_DELETE;     break;\r
    case VK_INSERT:     Key.ScanCode = SCAN_INSERT;     break;\r
    case VK_PRIOR:      Key.ScanCode = SCAN_PAGE_UP;    break;\r
    case VK_NEXT:       Key.ScanCode = SCAN_PAGE_DOWN;  break;\r
    case VK_ESCAPE:     Key.ScanCode = SCAN_ESC;        break;\r
\r
    case VK_F1:   Key.ScanCode = SCAN_F1;   break;\r
    case VK_F2:   Key.ScanCode = SCAN_F2;   break;\r
    case VK_F3:   Key.ScanCode = SCAN_F3;   break;\r
    case VK_F4:   Key.ScanCode = SCAN_F4;   break;\r
    case VK_F5:   Key.ScanCode = SCAN_F5;   break;\r
    case VK_F6:   Key.ScanCode = SCAN_F6;   break;\r
    case VK_F7:   Key.ScanCode = SCAN_F7;   break;\r
    case VK_F8:   Key.ScanCode = SCAN_F8;   break;\r
    case VK_F9:   Key.ScanCode = SCAN_F9;   break;\r
    case VK_F11:  Key.ScanCode = SCAN_F11;  break;\r
    case VK_F12:  Key.ScanCode = SCAN_F12;  break;\r
    }\r
\r
    if (Key.ScanCode != 0) {\r
      Key.UnicodeChar = 0;\r
      UgaPrivateAddQ (Private, Key);\r
    }\r
\r
    return 0;\r
\r
  case WM_CHAR:\r
    //\r
    // The ESC key also generate WM_CHAR.\r
    //\r
    if (wParam == 0x1B) {\r
      return 0;\r
    }\r
\r
    for (Index = 0; Index < (lParam & 0xffff); Index++) {\r
      if (wParam != 0) {\r
        Key.UnicodeChar = (CHAR16) wParam;\r
        Key.ScanCode    = 0;\r
        UgaPrivateAddQ (Private, Key);\r
      }\r
    }\r
\r
    return 0;\r
\r
  case WM_CLOSE:\r
    //\r
    // This close message is issued by user, core is not aware of this,\r
    // so don't release the window display resource, just hide the window.\r
    //\r
    Private->WinNtThunk->ShowWindow (Private->WindowHandle, SW_HIDE);\r
    return 0;\r
\r
  case WM_DESTROY:\r
    mWinNt->DestroyWindow (hwnd);\r
    mWinNt->PostQuitMessage (0);\r
\r
    mWinNt->HeapFree (Private->WinNtThunk->GetProcessHeap (), 0, Private->VirtualScreenInfo);\r
\r
    mWinNt->ExitThread (0);\r
    return 0;\r
\r
  default:\r
    break;\r
  };\r
\r
  return mWinNt->DefWindowProc (hwnd, iMsg, wParam, lParam);\r
}\r
\r
DWORD\r
WINAPI\r
WinNtUgaThreadWinMain (\r
  LPVOID    lpParameter\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This thread simulates the end of WinMain () aplication. Each Winow nededs\r
  to process it's events. The messages are dispatched to\r
  WinNtUgaThreadWindowProc ().\r
\r
  Be very careful sine WinNtUgaThreadWinMain () and WinNtUgaThreadWindowProc ()\r
  are running in a seperate thread. We have to do this to process the events.\r
\r
Arguments:\r
\r
  lpParameter - Handle of window to manage.\r
\r
Returns:\r
\r
  if a WM_QUIT message is returned exit.\r
\r
--*/\r
{\r
  MSG               Message;\r
  UGA_PRIVATE_DATA  *Private;\r
  ATOM              Atom;\r
  RECT              Rect;\r
\r
  Private = (UGA_PRIVATE_DATA *) lpParameter;\r
  ASSERT (NULL != Private);\r
\r
  //\r
  // Since each thread has unique private data, save the private data in Thread\r
  // Local Storage slot. Then the shared global mTlsIndex can be used to get\r
  // thread specific context.\r
  //\r
  Private->WinNtThunk->TlsSetValue (mTlsIndex, Private);\r
\r
  Private->ThreadId                   = Private->WinNtThunk->GetCurrentThreadId ();\r
\r
  Private->WindowsClass.cbSize        = sizeof (WNDCLASSEX);\r
  Private->WindowsClass.style         = CS_HREDRAW | CS_VREDRAW | CS_OWNDC;\r
  Private->WindowsClass.lpfnWndProc   = WinNtUgaThreadWindowProc;\r
  Private->WindowsClass.cbClsExtra    = 0;\r
  Private->WindowsClass.cbWndExtra    = 0;\r
  Private->WindowsClass.hInstance     = NULL;\r
  Private->WindowsClass.hIcon         = Private->WinNtThunk->LoadIcon (NULL, IDI_APPLICATION);\r
  Private->WindowsClass.hCursor       = Private->WinNtThunk->LoadCursor (NULL, IDC_ARROW);\r
  Private->WindowsClass.hbrBackground = (HBRUSH) COLOR_WINDOW;\r
  Private->WindowsClass.lpszMenuName  = NULL;\r
  Private->WindowsClass.lpszClassName = WIN_NT_UGA_CLASS_NAME;\r
  Private->WindowsClass.hIconSm       = Private->WinNtThunk->LoadIcon (NULL, IDI_APPLICATION);\r
\r
  //\r
  // This call will fail after the first time, but thats O.K. since we only need\r
  // WIN_NT_UGA_CLASS_NAME to exist to create the window.\r
  //\r
  // Note: Multiple instances of this DLL will use the same instance of this\r
  // Class, including the callback function, unless the Class is unregistered and\r
  // successfully registered again.\r
  //\r
  Atom = Private->WinNtThunk->RegisterClassEx (&Private->WindowsClass);\r
\r
  //\r
  // Setting Rect values to allow for the AdjustWindowRect to provide\r
  // us the correct sizes for the client area when doing the CreateWindowEx\r
  //\r
  Rect.top    = 0;\r
  Rect.bottom = Private->VerticalResolution;\r
  Rect.left   = 0;\r
  Rect.right  = Private->HorizontalResolution;\r
\r
  Private->WinNtThunk->AdjustWindowRect (&Rect, WS_OVERLAPPEDWINDOW, 0);\r
\r
  Private->WindowHandle = Private->WinNtThunk->CreateWindowEx (\r
                                                0,\r
                                                WIN_NT_UGA_CLASS_NAME,\r
                                                Private->WindowName,\r
                                                WS_OVERLAPPEDWINDOW,\r
                                                CW_USEDEFAULT,\r
                                                CW_USEDEFAULT,\r
                                                Rect.right - Rect.left,\r
                                                Rect.bottom - Rect.top,\r
                                                NULL,\r
                                                NULL,\r
                                                NULL,\r
                                                &Private\r
                                                );\r
\r
  //\r
  // The reset of this thread is the standard winows program. We need a sperate\r
  // thread since we must process the message loop to make windows act like\r
  // windows.\r
  //\r
\r
  Private->WinNtThunk->ShowWindow (Private->WindowHandle, SW_SHOW);\r
  Private->WinNtThunk->UpdateWindow (Private->WindowHandle);\r
\r
  //\r
  // Let the main thread get some work done\r
  //\r
  Private->WinNtThunk->ReleaseSemaphore (Private->ThreadInited, 1, NULL);\r
\r
  //\r
  // This is the message loop that all Windows programs need.\r
  //\r
  while (Private->WinNtThunk->GetMessage (&Message, Private->WindowHandle, 0, 0)) {\r
    Private->WinNtThunk->TranslateMessage (&Message);\r
    Private->WinNtThunk->DispatchMessage (&Message);\r
  }\r
\r
  return Message.wParam;\r
}\r
\r
EFI_STATUS\r
WinNtUgaStartWindow (\r
  IN  UGA_PRIVATE_DATA    *Private,\r
  IN  UINT32              HorizontalResolution,\r
  IN  UINT32              VerticalResolution,\r
  IN  UINT32              ColorDepth,\r
  IN  UINT32              RefreshRate\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  Private               - TODO: add argument description\r
  HorizontalResolution  - TODO: add argument description\r
  VerticalResolution    - TODO: add argument description\r
  ColorDepth            - TODO: add argument description\r
  RefreshRate           - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
{\r
  EFI_STATUS          Status;\r
  DWORD               NewThreadId;\r
\r
\r
  mWinNt  = Private->WinNtThunk;\r
\r
  //\r
  // Initialize a Thread Local Storge variable slot. We use TLS to get the\r
  // correct Private data instance into the windows thread.\r
  //\r
  if (mTlsIndex == TLS_OUT_OF_INDEXES) {\r
    ASSERT (0 == mTlsIndexUseCount);\r
    mTlsIndex = Private->WinNtThunk->TlsAlloc ();\r
  }\r
\r
  //\r
  // always increase the use count!\r
  //\r
  mTlsIndexUseCount++;\r
\r
  Private->HorizontalResolution = HorizontalResolution;\r
  Private->VerticalResolution   = VerticalResolution;\r
\r
  //\r
  // Register to be notified on exit boot services so we can destroy the window.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_SIGNAL_EXIT_BOOT_SERVICES,\r
                  EFI_TPL_CALLBACK,\r
                  KillNtUgaThread,\r
                  Private,\r
                  &mUgaScreenExitBootServicesEvent\r
                  );\r
\r
  Private->ThreadInited = Private->WinNtThunk->CreateSemaphore (NULL, 0, 1, NULL);\r
  Private->ThreadHandle = Private->WinNtThunk->CreateThread (\r
                                                NULL,\r
                                                0,\r
                                                WinNtUgaThreadWinMain,\r
                                                (VOID *) Private,\r
                                                0,\r
                                                &NewThreadId\r
                                                );\r
\r
  //\r
  // The other thread has entered the windows message loop so we can\r
  // continue our initialization.\r
  //\r
  Private->WinNtThunk->WaitForSingleObject (Private->ThreadInited, INFINITE);\r
  Private->WinNtThunk->CloseHandle (Private->ThreadInited);\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
WinNtUgaConstructor (\r
  UGA_PRIVATE_DATA    *Private\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
// TODO:    Private - add argument and description to function comment\r
// TODO:    EFI_SUCCESS - add return value to function comment\r
{\r
\r
  Private->UgaDraw.GetMode        = WinNtUgaGetMode;\r
  Private->UgaDraw.SetMode        = WinNtUgaSetMode;\r
  Private->UgaDraw.Blt            = WinNtUgaBlt;\r
\r
  Private->HardwareNeedsStarting  = TRUE;\r
  Private->FillLine               = NULL;\r
\r
  WinNtUgaInitializeSimpleTextInForWindow (Private);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
WinNtUgaDestructor (\r
  UGA_PRIVATE_DATA     *Private\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
// TODO:    Private - add argument and description to function comment\r
// TODO:    EFI_SUCCESS - add return value to function comment\r
{\r
  UINT32  UnregisterReturn;\r
\r
  if (!Private->HardwareNeedsStarting) {\r
    //\r
    // BugBug: Shutdown Uga Hardware and any child devices.\r
    //\r
    Private->WinNtThunk->SendMessage (Private->WindowHandle, WM_DESTROY, 0, 0);\r
    Private->WinNtThunk->CloseHandle (Private->ThreadHandle);\r
\r
    mTlsIndexUseCount--;\r
\r
    //\r
    // The callback function for another window could still be called,\r
    // so we need to make sure there are no more users of mTlsIndex.\r
    //\r
    if (0 == mTlsIndexUseCount) {\r
      ASSERT (TLS_OUT_OF_INDEXES != mTlsIndex);\r
\r
      Private->WinNtThunk->TlsFree (mTlsIndex);\r
      mTlsIndex = TLS_OUT_OF_INDEXES;\r
\r
      UnregisterReturn = Private->WinNtThunk->UnregisterClass (\r
                                                Private->WindowsClass.lpszClassName,\r
                                                Private->WindowsClass.hInstance\r
                                                );\r
    }\r
\r
    WinNtUgaDestroySimpleTextInForWindow (Private);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
VOID\r
EFIAPI\r
KillNtUgaThread (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This is the UGA screen's callback notification function for exit-boot-services.\r
  All we do here is call WinNtUgaDestructor().\r
\r
Arguments:\r
\r
  Event   - not used\r
  Context - pointer to the Private structure.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  Status = WinNtUgaDestructor (Context);\r
}\r