MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UdfDxe / Udf.c

/** @file\r
  UDF/ECMA-167 file system driver.\r
\r
  Copyright (C) 2014-2017 Paulo Alcantara <pcacjr@zytor.com>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include "Udf.h"\r
\r
//\r
// UDF filesystem driver's Global Variables.\r
//\r
EFI_DRIVER_BINDING_PROTOCOL gUdfDriverBinding = {\r
  UdfDriverBindingSupported,\r
  UdfDriverBindingStart,\r
  UdfDriverBindingStop,\r
  0x10,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL gUdfSimpleFsTemplate = {\r
  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION,\r
  UdfOpenVolume\r
};\r
\r
/**\r
  Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
  than contains a BlockIo and DiskIo protocol or a BlockIo2 protocol can be\r
  supported.\r
\r
  @param[in]  This                Protocol instance pointer.\r
  @param[in]  ControllerHandle    Handle of device to test.\r
  @param[in]  RemainingDevicePath Optional parameter use to pick a specific\r
                                  child device to start.\r
\r
  @retval EFI_SUCCESS         This driver supports this device.\r
  @retval EFI_ALREADY_STARTED This driver is already running on this device.\r
  @retval other               This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS            Status;\r
  EFI_DISK_IO_PROTOCOL  *DiskIo;\r
\r
  //\r
  // Open DiskIo protocol on ControllerHandle\r
  //\r
  Status = gBS->OpenProtocol (\r
    ControllerHandle,\r
    &gEfiDiskIoProtocolGuid,\r
    (VOID **)&DiskIo,\r
    This->DriverBindingHandle,\r
    ControllerHandle,\r
    EFI_OPEN_PROTOCOL_BY_DRIVER\r
    );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Close DiskIo protocol on ControllerHandle\r
  //\r
  gBS->CloseProtocol (\r
    ControllerHandle,\r
    &gEfiDiskIoProtocolGuid,\r
    This->DriverBindingHandle,\r
    ControllerHandle\r
    );\r
\r
  //\r
  // Test whether ControllerHandle supports BlockIo protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
    ControllerHandle,\r
    &gEfiBlockIoProtocolGuid,\r
    NULL,\r
    This->DriverBindingHandle,\r
    ControllerHandle,\r
    EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
    );\r
\r
  return Status;\r
}\r
\r
/**\r
  Start this driver on ControllerHandle by opening a Block IO or a Block IO2\r
  or both, and Disk IO protocol, reading Device Path, and creating a child\r
  handle with a Disk IO and device path protocol.\r
\r
  @param[in]  This                 Protocol instance pointer.\r
  @param[in]  ControllerHandle     Handle of device to bind driver to\r
  @param[in]  RemainingDevicePath  Optional parameter use to pick a specific\r
                                   child device to start.\r
\r
  @retval EFI_SUCCESS          This driver is added to ControllerHandle.\r
  @retval EFI_ALREADY_STARTED  This driver is already running on\r
                               ControllerHandle.\r
  @retval other                This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  EFI_TPL                     OldTpl;\r
  EFI_STATUS                  Status;\r
  EFI_BLOCK_IO_PROTOCOL       *BlockIo;\r
  EFI_DISK_IO_PROTOCOL        *DiskIo;\r
  PRIVATE_UDF_SIMPLE_FS_DATA  *PrivFsData;\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  //\r
  // Open BlockIo protocol on ControllerHandle\r
  //\r
  Status = gBS->OpenProtocol (\r
    ControllerHandle,\r
    &gEfiBlockIoProtocolGuid,\r
    (VOID **)&BlockIo,\r
    This->DriverBindingHandle,\r
    ControllerHandle,\r
    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Open DiskIo protocol on ControllerHandle\r
  //\r
  Status = gBS->OpenProtocol (\r
    ControllerHandle,\r
    &gEfiDiskIoProtocolGuid,\r
    (VOID **)&DiskIo,\r
    This->DriverBindingHandle,\r
    ControllerHandle,\r
    EFI_OPEN_PROTOCOL_BY_DRIVER\r
    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Check if ControllerHandle supports an UDF file system\r
  //\r
  Status = SupportUdfFileSystem (This, ControllerHandle);\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  //\r
  // Initialize private file system structure\r
  //\r
  PrivFsData =\r
    (PRIVATE_UDF_SIMPLE_FS_DATA *)\r
    AllocateZeroPool (sizeof (PRIVATE_UDF_SIMPLE_FS_DATA));\r
  if (PrivFsData == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Exit;\r
  }\r
\r
  //\r
  // Create new child handle\r
  //\r
  PrivFsData->Signature = PRIVATE_UDF_SIMPLE_FS_DATA_SIGNATURE;\r
  PrivFsData->BlockIo   = BlockIo;\r
  PrivFsData->DiskIo    = DiskIo;\r
  PrivFsData->Handle    = ControllerHandle;\r
\r
  //\r
  // Set up SimpleFs protocol\r
  //\r
  CopyMem ((VOID *)&PrivFsData->SimpleFs, (VOID *)&gUdfSimpleFsTemplate,\r
           sizeof (EFI_SIMPLE_FILE_SYSTEM_PROTOCOL));\r
\r
  //\r
  // Install child handle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
    &PrivFsData->Handle,\r
    &gEfiSimpleFileSystemProtocolGuid,\r
    &PrivFsData->SimpleFs,\r
    NULL\r
    );\r
\r
Exit:\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Close DiskIo protocol on ControllerHandle\r
    //\r
    gBS->CloseProtocol (\r
      ControllerHandle,\r
      &gEfiDiskIoProtocolGuid,\r
      This->DriverBindingHandle,\r
      ControllerHandle\r
      );\r
    //\r
    // Close BlockIo protocol on ControllerHandle\r
    //\r
    gBS->CloseProtocol (\r
      ControllerHandle,\r
      &gEfiBlockIoProtocolGuid,\r
      This->DriverBindingHandle,\r
      ControllerHandle\r
      );\r
  }\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle. Support stopping any child handles\r
  created by this driver.\r
\r
  @param  This              Protocol instance pointer.\r
  @param  ControllerHandle  Handle of device to stop driver on\r
  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                            children is zero stop the entire bus driver.\r
  @param  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
  @retval other             This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  IN  EFI_HANDLE                    ControllerHandle,\r
  IN  UINTN                         NumberOfChildren,\r
  IN  EFI_HANDLE                    *ChildHandleBuffer\r
  )\r
{\r
  PRIVATE_UDF_SIMPLE_FS_DATA        *PrivFsData;\r
  EFI_STATUS                        Status;\r
  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   *SimpleFs;\r
\r
  //\r
  // Open SimpleFs protocol on ControllerHandle\r
  //\r
  Status = gBS->OpenProtocol (\r
    ControllerHandle,\r
    &gEfiSimpleFileSystemProtocolGuid,\r
    (VOID **)&SimpleFs,\r
    This->DriverBindingHandle,\r
    ControllerHandle,\r
    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
    );\r
  if (!EFI_ERROR (Status)) {\r
    PrivFsData = PRIVATE_UDF_SIMPLE_FS_DATA_FROM_THIS (SimpleFs);\r
\r
    //\r
    // Uninstall child handle\r
    //\r
    Status = gBS->UninstallMultipleProtocolInterfaces (\r
      PrivFsData->Handle,\r
      &gEfiSimpleFileSystemProtocolGuid,\r
      &PrivFsData->SimpleFs,\r
      NULL\r
      );\r
\r
    FreePool ((VOID *)PrivFsData);\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Close DiskIo protocol on ControllerHandle\r
    //\r
    gBS->CloseProtocol (\r
      ControllerHandle,\r
      &gEfiDiskIoProtocolGuid,\r
      This->DriverBindingHandle,\r
      ControllerHandle\r
      );\r
    //\r
    // Close BlockIo protocol on ControllerHandle\r
    //\r
    gBS->CloseProtocol (\r
      ControllerHandle,\r
      &gEfiBlockIoProtocolGuid,\r
      This->DriverBindingHandle,\r
      ControllerHandle\r
      );\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  The user Entry Point for UDF file system driver. The user code starts with\r
  this function.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.\r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeUdf (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS              Status;\r
\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
    ImageHandle,\r
    SystemTable,\r
    &gUdfDriverBinding,\r
    ImageHandle,\r
    &gUdfComponentName,\r
    &gUdfComponentName2\r
    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r