OvmfPkg/PvScsiDxe: Install stubbed EXT_SCSI_PASS_THRU

Support dynamic insertion and removal of the protocol.

Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=2567
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Liran Alon <liran.alon@oracle.com>
Message-Id: <20200328200100.60786-6-liran.alon@oracle.com>
Reviewed-by: Nikita Leshenko <nikita.leshchenko@oracle.com>

diff --git a/OvmfPkg/PvScsiDxe/PvScsi.c b/OvmfPkg/PvScsiDxe/PvScsi.c
index 9923a31d25d7a12c520bbe37255fd9b32a09ccb8..04c08036b799be6adfb74f85ca179a3f98f90061 100644 (file)
--- a/OvmfPkg/PvScsiDxe/PvScsi.c
+++ b/OvmfPkg/PvScsiDxe/PvScsi.c
@@ -11,17 +11,156 @@
 \r
 #include <IndustryStandard/Pci.h>\r
 #include <IndustryStandard/PvScsi.h>\r
+#include <Library/MemoryAllocationLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiLib.h>\r
 #include <Protocol/PciIo.h>\r
 #include <Uefi/UefiSpec.h>\r
 \r
+#include "PvScsi.h"\r
+\r
 //\r
 // Higher versions will be used before lower, 0x10-0xffffffef is the version\r
 // range for IHV (Indie Hardware Vendors)\r
 //\r
 #define PVSCSI_BINDING_VERSION      0x10\r
 \r
