EmbeddedPkg: Added SATA Silicon Image driver
authorOlivier Martin <olivier.martin@arm.com>
Mon, 11 May 2015 17:50:27 +0000 (17:50 +0000)
committeroliviermartin <oliviermartin@Edk2>
Mon, 11 May 2015 17:50:27 +0000 (17:50 +0000)
Note: This is the same SATA controller present on Juno R1.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Olivier Martin <olivier.martin@arm.com>
Reviewed-by: Ronald Cron <Ronald.Cron@arm.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17413 6f19259b-4bc3-4df7-8a09-765794883524

EmbeddedPkg/Drivers/SataSiI3132Dxe/ComponentName.c [new file with mode: 0644]
EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132.c [new file with mode: 0644]
EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132.h [new file with mode: 0644]
EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132Dxe.inf [new file with mode: 0644]
EmbeddedPkg/Drivers/SataSiI3132Dxe/SiI3132AtaPassThru.c [new file with mode: 0644]
EmbeddedPkg/EmbeddedPkg.dec
EmbeddedPkg/EmbeddedPkg.dsc

diff --git a/EmbeddedPkg/Drivers/SataSiI3132Dxe/ComponentName.c b/EmbeddedPkg/Drivers/SataSiI3132Dxe/ComponentName.c
new file mode 100644 (file)
index 0000000..18e750a
--- /dev/null
@@ -0,0 +1,178 @@
+/** @file\r
+  UEFI Component Name(2) protocol implementation for Silicon Image I3132 SATA controller\r
+\r
+*  Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
+*\r
+*  This program and the accompanying materials\r
+*  are licensed and made available under the terms and conditions of the BSD License\r
+*  which accompanies this 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
+\r
+#include "SataSiI3132.h"\r
+\r
+//\r
+// EFI Component Name Protocol\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gSataSiI3132ComponentName = {\r
+  SataSiI3132ComponentNameGetDriverName,\r
+  SataSiI3132ComponentNameGetControllerName,\r
+  "eng"\r
+};\r
+\r
+//\r
+// EFI Component Name 2 Protocol\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gSataSiI3132ComponentName2 = {\r
+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) SataSiI3132ComponentNameGetDriverName,\r
+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) SataSiI3132ComponentNameGetControllerName,\r
+  "en"\r
+};\r
+\r
+\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSataSiI3132DriverNameTable[] = {\r
+  { "eng;en", L"Pci SATA Silicon Image 3132 Driver" },\r
+  { NULL , NULL }\r
+};\r
+\r
+\r
+/**\r
+  Retrieves a Unicode string that is the user readable name of the driver.\r
+\r
+  This function retrieves the user readable name of a driver in the form of a\r
+  Unicode string. If the driver specified by This has a user readable name in\r
+  the language specified by Language, then a pointer to the driver name is\r
+  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
+  by This does not support the language specified by Language,\r
+  then EFI_UNSUPPORTED is returned.\r
+\r
+  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
+\r
+  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+                                array indicating the language. This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified\r
+                                in RFC 4646 or ISO 639-2 language code format.\r
+\r
+  @param  DriverName[out]       A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                driver specified by This in the language\r
+                                specified by Language.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
+                                This and the language specified by Language was\r
+                                returned in DriverName.\r
+\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+\r
+  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132ComponentNameGetDriverName (\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
+           mSataSiI3132DriverNameTable,\r
+           DriverName,\r
+           (BOOLEAN)(This == &gSataSiI3132ComponentName)\r
+           );\r
+}\r
+\r
+/**\r
+  Retrieves a Unicode string that is the user readable name of the controller\r
+  that is being managed by a driver.\r
+\r
+  This function retrieves the user readable name of the controller specified by\r
+  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
+  driver specified by This has a user readable name in the language specified by\r
+  Language, then a pointer to the controller name is returned in ControllerName,\r
+  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
+  managing the controller specified by ControllerHandle and ChildHandle,\r
+  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
+  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
+\r
+  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
+\r
+  @param  ControllerHandle[in]  The handle of a controller that the driver\r
+                                specified by This is managing.  This handle\r
+                                specifies the controller whose name is to be\r
+                                returned.\r
+\r
+  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
+                                the name of.  This is an optional parameter that\r
+                                may be NULL.  It will be NULL for device\r
+                                drivers.  It will also be NULL for a bus drivers\r
+                                that wish to retrieve the name of the bus\r
+                                controller.  It will not be NULL for a bus\r
+                                driver that wishes to retrieve the name of a\r
+                                child controller.\r
+\r
+  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+                                array indicating the language.  This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified in\r
+                                RFC 4646 or ISO 639-2 language code format.\r
+\r
+  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                controller specified by ControllerHandle and\r
+                                ChildHandle in the language specified by\r
+                                Language from the point of view of the driver\r
+                                specified by This.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
+                                the language specified by Language for the\r
+                                driver specified by This was returned in\r
+                                DriverName.\r
+\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+\r
+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
+                                EFI_HANDLE.\r
+\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+\r
+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
+                                managing the controller specified by\r
+                                ControllerHandle and ChildHandle.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132ComponentNameGetControllerName (\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
+  IN  EFI_HANDLE                                      ControllerHandle,\r
+  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
+  IN  CHAR8                                           *Language,\r
+  OUT CHAR16                                          **ControllerName\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
diff --git a/EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132.c b/EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132.c
new file mode 100644 (file)
index 0000000..5a5526c
--- /dev/null
@@ -0,0 +1,545 @@
+/** @file\r
+*  PCIe Sata support for the Silicon Image I3132\r
+*\r
+*  Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
+*\r
+*  This program and the accompanying materials\r
+*  are licensed and made available under the terms and conditions of the BSD License\r
+*  which accompanies this 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
+\r
+#include "SataSiI3132.h"\r
+\r
+#include <IndustryStandard/Acpi10.h>\r
+\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/DxeServicesTableLib.h>\r
+#include <Library/BaseLib.h>\r
+\r
+#define ACPI_SPECFLAG_PREFETCHABLE      0x06\r
+\r
+EFI_DRIVER_BINDING_PROTOCOL\r
+gSataSiI3132DriverBinding = {\r
+  SataSiI3132DriverBindingSupported,\r
+  SataSiI3132DriverBindingStart,\r
+  SataSiI3132DriverBindingStop,\r
+  0x30,\r
+  NULL,\r
+  NULL\r
+};\r
+\r
+EFI_STATUS\r
+SataSiI3132PortConstructor (\r
+  IN  SATA_SI3132_INSTANCE *SataSiI3132Instance,\r
+  IN  UINTN                Index\r
+  )\r
+{\r
+  EFI_STATUS            Status;\r
+  SATA_SI3132_PORT      *Port;\r
+  VOID                  *HostPRB;\r
+  EFI_PHYSICAL_ADDRESS  PhysAddrHostPRB;\r
+  VOID                  *PciAllocMappingPRB;\r
+  UINTN                 NumberOfBytes;\r
+\r
+  Port = &(SataSiI3132Instance->Ports[Index]);\r
+\r
+  Port->Index    = Index;\r
+  Port->RegBase  = Index * 0x2000;\r
+  Port->Instance = SataSiI3132Instance;\r
+  InitializeListHead (&(Port->Devices));\r
+\r
+  NumberOfBytes = sizeof (SATA_SI3132_PRB);\r
+  Status = SataSiI3132Instance->PciIo->AllocateBuffer (\r
+             SataSiI3132Instance->PciIo, AllocateAnyPages, EfiBootServicesData,\r
+             EFI_SIZE_TO_PAGES (NumberOfBytes), &HostPRB, 0\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  // Check the alignment of the PCI Buffer\r
+  ASSERT (((UINTN)HostPRB & (0x1000 - 1)) == 0);\r
+  Status = SataSiI3132Instance->PciIo->Map (\r
+             SataSiI3132Instance->PciIo, EfiPciIoOperationBusMasterCommonBuffer, HostPRB,\r
+             &NumberOfBytes, &PhysAddrHostPRB, &PciAllocMappingPRB\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  Port->HostPRB            = HostPRB;\r
+  Port->PhysAddrHostPRB    = PhysAddrHostPRB;\r
+  Port->PciAllocMappingPRB = PciAllocMappingPRB;\r
+\r
+  return Status;\r
+}\r
+\r
+STATIC\r
+EFI_STATUS\r
+SataSiI3132Constructor (\r
+  IN  EFI_PCI_IO_PROTOCOL     *PciIo,\r
+  OUT SATA_SI3132_INSTANCE**  SataSiI3132Instance\r
+  )\r
+{\r
+  SATA_SI3132_INSTANCE    *Instance;\r
+  EFI_ATA_PASS_THRU_MODE  *AtaPassThruMode;\r
+\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Instance = (SATA_SI3132_INSTANCE*)AllocateZeroPool (sizeof (SATA_SI3132_INSTANCE));\r
+  if (Instance == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  Instance->Signature           = SATA_SII3132_SIGNATURE;\r
+  Instance->PciIo               = PciIo;\r
+\r
+  AtaPassThruMode = (EFI_ATA_PASS_THRU_MODE*)AllocatePool (sizeof (EFI_ATA_PASS_THRU_MODE));\r
+  AtaPassThruMode->Attributes = EFI_ATA_PASS_THRU_ATTRIBUTES_PHYSICAL | EFI_ATA_PASS_THRU_ATTRIBUTES_LOGICAL;\r
+  AtaPassThruMode->IoAlign = 0x1000;\r
+\r
+  // Initialize SiI3132 ports\r
+  SataSiI3132PortConstructor (Instance, 0);\r
+  SataSiI3132PortConstructor (Instance, 1);\r
+\r
+  // Set ATA Pass Thru Protocol\r
+  Instance->AtaPassThruProtocol.Mode            = AtaPassThruMode;\r
+  Instance->AtaPassThruProtocol.PassThru        = SiI3132AtaPassThru;\r
+  Instance->AtaPassThruProtocol.GetNextPort     = SiI3132GetNextPort;\r
+  Instance->AtaPassThruProtocol.GetNextDevice   = SiI3132GetNextDevice;\r
+  Instance->AtaPassThruProtocol.BuildDevicePath = SiI3132BuildDevicePath;\r
+  Instance->AtaPassThruProtocol.GetDevice       = SiI3132GetDevice;\r
+  Instance->AtaPassThruProtocol.ResetPort       = SiI3132ResetPort;\r
+  Instance->AtaPassThruProtocol.ResetDevice     = SiI3132ResetDevice;\r
+\r
+  *SataSiI3132Instance = Instance;\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+EFI_STATUS\r
+SiI3132SoftResetCommand (\r
+  IN   SATA_SI3132_PORT *Port,\r
+  OUT  UINT32* Signature\r
+  )\r
+{\r
+  EFI_STATUS                        Status;\r
+  EFI_ATA_PASS_THRU_COMMAND_PACKET  Packet;\r
+  EFI_ATA_STATUS_BLOCK              Asb;\r
+  EFI_ATA_COMMAND_BLOCK             Acb;\r
+  CONST UINT16                      PortMultiplierPort = 0;\r
+\r
+  ZeroMem (&Acb, sizeof (EFI_ATA_COMMAND_BLOCK));\r
+\r
+  Acb.Reserved1[1] = 0;\r
+\r
+  Packet.Asb      = &Asb;\r
+  Packet.Acb      = &Acb;\r
+  Packet.Timeout  = 100000;\r
+  Packet.Protocol = EFI_ATA_PASS_THRU_PROTOCOL_ATA_SOFTWARE_RESET;\r
+\r
+  Status = SiI3132AtaPassThruCommand (Port->Instance, Port, PortMultiplierPort, &Packet, 0);\r
+\r
+  if (Status == EFI_SUCCESS) {\r
+    *Signature = (Asb.AtaCylinderHigh << 24) | (Asb.AtaCylinderLow << 16) |\r
+                 (Asb.AtaSectorNumber << 8 ) | (Asb.AtaSectorCount);\r
+  }\r
+  return Status;\r
+}\r
+\r
+EFI_STATUS\r
+SataSiI3132PortInitialization (\r
+  IN SATA_SI3132_PORT *Port\r
+  )\r
+{\r
+  UINT32                  Value32;\r
+  SATA_SI3132_DEVICE*     Device;\r
+  UINT32                  Signature;\r
+  EFI_STATUS              Status;\r
+  EFI_PCI_IO_PROTOCOL*    PciIo;\r
+\r
+  Status = SiI3132HwResetPort (Port);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  PciIo = Port->Instance->PciIo;\r
+\r
+  // Is a device is present ?\r
+  Status = SATA_PORT_READ32 (Port->RegBase + SII3132_PORT_SSTATUS_REG, &Value32);\r
+  if (!EFI_ERROR (Status) && (Value32 & 0x3)) {\r
+    // Do a soft reset to see if it is a port multiplier\r
+    SATA_TRACE ("SataSiI3132PortInitialization: soft reset - it is a port multiplier\n");\r
+    Status = SiI3132SoftResetCommand (Port, &Signature);\r
+    if (!EFI_ERROR (Status)) {\r
+      if (Signature == SII3132_PORT_SIGNATURE_PMP) {\r
+        SATA_TRACE ("SataSiI3132PortInitialization(): a Port Multiplier is present");\r
+        if (FeaturePcdGet (PcdSataSiI3132FeaturePMPSupport)) {\r
+          ASSERT (0); // Not supported yet\r
+        } else {\r
+          return EFI_UNSUPPORTED;\r
+        }\r
+      } else if (Signature == SII3132_PORT_SIGNATURE_ATAPI) {\r
+        ASSERT (0); // Not supported yet\r
+        SATA_TRACE ("SataSiI3132PortInitialization(): an ATAPI device is present");\r
+        return EFI_UNSUPPORTED;\r
+      } else if (Signature == SII3132_PORT_SIGNATURE_ATA) {\r
+        SATA_TRACE ("SataSiI3132PortInitialization(): an ATA device is present");\r
+      } else {\r
+        SATA_TRACE ("SataSiI3132PortInitialization(): Present device unknown!");\r
+        ASSERT (0); // Not supported\r
+        return EFI_UNSUPPORTED;\r
+      }\r
+\r
+      // Create Device\r
+      Device            = (SATA_SI3132_DEVICE*)AllocatePool (sizeof (SATA_SI3132_DEVICE));\r
+      Device->Index     = Port->Index; //TODO: Could need to be fixed when SATA Port Multiplier support\r
+      Device->Port      = Port;\r
+      Device->BlockSize = 0;\r
+\r
+      // Attached the device to the Sata Port\r
+      InsertTailList (&Port->Devices, &Device->Link);\r
+\r
+      SATA_TRACE ("SataSiI3132PortInitialization(): Port Ready");\r
+    }\r
+  }\r
+  return Status;\r
+}\r
+\r
+EFI_STATUS\r
+SataSiI3132Initialization (\r
+  IN SATA_SI3132_INSTANCE* SataSiI3132Instance\r
+  )\r
+{\r
+  UINTN                 Index;\r
+  EFI_PCI_IO_PROTOCOL*  PciIo;\r
+\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  PciIo = SataSiI3132Instance->PciIo;\r
+\r
+  // Turn Off GPIO\r
+  SATA_GLOBAL_WRITE32 (SII3132_GLOBAL_FLASHADDR_REG, 0x0);\r
+\r
+  // Clear Global Control Register\r
+  SATA_GLOBAL_WRITE32 (SII3132_GLOBAL_CONTROL_REG, 0x0);\r
+\r
+  for (Index = 0; Index < SATA_SII3132_MAXPORT; Index++) {\r
+    SataSiI3132PortInitialization (&(SataSiI3132Instance->Ports[Index]));\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Test to see if this driver supports ControllerHandle.\r
+\r
+  @param  This                 Protocol instance pointer.\r
+  @param  Controller           Handle of device to test.\r
+  @param  RemainingDevicePath  Not used.\r
+\r
+  @return EFI_SUCCESS          This driver supports this device.\r
+  @return EFI_UNSUPPORTED      This driver does not support this device.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132DriverBindingSupported (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  Controller,\r
+  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
+  )\r
+{\r
+  EFI_STATUS              Status;\r
+  EFI_PCI_IO_PROTOCOL     *PciIo;\r
+  UINT32                   PciID;\r
+\r
+  //\r
+  // Test whether there is PCI IO Protocol attached on the controller handle.\r
+  //\r
+  Status = gBS->OpenProtocol (\r
+                Controller,\r
+                &gEfiPciIoProtocolGuid,\r
+                (VOID **) &PciIo,\r
+                This->DriverBindingHandle,\r
+                Controller,\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
+                      PCI_VENDOR_ID_OFFSET,\r
+                      1,\r
+                      &PciID\r
+                      );\r
+  if (EFI_ERROR (Status)) {\r
+      Status = EFI_UNSUPPORTED;\r
+      goto ON_EXIT;\r
+  }\r
+\r
+  //\r
+  // Test whether the controller belongs to SATA Mass Storage type\r
+  //\r
+  if (PciID != ((SATA_SII3132_DEVICE_ID << 16) | SATA_SII3132_VENDOR_ID)) {\r
+      Status = EFI_UNSUPPORTED;\r
+  }\r
+\r
+ON_EXIT:\r
+  gBS->CloseProtocol (\r
+       Controller,\r
+       &gEfiPciIoProtocolGuid,\r
+       This->DriverBindingHandle,\r
+       Controller\r
+       );\r
+\r
+  return Status;\r
+}\r
+\r
+BOOLEAN mbStarted = FALSE;\r
+\r
+/**\r
+  Starting the Pci SATA Driver.\r
+\r
+  @param  This                 Protocol instance pointer.\r
+  @param  Controller           Handle of device to test.\r
+  @param  RemainingDevicePath  Not used.\r
+\r
+  @return EFI_SUCCESS          supports this device.\r
+  @return EFI_UNSUPPORTED      do not support this device.\r
+  @return EFI_DEVICE_ERROR     cannot be started due to device Error.\r
+  @return EFI_OUT_OF_RESOURCES cannot allocate resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132DriverBindingStart (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  Controller,\r
+  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
+  )\r
+{\r
+  EFI_STATUS              Status;\r
+  EFI_PCI_IO_PROTOCOL     *PciIo;\r
+  UINT64                  Supports;\r
+  UINT64                  OriginalPciAttributes;\r
+  BOOLEAN                 PciAttributesSaved;\r
+  UINT32                  PciID;\r
+  SATA_SI3132_INSTANCE    *SataSiI3132Instance = NULL;\r
+\r
+  SATA_TRACE ("SataSiI3132DriverBindingStart()");\r
+\r
+  //TODO: Find a nicer way to do it !\r
+  if (mbStarted) {\r
+    return EFI_SUCCESS; // Don't restart me !\r
+  }\r
+\r
+  //\r
+  // Open the PciIo Protocol\r
+  //\r
+  Status = gBS->OpenProtocol (\r
+                Controller,\r
+                &gEfiPciIoProtocolGuid,\r
+                (VOID **) &PciIo,\r
+                This->DriverBindingHandle,\r
+                Controller,\r
+                EFI_OPEN_PROTOCOL_BY_DRIVER\r
+                );\r
+  if (EFI_ERROR (Status)) {\r
+      return Status;\r
+  }\r
+\r
+  PciAttributesSaved = FALSE;\r
+  //\r
+  // Save original PCI attributes\r
+  //\r
+  Status = PciIo->Attributes (\r
+                  PciIo,\r
+                  EfiPciIoAttributeOperationGet,\r
+                  0,\r
+                  &OriginalPciAttributes\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+      goto CLOSE_PCIIO;\r
+  }\r
+  PciAttributesSaved = TRUE;\r
+\r
+  Status = PciIo->Attributes (\r
+                  PciIo,\r
+                  EfiPciIoAttributeOperationSupported,\r
+                  0,\r
+                  &Supports\r
+                  );\r
+  if (!EFI_ERROR (Status)) {\r
+      Supports &= EFI_PCI_DEVICE_ENABLE;\r
+      Status = PciIo->Attributes (\r
+                        PciIo,\r
+                        EfiPciIoAttributeOperationEnable,\r
+                        Supports,\r
+                        NULL\r
+                        );\r
+  }\r
+  if (EFI_ERROR (Status)) {\r
+    DEBUG ((EFI_D_ERROR, "SataSiI3132DriverBindingStart: failed to enable controller\n"));\r
+    goto CLOSE_PCIIO;\r
+  }\r
+\r
+  //\r
+  // Get the Pci device class code.\r
+  //\r
+  Status = PciIo->Pci.Read (\r
+                      PciIo,\r
+                      EfiPciIoWidthUint32,\r
+                      PCI_VENDOR_ID_OFFSET,\r
+                      1,\r
+                      &PciID\r
+                      );\r
+  if (EFI_ERROR (Status)) {\r
+    Status = EFI_UNSUPPORTED;\r
+    goto CLOSE_PCIIO;\r
+  }\r
+\r
+  //\r
+  // Test whether the controller belongs to SATA Mass Storage type\r
+  //\r
+  if (PciID != ((SATA_SII3132_DEVICE_ID << 16) | SATA_SII3132_VENDOR_ID)) {\r
+    Status = EFI_UNSUPPORTED;\r
+    goto CLOSE_PCIIO;\r
+  }\r
+\r
+  // Create SiI3132 Sata Instance\r
+  Status = SataSiI3132Constructor (PciIo, &SataSiI3132Instance);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  // Initialize SiI3132 Sata Controller\r
+  Status = SataSiI3132Initialization (SataSiI3132Instance);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  // Install Ata Pass Thru Protocol\r
+  Status = gBS->InstallProtocolInterface (\r
+              &Controller,\r
+              &gEfiAtaPassThruProtocolGuid,\r
+              EFI_NATIVE_INTERFACE,\r
+              &(SataSiI3132Instance->AtaPassThruProtocol)\r
+              );\r
+  if (EFI_ERROR (Status)) {\r
+    goto FREE_POOL;\r
+  }\r
+\r
+/*  //\r
+  // Create event to stop the HC when exit boot service.\r
+  //\r
+  Status = gBS->CreateEventEx (\r
+                EVT_NOTIFY_SIGNAL,\r
+                TPL_NOTIFY,\r
+                EhcExitBootService,\r
+                Ehc,\r
+                &gEfiEventExitBootServicesGuid,\r
+                &Ehc->ExitBootServiceEvent\r
+                );\r
+  if (EFI_ERROR (Status)) {\r
+      goto UNINSTALL_USBHC;\r
+  }*/\r
+\r
+  mbStarted = TRUE;\r
+\r
+  SATA_TRACE ("SataSiI3132DriverBindingStart() Success!");\r
+  return EFI_SUCCESS;\r
+\r
+FREE_POOL:\r
+  //TODO: Free SATA Instance\r
+\r
+CLOSE_PCIIO:\r
+  if (PciAttributesSaved) {\r
+      //\r
+      // Restore original PCI attributes\r
+      //\r
+      PciIo->Attributes (\r
+                      PciIo,\r
+                      EfiPciIoAttributeOperationSet,\r
+                      OriginalPciAttributes,\r
+                      NULL\r
+                      );\r
+  }\r
+\r
+  gBS->CloseProtocol (\r
+       Controller,\r
+       &gEfiPciIoProtocolGuid,\r
+       This->DriverBindingHandle,\r
+       Controller\r
+       );\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Stop this driver on ControllerHandle. Support stoping any child handles\r
+  created by this driver.\r
+\r
+  @param  This                 Protocol instance pointer.\r
+  @param  Controller           Handle of device to stop driver on.\r
+  @param  NumberOfChildren     Number of Children in the ChildHandleBuffer.\r
+  @param  ChildHandleBuffer    List of handles for the children we need to stop.\r
+\r
+  @return EFI_SUCCESS          Success.\r
+  @return EFI_DEVICE_ERROR     Fail.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132DriverBindingStop (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  Controller,\r
+  IN UINTN                       NumberOfChildren,\r
+  IN EFI_HANDLE                  *ChildHandleBuffer\r
+  )\r
+{\r
+  SATA_TRACE ("SataSiI3132DriverBindingStop()");\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+/**\r
+  Entry point of this driver\r
+\r
+  @param ImageHandle     Handle of driver image\r
+  @param SystemTable     Point to EFI_SYSTEM_TABLE\r
+\r
+  @retval EFI_OUT_OF_RESOURCES  Can not allocate memory resource\r
+  @retval EFI_DEVICE_ERROR      Can not install the protocol instance\r
+  @retval EFI_SUCCESS           Success to initialize the Pci host bridge.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitializeSataSiI3132 (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  )\r
+{\r
+  SATA_TRACE ("InitializeSataSiI3132 ()");\r
+\r
+  return EfiLibInstallDriverBindingComponentName2 (\r
+         ImageHandle,\r
+         SystemTable,\r
+         &gSataSiI3132DriverBinding,\r
+         ImageHandle,\r
+         &gSataSiI3132ComponentName,\r
+         &gSataSiI3132ComponentName2\r
+         );\r
+}\r
diff --git a/EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132.h b/EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132.h
new file mode 100644 (file)
index 0000000..a7bc956
--- /dev/null
@@ -0,0 +1,269 @@
+/** @file\r
+*  Header containing the structure specific to the Silicon Image I3132 Sata PCI card\r
+*\r
+*  Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
+*\r
+*  This program and the accompanying materials\r
+*  are licensed and made available under the terms and conditions of the BSD License\r
+*  which accompanies this 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
+\r
+#ifndef __SATASII3132_H\r
+#define __SATASII3132_H\r
+\r
+#include <PiDxe.h>\r
+\r
+#include <Protocol/AtaPassThru.h>\r
+#include <Protocol/PciIo.h>\r
+\r
+#include <Library/UefiLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+\r
+#include <IndustryStandard/Pci.h>\r
+\r
+#define SATA_SII3132_DEVICE_ID      0x3132\r
+#define SATA_SII3132_VENDOR_ID      0x1095\r
+\r
+#define SII3132_PORT_SIGNATURE_PMP      0x96690101\r
+#define SII3132_PORT_SIGNATURE_ATAPI    0xEB140101\r
+#define SII3132_PORT_SIGNATURE_ATA      0x00000101\r
+\r
+/*\r
+ * Silicon Image SiI3132 Registers\r
+ */\r
+#define SII3132_GLOBAL_CONTROL_REG              0x40\r
+#define SII3132_GLOBAL_FLASHADDR_REG            0x70\r
+\r
+#define SII3132_PORT_STATUS_REG                 0x1000\r
+#define SII3132_PORT_CONTROLSET_REG             0x1000\r
+#define SII3132_PORT_CONTROLCLEAR_REG           0x1004\r
+#define SII3132_PORT_INTSTATUS_REG              0x1008\r
+#define SII3132_PORT_ENABLEINT_REG              0x1010\r
+#define SII3132_PORT_INTCLEAR_REG               0x1014\r
+#define SII3132_PORT_32BITACTIVADDR_REG         0x101C\r
+#define SII3132_PORT_CMDEXECFIFO_REG            0x1020\r
+#define SII3132_PORT_CMDERROR_REG               0x1024\r
+#define SII3132_PORT_ERRCOUNTDECODE             0x1040\r
+#define SII3132_PORT_ERRCOUNTCRC                0x1044\r
+#define SII3132_PORT_ERRCOUNTHANDSHAKE          0x1048\r
+#define SII3132_PORT_SLOTSTATUS_REG             0x1800\r
+#define SII3132_PORT_CMDACTIV_REG               0x1C00\r
+#define SII3132_PORT_SSTATUS_REG                0x1F04\r
+\r
+#define SII3132_PORT_CONTROL_RESET              (1 << 0)\r
+#define SII3132_PORT_DEVICE_RESET               (1 << 1)\r
+#define SII3132_PORT_CONTROL_INT                (1 << 2)\r
+#define SII3132_PORT_CONTROL_32BITACTIVATION    (1 << 10)\r
+\r
+#define SII3132_PORT_STATUS_PORTREADY           0x80000000\r
+\r
+#define SII3132_PORT_INT_CMDCOMPL               (1 << 0)\r
+#define SII3132_PORT_INT_CMDERR                 (1 << 1)\r
+#define SII3132_PORT_INT_PORTRDY                (1 << 2)\r
+\r
+#define SATA_SII3132_MAXPORT    2\r
+\r
+#define PRB_CTRL_ATA            0x0\r
+#define PRB_CTRL_PROT_OVERRIDE  0x1\r
+#define PRB_CTRL_RESTRANSMIT    0x2\r
+#define PRB_CTRL_EXT_CMD        0x4\r
+#define PRB_CTRL_RCV            0x8\r
+#define PRB_CTRL_PKT_READ       0x10\r
+#define PRB_CTRL_PKT_WRITE      0x20\r
+#define PRB_CTRL_INT_MASK       0x40\r
+#define PRB_CTRL_SRST           0x80\r
+\r
+#define PRB_PROT_PACKET         0x01\r
+#define PRB_PROT_LEGACY_QUEUE   0x02\r
+#define PRB_PROT_NATIVE_QUEUE   0x04\r
+#define PRB_PROT_READ           0x08\r
+#define PRB_PROT_WRITE          0x10\r
+#define PRB_PROT_TRANSPARENT    0x20\r
+\r
+#define SGE_XCF     (1 << 28)\r
+#define SGE_DRD     (1 << 29)\r
+#define SGE_LNK     (1 << 30)\r
+#define SGE_TRM     0x80000000\r
+\r
+typedef struct _SATA_SI3132_SGE {\r
+    UINT32      DataAddressLow;\r
+    UINT32      DataAddressHigh;\r
+    UINT32      DataCount;\r
+    UINT32      Attributes;\r
+} SATA_SI3132_SGE;\r
+\r
+typedef struct _SATA_SI3132_FIS {\r
+    UINT8               FisType;\r
+    UINT8               Control;\r
+    UINT8               Command;\r
+    UINT8               Features;\r
+    UINT8               Fis[5 * 4];\r
+} SATA_SI3132_FIS;\r
+\r
+typedef struct _SATA_SI3132_PRB {\r
+    UINT16              Control;\r
+    UINT16              ProtocolOverride;\r
+    UINT32              RecTransCount;\r
+    SATA_SI3132_FIS     Fis;\r
+    SATA_SI3132_SGE     Sge[2];\r
+} SATA_SI3132_PRB;\r
+\r
+typedef struct _SATA_SI3132_DEVICE {\r
+    LIST_ENTRY                  Link; // This attribute must be the first entry of this structure (to avoid pointer computation)\r
+    UINTN                       Index;\r
+    struct _SATA_SI3132_PORT    *Port;  //Parent Port\r
+    UINT32                      BlockSize;\r
+} SATA_SI3132_DEVICE;\r
+\r
+typedef struct _SATA_SI3132_PORT {\r
+    UINTN                           Index;\r
+    UINTN                           RegBase;\r
+    struct _SATA_SI3132_INSTANCE    *Instance;\r
+\r
+    //TODO: Support Port multiplier\r
+    LIST_ENTRY                      Devices;\r
+\r
+    SATA_SI3132_PRB*                HostPRB;\r
+    EFI_PHYSICAL_ADDRESS            PhysAddrHostPRB;\r
+    VOID*                           PciAllocMappingPRB;\r
+} SATA_SI3132_PORT;\r
+\r
+typedef struct _SATA_SI3132_INSTANCE {\r
+    UINTN                       Signature;\r
+\r
+    SATA_SI3132_PORT            Ports[SATA_SII3132_MAXPORT];\r
+\r
+    EFI_ATA_PASS_THRU_PROTOCOL  AtaPassThruProtocol;\r
+\r
+    EFI_PCI_IO_PROTOCOL         *PciIo;\r
+} SATA_SI3132_INSTANCE;\r
+\r
+#define SATA_SII3132_SIGNATURE              SIGNATURE_32('s', 'i', '3', '2')\r
+#define INSTANCE_FROM_ATAPASSTHRU_THIS(a)   CR(a, SATA_SI3132_INSTANCE, AtaPassThruProtocol, SATA_SII3132_SIGNATURE)\r
+\r
+#define SATA_GLOBAL_READ32(Offset, Value)  PciIo->Mem.Read (PciIo, EfiPciIoWidthUint32, 0, Offset, 1, Value)\r
+#define SATA_GLOBAL_WRITE32(Offset, Value) { UINT32 Value32 = Value; PciIo->Mem.Write (PciIo, EfiPciIoWidthUint32, 0, Offset, 1, &Value32); }\r
+\r
+#define SATA_PORT_READ32(Offset, Value)  PciIo->Mem.Read (PciIo, EfiPciIoWidthUint32, 1, Offset, 1, Value)\r
+#define SATA_PORT_WRITE32(Offset, Value) { UINT32 Value32 = Value; PciIo->Mem.Write (PciIo, EfiPciIoWidthUint32, 1, Offset, 1, &Value32); }\r
+\r
+#define SATA_TRACE(txt)  DEBUG((EFI_D_VERBOSE, "ARM_SATA: " txt "\n"))\r
+\r
+extern EFI_COMPONENT_NAME_PROTOCOL  gSataSiI3132ComponentName;\r
+extern EFI_COMPONENT_NAME2_PROTOCOL gSataSiI3132ComponentName2;\r
+\r
+/*\r
+ * Component Name Protocol Functions\r
+ */\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132ComponentNameGetDriverName (\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
+  IN  CHAR8                        *Language,\r
+  OUT CHAR16                       **DriverName\r
+  );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132ComponentNameGetControllerName (\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
+  IN  EFI_HANDLE                                      ControllerHandle,\r
+  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
+  IN  CHAR8                                           *Language,\r
+  OUT CHAR16                                          **ControllerName\r
+  );\r
+\r
+EFI_STATUS SiI3132HwResetPort (SATA_SI3132_PORT *Port);\r
+\r
+/*\r
+ * Driver Binding Protocol Functions\r
+ */\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132DriverBindingSupported (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  Controller,\r
+  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
+  );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132DriverBindingStart (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  Controller,\r
+  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
+  );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+SataSiI3132DriverBindingStop (\r
+  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+  IN EFI_HANDLE                  Controller,\r
+  IN UINTN                       NumberOfChildren,\r
+  IN EFI_HANDLE                  *ChildHandleBuffer\r
+  );\r
+\r
+EFI_STATUS SiI3132AtaPassThruCommand (\r
+  IN     SATA_SI3132_INSTANCE             *pSataSiI3132Instance,\r
+  IN     SATA_SI3132_PORT                 *pSataPort,\r
+  IN     UINT16                           PortMultiplierPort,\r
+  IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet,\r
+  IN     EFI_EVENT                        Event OPTIONAL\r
+  );\r
+\r
+/**\r
+ * EFI ATA Pass Thru Protocol\r
+ */\r
+EFI_STATUS SiI3132AtaPassThru (\r
+  IN     EFI_ATA_PASS_THRU_PROTOCOL       *This,\r
+  IN     UINT16                           Port,\r
+  IN     UINT16                           PortMultiplierPort,\r
+  IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet,\r
+  IN     EFI_EVENT                        Event OPTIONAL\r
+  );\r
+\r
+EFI_STATUS SiI3132GetNextPort (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN OUT UINT16                 *Port\r
+  );\r
+\r
+EFI_STATUS SiI3132GetNextDevice (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN UINT16                     Port,\r
+  IN OUT UINT16                 *PortMultiplierPort\r
+  );\r
+\r
+EFI_STATUS SiI3132BuildDevicePath (\r
+  IN     EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN     UINT16                     Port,\r
+  IN     UINT16                     PortMultiplierPort,\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL   **DevicePath\r
+  );\r
+\r
+EFI_STATUS SiI3132GetDevice (\r
+  IN  EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN  EFI_DEVICE_PATH_PROTOCOL   *DevicePath,\r
+  OUT UINT16                     *Port,\r
+  OUT UINT16                     *PortMultiplierPort\r
+  );\r
+\r
+EFI_STATUS SiI3132ResetPort (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN UINT16                     Port\r
+  );\r
+\r
+EFI_STATUS SiI3132ResetDevice (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN UINT16                     Port,\r
+  IN UINT16                     PortMultiplierPort\r
+  );\r
+\r
+#endif\r
diff --git a/EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132Dxe.inf b/EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132Dxe.inf
new file mode 100644 (file)
index 0000000..69aaab3
--- /dev/null
@@ -0,0 +1,48 @@
+#/** @file\r
+#  INF file for the Silicon Image I3132 SATA controller\r
+#\r
+#  Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
+#\r
+#  This program and the accompanying materials\r
+#  are licensed and made available under the terms and conditions of the BSD License\r
+#  which accompanies this 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
+\r
+[Defines]\r
+  INF_VERSION                    = 0x00010005\r
+  BASE_NAME                      = SataSiI3132\r
+  FILE_GUID                      = 1df18da0-a18b-11df-8c3a-0002a5d5c51b\r
+  MODULE_TYPE                    = DXE_DRIVER\r
+  VERSION_STRING                 = 1.0\r
+\r
+  ENTRY_POINT                    = InitializeSataSiI3132\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+  EmbeddedPkg/EmbeddedPkg.dec\r
+\r
+[LibraryClasses]\r
+  UefiLib\r
+  UefiDriverEntryPoint\r
+  MemoryAllocationLib\r
+\r
+[Sources]\r
+  SataSiI3132.c\r
+  ComponentName.c\r
+  SiI3132AtaPassThru.c\r
+\r
+[Protocols]\r
+  gEfiPciIoProtocolGuid                         # Consumed\r
+  gEfiAtaPassThruProtocolGuid                   # Produced\r
+\r
+[Pcd]\r
+  gEmbeddedTokenSpaceGuid.PcdSataSiI3132FeaturePMPSupport\r
+  gEmbeddedTokenSpaceGuid.PcdSataSiI3132FeatureDirectCommandIssuing\r
+\r
+[Depex]\r
+  TRUE\r
diff --git a/EmbeddedPkg/Drivers/SataSiI3132Dxe/SiI3132AtaPassThru.c b/EmbeddedPkg/Drivers/SataSiI3132Dxe/SiI3132AtaPassThru.c
new file mode 100644 (file)
index 0000000..2fb5fd6
--- /dev/null
@@ -0,0 +1,825 @@
+/** @file\r
+*\r
+*  Copyright (c) 2011-2015, ARM Limited. All rights reserved.\r
+*\r
+*  This program and the accompanying materials\r
+*  are licensed and made available under the terms and conditions of the BSD License\r
+*  which accompanies this 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
+\r
+#include "SataSiI3132.h"\r
+\r
+#include <IndustryStandard/Atapi.h>\r
+#include <Library/DevicePathLib.h>\r
+\r
+SATA_SI3132_DEVICE*\r
+GetSataDevice (\r
+  IN  SATA_SI3132_INSTANCE* SataInstance,\r
+  IN  UINT16 Port,\r
+  IN  UINT16 PortMultiplierPort\r
+) {\r
+  LIST_ENTRY              *List;\r
+  SATA_SI3132_PORT        *SataPort;\r
+  SATA_SI3132_DEVICE      *SataDevice;\r
+\r
+  if (Port >= SATA_SII3132_MAXPORT) {\r
+    return NULL;\r
+  }\r
+\r
+  SataPort = &(SataInstance->Ports[Port]);\r
+  List = SataPort->Devices.ForwardLink;\r
+\r
+  while (List != &SataPort->Devices) {\r
+    SataDevice = (SATA_SI3132_DEVICE*)List;\r
+    if (SataDevice->Index == PortMultiplierPort) {\r
+      return SataDevice;\r
+    }\r
+    List = List->ForwardLink;\r
+  }\r
+  return NULL;\r
+}\r
+\r
+EFI_STATUS\r
+SiI3132AtaPassThruCommand (\r
+  IN     SATA_SI3132_INSTANCE             *SataSiI3132Instance,\r
+  IN     SATA_SI3132_PORT                 *SataPort,\r
+  IN     UINT16                           PortMultiplierPort,\r
+  IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet,\r
+  IN     EFI_EVENT                        Event OPTIONAL\r
+  )\r
+{\r
+  SATA_SI3132_DEVICE      *SataDevice;\r
+  EFI_PHYSICAL_ADDRESS    PhysInDataBuffer;\r
+  UINTN                   InDataBufferLength = 0;\r
+  EFI_PHYSICAL_ADDRESS    PhysOutDataBuffer;\r
+  UINTN                   OutDataBufferLength;\r
+  CONST UINTN             EmptySlot = 0;\r
+  UINTN                   Control = PRB_CTRL_ATA;\r
+  UINTN                   Protocol = 0;\r
+  UINT32                  Value32, Error, Timeout = 0;\r
+  CONST UINT32            IrqMask = (SII3132_PORT_INT_CMDCOMPL | SII3132_PORT_INT_CMDERR) << 16;\r
+  EFI_STATUS              Status;\r
+  VOID*                   PciAllocMapping = NULL;\r
+  EFI_PCI_IO_PROTOCOL     *PciIo;\r
+\r
+  PciIo = SataSiI3132Instance->PciIo;\r
+  ZeroMem (SataPort->HostPRB, sizeof (SATA_SI3132_PRB));\r
+\r
+  // Construct Si3132 PRB\r
+  switch (Packet->Protocol) {\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_ATA_HARDWARE_RESET:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_ATA_SOFTWARE_RESET:\r
+    SATA_TRACE ("SiI3132AtaPassThru() EFI_ATA_PASS_THRU_PROTOCOL_ATA_SOFTWARE_RESET");\r
+    Control = PRB_CTRL_SRST;\r
+\r
+    if (FeaturePcdGet (PcdSataSiI3132FeaturePMPSupport)) {\r
+        SataPort->HostPRB->Fis.Control = 0x0F;\r
+    }\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_ATA_NON_DATA:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+\r
+  // There is no difference for SiI3132 between PIO and DMA invokation\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_IN:\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_IN:\r
+    // Fixup the size for block transfer. Following UEFI Specification, 'InTransferLength' should\r
+    // be in number of bytes. But for most data transfer commands, the value is in number of blocks\r
+    if (Packet->Acb->AtaCommand == ATA_CMD_IDENTIFY_DRIVE) {\r
+      InDataBufferLength = Packet->InTransferLength;\r
+    } else {\r
+      SataDevice = GetSataDevice (SataSiI3132Instance, SataPort->Index, PortMultiplierPort);\r
+      if (!SataDevice || (SataDevice->BlockSize == 0)) {\r
+        return EFI_INVALID_PARAMETER;\r
+      }\r
+\r
+      InDataBufferLength = Packet->InTransferLength * SataDevice->BlockSize;\r
+    }\r
+\r
+    Status = PciIo->Map (\r
+               PciIo, EfiPciIoOperationBusMasterRead,\r
+               Packet->InDataBuffer, &InDataBufferLength, &PhysInDataBuffer, &PciAllocMapping\r
+               );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+\r
+    // Construct SGEs (32-bit system)\r
+    SataPort->HostPRB->Sge[0].DataAddressLow = (UINT32)PhysInDataBuffer;\r
+    SataPort->HostPRB->Sge[0].DataAddressHigh = (UINT32)(PhysInDataBuffer >> 32);\r
+    SataPort->HostPRB->Sge[0].Attributes = SGE_TRM; // Only one SGE\r
+    SataPort->HostPRB->Sge[0].DataCount = InDataBufferLength;\r
+\r
+    // Copy the Ata Command Block\r
+    CopyMem (&SataPort->HostPRB->Fis, Packet->Acb, sizeof (EFI_ATA_COMMAND_BLOCK));\r
+\r
+    // Fixup the FIS\r
+    SataPort->HostPRB->Fis.FisType = 0x27; // Register - Host to Device FIS\r
+    SataPort->HostPRB->Fis.Control = 1 << 7; // Is a command\r
+    if (FeaturePcdGet (PcdSataSiI3132FeaturePMPSupport)) {\r
+      SataPort->HostPRB->Fis.Control |= PortMultiplierPort & 0xFF;\r
+    }\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_OUT:\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_OUT:\r
+    SataDevice = GetSataDevice (SataSiI3132Instance, SataPort->Index, PortMultiplierPort);\r
+    if (!SataDevice || (SataDevice->BlockSize == 0)) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+\r
+    // Fixup the size for block transfer. Following UEFI Specification, 'InTransferLength' should\r
+    // be in number of bytes. But for most data transfer commands, the value is in number of blocks\r
+    OutDataBufferLength = Packet->OutTransferLength * SataDevice->BlockSize;\r
+\r
+    Status = PciIo->Map (\r
+               PciIo, EfiPciIoOperationBusMasterWrite,\r
+               Packet->OutDataBuffer, &OutDataBufferLength, &PhysOutDataBuffer, &PciAllocMapping\r
+               );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+\r
+    // Construct SGEs (32-bit system)\r
+    SataPort->HostPRB->Sge[0].DataAddressLow  = (UINT32)PhysOutDataBuffer;\r
+    SataPort->HostPRB->Sge[0].DataAddressHigh = (UINT32)(PhysOutDataBuffer >> 32);\r
+    SataPort->HostPRB->Sge[0].Attributes      = SGE_TRM; // Only one SGE\r
+    SataPort->HostPRB->Sge[0].DataCount       = OutDataBufferLength;\r
+\r
+    // Copy the Ata Command Block\r
+    CopyMem (&SataPort->HostPRB->Fis, Packet->Acb, sizeof (EFI_ATA_COMMAND_BLOCK));\r
+\r
+    // Fixup the FIS\r
+    SataPort->HostPRB->Fis.FisType = 0x27; // Register - Host to Device FIS\r
+    SataPort->HostPRB->Fis.Control = 1 << 7; // Is a command\r
+    if (FeaturePcdGet (PcdSataSiI3132FeaturePMPSupport)) {\r
+      SataPort->HostPRB->Fis.Control |= PortMultiplierPort & 0xFF;\r
+    }\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_DMA:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_DMA_QUEUED:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_DEVICE_DIAGNOSTIC:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_DEVICE_RESET:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_FPDMA:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+  case EFI_ATA_PASS_THRU_PROTOCOL_RETURN_RESPONSE:\r
+    ASSERT (0); //TODO: Implement me!\r
+    break;\r
+  default:\r
+    ASSERT (0);\r
+    break;\r
+  }\r
+\r
+  SataPort->HostPRB->Control = Control;\r
+  SataPort->HostPRB->ProtocolOverride = Protocol;\r
+\r
+  // Clear IRQ\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, IrqMask);\r
+\r
+  if (!FeaturePcdGet (PcdSataSiI3132FeatureDirectCommandIssuing)) {\r
+    // Indirect Command Issuance\r
+\r
+    //TODO: Find which slot is free (maybe use the Cmd FIFO)\r
+    //SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_CMDEXECFIFO_REG, &EmptySlot);\r
+\r
+    SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_CMDACTIV_REG + (EmptySlot * 8),\r
+                     (UINT32)(SataPort->PhysAddrHostPRB & 0xFFFFFFFF));\r
+    SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_CMDACTIV_REG + (EmptySlot * 8) + 4,\r
+                     (UINT32)((SataPort->PhysAddrHostPRB >> 32) & 0xFFFFFFFF));\r
+  } else {\r
+    // Direct Command Issuance\r
+    Status = PciIo->Mem.Write (PciIo, EfiPciIoWidthUint32, 1, // Bar 1\r
+        SataPort->RegBase + (EmptySlot * 0x80),\r
+        sizeof (SATA_SI3132_PRB) / 4,\r
+        SataPort->HostPRB);\r
+    ASSERT_EFI_ERROR (Status);\r
+\r
+    SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_CMDEXECFIFO_REG, EmptySlot);\r
+  }\r
+\r
+#if 0\r
+  // Could need to be implemented if we run multiple command in parallel to know which slot has been completed\r
+  SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_SLOTSTATUS_REG, &Value32);\r
+  Timeout = Packet->Timeout;\r
+  while (!Timeout && !Value32) {\r
+    gBS->Stall (1);\r
+    SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_SLOTSTATUS_REG, &Value32);\r
+    Timeout--;\r
+  }\r
+#else\r
+  SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, &Value32);\r
+  if (!Packet->Timeout) {\r
+    while (!(Value32 & IrqMask)) {\r
+      gBS->Stall (1);\r
+      SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, &Value32);\r
+    }\r
+  } else {\r
+    Timeout = Packet->Timeout;\r
+    while (Timeout && !(Value32 & IrqMask)) {\r
+      gBS->Stall (1);\r
+      SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, &Value32);\r
+      Timeout--;\r
+    }\r
+  }\r
+#endif\r
+  // Fill Packet Ata Status Block\r
+  Status = PciIo->Mem.Read (PciIo, EfiPciIoWidthUint32, 1, // Bar 1\r
+      SataPort->RegBase + 0x08,\r
+      sizeof (EFI_ATA_STATUS_BLOCK) / 4,\r
+      Packet->Asb);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+\r
+  if ((Packet->Timeout != 0) && (Timeout == 0)) {\r
+    DEBUG ((EFI_D_ERROR, "SiI3132AtaPassThru() Err:Timeout\n"));\r
+    //ASSERT (0);\r
+    return EFI_TIMEOUT;\r
+  } else if (Value32 & (SII3132_PORT_INT_CMDERR << 16)) {\r
+    SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_CMDERROR_REG, &Error);\r
+    DEBUG ((EFI_D_ERROR, "SiI3132AtaPassThru() CmdErr:0x%X (SiI3132 Err:0x%X)\n", Value32, Error));\r
+    ASSERT (0);\r
+    return EFI_DEVICE_ERROR;\r
+  } else if (Value32 & (SII3132_PORT_INT_CMDCOMPL << 16)) {\r
+    // Clear Command Complete\r
+    SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, SII3132_PORT_INT_CMDCOMPL << 16);\r
+\r
+    if (PciAllocMapping) {\r
+      Status = PciIo->Unmap (PciIo, PciAllocMapping);\r
+      ASSERT (!EFI_ERROR (Status));\r
+    }\r
+\r
+    // If the command was ATA_CMD_IDENTIFY_DRIVE then we need to update the BlockSize\r
+    if (Packet->Acb->AtaCommand == ATA_CMD_IDENTIFY_DRIVE) {\r
+      ATA_IDENTIFY_DATA *IdentifyData = (ATA_IDENTIFY_DATA*)Packet->InDataBuffer;\r
+\r
+      // Get the corresponding Block Device\r
+      SataDevice = GetSataDevice (SataSiI3132Instance, SataPort->Index, PortMultiplierPort);\r
+\r
+      // Check logical block size\r
+      if ((IdentifyData->phy_logic_sector_support & BIT12) != 0) {\r
+        ASSERT (SataDevice != NULL);\r
+        SataDevice->BlockSize = (UINT32) (((IdentifyData->logic_sector_size_hi << 16) |\r
+                                            IdentifyData->logic_sector_size_lo) * sizeof (UINT16));\r
+      } else {\r
+        SataDevice->BlockSize = 0x200;\r
+      }\r
+    }\r
+    return EFI_SUCCESS;\r
+  } else {\r
+    ASSERT (0);\r
+    return EFI_DEVICE_ERROR;\r
+  }\r
+}\r
+\r
+/**\r
+  Sends an ATA command to an ATA device that is attached to the ATA controller. This function\r
+  supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required,\r
+  and the non-blocking I/O functionality is optional.\r
+\r
+  @param[in]     This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in]     Port                The port number of the ATA device to send the command.\r
+  @param[in]     PortMultiplierPort  The port multiplier port number of the ATA device to send the command.\r
+                                     If there is no port multiplier, then specify 0.\r
+  @param[in,out] Packet              A pointer to the ATA command to send to the ATA device specified by Port\r
+                                     and PortMultiplierPort.\r
+  @param[in]     Event               If non-blocking I/O is not supported then Event is ignored, and blocking\r
+                                     I/O is performed. If Event is NULL, then blocking I/O is performed. If\r
+                                     Event is not NULL and non blocking I/O is supported, then non-blocking\r
+                                     I/O is performed, and Event will be signaled when the ATA command completes.\r
+\r
+  @retval EFI_SUCCESS                The ATA command was sent by the host. For bi-directional commands,\r
+                                     InTransferLength bytes were transferred from InDataBuffer. For write and\r
+                                     bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.\r
+  @retval EFI_BAD_BUFFER_SIZE        The ATA command was not executed. The number of bytes that could be transferred\r
+                                     is returned in InTransferLength. For write and bi-directional commands,\r
+                                     OutTransferLength bytes were transferred by OutDataBuffer.\r
+  @retval EFI_NOT_READY              The ATA command could not be sent because there are too many ATA commands\r
+                                     already queued. The caller may retry again later.\r
+  @retval EFI_DEVICE_ERROR           A device error occurred while attempting to send the ATA command.\r
+  @retval EFI_INVALID_PARAMETER      Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA\r
+                                     command was not sent, so no additional status information is available.\r
+\r
+**/\r
+EFI_STATUS\r
+SiI3132AtaPassThru (\r
+  IN     EFI_ATA_PASS_THRU_PROTOCOL       *This,\r
+  IN     UINT16                           Port,\r
+  IN     UINT16                           PortMultiplierPort,\r
+  IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet,\r
+  IN     EFI_EVENT                        Event OPTIONAL\r
+  )\r
+{\r
+  SATA_SI3132_INSTANCE    *SataSiI3132Instance;\r
+  SATA_SI3132_DEVICE      *SataDevice;\r
+  SATA_SI3132_PORT        *SataPort;\r
+\r
+  SataSiI3132Instance = INSTANCE_FROM_ATAPASSTHRU_THIS (This);\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  SataDevice = GetSataDevice (SataSiI3132Instance, Port, PortMultiplierPort);\r
+  if (!SataDevice) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  SataPort = SataDevice->Port;\r
+\r
+  DEBUG ((EFI_D_INFO, "SiI3132AtaPassThru(%d,%d) : AtaCmd:0x%X Prot:%d\n", Port, PortMultiplierPort,\r
+         Packet->Acb->AtaCommand, Packet->Protocol));\r
+\r
+  return SiI3132AtaPassThruCommand (SataSiI3132Instance, SataPort, PortMultiplierPort, Packet, Event);\r
+}\r
+\r
+/**\r
+  Used to retrieve the list of legal port numbers for ATA devices on an ATA controller.\r
+  These can either be the list of ports where ATA devices are actually present or the\r
+  list of legal port numbers for the ATA controller. Regardless, the caller of this\r
+  function must probe the port number returned to see if an ATA device is actually\r
+  present at that location on the ATA controller.\r
+\r
+  The GetNextPort() function retrieves the port number on an ATA controller. If on input\r
+  Port is 0xFFFF, then the port number of the first port on the ATA controller is returned\r
+  in Port and EFI_SUCCESS is returned.\r
+\r
+  If Port is a port number that was returned on a previous call to GetNextPort(), then the\r
+  port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS\r
+  is returned. If Port is not 0xFFFF and Port was not returned on a previous call to\r
+  GetNextPort(), then EFI_INVALID_PARAMETER is returned.\r
+\r
+  If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is\r
+  returned.\r
+\r
+  @param[in]     This           A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in,out] Port           On input, a pointer to the port number on the ATA controller.\r
+                                On output, a pointer to the next port number on the ATA\r
+                                controller. An input value of 0xFFFF retrieves the first port\r
+                                number on the ATA controller.\r
+\r
+  @retval EFI_SUCCESS           The next port number on the ATA controller was returned in Port.\r
+  @retval EFI_NOT_FOUND         There are no more ports on this ATA controller.\r
+  @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call\r
+                                to GetNextPort().\r
+\r
+**/\r
+EFI_STATUS\r
+SiI3132GetNextPort (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN OUT UINT16                 *Port\r
+  )\r
+{\r
+  SATA_SI3132_INSTANCE    *SataSiI3132Instance;\r
+  UINTN                   PrevPort;\r
+  EFI_STATUS              Status = EFI_SUCCESS;\r
+\r
+  SataSiI3132Instance = INSTANCE_FROM_ATAPASSTHRU_THIS (This);\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  PrevPort = *Port;\r
+\r
+  if (PrevPort == 0xFFFF) {\r
+    *Port = 0;\r
+  } else {\r
+    if (PrevPort < SATA_SII3132_MAXPORT) {\r
+        *Port = PrevPort + 1;\r
+    } else {\r
+        Status = EFI_NOT_FOUND;\r
+    }\r
+  }\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA\r
+  controller. These can either be the list of port multiplier ports where ATA devices are actually\r
+  present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this\r
+  function must probe the port number and port multiplier port number returned to see if an ATA\r
+  device is actually present.\r
+\r
+  The GetNextDevice() function retrieves the port multiplier port number of an ATA device\r
+  present on a port of an ATA controller.\r
+\r
+  If PortMultiplierPort points to a port multiplier port number value that was returned on a\r
+  previous call to GetNextDevice(), then the port multiplier port number of the next ATA device\r
+  on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is\r
+  returned.\r
+\r
+  If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first\r
+  ATA device on port of the ATA controller is returned in PortMultiplierPort and\r
+  EFI_SUCCESS is returned.\r
+\r
+  If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort\r
+  was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER\r
+  is returned.\r
+\r
+  If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of\r
+  the ATA controller, then EFI_NOT_FOUND is returned.\r
+\r
+  @param[in]     This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in]     Port                The port number present on the ATA controller.\r
+  @param[in,out] PortMultiplierPort  On input, a pointer to the port multiplier port number of an\r
+                                     ATA device present on the ATA controller.\r
+                                     If on input a PortMultiplierPort of 0xFFFF is specified,\r
+                                     then the port multiplier port number of the first ATA device\r
+                                     is returned. On output, a pointer to the port multiplier port\r
+                                     number of the next ATA device present on an ATA controller.\r
+\r
+  @retval EFI_SUCCESS                The port multiplier port number of the next ATA device on the port\r
+                                     of the ATA controller was returned in PortMultiplierPort.\r
+  @retval EFI_NOT_FOUND              There are no more ATA devices on this port of the ATA controller.\r
+  @retval EFI_INVALID_PARAMETER      PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not\r
+                                     returned on a previous call to GetNextDevice().\r
+\r
+**/\r
+EFI_STATUS\r
+SiI3132GetNextDevice (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN UINT16                     Port,\r
+  IN OUT UINT16                 *PortMultiplierPort\r
+  )\r
+{\r
+  SATA_SI3132_INSTANCE    *SataSiI3132Instance;\r
+  SATA_SI3132_PORT        *SataPort;\r
+  SATA_SI3132_DEVICE      *SataDevice;\r
+  LIST_ENTRY              *List;\r
+  EFI_STATUS              Status = EFI_SUCCESS;\r
+\r
+  SataSiI3132Instance = INSTANCE_FROM_ATAPASSTHRU_THIS (This);\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (Port >= SATA_SII3132_MAXPORT) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  SataPort = &(SataSiI3132Instance->Ports[Port]);\r
+\r
+  if (*PortMultiplierPort == 0xFFFF) {\r
+    List = SataPort->Devices.ForwardLink;\r
+    if (List != &SataPort->Devices) {\r
+      // The list is not empty, return the first device\r
+      *PortMultiplierPort = ((SATA_SI3132_DEVICE*)List)->Index;\r
+    } else {\r
+      Status = EFI_NOT_FOUND;\r
+    }\r
+  } else {\r
+    SataDevice = GetSataDevice (SataSiI3132Instance, Port, *PortMultiplierPort);\r
+    if (SataDevice != NULL) {\r
+      // We have found the previous port multiplier, return the next one\r
+      List = SataDevice->Link.ForwardLink;\r
+      if (List != &SataPort->Devices) {\r
+        *PortMultiplierPort = ((SATA_SI3132_DEVICE*)List)->Index;\r
+      } else {\r
+        Status = EFI_NOT_FOUND;\r
+      }\r
+    } else {\r
+      Status = EFI_NOT_FOUND;\r
+    }\r
+  }\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Used to allocate and build a device path node for an ATA device on an ATA controller.\r
+\r
+  The BuildDevicePath() function allocates and builds a single device node for the ATA\r
+  device specified by Port and PortMultiplierPort. If the ATA device specified by Port and\r
+  PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned.\r
+  If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough\r
+  resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.\r
+\r
+  Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of\r
+  DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort,\r
+  and EFI_SUCCESS is returned.\r
+\r
+  @param[in]     This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in]     Port                Port specifies the port number of the ATA device for which a\r
+                                     device path node is to be allocated and built.\r
+  @param[in]     PortMultiplierPort  The port multiplier port number of the ATA device for which a\r
+                                     device path node is to be allocated and built. If there is no\r
+                                     port multiplier, then specify 0.\r
+  @param[in,out] DevicePath          A pointer to a single device path node that describes the ATA\r
+                                     device specified by Port and PortMultiplierPort. This function\r
+                                     is responsible for allocating the buffer DevicePath with the\r
+                                     boot service AllocatePool(). It is the caller's responsibility\r
+                                     to free DevicePath when the caller is finished with DevicePath.\r
+  @retval EFI_SUCCESS                The device path node that describes the ATA device specified by\r
+                                     Port and PortMultiplierPort was allocated and returned in DevicePath.\r
+  @retval EFI_NOT_FOUND              The ATA device specified by Port and PortMultiplierPort does not\r
+                                     exist on the ATA controller.\r
+  @retval EFI_INVALID_PARAMETER      DevicePath is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES       There are not enough resources to allocate DevicePath.\r
+\r
+**/\r
+EFI_STATUS\r
+SiI3132BuildDevicePath (\r
+  IN     EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN     UINT16                     Port,\r
+  IN     UINT16                     PortMultiplierPort,\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL   **DevicePath\r
+  )\r
+{\r
+  SATA_SI3132_INSTANCE        *SataSiI3132Instance;\r
+  SATA_SI3132_DEVICE          *SataDevice;\r
+  EFI_DEVICE_PATH_PROTOCOL    *SiI3132DevicePath;\r
+\r
+  SATA_TRACE ("SiI3132BuildDevicePath()");\r
+\r
+  SataSiI3132Instance = INSTANCE_FROM_ATAPASSTHRU_THIS (This);\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  SataDevice = GetSataDevice (SataSiI3132Instance, Port, PortMultiplierPort);\r
+  if (SataDevice == NULL) {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  SiI3132DevicePath = CreateDeviceNode (MESSAGING_DEVICE_PATH, MSG_SATA_DP, sizeof (SATA_DEVICE_PATH));\r
+  if (SiI3132DevicePath == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  ((SATA_DEVICE_PATH*)SiI3132DevicePath)->HBAPortNumber = Port;\r
+  if (FeaturePcdGet (PcdSataSiI3132FeaturePMPSupport)) {\r
+    ((SATA_DEVICE_PATH*)SiI3132DevicePath)->PortMultiplierPortNumber = PortMultiplierPort;\r
+  } else {\r
+    //Temp:((SATA_DEVICE_PATH*)SiI3132DevicePath)->PortMultiplierPortNumber = SATA_HBA_DIRECT_CONNECT_FLAG;\r
+    ((SATA_DEVICE_PATH*)SiI3132DevicePath)->PortMultiplierPortNumber = 0;\r
+  }\r
+  ((SATA_DEVICE_PATH*)SiI3132DevicePath)->Lun = Port; //TODO: Search information how to define properly LUN (Logical Unit Number)\r
+\r
+  *DevicePath = SiI3132DevicePath;\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Used to translate a device path node to a port number and port multiplier port number.\r
+\r
+  The GetDevice() function determines the port and port multiplier port number associated with\r
+  the ATA device described by DevicePath. If DevicePath is a device path node type that the\r
+  ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents\r
+  DevicePath into a port number and port multiplier port number.\r
+\r
+  If this translation is successful, then that port number and port multiplier port number are returned\r
+  in Port and PortMultiplierPort, and EFI_SUCCESS is returned.\r
+\r
+  If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.\r
+\r
+  If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then\r
+  EFI_UNSUPPORTED is returned.\r
+\r
+  If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not\r
+  a valid translation from DevicePath to a port number and port multiplier port number, then\r
+  EFI_NOT_FOUND is returned.\r
+\r
+  @param[in]  This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in]  DevicePath          A pointer to the device path node that describes an ATA device on the\r
+                                  ATA controller.\r
+  @param[out] Port                On return, points to the port number of an ATA device on the ATA controller.\r
+  @param[out] PortMultiplierPort  On return, points to the port multiplier port number of an ATA device\r
+                                  on the ATA controller.\r
+\r
+  @retval EFI_SUCCESS             DevicePath was successfully translated to a port number and port multiplier\r
+                                  port number, and they were returned in Port and PortMultiplierPort.\r
+  @retval EFI_INVALID_PARAMETER   DevicePath is NULL.\r
+  @retval EFI_INVALID_PARAMETER   Port is NULL.\r
+  @retval EFI_INVALID_PARAMETER   PortMultiplierPort is NULL.\r
+  @retval EFI_UNSUPPORTED         This driver does not support the device path node type in DevicePath.\r
+  @retval EFI_NOT_FOUND           A valid translation from DevicePath to a port number and port multiplier\r
+                                  port number does not exist.\r
+**/\r
+EFI_STATUS\r
+SiI3132GetDevice (\r
+  IN  EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN  EFI_DEVICE_PATH_PROTOCOL   *DevicePath,\r
+  OUT UINT16                     *Port,\r
+  OUT UINT16                     *PortMultiplierPort\r
+  )\r
+{\r
+  SATA_SI3132_INSTANCE        *SataSiI3132Instance;\r
+\r
+  SATA_TRACE ("SiI3132GetDevice()");\r
+\r
+  if (!DevicePath || !Port || !PortMultiplierPort) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if ((DevicePath->Type != MESSAGING_DEVICE_PATH) || (DevicePath->SubType != MSG_SATA_DP)) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
+  SataSiI3132Instance = INSTANCE_FROM_ATAPASSTHRU_THIS (This);\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (((SATA_DEVICE_PATH*)DevicePath)->Lun >= SATA_SII3132_MAXPORT) {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  if (FeaturePcdGet (PcdSataSiI3132FeaturePMPSupport)) {\r
+    ASSERT (0); //TODO: Implement me!\r
+    return EFI_UNSUPPORTED;\r
+  } else {\r
+    *Port = ((SATA_DEVICE_PATH*)DevicePath)->Lun;\r
+    // Return the first Sata Sevice as there should be only one directly connected\r
+    *PortMultiplierPort = ((SATA_SI3132_DEVICE*)SataSiI3132Instance->Ports[*Port].Devices.ForwardLink)->Index;\r
+    return EFI_SUCCESS;\r
+  }\r
+}\r
+\r
+EFI_STATUS\r
+SiI3132HwResetPort (\r
+  IN SATA_SI3132_PORT *SataPort\r
+  )\r
+{\r
+  EFI_PCI_IO_PROTOCOL *PciIo;\r
+  UINT32              Value32;\r
+  UINTN               Timeout;\r
+\r
+  SATA_TRACE ("SiI3132HwResetPort()");\r
+\r
+  PciIo = SataPort->Instance->PciIo;\r
+\r
+  // Clear Port Reset\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_CONTROLCLEAR_REG, SII3132_PORT_CONTROL_RESET);\r
+\r
+  SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_STATUS_REG, &Value32);\r
+  ASSERT (!(Value32 & SII3132_PORT_CONTROL_RESET));\r
+\r
+  // Initialize error counters\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_ERRCOUNTDECODE, 0);\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_ERRCOUNTCRC, 0);\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_ERRCOUNTHANDSHAKE, 0);\r
+\r
+  // Enable interrupts for command completion and command errors\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_ENABLEINT_REG, SII3132_PORT_INT_CMDCOMPL | SII3132_PORT_INT_CMDERR);\r
+\r
+  // Clear IRQ\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_ENABLEINT_REG, SII3132_PORT_INT_CMDCOMPL | SII3132_PORT_INT_CMDERR | SII3132_PORT_INT_PORTRDY | (1 << 3));\r
+\r
+  // Wait until Port Ready\r
+  SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, &Value32);\r
+  Timeout = 1000;\r
+  while ((Timeout > 0) && ((Value32 & SII3132_PORT_INT_PORTRDY) == 0)) {\r
+    gBS->Stall (1);\r
+    Timeout--;\r
+    SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, &Value32);\r
+  }\r
+  // Clear IRQ\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_INTSTATUS_REG, SII3132_PORT_INT_PORTRDY);\r
+\r
+  if (Timeout == 0) {\r
+    SATA_TRACE ("SiI3132HwResetPort(): Timeout");\r
+    return EFI_TIMEOUT;\r
+  } else if ((Value32 & SII3132_PORT_INT_PORTRDY) == 0) {\r
+    SATA_TRACE ("SiI3132HwResetPort(): Port Not Ready");\r
+    return EFI_DEVICE_ERROR;\r
+  } else {\r
+    return EFI_SUCCESS;\r
+  }\r
+}\r
+\r
+/**\r
+  Resets a specific port on the ATA controller. This operation also resets all the ATA devices\r
+  connected to the port.\r
+\r
+  The ResetChannel() function resets an a specific port on an ATA controller. This operation\r
+  resets all the ATA devices connected to that port. If this ATA controller does not support\r
+  a reset port operation, then EFI_UNSUPPORTED is returned.\r
+\r
+  If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is\r
+  returned.\r
+\r
+  If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.\r
+\r
+  If the port reset operation is completed, then EFI_SUCCESS is returned.\r
+\r
+  @param[in]  This          A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in]  Port          The port number on the ATA controller.\r
+\r
+  @retval EFI_SUCCESS       The ATA controller port was reset.\r
+  @retval EFI_UNSUPPORTED   The ATA controller does not support a port reset operation.\r
+  @retval EFI_DEVICE_ERROR  A device error occurred while attempting to reset the ATA port.\r
+  @retval EFI_TIMEOUT       A timeout occurred while attempting to reset the ATA port.\r
+\r
+**/\r
+EFI_STATUS\r
+SiI3132ResetPort (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN UINT16                     Port\r
+  )\r
+{\r
+  SATA_SI3132_INSTANCE    *SataSiI3132Instance;\r
+  SATA_SI3132_PORT        *SataPort;\r
+\r
+  SATA_TRACE ("SiI3132ResetPort()");\r
+\r
+  SataSiI3132Instance = INSTANCE_FROM_ATAPASSTHRU_THIS (This);\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (Port >= SATA_SII3132_MAXPORT) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
+  SataPort = &(SataSiI3132Instance->Ports[Port]);\r
+  return SiI3132HwResetPort (SataPort);\r
+}\r
+\r
+/**\r
+  Resets an ATA device that is connected to an ATA controller.\r
+\r
+  The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort.\r
+  If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is\r
+  returned.\r
+\r
+  If Port or PortMultiplierPort are not in a valid range for this ATA controller, then\r
+  EFI_INVALID_PARAMETER is returned.\r
+\r
+  If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR\r
+  is returned.\r
+\r
+  If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is\r
+  returned.\r
+\r
+  If the device reset operation is completed, then EFI_SUCCESS is returned.\r
+\r
+  @param[in] This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in] Port                Port represents the port number of the ATA device to be reset.\r
+  @param[in] PortMultiplierPort  The port multiplier port number of the ATA device to reset.\r
+                                 If there is no port multiplier, then specify 0.\r
+  @retval EFI_SUCCESS            The ATA device specified by Port and PortMultiplierPort was reset.\r
+  @retval EFI_UNSUPPORTED        The ATA controller does not support a device reset operation.\r
+  @retval EFI_INVALID_PARAMETER  Port or PortMultiplierPort are invalid.\r
+  @retval EFI_DEVICE_ERROR       A device error occurred while attempting to reset the ATA device\r
+                                 specified by Port and PortMultiplierPort.\r
+  @retval EFI_TIMEOUT            A timeout occurred while attempting to reset the ATA device\r
+                                 specified by Port and PortMultiplierPort.\r
+\r
+**/\r
+EFI_STATUS\r
+SiI3132ResetDevice (\r
+  IN EFI_ATA_PASS_THRU_PROTOCOL *This,\r
+  IN UINT16                     Port,\r
+  IN UINT16                     PortMultiplierPort\r
+  )\r
+{\r
+  EFI_PCI_IO_PROTOCOL     *PciIo;\r
+  SATA_SI3132_INSTANCE    *SataSiI3132Instance;\r
+  SATA_SI3132_PORT        *SataPort;\r
+  SATA_SI3132_DEVICE      *SataDevice;\r
+  UINTN                   Timeout;\r
+  UINT32                  Value32;\r
+\r
+  SATA_TRACE ("SiI3132ResetDevice()");\r
+\r
+  SataSiI3132Instance = INSTANCE_FROM_ATAPASSTHRU_THIS (This);\r
+  if (!SataSiI3132Instance) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  PciIo = SataSiI3132Instance->PciIo;\r
+\r
+  SataDevice = GetSataDevice (SataSiI3132Instance, Port, PortMultiplierPort);\r
+  if (!SataDevice) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  SataPort = SataDevice->Port;\r
+\r
+  SATA_PORT_WRITE32 (SataPort->RegBase + SII3132_PORT_CONTROLSET_REG, SII3132_PORT_DEVICE_RESET);\r
+\r
+  Timeout = 100;\r
+  SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_STATUS_REG, &Value32);\r
+  while ((Timeout > 0) && ((Value32 & SII3132_PORT_DEVICE_RESET) != 0)) {\r
+    gBS->Stall (1);\r
+    SATA_PORT_READ32 (SataPort->RegBase + SII3132_PORT_STATUS_REG, &Value32);\r
+    Timeout--;\r
+  }\r
+\r
+  if (Timeout == 0) {\r
+    SATA_TRACE ("SiI3132ResetDevice(): Timeout");\r
+    return EFI_TIMEOUT;\r
+  } else {\r
+    return EFI_SUCCESS;\r
+  }\r
+}\r
index 6e6e954..f557527 100644 (file)
@@ -3,7 +3,7 @@
 #\r
 # This Package provides headers and libraries that conform to EFI/PI Industry standards.\r
 # Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
