CorebootPayloadPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / CorebootPayloadPkg / 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
\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 gPciRootBridge \\r
  PNPID_DEVICE_PATH_NODE(0x0A03)\r
\r
#define gPnp16550ComPort \\r
  PNPID_DEVICE_PATH_NODE(0x0501)\r
\r
#define gUartVendor \\r
  { \\r
    { \\r
      HARDWARE_DEVICE_PATH, \\r
      HW_VENDOR_DP, \\r
      { \\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) \\r
      } \\r
    }, \\r
    {0xD3987D4B, 0x971A, 0x435F, {0x8C, 0xAF, 0x49, 0x67, 0xEB, 0x62, 0x72, 0x41}} \\r
  }\r
\r
#define gUart \\r
  { \\r
    { \\r
      MESSAGING_DEVICE_PATH, \\r
      MSG_UART_DP, \\r
      { \\r
        (UINT8) (sizeof (UART_DEVICE_PATH)), \\r
        (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8) \\r
      } \\r
    }, \\r
    0, \\r
    115200, \\r
    8, \\r
    1, \\r
    1 \\r
  }\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
\r
ACPI_HID_DEVICE_PATH       gPnp16550ComPortDeviceNode = gPnp16550ComPort;\r
UART_DEVICE_PATH           gUartDeviceNode            = gUart;\r
VENDOR_DEVICE_PATH         gTerminalTypeDeviceNode    = gPcAnsiTerminal;\r
VENDOR_DEVICE_PATH         gUartDeviceVendorNode      = gUartVendor;\r
\r
//\r
// Predefined platform root bridge\r
//\r
PLATFORM_ROOT_BRIDGE_DEVICE_PATH  gPlatformRootBridge0 = {\r
  gPciRootBridge,\r
  gEndEntire\r
};\r
\r
EFI_DEVICE_PATH_PROTOCOL          *gPlatformRootBridges[] = {\r
  (EFI_DEVICE_PATH_PROTOCOL *) &gPlatformRootBridge0,\r
  NULL\r
};\r
\r
BOOLEAN       mDetectVgaOnly;\r
\r
/**\r
  Add UART to ConOut, ConIn, ErrOut.\r
\r
  @param[in]   DeviceHandle - LPC device path.\r
\r
  @retval EFI_SUCCESS  - Serial console is added to ConOut, ConIn, and ErrOut.\r
  @retval EFI_STATUS   - No serial console is added.\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 COM1\r
  //\r
  DevicePath = AppendDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL *)NULL, (EFI_DEVICE_PATH_PROTOCOL *)&gUartDeviceVendorNode);\r
  DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *)&gUartDeviceNode);\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
\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
  ACPI_ADR_DEVICE_PATH             AcpiAdr;\r
  EFI_DEVICE_PATH_PROTOCOL        *MyDevicePath;\r
\r
  if (PciDevicePath == NULL || GopDevicePath == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  MyDevicePath = NULL;\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
  //\r
  // Try to connect this handle, so that GOP driver could start on this\r
  // device and create child handles with GraphicsOutput Protocol installed\r
  // on them, then we get device paths of these child handles and select\r
  // them as possible console device.\r
  //\r
  AcpiAdr.Header.Type     = ACPI_DEVICE_PATH;\r
  AcpiAdr.Header.SubType  = ACPI_ADR_DP;\r
  AcpiAdr.ADR= ACPI_DISPLAY_ADR (1, 0, 0, 1, 0, ACPI_ADR_DISPLAY_TYPE_INTERNAL_DIGITAL, 8, 0);\r
\r
  SetDevicePathNodeLength (&AcpiAdr.Header, sizeof (ACPI_ADR_DEVICE_PATH));\r
\r
  MyDevicePath = AppendDevicePathNode(MyDevicePath, (EFI_DEVICE_PATH_PROTOCOL*)&AcpiAdr);\r
\r
  gBS->ConnectController (PciDeviceHandle, NULL, MyDevicePath, FALSE);\r
\r
  FreePool(MyDevicePath);\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
      if (CompareMem (\r
            PciDevicePath,\r
            TempDevicePath,\r
            GetDevicePathSize (PciDevicePath) - END_DEVICE_PATH_LENGTH\r
          ) == 0) {\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
    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
  Add PCI Serial to ConOut, ConIn, ErrOut.\r
\r
  @param[in]  DeviceHandle - Handle of PciIo protocol.\r
\r
  @retval EFI_SUCCESS  - PCI Serial is added to ConOut, ConIn, and ErrOut.\r
  @retval EFI_STATUS   - No PCI Serial device is added.\r
\r
**/\r
EFI_STATUS\r
PreparePciSerialDevicePath (\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
  DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *)&gUartDeviceNode);\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
