]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/MptScsiDxe/MptScsi.c
OvmfPkg/MptScsiDxe: Build and decode DevicePath
[mirror_edk2.git] / OvmfPkg / MptScsiDxe / MptScsi.c
index c6c8142dfde666e001bb639608c86d56604c9797..66d57f1c85d877b21b944c54abe6c5004dea0954 100644 (file)
@@ -9,8 +9,463 @@
 \r
 **/\r
 \r
+#include <IndustryStandard/FusionMptScsi.h>\r
+#include <IndustryStandard/Pci.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/UefiLib.h>\r
+#include <Protocol/PciIo.h>\r
+#include <Protocol/ScsiPassThruExt.h>\r
 #include <Uefi/UefiSpec.h>\r
 \r
+//\r
+// Higher versions will be used before lower, 0x10-0xffffffef is the version\r
+// range for IVH (Indie Hardware Vendors)\r
+//\r
+#define MPT_SCSI_BINDING_VERSION 0x10\r
+\r
+//\r
+// Runtime Structures\r
+//\r
+\r
+#define MPT_SCSI_DEV_SIGNATURE SIGNATURE_32 ('M','P','T','S')\r
+typedef struct {\r
+  UINT32                          Signature;\r
+  EFI_EXT_SCSI_PASS_THRU_PROTOCOL PassThru;\r
+  EFI_EXT_SCSI_PASS_THRU_MODE     PassThruMode;\r
+  UINT8                           MaxTarget;\r
+} MPT_SCSI_DEV;\r
+\r
+#define MPT_SCSI_FROM_PASS_THRU(PassThruPtr) \\r
+  CR (PassThruPtr, MPT_SCSI_DEV, PassThru, MPT_SCSI_DEV_SIGNATURE)\r
+\r
+//\r
+// Ext SCSI Pass Thru\r
+//\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiPassThru (\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
+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
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiGetNextTargetLun (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
+  IN OUT UINT8                                      **Target,\r
+  IN OUT UINT64                                     *Lun\r
+  )\r
+{\r
+  MPT_SCSI_DEV *Dev;\r
+\r
+  Dev = MPT_SCSI_FROM_PASS_THRU (This);\r
+  //\r
+  // Currently support only LUN 0, so hardcode it\r
+  //\r
+  if (!IsTargetInitialized (*Target)) {\r
+    ZeroMem (*Target, TARGET_MAX_BYTES);\r
+    *Lun = 0;\r
+  } else if (**Target > Dev->MaxTarget || *Lun > 0) {\r
+    return EFI_INVALID_PARAMETER;\r
+  } else if (**Target < Dev->MaxTarget) {\r
+    //\r
+    // This device interface support 256 targets only, so it's enough to\r
+    // increment the LSB of Target, as it will never overflow.\r
+    //\r
+    **Target += 1;\r
+  } else {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiGetNextTarget (\r
+  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL               *This,\r
+  IN OUT UINT8                                     **Target\r
+  )\r
+{\r
+  MPT_SCSI_DEV *Dev;\r
+\r
+  Dev = MPT_SCSI_FROM_PASS_THRU (This);\r
+  if (!IsTargetInitialized (*Target)) {\r
+    ZeroMem (*Target, TARGET_MAX_BYTES);\r
+  } else if (**Target > Dev->MaxTarget) {\r
+    return EFI_INVALID_PARAMETER;\r
+  } else if (**Target < Dev->MaxTarget) {\r
+    //\r
+    // This device interface support 256 targets only, so it's enough to\r
+    // increment the LSB of Target, as it will never overflow.\r
+    //\r
+    **Target += 1;\r
+  } else {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiBuildDevicePath (\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
+  MPT_SCSI_DEV     *Dev;\r
+  SCSI_DEVICE_PATH *ScsiDevicePath;\r
+\r
+  if (DevicePath == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // This device support 256 targets only, so it's enough to dereference\r
+  // the LSB of Target.\r
+  //\r
+  Dev = MPT_SCSI_FROM_PASS_THRU (This);\r
+  if (*Target > Dev->MaxTarget || Lun > 0) {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  ScsiDevicePath = AllocateZeroPool (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              = *Target;\r
+  ScsiDevicePath->Lun              = (UINT16)Lun;\r
+\r
+  *DevicePath = &ScsiDevicePath->Header;\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiGetTargetLun (\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
+  MPT_SCSI_DEV     *Dev;\r
+  SCSI_DEVICE_PATH *ScsiDevicePath;\r
+\r
+  if (DevicePath == NULL ||\r
+      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
+  Dev = MPT_SCSI_FROM_PASS_THRU (This);\r
+  ScsiDevicePath = (SCSI_DEVICE_PATH *)DevicePath;\r
+  if (ScsiDevicePath->Pun > Dev->MaxTarget ||\r
+      ScsiDevicePath->Lun > 0) {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  ZeroMem (*Target, TARGET_MAX_BYTES);\r
+  //\r
+  // This device support 256 targets only, so it's enough to set the LSB\r
+  // of Target.\r
+  //\r
+  **Target = (UINT8)ScsiDevicePath->Pun;\r
+  *Lun = ScsiDevicePath->Lun;\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiResetChannel (\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
+MptScsiResetTargetLun (\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
+//\r
+// Driver Binding\r
+//\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiControllerSupported (\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 == LSI_LOGIC_PCI_VENDOR_ID &&\r
+      (Pci.Hdr.DeviceId == LSI_53C1030_PCI_DEVICE_ID ||\r
+       Pci.Hdr.DeviceId == LSI_SAS1068_PCI_DEVICE_ID ||\r
+       Pci.Hdr.DeviceId == LSI_SAS1068E_PCI_DEVICE_ID)) {\r
+    Status = EFI_SUCCESS;\r
+  } else {\r
+    Status = EFI_UNSUPPORTED;\r
+  }\r
+\r
+Done:\r
+  gBS->CloseProtocol (\r
+         ControllerHandle,\r
+         &gEfiPciIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         ControllerHandle\r
+         );\r
+  return Status;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiControllerStart (\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
+  MPT_SCSI_DEV         *Dev;\r
+\r
+  Dev = AllocateZeroPool (sizeof (*Dev));\r
+  if (Dev == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  Dev->Signature = MPT_SCSI_DEV_SIGNATURE;\r
+\r
+  Dev->MaxTarget = PcdGet8 (PcdMptScsiMaxTargetLimit);\r
+\r
+  //\r
+  // Host adapter channel, doesn't exist\r
+  //\r
+  Dev->PassThruMode.AdapterId = MAX_UINT32;\r
+  Dev->PassThruMode.Attributes =\r
+    EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL |\r
+    EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL;\r
+\r
+  Dev->PassThru.Mode = &Dev->PassThruMode;\r
+  Dev->PassThru.PassThru = &MptScsiPassThru;\r
+  Dev->PassThru.GetNextTargetLun = &MptScsiGetNextTargetLun;\r
+  Dev->PassThru.BuildDevicePath = &MptScsiBuildDevicePath;\r
+  Dev->PassThru.GetTargetLun = &MptScsiGetTargetLun;\r
+  Dev->PassThru.ResetChannel = &MptScsiResetChannel;\r
+  Dev->PassThru.ResetTargetLun = &MptScsiResetTargetLun;\r
+  Dev->PassThru.GetNextTarget = &MptScsiGetNextTarget;\r
+\r
+  Status = gBS->InstallProtocolInterface (\r
+                  &ControllerHandle,\r
+                  &gEfiExtScsiPassThruProtocolGuid,\r
+                  EFI_NATIVE_INTERFACE,\r
+                  &Dev->PassThru\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    goto FreePool;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+\r
+FreePool:\r
+  FreePool (Dev);\r
+\r
+  return Status;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiControllerStop (\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
+  MPT_SCSI_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 = MPT_SCSI_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
+  FreePool (Dev);\r
+\r
+  return Status;\r
+}\r
+\r
+STATIC\r
+EFI_DRIVER_BINDING_PROTOCOL mMptScsiDriverBinding = {\r
+  &MptScsiControllerSupported,\r
+  &MptScsiControllerStart,\r
+  &MptScsiControllerStop,\r
+  MPT_SCSI_BINDING_VERSION,\r
+  NULL, // ImageHandle, filled by EfiLibInstallDriverBindingComponentName2\r
+  NULL, // DriverBindingHandle, filled as well\r
+};\r
+\r
+//\r
+// Component Name\r
+//\r
+\r
+STATIC\r
+EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {\r
+  { "eng;en", L"LSI Fusion MPT SCSI Driver" },\r
+  { NULL,     NULL                   }\r
+};\r
+\r
+STATIC\r
+EFI_COMPONENT_NAME_PROTOCOL mComponentName;\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+MptScsiGetDriverName (\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
+EFI_STATUS\r
+EFIAPI\r
+MptScsiGetDeviceName (\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\r
+EFI_COMPONENT_NAME_PROTOCOL mComponentName = {\r
+  &MptScsiGetDriverName,\r
+  &MptScsiGetDeviceName,\r
+  "eng" // SupportedLanguages, ISO 639-2 language codes\r
+};\r
+\r
+STATIC\r
+EFI_COMPONENT_NAME2_PROTOCOL mComponentName2 = {\r
+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)     &MptScsiGetDriverName,\r
+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &MptScsiGetDeviceName,\r
+  "en" // SupportedLanguages, RFC 4646 language codes\r
+};\r
+\r
 //\r
 // Entry Point\r
 //\r
@@ -22,5 +477,12 @@ MptScsiEntryPoint (
   IN EFI_SYSTEM_TABLE *SystemTable\r
   )\r
 {\r
-  return EFI_UNSUPPORTED;\r
+  return EfiLibInstallDriverBindingComponentName2 (\r
+           ImageHandle,\r
+           SystemTable,\r
+           &mMptScsiDriverBinding,\r
+           ImageHandle, // The handle to install onto\r
+           &mComponentName,\r
+           &mComponentName2\r
+           );\r
 }\r