]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/PvScsiDxe/PvScsi.c
OvmfPkg/PvScsiDxe: Backup/Restore PCI attributes on Init/UnInit
[mirror_edk2.git] / OvmfPkg / PvScsiDxe / PvScsi.c
index 1ae4de9869c1e3e7e7b4926caa522b4ff744fcb3..5566b4cce46725743ce2f2aa2981278a5ceac06c 100644 (file)
@@ -9,8 +9,626 @@
 \r
 **/\r
 \r
+#include <IndustryStandard/Pci.h>\r
+#include <IndustryStandard/PvScsi.h>\r
+#include <Library/BaseMemoryLib.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 utilities\r
+//\r
+\r
+/**\r
+  Check if Target argument to EXT_SCSI_PASS_THRU.GetNextTarget() and\r
+  EXT_SCSI_PASS_THRU.GetNextTargetLun() is initialized\r
+**/\r
+STATIC\r
+BOOLEAN\r
+IsTargetInitialized (\r
+  IN UINT8                                          *Target\r
+  )\r
+{\r
+  UINTN Idx;\r
+\r
+  for (Idx = 0; Idx < TARGET_MAX_BYTES; ++Idx) {\r
+    if (Target[Idx] != 0xFF) {\r
+      return TRUE;\r
+    }\r
+  }\r
+  return FALSE;\r
+}\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
+  UINT8      *TargetPtr;\r
+  UINT8      LastTarget;\r
+  PVSCSI_DEV *Dev;\r
+\r
+  if (Target == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // The Target input parameter is unnecessarily a pointer-to-pointer\r
+  //\r
+  TargetPtr = *Target;\r
+\r
+  //\r
+  // If target not initialized, return first target & LUN\r
+  //\r
+  if (!IsTargetInitialized (TargetPtr)) {\r
+    ZeroMem (TargetPtr, TARGET_MAX_BYTES);\r
+    *Lun = 0;\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  //\r
+  // We only use first byte of target identifer\r
+  //\r
+  LastTarget = *TargetPtr;\r
+\r
+  //\r
+  // Increment (target, LUN) pair if valid on input\r
+  //\r
+  Dev = PVSCSI_FROM_PASS_THRU (This);\r
+  if (LastTarget > Dev->MaxTarget || *Lun > Dev->MaxLun) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (*Lun < Dev->MaxLun) {\r
+    ++*Lun;\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  if (LastTarget < Dev->MaxTarget) {\r
+    *Lun = 0;\r
+    ++LastTarget;\r
+    *TargetPtr = LastTarget;\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  return EFI_NOT_FOUND;\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
+  UINT8             TargetValue;\r
+  PVSCSI_DEV        *Dev;\r
+  SCSI_DEVICE_PATH  *ScsiDevicePath;\r
+\r
+  if (DevicePath == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // We only use first byte of target identifer\r
+  //\r
+  TargetValue = *Target;\r
+\r
+  Dev = PVSCSI_FROM_PASS_THRU (This);\r
+  if (TargetValue > Dev->MaxTarget || Lun > Dev->MaxLun) {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  ScsiDevicePath = AllocatePool (sizeof (*ScsiDevicePath));\r
+  if (ScsiDevicePath == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  ScsiDevicePath->Header.Type      = MESSAGING_DEVICE_PATH;\r
+  ScsiDevicePath->Header.SubType   = MSG_SCSI_DP;\r
+  ScsiDevicePath->Header.Length[0] = (UINT8)sizeof (*ScsiDevicePath);\r
+  ScsiDevicePath->Header.Length[1] = (UINT8)(sizeof (*ScsiDevicePath) >> 8);\r
+  ScsiDevicePath->Pun              = TargetValue;\r
+  ScsiDevicePath->Lun              = (UINT16)Lun;\r
+\r
+  *DevicePath = &ScsiDevicePath->Header;\r
+  return EFI_SUCCESS;\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
+  SCSI_DEVICE_PATH *ScsiDevicePath;\r
+  PVSCSI_DEV       *Dev;\r
+\r
+  if (DevicePath == NULL || Target == NULL || *Target == NULL || Lun == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (DevicePath->Type    != MESSAGING_DEVICE_PATH ||\r
+      DevicePath->SubType != MSG_SCSI_DP) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
+  ScsiDevicePath = (SCSI_DEVICE_PATH *)DevicePath;\r
+  Dev = PVSCSI_FROM_PASS_THRU (This);\r
+  if (ScsiDevicePath->Pun > Dev->MaxTarget ||\r
+      ScsiDevicePath->Lun > Dev->MaxLun) {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  //\r
+  // We only use first byte of target identifer\r
+  //\r
+  **Target = (UINT8)ScsiDevicePath->Pun;\r
+  ZeroMem (*Target + 1, TARGET_MAX_BYTES - 1);\r
+  *Lun = ScsiDevicePath->Lun;\r
+\r
+  return EFI_SUCCESS;\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
+  UINT8      *TargetPtr;\r
+  UINT8      LastTarget;\r
+  PVSCSI_DEV *Dev;\r
+\r
+  if (Target == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // The Target input parameter is unnecessarily a pointer-to-pointer\r
+  //\r
+  TargetPtr = *Target;\r
+\r
+  //\r
+  // If target not initialized, return first target\r
+  //\r
+  if (!IsTargetInitialized (TargetPtr)) {\r
+    ZeroMem (TargetPtr, TARGET_MAX_BYTES);\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  //\r
+  // We only use first byte of target identifer\r
+  //\r
+  LastTarget = *TargetPtr;\r
+\r
+  //\r
+  // Increment target if valid on input\r
+  //\r
+  Dev = PVSCSI_FROM_PASS_THRU (This);\r
+  if (LastTarget > Dev->MaxTarget) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (LastTarget < Dev->MaxTarget) {\r
+    ++LastTarget;\r
+    *TargetPtr = LastTarget;\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  return EFI_NOT_FOUND;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+PvScsiSetPciAttributes (\r
+  IN OUT PVSCSI_DEV *Dev\r
+  )\r
+{\r
+  EFI_STATUS Status;\r
+\r
+  //\r
+  // Backup original PCI Attributes\r
+  //\r
+  Status = Dev->PciIo->Attributes (\r
+                         Dev->PciIo,\r
+                         EfiPciIoAttributeOperationGet,\r
+                         0,\r
+                         &Dev->OriginalPciAttributes\r
+                         );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // TODO: Change PCI Attributes\r
+  //\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+VOID\r
+PvScsiRestorePciAttributes (\r
+  IN PVSCSI_DEV *Dev\r
+  )\r
+{\r
+  Dev->PciIo->Attributes (\r
+                Dev->PciIo,\r
+                EfiPciIoAttributeOperationSet,\r
+                Dev->OriginalPciAttributes,\r
+                NULL\r
+                );\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+PvScsiInit (\r
+  IN OUT PVSCSI_DEV *Dev\r
+  )\r
+{\r
+  EFI_STATUS Status;\r
+\r
+  //\r
+  // Init configuration\r
+  //\r
+  Dev->MaxTarget = PcdGet8 (PcdPvScsiMaxTargetLimit);\r
+  Dev->MaxLun = PcdGet8 (PcdPvScsiMaxLunLimit);\r
+\r
+  //\r
+  // Set PCI Attributes\r
+  //\r
+  Status = PvScsiSetPciAttributes (Dev);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\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
+  PvScsiRestorePciAttributes (Dev);\r
+}\r
+\r
+//\r
+// Driver Binding\r
+//\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiDriverBindingSupported (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  ControllerHandle,\r
+  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL\r
+  )\r
+{\r
+  EFI_STATUS          Status;\r
+  EFI_PCI_IO_PROTOCOL *PciIo;\r
+  PCI_TYPE00          Pci;\r
+\r
+  Status = gBS->OpenProtocol (\r
+                  ControllerHandle,\r
+                  &gEfiPciIoProtocolGuid,\r
+                  (VOID **)&PciIo,\r
+                  This->DriverBindingHandle,\r
+                  ControllerHandle,\r
+                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  Status = PciIo->Pci.Read (\r
+                        PciIo,\r
+                        EfiPciIoWidthUint32,\r
+                        0,\r
+                        sizeof (Pci) / sizeof (UINT32),\r
+                        &Pci\r
+                        );\r
+  if (EFI_ERROR (Status)) {\r
+    goto Done;\r
+  }\r
+\r
+  if ((Pci.Hdr.VendorId != PCI_VENDOR_ID_VMWARE) ||\r
+      (Pci.Hdr.DeviceId != PCI_DEVICE_ID_VMWARE_PVSCSI)) {\r
+    Status = EFI_UNSUPPORTED;\r
+    goto Done;\r
+  }\r
+\r
+  Status = EFI_SUCCESS;\r
+\r
+Done:\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gEfiPciIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
+\r
+  return Status;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiDriverBindingStart (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  ControllerHandle,\r
+  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath OPTIONAL\r
+  )\r
+{\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 = gBS->OpenProtocol (\r
+                  ControllerHandle,\r
+                  &gEfiPciIoProtocolGuid,\r
+                  (VOID **)&Dev->PciIo,\r
+                  This->DriverBindingHandle,\r
+                  ControllerHandle,\r
+                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    goto FreePvScsi;\r
+  }\r
+\r
+  Status = PvScsiInit (Dev);\r
+  if (EFI_ERROR (Status)) {\r
+    goto ClosePciIo;\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
+ClosePciIo:\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gEfiPciIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
+\r
+FreePvScsi:\r
+  FreePool (Dev);\r
+\r
+  return Status;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiDriverBindingStop (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  ControllerHandle,\r
+  IN UINTN                       NumberOfChildren,\r
+  IN EFI_HANDLE                  *ChildHandleBuffer\r
+  )\r
+{\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
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gEfiPciIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
+\r
+  FreePool (Dev);\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+STATIC EFI_DRIVER_BINDING_PROTOCOL mPvScsiDriverBinding = {\r
+  &PvScsiDriverBindingSupported,\r
+  &PvScsiDriverBindingStart,\r
+  &PvScsiDriverBindingStop,\r
+  PVSCSI_BINDING_VERSION,\r
+  NULL, // ImageHandle, filled by EfiLibInstallDriverBindingComponentName2()\r
+  NULL  // DriverBindingHandle, filled as well\r
+};\r
+\r
+//\r
+// Component Name\r
+//\r
+\r
+STATIC EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {\r
+  { "eng;en", L"PVSCSI Host Driver" },\r
+  { NULL,     NULL                  }\r
+};\r
+\r
+STATIC EFI_COMPONENT_NAME_PROTOCOL mComponentName;\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiGetDriverName (\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
+  IN  CHAR8                       *Language,\r
+  OUT CHAR16                      **DriverName\r
+  )\r
+{\r
+  return LookupUnicodeString2 (\r
+           Language,\r
+           This->SupportedLanguages,\r
+           mDriverNameTable,\r
+           DriverName,\r
+           (BOOLEAN)(This == &mComponentName) // Iso639Language\r
+           );\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+PvScsiGetDeviceName (\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL *This,\r
+  IN  EFI_HANDLE                  DeviceHandle,\r
+  IN  EFI_HANDLE                  ChildHandle,\r
+  IN  CHAR8                       *Language,\r
+  OUT CHAR16                      **ControllerName\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+STATIC EFI_COMPONENT_NAME_PROTOCOL mComponentName = {\r
+  &PvScsiGetDriverName,\r
+  &PvScsiGetDeviceName,\r
+  "eng" // SupportedLanguages, ISO 639-2 language codes\r
+};\r
+\r
+STATIC EFI_COMPONENT_NAME2_PROTOCOL mComponentName2 = {\r
+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)     &PvScsiGetDriverName,\r
+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &PvScsiGetDeviceName,\r
+  "en" // SupportedLanguages, RFC 4646 language codes\r
+};\r
+\r
 //\r
 // Entry Point\r
 //\r
@@ -22,5 +640,12 @@ PvScsiEntryPoint (
   IN EFI_SYSTEM_TABLE *SystemTable\r
   )\r
 {\r
-  return EFI_UNSUPPORTED;\r
+  return EfiLibInstallDriverBindingComponentName2 (\r
+           ImageHandle,\r
+           SystemTable,\r
+           &mPvScsiDriverBinding,\r
+           ImageHandle,\r
+           &mComponentName,\r
+           &mComponentName2\r
+           );\r
 }\r