1. Correct File header to ## @file 2. Remove unnecessary .common] postfix on section.

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

/*++\r
\r
Copyright (c) 2005 - 2009, Intel Corporation\r
All rights reserved. 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
Module Name:\r
\r
  open.c\r
\r
Abstract:\r
\r
  Routines dealing with file open\r
\r
Revision History\r
\r
--*/\r
\r
#include "Fat.h"\r
\r
EFI_STATUS\r
FatAllocateIFile (\r
  IN FAT_OFILE    *OFile,\r
  OUT FAT_IFILE   **PtrIFile\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Create an Open instance for the existing OFile.\r
  The IFile of the newly opened file is passed out.\r
\r
Arguments:\r
\r
  OFile                 - The file that serves as a starting reference point.\r
  PtrIFile              - The newly generated IFile instance.\r
\r
Returns:\r
\r
  EFI_OUT_OF_RESOURCES  - Can not allocate the memory for the IFile\r
  EFI_SUCCESS           - Create the new IFile for the OFile successfully\r
\r
--*/\r
{\r
  FAT_IFILE *IFile;\r
\r
  ASSERT_VOLUME_LOCKED (OFile->Volume);\r
\r
  //\r
  // Allocate a new open instance\r
  //\r
  IFile = AllocateZeroPool (sizeof (FAT_IFILE));\r
  if (IFile == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  IFile->Signature = FAT_IFILE_SIGNATURE;\r
\r
  CopyMem (&(IFile->Handle), &FatFileInterface, sizeof (EFI_FILE_PROTOCOL));\r
\r
  IFile->OFile = OFile;\r
  InsertTailList (&OFile->Opens, &IFile->Link);\r
\r
  *PtrIFile = IFile;\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
FatOFileOpen (\r
  IN  FAT_OFILE            *OFile,\r
  OUT FAT_IFILE            **NewIFile,\r
  IN  CHAR16               *FileName,\r
  IN  UINT64               OpenMode,\r
  IN  UINT8                Attributes\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Open a file for a file name relative to an existing OFile.\r
  The IFile of the newly opened file is passed out.\r
\r
Arguments:\r
\r
  OFile                 - The file that serves as a starting reference point.\r
  NewIFile              - The newly generated IFile instance.\r
  FileName              - The file name relative to the OFile.\r
  OpenMode              - Open mode.\r
  Attributes            - Attributes to set if the file is created.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Open the file successfully.\r
  EFI_INVALID_PARAMETER - The open mode is conflict with the attributes\r
                          or the file name is not valid.\r
  EFI_NOT_FOUND         - Conficts between dir intention and attribute.\r
  EFI_WRITE_PROTECTED   - Can't open for write if the volume is read only.\r
  EFI_ACCESS_DENIED     - If the file's attribute is read only, and the\r
                          open is for read-write fail it.\r
  EFI_OUT_OF_RESOURCES  - Can not allocate the memory.\r
\r
--*/\r
{\r
  FAT_VOLUME  *Volume;\r
  EFI_STATUS  Status;\r
  CHAR16      NewFileName[EFI_PATH_STRING_LENGTH];\r
  FAT_DIRENT  *DirEnt;\r
  UINT8       FileAttributes;\r
  BOOLEAN     WriteMode;\r
\r
  Volume = OFile->Volume;\r
  ASSERT_VOLUME_LOCKED (Volume);\r
  WriteMode = (BOOLEAN) (OpenMode & EFI_FILE_MODE_WRITE);\r
  if (Volume->ReadOnly && WriteMode) {\r
    return EFI_WRITE_PROTECTED;\r
  }\r
  //\r
  // Verify the source file handle isn't in an error state\r
  //\r
  Status = OFile->Error;\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  //\r
  // Get new OFile for the file\r
  //\r
  Status = FatLocateOFile (&OFile, FileName, Attributes, NewFileName);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (*NewFileName != 0) {\r
    //\r
    // If there's a remaining part of the name, then we had\r
    // better be creating the file in the directory\r
    //\r
    if ((OpenMode & EFI_FILE_MODE_CREATE) == 0) {\r
      return EFI_NOT_FOUND;\r
    }\r
\r
    Status = FatCreateDirEnt (OFile, NewFileName, Attributes, &DirEnt);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    Status = FatOpenDirEnt (OFile, DirEnt);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    OFile = DirEnt->OFile;\r
    if (OFile->ODir != NULL) {\r
      //\r
      // If we just created a directory, we need to create "." and ".."\r
      //\r
      Status = FatCreateDotDirEnts (OFile);\r
      if (EFI_ERROR (Status)) {\r
        return Status;\r
      }\r
    }\r
  }\r
  //\r
  // If the file's attribute is read only, and the open is for\r
  // read-write, then the access is denied.\r
  //\r
  FileAttributes = OFile->DirEnt->Entry.Attributes;\r
  if ((FileAttributes & EFI_FILE_READ_ONLY) != 0 && (FileAttributes & FAT_ATTRIBUTE_DIRECTORY) == 0 && WriteMode) {\r
    return EFI_ACCESS_DENIED;\r
  }\r
  //\r
  // Create an open instance of the OFile\r
  //\r
  Status = FatAllocateIFile (OFile, NewIFile);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  (*NewIFile)->ReadOnly = (BOOLEAN)!WriteMode;\r
\r
  DEBUG ((EFI_D_INFO, "FSOpen: Open '%S' %r\n", FileName, Status));\r
  return FatOFileFlush (OFile);\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
FatOpen (\r
  IN  EFI_FILE_PROTOCOL   *FHand,\r
  OUT EFI_FILE_PROTOCOL   **NewHandle,\r
  IN  CHAR16              *FileName,\r
  IN  UINT64              OpenMode,\r
  IN  UINT64              Attributes\r
  )\r
/*++\r
Routine Description:\r
\r
  Implements Open() of Simple File System Protocol.\r
\r
Arguments:\r
\r
  FHand                 - File handle of the file serves as a starting reference point.\r
  NewHandle             - Handle of the file that is newly opened.\r
  FileName              - File name relative to FHand.\r
  OpenMode              - Open mode.\r
  Attributes            - Attributes to set if the file is created.\r
\r
Returns:\r
\r
  EFI_INVALID_PARAMETER - The FileName is NULL or the file string is empty.\r
                          The OpenMode is not supported.\r
                          The Attributes is not the valid attributes.\r
  EFI_OUT_OF_RESOURCES  - Can not allocate the memory for file string.\r
  EFI_SUCCESS           - Open the file successfully.\r
  Others                - The status of open file.\r
\r
--*/\r
{\r
  FAT_IFILE   *IFile;\r
  FAT_IFILE   *NewIFile;\r
  FAT_OFILE   *OFile;\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Perform some parameter checking\r
  //\r
  if (FileName == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  //\r
  // Check for a valid mode\r
  //\r
  switch (OpenMode) {\r
  case EFI_FILE_MODE_READ:\r
  case EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE:\r
  case EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE | EFI_FILE_MODE_CREATE:\r
    break;\r
\r
  default:\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  //\r
  // Check for valid Attributes for file creation case. \r
  //\r
  if (((OpenMode & EFI_FILE_MODE_CREATE) != 0) && (Attributes & (EFI_FILE_READ_ONLY | (~EFI_FILE_VALID_ATTR))) != 0) {\r
	return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  IFile = IFILE_FROM_FHAND (FHand);\r
  OFile = IFile->OFile;\r
\r
  //\r
  // Lock\r
  //\r
  FatAcquireLock ();\r
\r
  //\r
  // Open the file\r
  //\r
  Status = FatOFileOpen (OFile, &NewIFile, FileName, OpenMode, (UINT8) Attributes);\r
\r
  //\r
  // If the file was opened, return the handle to the caller\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    *NewHandle = &NewIFile->Handle;\r
  }\r
  //\r
  // Unlock\r
  //\r
  Status = FatCleanupVolume (OFile->Volume, NULL, Status);\r
  FatReleaseLock ();\r
\r
  return Status;\r
}\r