OvmfPkg: Apply uncrustify changes

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

/** @file\r
\r
  Copyright (c) 2020, Rebecca Cran <rebecca@bsdio.com>\r
  Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>\r
  Copyright (C) 2013, Red Hat, Inc.\r
  Copyright (c) 2015, Nahanni Systems.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Uefi.h"\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BhyveFwCtlLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#define FW_PORT   0x510\r
#define FW_IPORT  0x511\r
\r
/* Transport protocol basic operations */\r
#define OP_NULL     1\r
#define OP_ECHO     2\r
#define OP_GET      3\r
#define OP_GET_LEN  4\r
#define OP_SET      5\r
\r
/* Transport protocol error returns */\r
#define T_ESUCCESS  0\r
#define T_ENOENT    2\r
#define T_E2BIG     7\r
#define T_EMSGSIZE  40\r
\r
#define ROUNDUP(x, y)  ((((x)+((y)-1))/(y))*(y))\r
\r
STATIC CONST CHAR8  mBhyveSig[4] = { 'B', 'H', 'Y', 'V' };\r
\r
STATIC BOOLEAN  mBhyveFwCtlSupported = FALSE;\r
\r
STATIC INT32  mBhyveFwCtlTxid = 0xa5;\r
\r
/* XXX Maybe a better inbuilt version of this ? */\r
typedef struct {\r
  VOID      *Base;\r
  UINT32    Len;\r
} BIO_VEC;\r
\r
typedef struct {\r
  UINT32    Sz;\r
  UINT32    Op;\r
  UINT32    TxId;\r
  UINT32    Err;\r
} MSG_RX_HDR;\r
\r
STATIC\r
RETURN_STATUS\r
EFIAPI\r
BhyveFwCtl_CvtErr (\r
  IN UINT32  errno\r
  )\r
{\r
  RETURN_STATUS  Status;\r
\r
  switch (errno) {\r
    case T_ESUCCESS:\r
      Status = RETURN_SUCCESS;\r
      break;\r
    case T_ENOENT:\r
      Status = RETURN_NOT_FOUND;\r
      break;\r
    case T_E2BIG:\r
      Status = RETURN_INVALID_PARAMETER;\r
      break;\r
    case T_EMSGSIZE:\r
      Status = RETURN_BUFFER_TOO_SMALL;\r
      break;\r
    default:\r
      Status = RETURN_PROTOCOL_ERROR;\r
      break;\r
  }\r
\r
  return Status;\r
}\r
\r
STATIC\r
UINT32\r
EFIAPI\r
BIov_WLen (\r
  IN BIO_VEC  b[]\r
  )\r
{\r
  UINT32  i;\r
  UINT32  tLen;\r
\r
  tLen = 0;\r
\r
  if (b != NULL) {\r
    for (i = 0; b[i].Base != NULL; i++) {\r
      tLen += ROUNDUP (b[i].Len, sizeof (UINT32));\r
    }\r
  }\r
\r
  return tLen;\r
}\r
\r
/**\r
   Utility to send 1-3 bytes of input as a 4-byte value\r
   with trailing zeroes.\r
 **/\r
STATIC\r
UINT32\r
BIov_Send_Rem (\r
  IN UINT32  *Data,\r
  IN UINT32  Len\r
  )\r
{\r
  union {\r
    UINT8     c[4];\r
    UINT32    w;\r
  } u;\r
  UINT8   *cdata;\r
  UINT32  i;\r
\r
  cdata = (UINT8 *)Data;\r
  u.w   = 0;\r
\r
  for (i = 0; i < Len; i++) {\r
    u.c[i] = *cdata++;\r
  }\r
\r
  return u.w;\r
}\r
\r
/**\r
   Send a block of data out the i/o port as 4-byte quantities,\r
   appending trailing zeroes on the last if required.\r
 **/\r
STATIC\r
VOID\r
BIov_Send (\r
  IN char    *Data,\r
  IN UINT32  Len\r
  )\r
{\r
  UINT32  *LData;\r
\r
  LData = (UINT32 *)Data;\r
\r
  while (Len > sizeof (UINT32)) {\r
    IoWrite32 (FW_PORT, *LData++);\r
    Len -= sizeof (UINT32);\r
  }\r
\r
  if (Len > 0) {\r
    IoWrite32 (FW_PORT, BIov_Send_Rem (LData, Len));\r
  }\r
}\r
\r
/**\r
   Send data described by an array of iovecs out the i/o port.\r
 **/\r
