UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / UefiPayloadPkg / Library / PlatformBootManagerLib / PlatformConsole.c

/** @file\r
This file include all platform action which can be customized by IBV/OEM.\r
\r
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PlatformBootManager.h"\r
#include "PlatformConsole.h"\r
#include <Guid/SerialPortLibVendor.h>\r
\r
#define PCI_DEVICE_PATH_NODE(Func, Dev) \\r
  { \\r
    { \\r
      HARDWARE_DEVICE_PATH, \\r
      HW_PCI_DP, \\r
      { \\r
        (UINT8) (sizeof (PCI_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) \\r
      } \\r
    }, \\r
    (Func), \\r
    (Dev) \\r
  }\r
\r
#define PNPID_DEVICE_PATH_NODE(PnpId) \\r
  { \\r
    { \\r
      ACPI_DEVICE_PATH, \\r
      ACPI_DP, \\r
      { \\r
        (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \\r
      }, \\r
    }, \\r
    EISA_PNP_ID((PnpId)), \\r
    0 \\r
  }\r
\r
#define gPnp16550ComPort \\r
  PNPID_DEVICE_PATH_NODE(0x0501)\r
\r
#define gPnpPs2Keyboard \\r
  PNPID_DEVICE_PATH_NODE(0x0303)\r
\r
#define gPcAnsiTerminal \\r
  { \\r
    { \\r
      MESSAGING_DEVICE_PATH, \\r
      MSG_VENDOR_DP, \\r
      { \\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) \\r
      } \\r
    }, \\r
    DEVICE_PATH_MESSAGING_PC_ANSI \\r
  }\r
\r
ACPI_HID_DEVICE_PATH  gPnpPs2KeyboardDeviceNode  = gPnpPs2Keyboard;\r
ACPI_HID_DEVICE_PATH  gPnp16550ComPortDeviceNode = gPnp16550ComPort;\r
VENDOR_DEVICE_PATH    gTerminalTypeDeviceNode    = gPcAnsiTerminal;\r
\r
BOOLEAN  mDetectDisplayOnly;\r
\r
/**\r
  Add IsaKeyboard to ConIn.\r
\r
  @param[in] DeviceHandle  Handle of the LPC Bridge device.\r
\r
  @retval EFI_SUCCESS  IsaKeyboard on the LPC bridge have been added to ConIn.\r
  @return              Error codes, due to EFI_DEVICE_PATH_PROTOCOL missing\r
                       from DeviceHandle.\r
**/\r
EFI_STATUS\r
PrepareLpcBridgeDevicePath (\r
  IN EFI_HANDLE  DeviceHandle\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
\r
  DevicePath = NULL;\r
  Status     = gBS->HandleProtocol (\r
                      DeviceHandle,\r
                      &gEfiDevicePathProtocolGuid,\r
                      (VOID *)&DevicePath\r
                      );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Register Keyboard\r
  //\r
  DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *)&gPnpPs2KeyboardDeviceNode);\r
  EfiBootManagerUpdateConsoleVariable (ConIn, DevicePath, NULL);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Return the GOP device path in the platform.\r
\r
  @param[in]   PciDevicePath - Device path for the PCI graphics device.\r
  @param[out]  GopDevicePath - Return the device path with GOP installed.\r
\r
  @retval EFI_SUCCESS  - PCI VGA is added to ConOut.\r
  @retval EFI_INVALID_PARAMETER   - The device path parameter is invalid.\r
  @retval EFI_STATUS   - No GOP device found.\r
