OvmfPkg: Apply uncrustify changes

[mirror_edk2.git] / OvmfPkg / VirtioFsDxe / FuseInit.c

/** @file\r
  FUSE_INIT wrapper for the Virtio Filesystem device.\r
\r
  Copyright (C) 2020, Red Hat, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include "VirtioFsDxe.h"\r
\r
/**\r
  Send a FUSE_INIT request to the Virtio Filesystem device, for starting the\r
  FUSE session.\r
\r
  From virtio-v1.1-cs01-87fa6b5d8155, 5.11.5 Device Initialization: "On\r
  initialization the driver first discovers the device's virtqueues. The FUSE\r
  session is started by sending a FUSE_INIT request as defined by the FUSE\r
  protocol on one request virtqueue."\r
\r
  The function may only be called after VirtioFsInit() returns successfully and\r
  before VirtioFsUninit() is called.\r
\r
  @param[in,out] VirtioFs  The Virtio Filesystem device to send the FUSE_INIT\r
                           request to. The FUSE request counter\r
                           "VirtioFs->RequestId" is set to 1 on output. The\r
                           maximum write buffer size exposed in the FUSE_INIT\r
                           response is saved in "VirtioFs->MaxWrite", on\r
                           output.\r
\r
  @retval EFI_SUCCESS      The FUSE session has been started.\r
\r
  @retval EFI_UNSUPPORTED  FUSE interface version or feature negotiation\r
                           failed.\r
\r
  @return                  The "errno" value mapped to an EFI_STATUS code, if\r
                           the Virtio Filesystem device explicitly reported an\r
                           error.\r
\r
  @return                  Error codes propagated from\r
                           VirtioFsSgListsValidate(), VirtioFsFuseNewRequest(),\r
                           VirtioFsSgListsSubmit(),\r
                           VirtioFsFuseCheckResponse().\r
**/\r
EFI_STATUS\r
VirtioFsFuseInitSession (\r
  IN OUT VIRTIO_FS  *VirtioFs\r
  )\r
{\r
  VIRTIO_FS_FUSE_REQUEST         CommonReq;\r
  VIRTIO_FS_FUSE_INIT_REQUEST    InitReq;\r
  VIRTIO_FS_IO_VECTOR            ReqIoVec[2];\r
  VIRTIO_FS_SCATTER_GATHER_LIST  ReqSgList;\r
  VIRTIO_FS_FUSE_RESPONSE        CommonResp;\r
  VIRTIO_FS_FUSE_INIT_RESPONSE   InitResp;\r
  VIRTIO_FS_IO_VECTOR            RespIoVec[2];\r
  VIRTIO_FS_SCATTER_GATHER_LIST  RespSgList;\r
  EFI_STATUS                     Status;\r
\r
  //\r
  // Initialize the FUSE request counter.\r
  //\r
  VirtioFs->RequestId = 1;\r
\r
  //\r
  // Set up the scatter-gather lists.\r
  //\r
  ReqIoVec[0].Buffer = &CommonReq;\r
  ReqIoVec[0].Size   = sizeof CommonReq;\r
  ReqIoVec[1].Buffer = &InitReq;\r
  ReqIoVec[1].Size   = sizeof InitReq;\r
  ReqSgList.IoVec    = ReqIoVec;\r
  ReqSgList.NumVec   = ARRAY_SIZE (ReqIoVec);\r
\r
  RespIoVec[0].Buffer = &CommonResp;\r
  RespIoVec[0].Size   = sizeof CommonResp;\r
  RespIoVec[1].Buffer = &InitResp;\r
  RespIoVec[1].Size   = sizeof InitResp;\r
  RespSgList.IoVec    = RespIoVec;\r
  RespSgList.NumVec   = ARRAY_SIZE (RespIoVec);\r
\r
  //\r
  // Validate the scatter-gather lists; calculate the total transfer sizes.\r
  //\r
  Status = VirtioFsSgListsValidate (VirtioFs, &ReqSgList, &RespSgList);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Populate the common request header.\r
  //\r
  Status = VirtioFsFuseNewRequest (\r
             VirtioFs,\r
             &CommonReq,\r
             ReqSgList.TotalSize,\r
             VirtioFsFuseOpInit,\r
             0\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Populate the FUSE_INIT-specific fields.\r
  //\r
  InitReq.Major        = VIRTIO_FS_FUSE_MAJOR;\r
  InitReq.Minor        = VIRTIO_FS_FUSE_MINOR;\r
  InitReq.MaxReadahead = 0;\r
  InitReq.Flags        = VIRTIO_FS_FUSE_INIT_REQ_F_DO_READDIRPLUS;\r
\r
  //\r
  // Submit the request.\r
  //\r
  Status = VirtioFsSgListsSubmit (VirtioFs, &ReqSgList, &RespSgList);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Verify the response (all response buffers are fixed size).\r
  //\r
  Status = VirtioFsFuseCheckResponse (&RespSgList, CommonReq.Unique, NULL);\r
  if (EFI_ERROR (Status)) {\r
    if (Status == EFI_DEVICE_ERROR) {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "%a: Label=\"%s\" Errno=%d\n",\r
        __FUNCTION__,\r
        VirtioFs->Label,\r
        CommonResp.Error\r
        ));\r
      Status = VirtioFsErrnoToEfiStatus (CommonResp.Error);\r
    }\r
\r
    return Status;\r
  }\r
\r
  //\r
  // Check FUSE interface version / feature compatibility.\r
  //\r
  if ((InitResp.Major < InitReq.Major) ||\r
      ((InitResp.Major == InitReq.Major) && (InitResp.Minor < InitReq.Minor)) ||\r
      ((InitResp.Flags & VIRTIO_FS_FUSE_INIT_REQ_F_DO_READDIRPLUS) == 0) ||\r
      (InitResp.MaxWrite < SIZE_4KB))\r
  {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Save the maximum write buffer size for FUSE_WRITE requests.\r
  //\r
  VirtioFs->MaxWrite = InitResp.MaxWrite;\r
  return EFI_SUCCESS;\r
}\r