\r
  return EFI_SUCCESS;\r
}\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
  @param[in]  Context    - The context of the callback\r
\r
  @retval EFI_STATUS - Callback function failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
VisitAllInstancesOfProtocol (\r
  IN EFI_GUID                    *Id,\r
  IN PROTOCOL_INSTANCE_CALLBACK  CallBackFunction,\r
  IN VOID                        *Context\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
               Context\r
             );\r
  }\r
\r
  gBS->FreePool (HandleBuffer);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  For every PCI instance execute a callback function.\r
\r
  @param[in]  Handle     - The PCI device handle\r
  @param[in]  Instance   - The instance of the PciIo protocol\r
  @param[in]  Context    - The context of the callback\r
\r
  @retval EFI_STATUS - Callback function failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
VisitingAPciInstance (\r
  IN EFI_HANDLE  Handle,\r
  IN VOID        *Instance,\r
  IN VOID        *Context\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
  return (*(VISIT_PCI_INSTANCE_CALLBACK)(UINTN) Context) (\r
           Handle,\r
           PciIo,\r
           &Pci\r
         );\r
\r
}\r
\r
\r
/**\r
  For every PCI instance execute a callback function.\r
\r
  @param[in]  CallBackFunction - Callback function pointer\r
\r
  @retval EFI_STATUS - Callback function failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
VisitAllPciInstances (\r
  IN VISIT_PCI_INSTANCE_CALLBACK CallBackFunction\r
)\r
{\r
  return VisitAllInstancesOfProtocol (\r
           &gEfiPciIoProtocolGuid,\r
           VisitingAPciInstance,\r
           (VOID*)(UINTN) CallBackFunction\r
         );\r
}\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]  PciIo - PCI IO protocol instance\r
  @param[in]  Pci - PCI Header register block\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 EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN PCI_TYPE00           *Pci\r
)\r
{\r
  EFI_STATUS                Status;\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 (!mDetectVgaOnly) {\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
      // Add IsaKeyboard to ConIn,\r
      // add IsaSerial to ConOut, ConIn, ErrOut\r
      //\r
      DEBUG ((EFI_D_INFO, "Found LPC Bridge device\n"));\r
      PrepareLpcBridgeDevicePath (Handle);\r
      return EFI_SUCCESS;\r
    }\r
    //\r
    // Here we decide which Serial device to enable in PCI bus\r
    //\r
    if (IS_PCI_16550SERIAL (Pci)) {\r
      //\r
      // Add them to ConOut, ConIn, ErrOut.\r
      //\r
      DEBUG ((EFI_D_INFO, "Found PCI 16550 SERIAL device\n"));\r
      PreparePciSerialDevicePath (Handle);\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  //\r
  // Here we decide which VGA device to enable in PCI bus\r
  //\r
  if (IS_PCI_VGA (Pci)) {\r
    //\r
    // Add them to ConOut.\r
    //\r
    DEBUG ((EFI_D_INFO, "Found PCI VGA device\n"));\r
    PreparePciVgaDevicePath (Handle);\r
    return EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Do platform specific PCI Device check and add them to ConOut, ConIn, ErrOut\r
\r
  @param[in]  DetectVgaOnly - Only detect VGA 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 DetectVgaOnly\r
)\r
{\r
  mDetectVgaOnly = DetectVgaOnly;\r
  return VisitAllPciInstances (DetectAndPreparePlatformPciDevicePath);\r
}\r
\r
\r
/**\r
  The function will connect root bridge\r
\r
   @return EFI_SUCCESS      Connect RootBridge successfully.\r
\r
**/\r
EFI_STATUS\r
ConnectRootBridge (\r
  VOID\r
)\r
{\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                RootHandle;\r
\r
  //\r
  // Make all the PCI_IO protocols on PCI Seg 0 show up\r
  //\r
  Status = gBS->LocateDevicePath (\r
             &gEfiDevicePathProtocolGuid,\r
             &gPlatformRootBridges[0],\r
             &RootHandle\r
           );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->ConnectController (RootHandle, 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
  gUartDeviceNode.BaudRate = PcdGet64 (PcdUartDefaultBaudRate);\r
  gUartDeviceNode.DataBits = PcdGet8 (PcdUartDefaultDataBits);\r
  gUartDeviceNode.Parity   = PcdGet8 (PcdUartDefaultParity);\r
  gUartDeviceNode.StopBits = PcdGet8 (PcdUartDefaultStopBits);\r
\r
  ConnectRootBridge ();\r
\r
  //\r
  // Do platform specific PCI Device check and add them to ConOut, ConIn, ErrOut\r
  //\r
  DetectAndPreparePlatformPciDevicePaths (FALSE);\r
}\r