-# Copyright (c) 2012-2014, ARM Ltd. All rights reserved.<BR>\r
+# Copyright (c) 2012-2015, ARM Ltd. All rights reserved.<BR>\r
 #\r
 #    This program and the accompanying materials are licensed and made available under\r
 #    the terms and conditions of the BSD License which accompanies this distribution.\r
@@ -87,6 +87,8 @@
   # Add 'dumpfdt' EFI Shell command\r
   gEmbeddedTokenSpaceGuid.PcdDumpFdtShellCommand|TRUE|BOOLEAN|0x00000056\r
 \r
+  gEmbeddedTokenSpaceGuid.PcdSataSiI3132FeaturePMPSupport|FALSE|BOOLEAN|0x00000050\r
+  gEmbeddedTokenSpaceGuid.PcdSataSiI3132FeatureDirectCommandIssuing|FALSE|BOOLEAN|0x00000051\r
 \r
 [PcdsFixedAtBuild.common]\r
   gEmbeddedTokenSpaceGuid.PcdEmbeddedAutomaticBootCommand|L""|VOID*|0x00000007\r
index 76c5ced..6719eea 100644 (file)
   # Drivers\r
   EmbeddedPkg/Drivers/Isp1761UsbDxe/Isp1761UsbDxe.inf\r
   EmbeddedPkg/Drivers/Lan9118Dxe/Lan9118Dxe.inf\r
+  EmbeddedPkg/Drivers/SataSiI3132Dxe/SataSiI3132Dxe.inf\r
 \r
 [Components.IA32, Components.X64, Components.IPF, Components.ARM]\r
   EmbeddedPkg/GdbStub/GdbStub.inf\r