ArmVirtPkg/Library/DebugLibFdtPL011Uart/Flash.c

/** @file
  Define DebugLibFdtPL011UartWrite() for modules that may run from flash or RAM.

  Copyright (C) Red Hat

  SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/FdtSerialPortAddressLib.h>
#include <Library/PL011UartLib.h>
#include <Library/PcdLib.h>

#include "Write.h"

//
// Duplicated in ArmVirtPkg/Library/PlatformPeiLib/PlatformPeiLib.c —
// keep both copies in sync.
//

/**
  Parse a serial debug level string.

  Accepted values are "silent" (DEBUG_ERROR only), "verbose" (no
  override), or a hex bitmask (e.g. "0x80000040").

  @param[in]  String      NUL-terminated ASCII string to parse.
  @param[out] DebugLevel  On success, the parsed debug level bitmask.

  @retval TRUE   String was recognised; *DebugLevel is valid.
  @retval FALSE  String is NULL, "verbose", or unrecognised; no override.
**/
STATIC
BOOLEAN
ParseSerialDebugLevel (
  IN  CONST CHAR8  *String,
  OUT UINT32       *DebugLevel
  )
{
  UINT64  Value;
  CHAR8   *End;

  if ((String == NULL) || (DebugLevel == NULL)) {
    return FALSE;
  }

  if (AsciiStrCmp (String, "silent") == 0) {
    *DebugLevel = DEBUG_ERROR;
    return TRUE;
  }

  if (AsciiStrCmp (String, "verbose") == 0) {
    return FALSE;
  }

  if (!EFI_ERROR (AsciiStrHexToUint64S (String, &End, &Value)) &&
      (*End == '\0'))
  {
    *DebugLevel = (UINT32)Value;
    return TRUE;
  }

  return FALSE;
}

/**
  (Copied from SerialPortWrite() in "MdePkg/Include/Library/SerialPortLib.h" at
  commit c4547aefb3d0, with the Buffer non-nullity assertion removed:)

  Write data from buffer to serial device.

  Writes NumberOfBytes data bytes from Buffer to the serial device.
  The number of bytes actually written to the serial device is returned.
  If the return value is less than NumberOfBytes, then the write operation failed.
  If NumberOfBytes is zero, then return 0.

  @param  Buffer           Pointer to the data buffer to be written.
  @param  NumberOfBytes    Number of bytes to written to the serial device.

  @retval 0                NumberOfBytes is 0.
  @retval >0               The number of bytes written to the serial device.
                           If this value is less than NumberOfBytes, then the write operation failed.
**/
UINTN
DebugLibFdtPL011UartWrite (
  IN UINT8  *Buffer,
  IN UINTN  NumberOfBytes
  )
{
  CONST VOID          *DeviceTree;
  RETURN_STATUS       Status;
  FDT_SERIAL_PORTS    Ports;
  UINT64              DebugAddress;
  UINT64              BaudRate;
  UINT32              ReceiveFifoDepth;
  EFI_PARITY_TYPE     Parity;
  UINT8               DataBits;
  EFI_STOP_BITS_TYPE  StopBits;

  DeviceTree = (VOID *)(UINTN)PcdGet64 (PcdDeviceTreeInitialBaseAddress);
  if (DeviceTree == NULL) {
    return 0;
  }

  Status = FdtSerialGetPorts (DeviceTree, "arm,pl011", &Ports);
  if (RETURN_ERROR (Status)) {
    return 0;
  }

  if (Ports.NumberOfPorts == 1) {
    //
    // Just one UART; direct DebugLib to it.
    //
    DebugAddress = Ports.BaseAddress[0];
  } else {
    UINT64  ConsoleAddress;

    Status = FdtSerialGetConsolePort (DeviceTree, &ConsoleAddress);
    if (EFI_ERROR (Status)) {
      //
      // At least two UARTs; but failed to get the console preference. Use the
      // second UART for DebugLib.
      //
      DebugAddress = Ports.BaseAddress[1];
    } else {
      //
      // At least two UARTs; and console preference available. Use the first
      // such UART for DebugLib that *differs* from ConsoleAddress.
      //
      if (ConsoleAddress == Ports.BaseAddress[0]) {
        DebugAddress = Ports.BaseAddress[1];
      } else {
        DebugAddress = Ports.BaseAddress[0];
      }
    }
  }

  BaudRate         = (UINTN)FixedPcdGet64 (PcdUartDefaultBaudRate);
  ReceiveFifoDepth = 0; // Use the default value for Fifo depth
  Parity           = (EFI_PARITY_TYPE)FixedPcdGet8 (PcdUartDefaultParity);
  DataBits         = FixedPcdGet8 (PcdUartDefaultDataBits);
  StopBits         = (EFI_STOP_BITS_TYPE)FixedPcdGet8 (PcdUartDefaultStopBits);

  Status = PL011UartInitializePort (
             (UINTN)DebugAddress,
             FixedPcdGet32 (PL011UartClkInHz),
             &BaudRate,
             &ReceiveFifoDepth,
             &Parity,
             &DataBits,
             &StopBits
             );
  if (RETURN_ERROR (Status)) {
    return 0;
  }

  return PL011UartWrite ((UINTN)DebugAddress, Buffer, NumberOfBytes);
}

/**
  Retrieve the serial debug print error level override.

  The flash variant parses the compile-time PCD only.  The fw_cfg
  override is not available in SEC/PEI_CORE phases.

  @param[out] Value  On success, the debug log level bitmask.

  @retval EFI_SUCCESS    The debug level was retrieved successfully.
  @retval EFI_INVALID_PARAMETER  Value is NULL.
  @retval EFI_NOT_FOUND  No override is configured (e.g. "verbose").
**/
EFI_STATUS
GetSerialDebugPrintErrorLevel (
  OUT UINT32  *Value
  )
{
  CONST CHAR8  *String;

  if (Value == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  String = (CONST CHAR8 *)PcdGetPtr (PcdSerialDebugPrintErrorLevel);

  if (ParseSerialDebugLevel (String, Value)) {
    return EFI_SUCCESS;
  }

  return EFI_NOT_FOUND;
}