OvmfPkg: XenConsoleSerialPortLib: deal with output overflow

[mirror_edk2.git] / OvmfPkg / Library / XenConsoleSerialPortLib / XenConsoleSerialPortLib.c

/** @file\r
  Xen console SerialPortLib instance\r
\r
  Copyright (c) 2015, Linaro Ltd. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <Base.h>\r
#include <Uefi/UefiBaseType.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/SerialPortLib.h>\r
#include <Library/XenHypercallLib.h>\r
\r
#include <IndustryStandard/Xen/io/console.h>\r
#include <IndustryStandard/Xen/hvm/params.h>\r
#include <IndustryStandard/Xen/event_channel.h>\r
\r
//\r
// We can't use DebugLib due to a constructor dependency cycle between DebugLib\r
// and ourselves.\r
//\r
#define ASSERT(Expression)      \\r
  do {                          \\r
    if (!(Expression)) {        \\r
      CpuDeadLoop ();           \\r
    }                           \\r
  } while (FALSE)\r
\r
//\r
// The code below expects these global variables to be mutable, even in the case\r
// that we have been incorporated into SEC or PEIM phase modules (which is\r
// allowed by our INF description). While this is a dangerous assumption to make\r
// in general, it is actually fine for the Xen domU (guest) environment that\r
// this module is intended for, as UEFI always executes from DRAM in that case.\r
//\r
STATIC evtchn_send_t              mXenConsoleEventChain;\r
STATIC struct xencons_interface   *mXenConsoleInterface;\r
\r
/**\r
  Initialize the serial device hardware.\r
\r
  If no initialization is required, then return RETURN_SUCCESS.\r
  If the serial device was successfully initialized, then return RETURN_SUCCESS.\r
  If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.\r
\r
  @retval RETURN_SUCCESS        The serial device was initialized.\r
  @retval RETURN_DEVICE_ERROR   The serial device could not be initialized.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SerialPortInitialize (\r
  VOID\r
  )\r
{\r
  if (! XenHypercallIsAvailable ()) {\r
    return RETURN_DEVICE_ERROR;\r
  }\r
\r
  if (!mXenConsoleInterface) {\r
    mXenConsoleEventChain.port = (UINT32)XenHypercallHvmGetParam (HVM_PARAM_CONSOLE_EVTCHN);\r
    mXenConsoleInterface = (struct xencons_interface *)(UINTN)\r
      (XenHypercallHvmGetParam (HVM_PARAM_CONSOLE_PFN) << EFI_PAGE_SHIFT);\r
\r
    //\r
    // No point in ASSERT'ing here as we won't be seeing the output\r
    //\r
  }\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Write data from buffer to serial device.\r
\r
  Writes NumberOfBytes data bytes from Buffer to the serial device.\r
  The number of bytes actually written to the serial device is returned.\r
  If the return value is less than NumberOfBytes, then the write operation failed.\r
  If Buffer is NULL, then ASSERT().\r
  If NumberOfBytes is zero, then return 0.\r
\r
  @param  Buffer           Pointer to the data buffer to be written.\r
  @param  NumberOfBytes    Number of bytes to written to the serial device.\r
\r
  @retval 0                NumberOfBytes is 0.\r
  @retval >0               The number of bytes written to the serial device.\r
                           If this value is less than NumberOfBytes, then the write operation failed.\r
\r
**/\r
UINTN\r
EFIAPI\r
SerialPortWrite (\r
  IN UINT8     *Buffer,\r
  IN UINTN     NumberOfBytes\r
  )\r
{\r
  XENCONS_RING_IDX  Consumer, Producer;\r
  UINTN             Sent;\r
\r
  ASSERT (Buffer != NULL);\r
\r
  if (NumberOfBytes == 0) {\r
    return 0;\r
  }\r
\r
  if (!mXenConsoleInterface) {\r
    return 0;\r
  }\r
\r
  Sent = 0;\r
  do {\r
    Consumer = mXenConsoleInterface->out_cons;\r
    Producer = mXenConsoleInterface->out_prod;\r
\r
    MemoryFence ();\r
\r
    while (Sent < NumberOfBytes && ((Producer - Consumer) < sizeof (mXenConsoleInterface->out)))\r
      mXenConsoleInterface->out[MASK_XENCONS_IDX(Producer++, mXenConsoleInterface->out)] = Buffer[Sent++];\r
\r
    MemoryFence ();\r
\r
    mXenConsoleInterface->out_prod = Producer;\r
\r
    XenHypercallEventChannelOp (EVTCHNOP_send, &mXenConsoleEventChain);\r
\r
  } while (Sent < NumberOfBytes);\r
\r
  return Sent;\r
}\r
\r
/**\r
  Read data from serial device and save the datas in buffer.\r
\r
  Reads NumberOfBytes data bytes from a serial device into the buffer\r
  specified by Buffer. The number of bytes actually read is returned.\r
  If Buffer is NULL, then ASSERT().\r
  If NumberOfBytes is zero, then return 0.\r
\r
  @param  Buffer           Pointer to the data buffer to store the data read from the serial device.\r
  @param  NumberOfBytes    Number of bytes which will be read.\r
\r
  @retval 0                Read data failed, no data is to be read.\r
  @retval >0               Actual number of bytes read from serial device.\r
\r
**/\r
UINTN\r
EFIAPI\r
SerialPortRead (\r
  OUT UINT8     *Buffer,\r
  IN  UINTN     NumberOfBytes\r
)\r
{\r
  XENCONS_RING_IDX  Consumer, Producer;\r
  UINTN             Received;\r
\r
  ASSERT (Buffer != NULL);\r
\r
  if (NumberOfBytes == 0) {\r
    return 0;\r
  }\r
\r
  if (!mXenConsoleInterface) {\r
    return 0;\r
  }\r
\r
  Consumer = mXenConsoleInterface->in_cons;\r
  Producer = mXenConsoleInterface->in_prod;\r
\r
  MemoryFence ();\r
\r
  Received = 0;\r
  while (Received < NumberOfBytes && Consumer < Producer)\r
     Buffer[Received++] = mXenConsoleInterface->in[MASK_XENCONS_IDX(Consumer++, mXenConsoleInterface->in)];\r
\r
  MemoryFence ();\r
\r
  mXenConsoleInterface->in_cons = Consumer;\r
\r
  XenHypercallEventChannelOp (EVTCHNOP_send, &mXenConsoleEventChain);\r
\r
  return Received;\r
}\r
\r
/**\r
  Polls a serial device to see if there is any data waiting to be read.\r
\r
  @retval TRUE             Data is waiting to be read from the serial device.\r
  @retval FALSE            There is no data waiting to be read from the serial device.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
SerialPortPoll (\r
  VOID\r
  )\r
{\r
  return mXenConsoleInterface &&\r
    mXenConsoleInterface->in_cons != mXenConsoleInterface->in_prod;\r
}\r