+//\r
+// Ext SCSI Pass Thru\r
+//\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiPassThru (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
+  IN UINT8                                          *Target,\r
+  IN UINT64                                         Lun,\r
+  IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
+  IN EFI_EVENT                                      Event    OPTIONAL\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiGetNextTargetLun (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
+  IN OUT UINT8                                      **Target,\r
+  IN OUT UINT64                                     *Lun\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiBuildDevicePath (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
+  IN UINT8                                          *Target,\r
+  IN UINT64                                         Lun,\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL                   **DevicePath\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiGetTargetLun (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
+  IN EFI_DEVICE_PATH_PROTOCOL                       *DevicePath,\r
+  OUT UINT8                                         **Target,\r
+  OUT UINT64                                        *Lun\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiResetChannel (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiResetTargetLun (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
+  IN UINT8                                          *Target,\r
+  IN UINT64                                         Lun\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiGetNextTarget (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
+  IN OUT UINT8                                      **Target\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+PvScsiInit (\r
+  IN OUT PVSCSI_DEV *Dev\r
+  )\r
+{\r
+  //\r
+  // Populate the exported interface's attributes\r
+  //\r
+  Dev->PassThru.Mode             = &Dev->PassThruMode;\r
+  Dev->PassThru.PassThru         = &PvScsiPassThru;\r
+  Dev->PassThru.GetNextTargetLun = &PvScsiGetNextTargetLun;\r
+  Dev->PassThru.BuildDevicePath  = &PvScsiBuildDevicePath;\r
+  Dev->PassThru.GetTargetLun     = &PvScsiGetTargetLun;\r
+  Dev->PassThru.ResetChannel     = &PvScsiResetChannel;\r
+  Dev->PassThru.ResetTargetLun   = &PvScsiResetTargetLun;\r
+  Dev->PassThru.GetNextTarget    = &PvScsiGetNextTarget;\r
+\r
+  //\r
+  // AdapterId is a target for which no handle will be created during bus scan.\r
+  // Prevent any conflict with real devices.\r
+  //\r
+  Dev->PassThruMode.AdapterId = MAX_UINT32;\r
+\r
+  //\r
+  // Set both physical and logical attributes for non-RAID SCSI channel\r
+  //\r
+  Dev->PassThruMode.Attributes = EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL |\r
+                                 EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL;\r
+\r
+  //\r
+  // No restriction on transfer buffer alignment\r
+  //\r
+  Dev->PassThruMode.IoAlign = 0;\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+VOID\r
+PvScsiUninit (\r
+  IN OUT PVSCSI_DEV *Dev\r
+  )\r
+{\r
+  // Currently nothing to do here\r
+}\r
+\r
 //\r
 // Driver Binding\r
 //\r
@@ -90,7 +229,42 @@ PvScsiDriverBindingStart (
   IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
-  return EFI_UNSUPPORTED;\r
+  PVSCSI_DEV *Dev;\r
+  EFI_STATUS Status;\r
+\r
+  Dev = (PVSCSI_DEV *) AllocateZeroPool (sizeof (*Dev));\r
+  if (Dev == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  Status = PvScsiInit (Dev);\r
+  if (EFI_ERROR (Status)) {\r
+    goto FreePvScsi;\r
+  }\r
+\r
+  //\r
+  // Setup complete, attempt to export the driver instance's PassThru interface\r
+  //\r
+  Dev->Signature = PVSCSI_SIG;\r
+  Status = gBS->InstallProtocolInterface (\r
+                  &ControllerHandle,\r
+                  &gEfiExtScsiPassThruProtocolGuid,\r
+                  EFI_NATIVE_INTERFACE,\r
+                  &Dev->PassThru\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    goto UninitDev;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+\r
+UninitDev:\r
+  PvScsiUninit (Dev);\r
+\r
+FreePvScsi:\r
+  FreePool (Dev);\r
+\r
+  return Status;\r
 }\r
 \r
 STATIC\r
@@ -103,7 +277,38 @@ PvScsiDriverBindingStop (
   IN EFI_HANDLE                  *ChildHandleBuffer\r
   )\r
 {\r
-  return EFI_UNSUPPORTED;\r
+  EFI_STATUS                      Status;\r
+  EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru;\r
+  PVSCSI_DEV                      *Dev;\r
+\r
+  Status = gBS->OpenProtocol (\r
+                  ControllerHandle,\r
+                  &gEfiExtScsiPassThruProtocolGuid,\r
+                  (VOID **)&PassThru,\r
+                  This->DriverBindingHandle,\r
+                  ControllerHandle,\r
+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL // Lookup only\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  Dev = PVSCSI_FROM_PASS_THRU (PassThru);\r
+\r
+  Status = gBS->UninstallProtocolInterface (\r
+                  ControllerHandle,\r
+                  &gEfiExtScsiPassThruProtocolGuid,\r
+                  &Dev->PassThru\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  PvScsiUninit (Dev);\r
+\r
+  FreePool (Dev);\r
+\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 STATIC EFI_DRIVER_BINDING_PROTOCOL mPvScsiDriverBinding = {\r

diff --git a/OvmfPkg/PvScsiDxe/PvScsi.h b/OvmfPkg/PvScsiDxe/PvScsi.h
new file mode 100644 (file)
index 0000000..3940b4c
--- /dev/null
+++ b/OvmfPkg/PvScsiDxe/PvScsi.h
@@ -0,0 +1,29 @@
+/** @file\r
+\r
+  Internal definitions for the PVSCSI driver, which produces Extended SCSI\r
+  Pass Thru Protocol instances for pvscsi devices.\r
+\r
+  Copyright (C) 2020, Oracle and/or its affiliates.\r
+\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#ifndef __PVSCSI_DXE_H_\r
+#define __PVSCSI_DXE_H_\r
+\r
+#include <Library/DebugLib.h>\r
+#include <Protocol/ScsiPassThruExt.h>\r
+\r
+#define PVSCSI_SIG SIGNATURE_32 ('P', 'S', 'C', 'S')\r
+\r
+typedef struct {\r
+  UINT32                          Signature;\r
+  EFI_EXT_SCSI_PASS_THRU_PROTOCOL PassThru;\r
+  EFI_EXT_SCSI_PASS_THRU_MODE     PassThruMode;\r
+} PVSCSI_DEV;\r
+\r
+#define PVSCSI_FROM_PASS_THRU(PassThruPointer) \\r
+  CR (PassThruPointer, PVSCSI_DEV, PassThru, PVSCSI_SIG)\r
+\r
+#endif // __PVSCSI_DXE_H_\r

diff --git a/OvmfPkg/PvScsiDxe/PvScsiDxe.inf b/OvmfPkg/PvScsiDxe/PvScsiDxe.inf
index c1f0663832eda13e602bbb7e8eaf12c57fe480bc..f4d452c6c3d2fe804626be8d8968efc09d392e07 100644 (file)
--- a/OvmfPkg/PvScsiDxe/PvScsiDxe.inf
+++ b/OvmfPkg/PvScsiDxe/PvScsiDxe.inf
@@ -19,15 +19,19 @@
 \r
 [Sources]\r
   PvScsi.c\r
+  PvScsi.h\r
 \r
 [Packages]\r
   MdePkg/MdePkg.dec\r
   OvmfPkg/OvmfPkg.dec\r
 \r
 [LibraryClasses]\r
+  DebugLib\r
+  MemoryAllocationLib\r
   UefiBootServicesTableLib\r
   UefiDriverEntryPoint\r
   UefiLib\r
 \r
 [Protocols]\r
-  gEfiPciIoProtocolGuid        ## TO_START\r
+  gEfiExtScsiPassThruProtocolGuid   ## BY_START\r
+  gEfiPciIoProtocolGuid             ## TO_START\r