FatPkg/EnhancedFatDxe: Make the comments align with EDKIIcoding style

[mirror_edk2.git] / FatPkg / EnhancedFatDxe / OpenVolume.c

/** @file\r
  OpenVolume() function of Simple File System Protocol.\r
\r
Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available\r
under the terms and conditions of the BSD License which accompanies this\r
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 "Fat.h"\r
\r
/**\r
\r
  Implements Simple File System Protocol interface function OpenVolume().\r
\r
  @param  This                  - Calling context.\r
  @param  File                  - the Root Directory of the volume.\r
\r
  @retval EFI_OUT_OF_RESOURCES  - Can not allocate the memory.\r
  @retval EFI_VOLUME_CORRUPTED  - The FAT type is error.\r
  @retval EFI_SUCCESS           - Open the volume successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatOpenVolume (\r
  IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *This,\r
  OUT EFI_FILE_PROTOCOL                **File\r
  )\r
{\r
  EFI_STATUS  Status;\r
  FAT_VOLUME  *Volume;\r
  FAT_IFILE   *IFile;\r
\r
  Volume = VOLUME_FROM_VOL_INTERFACE (This);\r
  FatAcquireLock ();\r
\r
  //\r
  // Open Root file\r
  //\r
  Status = FatOpenDirEnt (NULL, &Volume->RootDirEnt);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
  //\r
  // Open a new instance to the root\r
  //\r
  Status = FatAllocateIFile (Volume->Root, &IFile);\r
  if (!EFI_ERROR (Status)) {\r
    *File = &IFile->Handle;\r
  }\r
\r
Done:\r
\r
  Status = FatCleanupVolume (Volume, Volume->Root, Status, NULL);\r
  FatReleaseLock ();\r
\r
  return Status;\r
}\r