STATIC\r
VOID\r
BIov_SendAll (\r
  IN BIO_VEC  b[]\r
  )\r
{\r
  INT32  i;\r
\r
  if (b != NULL) {\r
    for (i = 0; b[i].Base; i++) {\r
      BIov_Send (b[i].Base, b[i].Len);\r
    }\r
  }\r
}\r
\r
/**\r
   Prepend the transport header to a block of data and send.\r
 **/\r
STATIC\r
VOID\r
EFIAPI\r
BhyveFwCtl_MsgSend (\r
  IN  UINT32   OpCode,\r
  IN  BIO_VEC  Data[]\r
  )\r
{\r
  BIO_VEC  hIov[4];\r
  UINT32   Hdr[3];\r
  UINT32   i;\r
\r
  /* Set up header as an iovec */\r
  for (i = 0; i < 3; i++) {\r
    hIov[i].Base = &Hdr[i];\r
    hIov[i].Len  = sizeof (Hdr[0]);\r
  }\r
\r
  hIov[i].Base = NULL;\r
  hIov[i].Len  = 0;\r
\r
  /* Initialize header */\r
  Hdr[0] = BIov_WLen (hIov) + BIov_WLen (Data);\r
  Hdr[1] = (UINT32)OpCode;\r
  Hdr[2] = mBhyveFwCtlTxid;\r
\r
  /* Send header and data */\r
  BIov_SendAll (hIov);\r
  BIov_SendAll (Data);\r
}\r
\r
/**\r
   Read a transport response and optional data from the i/o port.\r
 **/\r
