[FREELDR:XBOX/UEFI] Unify the XBOX and UEFI linear framebuffer support together (reactos#8509)

CORE-11954, CORE-16216

Here only moving and adjusting existing code has been done.
In the future, this code will be expanded to support other bits-per-pixel
formats and pixel bitmasks, available in UEFI platforms, and be used to
handle bios-based PC VESA framebuffer.

Author: HBelusca

boot/freeldr/freeldr/arch/i386/xbox/machxbox.c

@@ -24,14 +24,13 @@ DBG_DEFAULT_CHANNEL(HWDETECT);
 
 #define MAX_XBOX_COM_PORTS    2
 
-extern PVOID FrameBuffer;
+extern ULONG_PTR FrameBuffer;
 extern ULONG FrameBufferSize;
 
 BOOLEAN
 XboxFindPciBios(PPCI_REGISTRY_INFO BusData)
 {
     /* We emulate PCI BIOS here, there are 2 known working PCI buses on an original Xbox */
-
     BusData->NoBuses = 2;
     BusData->MajorRevision = 1;
     BusData->MinorRevision = 0;
@@ -181,7 +180,7 @@ DetectDisplayController(PCONFIGURATION_COMPONENT_DATA BusKey)
     PartialDescriptor->Type = CmResourceTypeMemory;
     PartialDescriptor->ShareDisposition = CmResourceShareDeviceExclusive;
     PartialDescriptor->Flags = CM_RESOURCE_MEMORY_READ_WRITE;
-    PartialDescriptor->u.Memory.Start.LowPart = (ULONG_PTR)FrameBuffer & 0x0FFFFFFF;
+    PartialDescriptor->u.Memory.Start.LowPart = (FrameBuffer & 0x0FFFFFFF);
     PartialDescriptor->u.Memory.Length = FrameBufferSize;
 
     FldrCreateComponentKey(BusKey,

boot/freeldr/freeldr/arch/i386/xbox/xboxmem.c

@@ -20,15 +20,15 @@
  */
 
 #include <freeldr.h>
-#include <debug.h>
 
+#include <debug.h>
 DBG_DEFAULT_CHANNEL(MEMORY);
 
 static ULONG InstalledMemoryMb = 0;
 static ULONG AvailableMemoryMb = 0;
 extern multiboot_info_t * MultibootInfoPtr;
 extern ULONG NvBase;
-extern PVOID FrameBuffer;
+extern ULONG_PTR FrameBuffer;
 extern ULONG FrameBufferSize;
 
 #define TEST_SIZE     0x200
@@ -267,7 +267,7 @@ XboxMemGetMemoryMap(ULONG *MemoryMapSize)
         {
             /* Video memory */
             ReserveMemory(XboxMemoryMap,
-                          (ULONG_PTR)FrameBuffer,
+                          FrameBuffer,
                           FrameBufferSize,
                           LoaderFirmwarePermanent,
                           "Video memory");

boot/freeldr/freeldr/arch/i386/xbox/xboxvideo.c

@@ -20,148 +20,58 @@
  */
 
 #include <freeldr.h>
-#include "../../vgafont.h"
+#include "../../vidfb.h"
 
 #include <debug.h>
 DBG_DEFAULT_CHANNEL(UI);
 
 ULONG NvBase = 0xFD000000;
-PVOID FrameBuffer;
+ULONG_PTR FrameBuffer;
 ULONG FrameBufferSize;
-static ULONG ScreenWidth;
-static ULONG ScreenHeight;
-static ULONG BytesPerPixel;
-static ULONG Delta;
 extern multiboot_info_t * MultibootInfoPtr;
+#define FB_SIZE_MB 4
 
 UCHAR MachDefaultTextColor = COLOR_GRAY;
 
-#define TOP_BOTTOM_LINES 0
-
-#define FB_SIZE_MB 4
-
 #define MAKE_COLOR(Red, Green, Blue) (0xff000000 | (((Red) & 0xff) << 16) | (((Green) & 0xff) << 8) | ((Blue) & 0xff))
 
-static VOID
-XboxVideoOutputChar(UCHAR Char, unsigned X, unsigned Y, ULONG FgColor, ULONG BgColor)
-{
-  const UCHAR* FontPtr;
-  PULONG Pixel;
-  UCHAR Mask;
-  unsigned Line;
-  unsigned Col;
-
-  FontPtr = BitmapFont8x16 + Char * CHAR_HEIGHT;
-  Pixel = (PULONG) ((char *) FrameBuffer + (Y * CHAR_HEIGHT + TOP_BOTTOM_LINES) * Delta
-                  + X * CHAR_WIDTH * BytesPerPixel);
-  for (Line = 0; Line < CHAR_HEIGHT; Line++)
-    {
-      Mask = 0x80;
-      for (Col = 0; Col < CHAR_WIDTH; Col++)
-        {
-          Pixel[Col] = (0 != (FontPtr[Line] & Mask) ? FgColor : BgColor);
-          Mask = Mask >> 1;
-        }
-      Pixel = (PULONG) ((char *) Pixel + Delta);
-    }
-}
-
-static ULONG
-XboxVideoAttrToSingleColor(UCHAR Attr)
-{
-  UCHAR Intensity;
-
-  Intensity = (0 == (Attr & 0x08) ? 127 : 255);
-
-  return 0xff000000 |
-         (0 == (Attr & 0x04) ? 0 : (Intensity << 16)) |
-         (0 == (Attr & 0x02) ? 0 : (Intensity << 8)) |
-         (0 == (Attr & 0x01) ? 0 : Intensity);
-}
-
-static VOID
-XboxVideoAttrToColors(UCHAR Attr, ULONG *FgColor, ULONG *BgColor)
-{
-  *FgColor = XboxVideoAttrToSingleColor(Attr & 0xf);
-  *BgColor = XboxVideoAttrToSingleColor((Attr >> 4) & 0xf);
-}
-
-static VOID
-XboxVideoClearScreenColor(ULONG Color, BOOLEAN FullScreen)
-{
-  ULONG Line, Col;
-  PULONG p;
-
-  for (Line = 0; Line < ScreenHeight - (FullScreen ? 0 : 2 * TOP_BOTTOM_LINES); Line++)
-    {
-      p = (PULONG) ((char *) FrameBuffer + (Line + (FullScreen ? 0 : TOP_BOTTOM_LINES)) * Delta);
-      for (Col = 0; Col < ScreenWidth; Col++)
-        {
-          *p++ = Color;
-        }
-    }
-}
-
 VOID
 XboxVideoScrollUp(VOID)
 {
-    ULONG BgColor, Dummy;
-    ULONG PixelCount = ScreenWidth * CHAR_HEIGHT *
-                       (((ScreenHeight - 2 * TOP_BOTTOM_LINES) / CHAR_HEIGHT) - 1);
-    PULONG Src = (PULONG)((PUCHAR)FrameBuffer + (CHAR_HEIGHT + TOP_BOTTOM_LINES) * Delta);
-    PULONG Dst = (PULONG)((PUCHAR)FrameBuffer + TOP_BOTTOM_LINES * Delta);
-
-    XboxVideoAttrToColors(ATTR(COLOR_WHITE, COLOR_BLACK), &Dummy, &BgColor);
-
-    while (PixelCount--)
-        *Dst++ = *Src++;
-
-    for (PixelCount = 0; PixelCount < ScreenWidth * CHAR_HEIGHT; PixelCount++)
-        *Dst++ = BgColor;
+    VidFbScrollUp();
 }
 
 VOID
 XboxVideoClearScreen(UCHAR Attr)
 {
-  ULONG FgColor, BgColor;
-
-  XboxVideoAttrToColors(Attr, &FgColor, &BgColor);
-
-  XboxVideoClearScreenColor(BgColor, FALSE);
+    VidFbClearScreen(Attr);
 }
 
 VOID
 XboxVideoPutChar(int Ch, UCHAR Attr, unsigned X, unsigned Y)
 {
-  ULONG FgColor, BgColor;
-
-  XboxVideoAttrToColors(Attr, &FgColor, &BgColor);
-
-  XboxVideoOutputChar(Ch, X, Y, FgColor, BgColor);
+    VidFbPutChar(Ch, Attr, X, Y);
 }
 
-UCHAR
+static UCHAR
 NvGetCrtc(UCHAR Index)
 {
     WRITE_REGISTER_UCHAR(NvBase + NV2A_CRTC_REGISTER_INDEX, Index);
     return READ_REGISTER_UCHAR(NvBase + NV2A_CRTC_REGISTER_VALUE);
 }
 
-ULONG
-XboxGetFramebufferSize(PVOID Offset)
+static ULONG
+XboxGetFramebufferSize(
+    _In_ ULONG_PTR Offset)
 {
     memory_map_t * MemoryMap;
     INT Count, i;
 
     if (!MultibootInfoPtr)
-    {
         return 0;
-    }
 
     if (!(MultibootInfoPtr->flags & MB_INFO_FLAG_MEMORY_MAP))
-    {
         return 0;
-    }
 
     MemoryMap = (memory_map_t *)MultibootInfoPtr->mmap_addr;
 
@@ -180,7 +90,7 @@ XboxGetFramebufferSize(PVOID Offset)
         /* Framebuffer address offset value is coming from the GPU within
          * memory mapped I/O address space, so we're comparing only low
          * 28 bits of the address within actual RAM address space */
-        if (MemoryMap->base_addr_low == ((ULONG)Offset & 0x0FFFFFFF) && MemoryMap->base_addr_high == 0)
+        if (MemoryMap->base_addr_low == (Offset & 0x0FFFFFFF) && MemoryMap->base_addr_high == 0)
         {
             TRACE("Video memory found\n");
             return MemoryMap->length_low;
@@ -193,62 +103,67 @@ XboxGetFramebufferSize(PVOID Offset)
 VOID
 XboxVideoInit(VOID)
 {
-  /* Reuse framebuffer that was set up by firmware */
-  FrameBuffer = (PVOID)READ_REGISTER_ULONG(NvBase + NV2A_CRTC_FRAMEBUFFER_START);
-  /* Verify that framebuffer address is page-aligned */
-  ASSERT((ULONG_PTR)FrameBuffer % PAGE_SIZE == 0);
-
-  /* Obtain framebuffer memory size from multiboot memory map */
-  if ((FrameBufferSize = XboxGetFramebufferSize(FrameBuffer)) == 0)
-  {
-    /* Fallback to Cromwell standard which reserves high 4 MB of RAM */
-    FrameBufferSize = 4 * 1024 * 1024;
-    WARN("Could not detect framebuffer memory size, fallback to 4 MB\n");
-  }
-
-  ScreenWidth = READ_REGISTER_ULONG(NvBase + NV2A_RAMDAC_FP_HVALID_END) + 1;
-  ScreenHeight = READ_REGISTER_ULONG(NvBase + NV2A_RAMDAC_FP_VVALID_END) + 1;
-  /* Get BPP directly from NV2A CRTC (magic constants are from Cromwell) */
-  BytesPerPixel = 8 * (((NvGetCrtc(0x19) & 0xE0) << 3) | (NvGetCrtc(0x13) & 0xFF)) / ScreenWidth;
-  if (BytesPerPixel == 4)
-  {
-    ASSERT((NvGetCrtc(0x28) & 0xF) == BytesPerPixel - 1);
-  }
-  else
-  {
-    ASSERT((NvGetCrtc(0x28) & 0xF) == BytesPerPixel);
-  }
-  Delta = (ScreenWidth * BytesPerPixel + 3) & ~ 0x3;
-
-  /* Verify screen resolution */
-  ASSERT(ScreenWidth > 1);
-  ASSERT(ScreenHeight > 1);
-  ASSERT(BytesPerPixel >= 1 && BytesPerPixel <= 4);
-  /* Verify that screen fits framebuffer size */
-  ASSERT(ScreenWidth * ScreenHeight * BytesPerPixel <= FrameBufferSize);
-
-  XboxVideoClearScreenColor(MAKE_COLOR(0, 0, 0), TRUE);
+    ULONG ScreenWidth;
+    ULONG ScreenHeight;
+    ULONG BytesPerPixel;
+
+    /* Reuse framebuffer that was set up by firmware */
+    FrameBuffer = (ULONG_PTR)READ_REGISTER_ULONG(NvBase + NV2A_CRTC_FRAMEBUFFER_START);
+    /* Verify that framebuffer address is page-aligned */
+    ASSERT(FrameBuffer % PAGE_SIZE == 0);
+
+    /* Obtain framebuffer memory size from multiboot memory map */
+    if ((FrameBufferSize = XboxGetFramebufferSize(FrameBuffer)) == 0)
+    {
+        /* Fallback to Cromwell standard which reserves high 4 MB of RAM */
+        FrameBufferSize = 4 * 1024 * 1024;
+        WARN("Could not detect framebuffer memory size, fallback to 4 MB\n");
+    }
+
+    ScreenWidth = READ_REGISTER_ULONG(NvBase + NV2A_RAMDAC_FP_HVALID_END) + 1;
+    ScreenHeight = READ_REGISTER_ULONG(NvBase + NV2A_RAMDAC_FP_VVALID_END) + 1;
+
+    /* Get BPP directly from NV2A CRTC (magic constants are from Cromwell) */
+    BytesPerPixel = 8 * (((NvGetCrtc(0x19) & 0xE0) << 3) | (NvGetCrtc(0x13) & 0xFF)) / ScreenWidth;
+    if (BytesPerPixel == 4)
+        ASSERT((NvGetCrtc(0x28) & 0xF) == BytesPerPixel - 1);
+    else
+        ASSERT((NvGetCrtc(0x28) & 0xF) == BytesPerPixel);
+
+    /* Verify screen resolution */
+    ASSERT(ScreenWidth > 1);
+    ASSERT(ScreenHeight > 1);
+    ASSERT(BytesPerPixel >= 1 && BytesPerPixel <= 4);
+    /* Verify that screen fits framebuffer size */
+    ASSERT(ScreenWidth * ScreenHeight * BytesPerPixel <= FrameBufferSize);
+
+    VidFbInitializeVideo(FrameBuffer,
+                         FrameBufferSize,
+                         ScreenWidth,
+                         ScreenHeight,
+                         ScreenWidth, // PixelsPerScanLine
+                         BytesPerPixel * 8);
+
+    VidFbClearScreenColor(MAKE_COLOR(0, 0, 0), TRUE);
 }
 
 VIDEODISPLAYMODE
 XboxVideoSetDisplayMode(PCSTR DisplayMode, BOOLEAN Init)
 {
-  /* We only have one mode, semi-text */
-  return VideoTextMode;
+    /* We only have one mode, semi-text */
+    return VideoTextMode;
 }
 
 VOID
 XboxVideoGetDisplaySize(PULONG Width, PULONG Height, PULONG Depth)
 {
-  *Width = ScreenWidth / CHAR_WIDTH;
-  *Height = (ScreenHeight - 2 * TOP_BOTTOM_LINES) / CHAR_HEIGHT;
-  *Depth = 0;
+    VidFbGetDisplaySize(Width, Height, Depth);
 }
 
 ULONG
 XboxVideoGetBufferSize(VOID)
 {
-  return (ScreenHeight - 2 * TOP_BOTTOM_LINES) / CHAR_HEIGHT * (ScreenWidth / CHAR_WIDTH) * 2;
+    return VidFbGetBufferSize();
 }
 
 VOID
@@ -260,47 +175,37 @@ XboxVideoGetFontsFromFirmware(PULONG RomFontPointers)
 VOID
 XboxVideoSetTextCursorPosition(UCHAR X, UCHAR Y)
 {
-  /* We don't have a cursor yet */
+    /* We don't have a cursor yet */
 }
 
 VOID
 XboxVideoHideShowTextCursor(BOOLEAN Show)
 {
-  /* We don't have a cursor yet */
+    /* We don't have a cursor yet */
 }
 
 VOID
 XboxVideoCopyOffScreenBufferToVRAM(PVOID Buffer)
 {
-  PUCHAR OffScreenBuffer = (PUCHAR) Buffer;
-  ULONG Col, Line;
-
-  for (Line = 0; Line < (ScreenHeight - 2 * TOP_BOTTOM_LINES) / CHAR_HEIGHT; Line++)
-    {
-      for (Col = 0; Col < ScreenWidth / CHAR_WIDTH; Col++)
-        {
-          XboxVideoPutChar(OffScreenBuffer[0], OffScreenBuffer[1], Col, Line);
-          OffScreenBuffer += 2;
-        }
-    }
+    VidFbCopyOffScreenBufferToVRAM(Buffer);
 }
 
 BOOLEAN
 XboxVideoIsPaletteFixed(VOID)
 {
-  return FALSE;
+    return FALSE;
 }
 
 VOID
 XboxVideoSetPaletteColor(UCHAR Color, UCHAR Red, UCHAR Green, UCHAR Blue)
 {
-  /* Not supported */
+    /* Not supported */
 }
 
 VOID
 XboxVideoGetPaletteColor(UCHAR Color, UCHAR* Red, UCHAR* Green, UCHAR* Blue)
 {
-  /* Not supported */
+    /* Not supported */
 }
 
 VOID
@@ -312,7 +217,7 @@ XboxVideoSync(VOID)
 VOID
 XboxVideoPrepareForReactOS(VOID)
 {
-    XboxVideoClearScreenColor(MAKE_COLOR(0, 0, 0), TRUE);
+    VidFbClearScreenColor(MAKE_COLOR(0, 0, 0), TRUE);
     XboxVideoHideShowTextCursor(FALSE);
 }