**/\r
EFI_STATUS\r
GetGopDevicePath (\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *PciDevicePath,\r
  OUT EFI_DEVICE_PATH_PROTOCOL  **GopDevicePath\r
  )\r
{\r
  UINTN                     Index;\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                PciDeviceHandle;\r
  EFI_DEVICE_PATH_PROTOCOL  *TempDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL  *TempPciDevicePath;\r
  UINTN                     GopHandleCount;\r
  EFI_HANDLE                *GopHandleBuffer;\r
\r
  if ((PciDevicePath == NULL) || (GopDevicePath == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Initialize the GopDevicePath to be PciDevicePath\r
  //\r
  *GopDevicePath    = PciDevicePath;\r
  TempPciDevicePath = PciDevicePath;\r
\r
  Status = gBS->LocateDevicePath (\r
                  &gEfiDevicePathProtocolGuid,\r
                  &TempPciDevicePath,\r
                  &PciDeviceHandle\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  gBS->ConnectController (PciDeviceHandle, NULL, NULL, FALSE);\r
\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiGraphicsOutputProtocolGuid,\r
                  NULL,\r
                  &GopHandleCount,\r
                  &GopHandleBuffer\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Add all the child handles as possible Console Device\r
    //\r
    for (Index = 0; Index < GopHandleCount; Index++) {\r
      Status = gBS->HandleProtocol (GopHandleBuffer[Index], &gEfiDevicePathProtocolGuid, (VOID *)&TempDevicePath);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      if (CompareMem (\r
            PciDevicePath,\r
            TempDevicePath,\r
            GetDevicePathSize (PciDevicePath) - END_DEVICE_PATH_LENGTH\r
            ) == 0)\r
      {\r
        //\r
        // In current implementation, we only enable one of the child handles\r
        // as console device, i.e. sotre one of the child handle's device\r
        // path to variable "ConOut"\r
        // In future, we could select all child handles to be console device\r
        //\r
        *GopDevicePath = TempDevicePath;\r
\r
        //\r
        // Delete the PCI device's path that added by GetPlugInPciVgaDevicePath()\r
        // Add the integrity GOP device path.\r
        //\r
        EfiBootManagerUpdateConsoleVariable (ConOut, NULL, PciDevicePath);\r
        EfiBootManagerUpdateConsoleVariable (ConOut, TempDevicePath, NULL);\r
      }\r
    }\r
\r
    gBS->FreePool (GopHandleBuffer);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Add PCI VGA to ConOut, ConIn, ErrOut.\r
\r
  @param[in]  DeviceHandle - Handle of PciIo protocol.\r
\r
  @retval EFI_SUCCESS  - PCI VGA is added to ConOut.\r
  @retval EFI_STATUS   - No PCI VGA device is added.\r
\r
**/\r
EFI_STATUS\r
PreparePciVgaDevicePath (\r
  IN EFI_HANDLE  DeviceHandle\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL  *GopDevicePath;\r
\r
  DevicePath = NULL;\r
  Status     = gBS->HandleProtocol (\r
                      DeviceHandle,\r
                      &gEfiDevicePathProtocolGuid,\r
                      (VOID *)&DevicePath\r
                      );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  GetGopDevicePath (DevicePath, &GopDevicePath);\r
  DevicePath = GopDevicePath;\r
\r
  EfiBootManagerUpdateConsoleVariable (ConOut, DevicePath, NULL);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  For every PCI instance execute a callback function.\r
\r
  @param[in]  Id                 - The protocol GUID for callback\r
  @param[in]  CallBackFunction   - The callback function\r
\r
  @retval EFI_STATUS - Callback function failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
VisitAllInstancesOfProtocol (\r
  IN EFI_GUID                           *Id,\r
  IN SIMPLE_PROTOCOL_INSTANCE_CALLBACK  CallBackFunction\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       HandleCount;\r
  EFI_HANDLE  *HandleBuffer;\r
  UINTN       Index;\r
  VOID        *Instance;\r
\r
  //\r
  // Start to check all the PciIo to find all possible device\r
  //\r
  HandleCount  = 0;\r
  HandleBuffer = NULL;\r
  Status       = gBS->LocateHandleBuffer (\r
                        ByProtocol,\r
                        Id,\r
                        NULL,\r
                        &HandleCount,\r
                        &HandleBuffer\r
                        );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  for (Index = 0; Index < HandleCount; Index++) {\r
    Status = gBS->HandleProtocol (HandleBuffer[Index], Id, &Instance);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    Status = (*CallBackFunction)(\r
  HandleBuffer[Index],\r
  Instance\r
  );\r
  }\r
\r
  gBS->FreePool (HandleBuffer);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Do platform specific PCI Device check and add them to\r
  ConOut, ConIn, ErrOut.\r
\r
  @param[in]  Handle    - Handle of PCI device instance\r
  @param[in]  Instance  - The instance of PCI device\r
\r
  @retval EFI_SUCCESS - PCI Device check and Console variable update successfully.\r
  @retval EFI_STATUS - PCI Device check or Console variable update fail.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DetectAndPreparePlatformPciDevicePath (\r
  IN EFI_HANDLE  Handle,\r
  IN VOID        *Instance\r
  )\r
{\r
  EFI_STATUS           Status;\r
  EFI_PCI_IO_PROTOCOL  *PciIo;\r
  PCI_TYPE00           Pci;\r
\r
  PciIo = (EFI_PCI_IO_PROTOCOL *)Instance;\r
\r
  //\r
  // Check for all PCI device\r
  //\r
  Status = PciIo->Pci.Read (\r
                        PciIo,\r
                        EfiPciIoWidthUint32,\r
                        0,\r
                        sizeof (Pci) / sizeof (UINT32),\r
                        &Pci\r
                        );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = PciIo->Attributes (\r
                    PciIo,\r
                    EfiPciIoAttributeOperationEnable,\r
                    EFI_PCI_DEVICE_ENABLE,\r
                    NULL\r
                    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  if (!mDetectDisplayOnly) {\r
    //\r
    // Here we decide whether it is LPC Bridge\r
    //\r
    if ((IS_PCI_LPC (&Pci)) ||\r
        ((IS_PCI_ISA_PDECODE (&Pci)) &&\r
         (Pci.Hdr.VendorId == 0x8086)\r
        )\r
        )\r
    {\r
      //\r
      // Add IsaKeyboard to ConIn,\r
      // add IsaSerial to ConOut, ConIn, ErrOut\r
      //\r
      DEBUG ((DEBUG_INFO, "Found LPC Bridge device\n"));\r
      PrepareLpcBridgeDevicePath (Handle);\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  //\r
  // Enable all display devices\r
  //\r
  if (IS_PCI_DISPLAY (&Pci)) {\r
    //\r
    // Add them to ConOut.\r
    //\r
    DEBUG ((DEBUG_INFO, "Found PCI Display device\n"));\r
    EfiBootManagerConnectVideoController (Handle);\r
    return EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  For every Serial Io instance, add it to ConOut, ConIn, ErrOut.\r
\r
  @param[in]  Handle     - The Serial Io device handle\r
  @param[in]  Instance   - The instance of the SerialIo protocol\r
\r
  @retval EFI_STATUS - Callback function failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AddDevicePathForOneSerialIoInstance (\r
  IN EFI_HANDLE  Handle,\r
  IN VOID        *Instance\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
\r
  DevicePath = NULL;\r
  Status     = gBS->HandleProtocol (\r
                      Handle,\r
                      &gEfiDevicePathProtocolGuid,\r
                      (VOID *)&DevicePath\r
                      );\r
  DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *)&gTerminalTypeDeviceNode);\r
\r
  EfiBootManagerUpdateConsoleVariable (ConOut, DevicePath, NULL);\r
  EfiBootManagerUpdateConsoleVariable (ConIn, DevicePath, NULL);\r
  EfiBootManagerUpdateConsoleVariable (ErrOut, DevicePath, NULL);\r
  return Status;\r
}\r
\r
/**\r
  Do platform specific PCI Device check and add them to ConOut, ConIn, ErrOut\r
\r
  @param[in]  DetectDisplayOnly - Only detect display device if it's TRUE.\r
\r
  @retval EFI_SUCCESS - PCI Device check and Console variable update successfully.\r
  @retval EFI_STATUS - PCI Device check or Console variable update fail.\r
\r
**/\r
EFI_STATUS\r
DetectAndPreparePlatformPciDevicePaths (\r
  BOOLEAN  DetectDisplayOnly\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  mDetectDisplayOnly = DetectDisplayOnly;\r
\r
  EfiBootManagerUpdateConsoleVariable (\r
    ConIn,\r
    (EFI_DEVICE_PATH_PROTOCOL *)&gUsbClassKeyboardDevicePath,\r
    NULL\r
    );\r
\r
  VisitAllInstancesOfProtocol (\r
    &gEfiSerialIoProtocolGuid,\r
    AddDevicePathForOneSerialIoInstance\r
    );\r
\r
  Status = VisitAllInstancesOfProtocol (\r
             &gEfiPciIoProtocolGuid,\r
             DetectAndPreparePlatformPciDevicePath\r
             );\r
  return Status;\r
}\r
\r
/**\r
  The function will connect one root bridge\r
\r
  @param[in]  Handle     - The root bridge handle\r
  @param[in]  Instance   - The instance of the root bridge\r
\r
  @return EFI_SUCCESS      Connect RootBridge successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConnectOneRootBridge (\r
  IN EFI_HANDLE  Handle,\r
  IN VOID        *Instance\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = gBS->ConnectController (Handle, NULL, NULL, FALSE);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Platform console init. Include the platform firmware vendor, revision\r
  and so crc check.\r
\r
**/\r
VOID\r
EFIAPI\r
PlatformConsoleInit (\r
  VOID\r
  )\r
{\r
  VisitAllInstancesOfProtocol (\r
    &gEfiPciRootBridgeIoProtocolGuid,\r
    ConnectOneRootBridge\r
    );\r
\r
  //\r
  // Do platform specific PCI Device check and add them to ConOut, ConIn, ErrOut\r
  //\r
  DetectAndPreparePlatformPciDevicePaths (FALSE);\r
}\r