STATIC\r
RETURN_STATUS\r
EFIAPI\r
BhyveFwCtl_MsgRecv (\r
  OUT  MSG_RX_HDR  *Rhdr,\r
  OUT  BIO_VEC     Data[]\r
  )\r
{\r
  RETURN_STATUS  Status;\r
  UINT32         *Dp;\r
  UINT32         Rd;\r
  UINT32         remLen;\r
  INT32          oLen;\r
  INT32          xLen;\r
\r
  Rd = IoRead32 (FW_PORT);\r
  if (Rd < sizeof (MSG_RX_HDR)) {\r
  }\r
\r
  /* Read in header and setup initial error */\r
  Rhdr->Sz   = Rd;\r
  Rhdr->Op   = IoRead32 (FW_PORT);\r
  Rhdr->TxId = IoRead32 (FW_PORT);\r
  Rhdr->Err  = IoRead32 (FW_PORT);\r
\r
  /* Convert transport errno into UEFI error status */\r
  Status = BhyveFwCtl_CvtErr (Rhdr->Err);\r
\r
  remLen = Rd - sizeof (MSG_RX_HDR);\r
  xLen   = 0;\r
\r
  /*\r
   * A few cases to handle:\r
   *  - the user didn't supply a read buffer\r
   *  - the buffer is too small for the response\r
   *  - the response is zero-length\r
   */\r
  if (Data != NULL) {\r
    Dp   = (UINT32 *)Data[0].Base;\r
    oLen = remLen;\r
    if (remLen > Data[0].Len) {\r
      Status = RETURN_BUFFER_TOO_SMALL;\r
      xLen   = remLen - Data[0].Len;\r
      oLen   = remLen = Data[0].Len;\r
    }\r
\r
    while (remLen > 0) {\r
      *Dp++   = IoRead32 (FW_PORT);\r
      remLen -= sizeof (UINT32);\r
    }\r
\r
    Data[0].Len = oLen;\r
  } else {\r
    /* No user data, but data returned - drop */\r
    if (remLen > 0) {\r
      Status = RETURN_BUFFER_TOO_SMALL;\r
      xLen   = remLen;\r
    }\r
  }\r
\r
  /* Drop additional data */\r
  while (xLen > 0) {\r
    (void)IoRead32 (FW_PORT);\r
    xLen -= sizeof (UINT32);\r
  }\r
\r
  return Status;\r
}\r
\r
STATIC\r
RETURN_STATUS\r
EFIAPI\r
BhyveFwCtl_Msg (\r
  IN   UINT32   OpCode,\r
  IN   BIO_VEC  Sdata[],\r
  OUT  BIO_VEC  Rdata[]\r
  )\r
{\r
  MSG_RX_HDR     Rh;\r
  RETURN_STATUS  Status;\r
\r
  Status = RETURN_SUCCESS;\r
\r
  BhyveFwCtl_MsgSend (OpCode, Sdata);\r
  Status = BhyveFwCtl_MsgRecv (&Rh, Rdata);\r
\r
  mBhyveFwCtlTxid++;\r
\r
  return Status;\r
}\r
\r
STATIC\r
RETURN_STATUS\r
EFIAPI\r
BhyveFwCtlGetLen (\r
  IN CONST CHAR8   *Name,\r
  IN OUT   UINT32  *Size\r
  )\r
{\r
  BIO_VEC        Req[2], Resp[2];\r
  RETURN_STATUS  Status;\r
\r
  Req[0].Base = (VOID *)Name;\r
  Req[0].Len  = (UINT32)AsciiStrLen (Name) + 1;\r
  Req[1].Base = NULL;\r
\r
  Resp[0].Base = Size;\r
  Resp[0].Len  = sizeof (UINT32);\r
  Resp[1].Base = NULL;\r
\r
  Status = BhyveFwCtl_Msg (OP_GET_LEN, Req, Resp);\r
\r
  return Status;\r
}\r
\r
#define FMAXSZ  1024\r
STATIC struct {\r
  UINT64    fSize;\r
  UINT32    fData[FMAXSZ];\r
} FwGetvalBuf;\r
\r
STATIC\r
RETURN_STATUS\r
EFIAPI\r
BhyveFwCtlGetVal (\r
  IN CONST CHAR8   *Name,\r
  OUT      VOID    *Item,\r
  IN OUT   UINT32  *Size\r
  )\r
{\r
  BIO_VEC        Req[2];\r
  BIO_VEC        Resp[2];\r
  RETURN_STATUS  Status;\r
\r
  /* Make sure temp buffer is larger than passed-in size */\r
  if (*Size > sizeof (FwGetvalBuf.fData)) {\r
    return RETURN_INVALID_PARAMETER;\r
  }\r
\r
  Req[0].Base = (VOID *)Name;\r
  Req[0].Len  = (UINT32)AsciiStrLen (Name) + 1;\r
  Req[1].Base = NULL;\r
\r
  Resp[0].Base = &FwGetvalBuf;\r
  Resp[0].Len  = sizeof (UINT64) + *Size;\r
  Resp[1].Base = NULL;\r
\r
  Status = BhyveFwCtl_Msg (OP_GET, Req, Resp);\r
\r
  /*\r
   * Copy out data on success (or on a truncated message).\r
   * XXX This step can be eliminted with Msg() supporting\r
   *     multiple iovecs.\r
   */\r
  if ((Status == RETURN_SUCCESS) || (Status == RETURN_BUFFER_TOO_SMALL)) {\r
    *Size = (UINT32)FwGetvalBuf.fSize;\r
    CopyMem (Item, FwGetvalBuf.fData, *Size);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
   Front end to the internal GET_LEN and GET protocols\r
 **/\r
RETURN_STATUS\r
EFIAPI\r
BhyveFwCtlGet (\r
  IN   CONST CHAR8  *Name,\r
  OUT  VOID         *Item,\r
  IN OUT  UINTN     *Size\r
  )\r
{\r
  RETURN_STATUS  Status;\r
\r
  if (mBhyveFwCtlSupported == FALSE) {\r
    return RETURN_UNSUPPORTED;\r
  }\r
\r
  if (Item == NULL) {\r
    Status = BhyveFwCtlGetLen (Name, (UINT32 *)Size);\r
  } else {\r
    Status = BhyveFwCtlGetVal (Name, Item, (UINT32 *)Size);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
   Library initialization. Probe the host to see if the f/w ctl\r
   interface is supported.\r
 **/\r
RETURN_STATUS\r
EFIAPI\r
BhyveFwCtlInitialize (\r
  VOID\r
  )\r
{\r
  UINT32  i;\r
  UINT8   ch;\r
\r
  DEBUG ((DEBUG_INFO, "FwCtlInitialize\n"));\r
\r
  IoWrite16 (FW_PORT, 0x0000);\r
  for (i = 0; i < 4; i++) {\r
    ch = IoRead8 (FW_IPORT);\r
    if (ch != mBhyveSig[i]) {\r
      DEBUG ((DEBUG_INFO, "Host f/w sig mismatch %c/%c\n", ch, mBhyveSig[i]));\r
      return RETURN_SUCCESS;\r
    }\r
  }\r
\r
  mBhyveFwCtlSupported = TRUE;\r
\r
  return RETURN_SUCCESS;\r
}\r