OvmfPkg/PlatformBootManagerLib: Use a Xen console for ConOut/ConIn

On a Xen PVH guest, none of the existing serial or console interface
works, so we add a new one, based on XenConsoleSerialPortLib, and
implemented via SerialDxe.

That is a simple console implementation that can work on both PVH
guest and HVM guests, even if it is rarely going to be used on HVM.

Have PlatformBootManagerLib look for the new console, when running as a
Xen guest.

Since we use VENDOR_UART_DEVICE_PATH, fix its description and coding
style.

Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1689
Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Message-Id: <20190813113119.14804-32-anthony.perard@citrix.com>

6 files changed, 58 insertions, 4 deletions

diff --git a/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.c b/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.c
index 1eba304f09..70df6b841a 100644
--- a/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.c
+++ b/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.c
@@ -398,7 +398,8 @@ PlatformBootManagerBeforeConsole (
   //

   EfiBootManagerDispatchDeferredImages ();

 

-  PlatformInitializeConsole (gPlatformConsole);

+  PlatformInitializeConsole (

+    XenDetected() ? gXenPlatformConsole : gPlatformConsole);

   PcdStatus = PcdSet16S (PcdPlatformBootTimeOut,

                 GetFrontPageTimeoutFromQemu ());

   ASSERT_RETURN_ERROR (PcdStatus);

diff --git a/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h b/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h
index 49a072b400..153e215101 100644
--- a/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h
+++ b/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h
@@ -165,6 +165,7 @@ typedef struct {
 #define CONSOLE_IN  BIT1

 #define STD_ERROR   BIT2

 extern PLATFORM_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];

+extern PLATFORM_CONSOLE_CONNECT_ENTRY  gXenPlatformConsole[];

 

 //

 // Platform BDS Functions

diff --git a/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf b/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
index 04d614cd49..f89cce1879 100644
--- a/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
+++ b/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
@@ -61,6 +61,10 @@
   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashVariablesEnable

   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfHostBridgePciDevId

   gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut

+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate         ## CONSUMES

+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits         ## CONSUMES

+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity           ## CONSUMES

+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits         ## CONSUMES

 

 [Pcd.IA32, Pcd.X64]

   gEfiMdePkgTokenSpaceGuid.PcdFSBClock

diff --git a/OvmfPkg/Library/PlatformBootManagerLib/PlatformData.c b/OvmfPkg/Library/PlatformBootManagerLib/PlatformData.c
index 36aab784d7..2858c3dfd5 100644
--- a/OvmfPkg/Library/PlatformBootManagerLib/PlatformData.c
+++ b/OvmfPkg/Library/PlatformBootManagerLib/PlatformData.c
@@ -9,18 +9,19 @@
 

 #include "BdsPlatform.h"

 #include <Guid/QemuRamfb.h>

+#include <Guid/SerialPortLibVendor.h>

 

 //

-// Debug Agent UART Device Path structure

+// Vendor UART Device Path structure

 //

-#pragma pack(1)

+#pragma pack (1)

 typedef struct {

   VENDOR_DEVICE_PATH        VendorHardware;

   UART_DEVICE_PATH          Uart;

   VENDOR_DEVICE_PATH        TerminalType;

   EFI_DEVICE_PATH_PROTOCOL  End;

 } VENDOR_UART_DEVICE_PATH;

-#pragma pack()

+#pragma pack ()

 

 //

 // USB Keyboard Device Path structure

@@ -141,6 +142,37 @@ STATIC VENDOR_RAMFB_DEVICE_PATH gQemuRamfbDevicePath = {
   gEndEntire

 };

 

+STATIC VENDOR_UART_DEVICE_PATH gXenConsoleDevicePath = {

+  {

+    {

+      HARDWARE_DEVICE_PATH,

+      HW_VENDOR_DP,

+      {

+        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),

+        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)

+      }

+    },

+    EDKII_SERIAL_PORT_LIB_VENDOR_GUID

+  },

+  {

+    {

+      MESSAGING_DEVICE_PATH,

+      MSG_UART_DP,

+      {

+        (UINT8) (sizeof (UART_DEVICE_PATH)),

+        (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8)

+      }

+    },

+    0,

+    FixedPcdGet64 (PcdUartDefaultBaudRate),

+    FixedPcdGet8 (PcdUartDefaultDataBits),

+    FixedPcdGet8 (PcdUartDefaultParity),

+    FixedPcdGet8 (PcdUartDefaultStopBits),

+  },

+  gPcAnsiTerminal,

+  gEndEntire

+};

+

 //

 // Predefined platform default console device path

 //

@@ -163,6 +195,17 @@ PLATFORM_CONSOLE_CONNECT_ENTRY   gPlatformConsole[] = {
   }

 };

 

+PLATFORM_CONSOLE_CONNECT_ENTRY   gXenPlatformConsole[] = {

+  {

+    (EFI_DEVICE_PATH_PROTOCOL *)&gXenConsoleDevicePath,

+    (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)

+  },

+  {

+    NULL,

+    0

+  }

+};

+

 //

 // Predefined platform connect sequence

 //

diff --git a/OvmfPkg/OvmfXen.dsc b/OvmfPkg/OvmfXen.dsc
index 54ac910d8e..e719a168f8 100644
--- a/OvmfPkg/OvmfXen.dsc
+++ b/OvmfPkg/OvmfXen.dsc
@@ -586,6 +586,10 @@
   OvmfPkg/XenIoPciDxe/XenIoPciDxe.inf

   OvmfPkg/XenBusDxe/XenBusDxe.inf

   OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.inf

+  MdeModulePkg/Universal/SerialDxe/SerialDxe.inf {

+    <LibraryClasses>

+      SerialPortLib|OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.inf

+  }

   MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf

   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf

   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf

diff --git a/OvmfPkg/OvmfXen.fdf b/OvmfPkg/OvmfXen.fdf
index fa0830a324..5c1a925d6a 100644
--- a/OvmfPkg/OvmfXen.fdf
+++ b/OvmfPkg/OvmfXen.fdf
@@ -312,6 +312,7 @@ INF  PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcatRealTimeClockRuntimeDxe.inf
 INF  OvmfPkg/XenIoPciDxe/XenIoPciDxe.inf

 INF  OvmfPkg/XenBusDxe/XenBusDxe.inf

 INF  OvmfPkg/XenPvBlkDxe/XenPvBlkDxe.inf

+INF  MdeModulePkg/Universal/SerialDxe/SerialDxe.inf

 

 INF  MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf

 INF  MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf