OvmfPkg/SataControllerDxe/SataController.c

   1 /** @file
   2   This driver module produces IDE_CONTROLLER_INIT protocol for Sata Controllers.
   3
   4   Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "SataController.h"
  16
  17 ///
  18 /// EFI_DRIVER_BINDING_PROTOCOL instance
  19 ///
  20 EFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding = {
  21   SataControllerSupported,
  22   SataControllerStart,
  23   SataControllerStop,
  24   0xa,
  25   NULL,
  26   NULL
  27 };
  28
  29 /**
  30   Read AHCI Operation register.
  31
  32   @param PciIo      The PCI IO protocol instance.
  33   @param Offset     The operation register offset.
  34
  35   @return The register content read.
  36
  37 **/
  38 UINT32
  39 EFIAPI
  40 AhciReadReg (
  41   IN EFI_PCI_IO_PROTOCOL    *PciIo,
  42   IN UINT32                 Offset
  43   )
  44 {
  45   UINT32    Data;
  46
  47   ASSERT (PciIo != NULL);
  48
  49   Data = 0;
  50
  51   PciIo->Mem.Read (
  52                PciIo,
  53                EfiPciIoWidthUint32,
  54                AHCI_BAR_INDEX,
  55                (UINT64) Offset,
  56                1,
  57                &Data
  58                );
  59
  60   return Data;
  61 }
  62
  63 /**
  64   Write AHCI Operation register.
  65
  66   @param PciIo      The PCI IO protocol instance.
  67   @param Offset     The operation register offset.
  68   @param Data       The data used to write down.
  69
  70 **/
  71 VOID
  72 EFIAPI
  73 AhciWriteReg (
  74   IN EFI_PCI_IO_PROTOCOL    *PciIo,
  75   IN UINT32                 Offset,
  76   IN UINT32                 Data
  77   )
  78 {
  79   ASSERT (PciIo != NULL);
  80
  81   PciIo->Mem.Write (
  82                PciIo,
  83                EfiPciIoWidthUint32,
  84                AHCI_BAR_INDEX,
  85                (UINT64) Offset,
  86                1,
  87                &Data
  88                );
  89
  90   return;
  91 }
  92
  93 /**
  94   This function is used to calculate the best PIO mode supported by specific IDE device
  95
  96   @param IdentifyData   The identify data of specific IDE device.
  97   @param DisPioMode     Disqualified PIO modes collection.
  98   @param SelectedMode   Available PIO modes collection.
  99
 100   @retval EFI_SUCCESS       Best PIO modes are returned.
 101   @retval EFI_UNSUPPORTED   The device doesn't support PIO mode,
 102                             or all supported modes have been disqualified.
 103 **/
 104 EFI_STATUS
 105 CalculateBestPioMode (
 106   IN EFI_IDENTIFY_DATA  *IdentifyData,
 107   IN UINT16             *DisPioMode OPTIONAL,
 108   OUT UINT16            *SelectedMode
 109   )
 110 {
 111   UINT16    PioMode;
 112   UINT16    AdvancedPioMode;
 113   UINT16    Temp;
 114   UINT16    Index;
 115   UINT16    MinimumPioCycleTime;
 116
 117   Temp = 0xff;
 118
 119   PioMode = (UINT8) (((ATA5_IDENTIFY_DATA *) (&(IdentifyData->AtaData)))->pio_cycle_timing >> 8);
 120
 121   //
 122   // See whether Identify Data word 64 - 70 are valid
 123   //
 124   if ((IdentifyData->AtaData.field_validity & 0x02) == 0x02) {
 125
 126     AdvancedPioMode = IdentifyData->AtaData.advanced_pio_modes;
 127     DEBUG ((EFI_D_INFO, "CalculateBestPioMode: AdvancedPioMode = %x\n", AdvancedPioMode));
 128
 129     for (Index = 0; Index < 8; Index++) {
 130       if ((AdvancedPioMode & 0x01) != 0) {
 131         Temp = Index;
 132       }
 133
 134       AdvancedPioMode >>= 1;
 135     }
 136
 137     //
 138     // If Temp is modified, mean the advanced_pio_modes is not zero;
 139     // if Temp is not modified, mean there is no advanced PIO mode supported,
 140     // the best PIO Mode is the value in pio_cycle_timing.
 141     //
 142     if (Temp != 0xff) {
 143       AdvancedPioMode = (UINT16) (Temp + 3);
 144     } else {
 145       AdvancedPioMode = PioMode;
 146     }
 147
 148     //
 149     // Limit the PIO mode to at most PIO4.
 150     //
 151     PioMode = (UINT16) MIN (AdvancedPioMode, 4);
 152
 153     MinimumPioCycleTime = IdentifyData->AtaData.min_pio_cycle_time_with_flow_control;
 154
 155     if (MinimumPioCycleTime <= 120) {
 156       PioMode = (UINT16) MIN (4, PioMode);
 157     } else if (MinimumPioCycleTime <= 180) {
 158       PioMode = (UINT16) MIN (3, PioMode);
 159     } else if (MinimumPioCycleTime <= 240) {
 160       PioMode = (UINT16) MIN (2, PioMode);
 161     } else {
 162       PioMode = 0;
 163     }
 164
 165     //
 166     // Degrade the PIO mode if the mode has been disqualified
 167     //
 168     if (DisPioMode != NULL) {
 169       if (*DisPioMode < 2) {
 170         return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2
 171       }
 172
 173       if (PioMode >= *DisPioMode) {
 174         PioMode = (UINT16) (*DisPioMode - 1);
 175       }
 176     }
 177
 178     if (PioMode < 2) {
 179       *SelectedMode = 1;        // ATA_PIO_MODE_BELOW_2;
 180     } else {
 181       *SelectedMode = PioMode;  // ATA_PIO_MODE_2 to ATA_PIO_MODE_4;
 182     }
 183
 184   } else {
 185     //
 186     // Identify Data word 64 - 70 are not valid
 187     // Degrade the PIO mode if the mode has been disqualified
 188     //
 189     if (DisPioMode != NULL) {
 190       if (*DisPioMode < 2) {
 191         return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2
 192       }
 193
 194       if (PioMode == *DisPioMode) {
 195         PioMode--;
 196       }
 197     }
 198
 199     if (PioMode < 2) {
 200       *SelectedMode = 1;        // ATA_PIO_MODE_BELOW_2;
 201     } else {
 202       *SelectedMode = 2;        // ATA_PIO_MODE_2;
 203     }
 204
 205   }
 206
 207   return EFI_SUCCESS;
 208 }
 209
 210 /**
 211   This function is used to calculate the best UDMA mode supported by specific IDE device
 212
 213   @param IdentifyData   The identify data of specific IDE device.
 214   @param DisUDmaMode     Disqualified UDMA modes collection.
 215   @param SelectedMode   Available UDMA modes collection.
 216
 217   @retval EFI_SUCCESS       Best UDMA modes are returned.
 218   @retval EFI_UNSUPPORTED   The device doesn't support UDMA mode,
 219                             or all supported modes have been disqualified.
 220 **/
 221 EFI_STATUS
 222 CalculateBestUdmaMode (
 223   IN EFI_IDENTIFY_DATA  *IdentifyData,
 224   IN UINT16             *DisUDmaMode OPTIONAL,
 225   OUT UINT16            *SelectedMode
 226   )
 227 {
 228   UINT16    TempMode;
 229   UINT16    DeviceUDmaMode;
 230
 231   DeviceUDmaMode = 0;
 232
 233   //
 234   // Check whether the WORD 88 (supported UltraDMA by drive) is valid
 235   //
 236   if ((IdentifyData->AtaData.field_validity & 0x04) == 0x00) {
 237     return EFI_UNSUPPORTED;
 238   }
 239
 240   DeviceUDmaMode = IdentifyData->AtaData.ultra_dma_mode;
 241   DEBUG ((EFI_D_INFO, "CalculateBestUdmaMode: DeviceUDmaMode = %x\n", DeviceUDmaMode));
 242   DeviceUDmaMode &= 0x3f;
 243   TempMode = 0;                 // initialize it to UDMA-0
 244
 245   while ((DeviceUDmaMode >>= 1) != 0) {
 246     TempMode++;
 247   }
 248
 249   //
 250   // Degrade the UDMA mode if the mode has been disqualified
 251   //
 252   if (DisUDmaMode != NULL) {
 253     if (*DisUDmaMode == 0) {
 254       *SelectedMode = 0;
 255       return EFI_UNSUPPORTED;   // no mode below ATA_UDMA_MODE_0
 256     }
 257
 258     if (TempMode >= *DisUDmaMode) {
 259       TempMode = (UINT16) (*DisUDmaMode - 1);
 260     }
 261   }
 262
 263   //
 264   // Possible returned mode is between ATA_UDMA_MODE_0 and ATA_UDMA_MODE_5
 265   //
 266   *SelectedMode = TempMode;
 267
 268   return EFI_SUCCESS;
 269 }
 270
 271 /**
 272   The Entry Point of module. It follows the standard UEFI driver model.
 273
 274   @param[in] ImageHandle    The firmware allocated handle for the EFI image.
 275   @param[in] SystemTable    A pointer to the EFI System Table.
 276
 277   @retval EFI_SUCCESS   The entry point is executed successfully.
 278   @retval other         Some error occurs when executing this entry point.
 279
 280 **/
 281 EFI_STATUS
 282 EFIAPI
 283 InitializeSataControllerDriver (
 284   IN EFI_HANDLE         ImageHandle,
 285   IN EFI_SYSTEM_TABLE   *SystemTable
 286   )
 287 {
 288   EFI_STATUS    Status;
 289
 290   //
 291   // Install driver model protocol(s).
 292   //
 293   Status = EfiLibInstallDriverBindingComponentName2 (
 294              ImageHandle,
 295              SystemTable,
 296              &gSataControllerDriverBinding,
 297              ImageHandle,
 298              &gSataControllerComponentName,
 299              &gSataControllerComponentName2
 300              );
 301   ASSERT_EFI_ERROR (Status);
 302
 303   return Status;
 304 }
 305
 306 /**
 307   Supported function of Driver Binding protocol for this driver.
 308   Test to see if this driver supports ControllerHandle.
 309
 310   @param This                   Protocol instance pointer.
 311   @param Controller             Handle of device to test.
 312   @param RemainingDevicePath    A pointer to the device path.
 313                                 it should be ignored by device driver.
 314
 315   @retval EFI_SUCCESS           This driver supports this device.
 316   @retval EFI_ALREADY_STARTED   This driver is already running on this device.
 317   @retval other                 This driver does not support this device.
 318
 319 **/
 320 EFI_STATUS
 321 EFIAPI
 322 SataControllerSupported (
 323   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 324   IN EFI_HANDLE                     Controller,
 325   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 326   )
 327 {
 328   EFI_STATUS            Status;
 329   EFI_PCI_IO_PROTOCOL   *PciIo;
 330   PCI_TYPE00            PciData;
 331
 332   //
 333   // Attempt to open PCI I/O Protocol
 334   //
 335   Status = gBS->OpenProtocol (
 336                   Controller,
 337                   &gEfiPciIoProtocolGuid,
 338                   (VOID **) &PciIo,
 339                   This->DriverBindingHandle,
 340                   Controller,
 341                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 342                   );
 343   if (EFI_ERROR (Status)) {
 344     return Status;
 345   }
 346
 347   //
 348   // Now further check the PCI header: Base Class (offset 0x0B) and
 349   // Sub Class (offset 0x0A). This controller should be an SATA controller
 350   //
 351   Status = PciIo->Pci.Read (
 352                         PciIo,
 353                         EfiPciIoWidthUint8,
 354                         PCI_CLASSCODE_OFFSET,
 355                         sizeof (PciData.Hdr.ClassCode),
 356                         PciData.Hdr.ClassCode
 357                         );
 358   if (EFI_ERROR (Status)) {
 359     return EFI_UNSUPPORTED;
 360   }
 361
 362   if (IS_PCI_IDE (&PciData) || IS_PCI_SATADPA (&PciData)) {
 363     return EFI_SUCCESS;
 364   }
 365
 366   return EFI_UNSUPPORTED;
 367 }
 368
 369 /**
 370   This routine is called right after the .Supported() called and
 371   Start this driver on ControllerHandle.
 372
 373   @param This                   Protocol instance pointer.
 374   @param Controller             Handle of device to bind driver to.
 375   @param RemainingDevicePath    A pointer to the device path.
 376                                 it should be ignored by device driver.
 377
 378   @retval EFI_SUCCESS           This driver is added to this device.
 379   @retval EFI_ALREADY_STARTED   This driver is already running on this device.
 380   @retval other                 Some error occurs when binding this driver to this device.
 381
 382 **/
 383 EFI_STATUS
 384 EFIAPI
 385 SataControllerStart (
 386   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 387   IN EFI_HANDLE                     Controller,
 388   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
 389   )
 390 {
 391   EFI_STATUS                        Status;
 392   EFI_PCI_IO_PROTOCOL               *PciIo;
 393   UINT64                            OriginalPciAttributes;
 394   PCI_TYPE00                        PciData;
 395   EFI_SATA_CONTROLLER_PRIVATE_DATA  *SataPrivateData;
 396   UINT32                            Data32;
 397   UINTN                             ChannelDeviceCount;
 398
 399   DEBUG ((EFI_D_INFO, "SataControllerStart START\n"));
 400
 401   SataPrivateData = NULL;
 402
 403   //
 404   // Now test and open PCI I/O Protocol
 405   //
 406   Status = gBS->OpenProtocol (
 407                   Controller,
 408                   &gEfiPciIoProtocolGuid,
 409                   (VOID **) &PciIo,
 410                   This->DriverBindingHandle,
 411                   Controller,
 412                   EFI_OPEN_PROTOCOL_BY_DRIVER
 413                   );
 414   if (EFI_ERROR (Status)) {
 415     goto Bail;
 416   }
 417
 418   //
 419   // Save original PCI attributes, and enable IO space access, memory space
 420   // access, and Bus Master (DMA).
 421   //
 422   Status = PciIo->Attributes (PciIo, EfiPciIoAttributeOperationGet, 0,
 423                     &OriginalPciAttributes);
 424   if (EFI_ERROR (Status)) {
 425     goto ClosePciIo;
 426   }
 427   Status = PciIo->Attributes (PciIo, EfiPciIoAttributeOperationEnable,
 428                     EFI_PCI_DEVICE_ENABLE, NULL);
 429   if (EFI_ERROR (Status)) {
 430     goto ClosePciIo;
 431   }
 432
 433   //
 434   // Allocate Sata Private Data structure
 435   //
 436   SataPrivateData = AllocateZeroPool (sizeof (EFI_SATA_CONTROLLER_PRIVATE_DATA));
 437   if (SataPrivateData == NULL) {
 438     Status = EFI_OUT_OF_RESOURCES;
 439     goto RestorePciAttributes;
 440   }
 441
 442   //
 443   // Initialize Sata Private Data
 444   //
 445   SataPrivateData->Signature = SATA_CONTROLLER_SIGNATURE;
 446   SataPrivateData->PciIo = PciIo;
 447   SataPrivateData->OriginalPciAttributes = OriginalPciAttributes;
 448   SataPrivateData->IdeInit.GetChannelInfo = IdeInitGetChannelInfo;
 449   SataPrivateData->IdeInit.NotifyPhase = IdeInitNotifyPhase;
 450   SataPrivateData->IdeInit.SubmitData = IdeInitSubmitData;
 451   SataPrivateData->IdeInit.DisqualifyMode = IdeInitDisqualifyMode;
 452   SataPrivateData->IdeInit.CalculateMode = IdeInitCalculateMode;
 453   SataPrivateData->IdeInit.SetTiming = IdeInitSetTiming;
 454   SataPrivateData->IdeInit.EnumAll = SATA_ENUMER_ALL;
 455
 456   Status = PciIo->Pci.Read (
 457                         PciIo,
 458                         EfiPciIoWidthUint8,
 459                         PCI_CLASSCODE_OFFSET,
 460                         sizeof (PciData.Hdr.ClassCode),
 461                         PciData.Hdr.ClassCode
 462                         );
 463   if (EFI_ERROR (Status)) {
 464     goto FreeSataPrivateData;
 465   }
 466
 467   if (IS_PCI_IDE (&PciData)) {
 468     SataPrivateData->IdeInit.ChannelCount = IDE_MAX_CHANNEL;
 469     SataPrivateData->DeviceCount = IDE_MAX_DEVICES;
 470   } else if (IS_PCI_SATADPA (&PciData)) {
 471     //
 472     // Read Host Capability Register(CAP) to get Number of Ports(NPS) and Supports Port Multiplier(SPM)
 473     //   NPS is 0's based value indicating the maximum number of ports supported by the HBA silicon.
 474     //   A maximum of 32 ports can be supported. A value of '0h', indicating one port, is the minimum requirement.
 475     //
 476     Data32 = AhciReadReg (PciIo, R_AHCI_CAP);
 477     SataPrivateData->IdeInit.ChannelCount = (UINT8) ((Data32 & B_AHCI_CAP_NPS) + 1);
 478     SataPrivateData->DeviceCount = AHCI_MAX_DEVICES;
 479     if ((Data32 & B_AHCI_CAP_SPM) == B_AHCI_CAP_SPM) {
 480       SataPrivateData->DeviceCount = AHCI_MULTI_MAX_DEVICES;
 481     }
 482   }
 483
 484   ChannelDeviceCount = (UINTN) (SataPrivateData->IdeInit.ChannelCount) * (UINTN) (SataPrivateData->DeviceCount);
 485   SataPrivateData->DisqualifiedModes = AllocateZeroPool ((sizeof (EFI_ATA_COLLECTIVE_MODE)) * ChannelDeviceCount);
 486   if (SataPrivateData->DisqualifiedModes == NULL) {
 487     Status = EFI_OUT_OF_RESOURCES;
 488     goto FreeSataPrivateData;
 489   }
 490
 491   SataPrivateData->IdentifyData = AllocateZeroPool ((sizeof (EFI_IDENTIFY_DATA)) * ChannelDeviceCount);
 492   if (SataPrivateData->IdentifyData == NULL) {
 493     Status = EFI_OUT_OF_RESOURCES;
 494     goto FreeDisqualifiedModes;
 495   }
 496
 497   SataPrivateData->IdentifyValid = AllocateZeroPool ((sizeof (BOOLEAN)) * ChannelDeviceCount);
 498   if (SataPrivateData->IdentifyValid == NULL) {
 499     Status = EFI_OUT_OF_RESOURCES;
 500     goto FreeIdentifyData;
 501   }
 502
 503   //
 504   // Install IDE Controller Init Protocol to this instance
 505   //
 506   Status = gBS->InstallMultipleProtocolInterfaces (
 507                   &Controller,
 508                   &gEfiIdeControllerInitProtocolGuid,
 509                   &(SataPrivateData->IdeInit),
 510                   NULL
 511                   );
 512
 513   if (EFI_ERROR (Status)) {
 514     goto FreeIdentifyValid;
 515   }
 516
 517   DEBUG ((EFI_D_INFO, "SataControllerStart END status = %r\n", Status));
 518   return Status;
 519
 520 FreeIdentifyValid:
 521   FreePool (SataPrivateData->IdentifyValid);
 522
 523 FreeIdentifyData:
 524   FreePool (SataPrivateData->IdentifyData);
 525
 526 FreeDisqualifiedModes:
 527   FreePool (SataPrivateData->DisqualifiedModes);
 528
 529 FreeSataPrivateData:
 530   FreePool (SataPrivateData);
 531
 532 RestorePciAttributes:
 533   PciIo->Attributes (PciIo, EfiPciIoAttributeOperationSet,
 534            OriginalPciAttributes, NULL);
 535
 536 ClosePciIo:
 537   gBS->CloseProtocol (
 538          Controller,
 539          &gEfiPciIoProtocolGuid,
 540          This->DriverBindingHandle,
 541          Controller
 542          );
 543
 544 Bail:
 545   DEBUG ((EFI_D_ERROR, "SataControllerStart error return status = %r\n", Status));
 546   return Status;
 547 }
 548
 549 /**
 550   Stop this driver on ControllerHandle.
 551
 552   @param This               Protocol instance pointer.
 553   @param Controller         Handle of device to stop driver on.
 554   @param NumberOfChildren   Not used.
 555   @param ChildHandleBuffer  Not used.
 556
 557   @retval EFI_SUCCESS   This driver is removed from this device.
 558   @retval other         Some error occurs when removing this driver from this device.
 559
 560 **/
 561 EFI_STATUS
 562 EFIAPI
 563 SataControllerStop (
 564   IN EFI_DRIVER_BINDING_PROTOCOL    *This,
 565   IN EFI_HANDLE                     Controller,
 566   IN UINTN                          NumberOfChildren,
 567   IN EFI_HANDLE                     *ChildHandleBuffer
 568   )
 569 {
 570   EFI_STATUS                        Status;
 571   EFI_IDE_CONTROLLER_INIT_PROTOCOL  *IdeInit;
 572   EFI_SATA_CONTROLLER_PRIVATE_DATA  *SataPrivateData;
 573
 574   //
 575   // Open the produced protocol
 576   //
 577   Status = gBS->OpenProtocol (
 578                   Controller,
 579                   &gEfiIdeControllerInitProtocolGuid,
 580                   (VOID **) &IdeInit,
 581                   This->DriverBindingHandle,
 582                   Controller,
 583                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 584                   );
 585   if (EFI_ERROR (Status)) {
 586     return EFI_UNSUPPORTED;
 587   }
 588
 589   SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (IdeInit);
 590   ASSERT (SataPrivateData != NULL);
 591
 592   //
 593   // Uninstall the IDE Controller Init Protocol from this instance
 594   //
 595   Status = gBS->UninstallMultipleProtocolInterfaces (
 596                   Controller,
 597                   &gEfiIdeControllerInitProtocolGuid,
 598                   &(SataPrivateData->IdeInit),
 599                   NULL
 600                   );
 601   if (EFI_ERROR (Status)) {
 602     return Status;
 603   }
 604
 605   if (SataPrivateData->DisqualifiedModes != NULL) {
 606     FreePool (SataPrivateData->DisqualifiedModes);
 607   }
 608   if (SataPrivateData->IdentifyData != NULL) {
 609     FreePool (SataPrivateData->IdentifyData);
 610   }
 611   if (SataPrivateData->IdentifyValid != NULL) {
 612     FreePool (SataPrivateData->IdentifyValid);
 613   }
 614   FreePool (SataPrivateData);
 615
 616   //
 617   // Restore original PCI attributes
 618   //
 619   SataPrivateData->PciIo->Attributes (
 620                             SataPrivateData->PciIo,
 621                             EfiPciIoAttributeOperationSet,
 622                             SataPrivateData->OriginalPciAttributes,
 623                             NULL
 624                             );
 625
 626   //
 627   // Close protocols opened by Sata Controller driver
 628   //
 629   return gBS->CloseProtocol (
 630                 Controller,
 631                 &gEfiPciIoProtocolGuid,
 632                 This->DriverBindingHandle,
 633                 Controller
 634                 );
 635 }
 636
 637 /**
 638   Calculate the flat array subscript of a (Channel, Device) pair.
 639
 640   @param[in] SataPrivateData  The private data structure corresponding to the
 641                               SATA controller that attaches the device for
 642                               which the flat array subscript is being
 643                               calculated.
 644
 645   @param[in] Channel          The channel (ie. port) number on the SATA
 646                               controller that the device is attached to.
 647
 648   @param[in] Device           The device number on the channel.
 649
 650   @return  The flat array subscript suitable for indexing DisqualifiedModes,
 651            IdentifyData, and IdentifyValid.
 652 **/
 653 STATIC
 654 UINTN
 655 FlatDeviceIndex (
 656   IN CONST EFI_SATA_CONTROLLER_PRIVATE_DATA  *SataPrivateData,
 657   IN UINTN                                   Channel,
 658   IN UINTN                                   Device
 659   )
 660 {
 661   ASSERT (SataPrivateData != NULL);
 662   ASSERT (Channel < SataPrivateData->IdeInit.ChannelCount);
 663   ASSERT (Device < SataPrivateData->DeviceCount);
 664
 665   return Channel * SataPrivateData->DeviceCount + Device;
 666 }
 667
 668 //
 669 // Interface functions of IDE_CONTROLLER_INIT protocol
 670 //
 671 /**
 672   Returns the information about the specified IDE channel.
 673
 674   This function can be used to obtain information about a particular IDE channel.
 675   The driver entity uses this information during the enumeration process.
 676
 677   If Enabled is set to FALSE, the driver entity will not scan the channel. Note
 678   that it will not prevent an operating system driver from scanning the channel.
 679
 680   For most of today's controllers, MaxDevices will either be 1 or 2. For SATA
 681   controllers, this value will always be 1. SATA configurations can contain SATA
 682   port multipliers. SATA port multipliers behave like SATA bridges and can support
 683   up to 16 devices on the other side. If a SATA port out of the IDE controller
 684   is connected to a port multiplier, MaxDevices will be set to the number of SATA
 685   devices that the port multiplier supports. Because today's port multipliers
 686   support up to fifteen SATA devices, this number can be as large as fifteen. The IDE
 687   bus driver is required to scan for the presence of port multipliers behind an SATA
 688   controller and enumerate up to MaxDevices number of devices behind the port
 689   multiplier.
 690
 691   In this context, the devices behind a port multiplier constitute a channel.
 692
 693   @param[in]  This         The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
 694   @param[in]  Channel      Zero-based channel number.
 695   @param[out] Enabled      TRUE if this channel is enabled.  Disabled channels
 696                            are not scanned to see if any devices are present.
 697   @param[out] MaxDevices   The maximum number of IDE devices that the bus driver
 698                            can expect on this channel.  For the ATA/ATAPI
 699                            specification, version 6, this number will either be
 700                            one or two. For Serial ATA (SATA) configurations with a
 701                            port multiplier, this number can be as large as fifteen.
 702
 703   @retval EFI_SUCCESS             Information was returned without any errors.
 704   @retval EFI_INVALID_PARAMETER   Channel is invalid (Channel >= ChannelCount).
 705
 706 **/
 707 EFI_STATUS
 708 EFIAPI
 709 IdeInitGetChannelInfo (
 710   IN EFI_IDE_CONTROLLER_INIT_PROTOCOL   *This,
 711   IN UINT8                              Channel,
 712   OUT BOOLEAN                           *Enabled,
 713   OUT UINT8                             *MaxDevices
 714   )
 715 {
 716   EFI_SATA_CONTROLLER_PRIVATE_DATA  *SataPrivateData;
 717   SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);
 718   ASSERT (SataPrivateData != NULL);
 719
 720   if (Channel < This->ChannelCount) {
 721     *Enabled = TRUE;
 722     *MaxDevices = SataPrivateData->DeviceCount;
 723     return EFI_SUCCESS;
 724   }
 725
 726   *Enabled = FALSE;
 727   return EFI_INVALID_PARAMETER;
 728 }
 729
 730 /**
 731   The notifications from the driver entity that it is about to enter a certain
 732   phase of the IDE channel enumeration process.
 733
 734   This function can be used to notify the IDE controller driver to perform
 735   specific actions, including any chipset-specific initialization, so that the
 736   chipset is ready to enter the next phase. Seven notification points are defined
 737   at this time.
 738
 739   More synchronization points may be added as required in the future.
 740
 741   @param[in] This      The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
 742   @param[in] Phase     The phase during enumeration.
 743   @param[in] Channel   Zero-based channel number.
 744
 745   @retval EFI_SUCCESS             The notification was accepted without any errors.
 746   @retval EFI_UNSUPPORTED         Phase is not supported.
 747   @retval EFI_INVALID_PARAMETER   Channel is invalid (Channel >= ChannelCount).
 748   @retval EFI_NOT_READY           This phase cannot be entered at this time; for
 749                                   example, an attempt was made to enter a Phase
 750                                   without having entered one or more previous
 751                                   Phase.
 752
 753 **/
 754 EFI_STATUS
 755 EFIAPI
 756 IdeInitNotifyPhase (
 757   IN EFI_IDE_CONTROLLER_INIT_PROTOCOL   *This,
 758   IN EFI_IDE_CONTROLLER_ENUM_PHASE      Phase,
 759   IN UINT8                              Channel
 760   )
 761 {
 762   return EFI_SUCCESS;
 763 }
 764
 765 /**
 766   Submits the device information to the IDE controller driver.
 767
 768   This function is used by the driver entity to pass detailed information about
 769   a particular device to the IDE controller driver. The driver entity obtains
 770   this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData
 771   is the pointer to the response data buffer. The IdentifyData buffer is owned
 772   by the driver entity, and the IDE controller driver must make a local copy
 773   of the entire buffer or parts of the buffer as needed. The original IdentifyData
 774   buffer pointer may not be valid when
 775
 776     - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or
 777     - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point.
 778
 779   The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to
 780   compute the optimum mode for the device. These fields are not limited to the
 781   timing information. For example, an implementation of the IDE controller driver
 782   may examine the vendor and type/mode field to match known bad drives.
 783
 784   The driver entity may submit drive information in any order, as long as it
 785   submits information for all the devices belonging to the enumeration group
 786   before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device
 787   in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
 788   should be called with IdentifyData set to NULL.  The IDE controller driver may
 789   not have any other mechanism to know whether a device is present or not. Therefore,
 790   setting IdentifyData to NULL does not constitute an error condition.
 791   EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a
 792   given (Channel, Device) pair.
 793
 794   @param[in] This           A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
 795   @param[in] Channel        Zero-based channel number.
 796   @param[in] Device         Zero-based device number on the Channel.
 797   @param[in] IdentifyData   The device's response to the ATA IDENTIFY_DEVICE command.
 798
 799   @retval EFI_SUCCESS             The information was accepted without any errors.
 800   @retval EFI_INVALID_PARAMETER   Channel is invalid (Channel >= ChannelCount).
 801   @retval EFI_INVALID_PARAMETER   Device is invalid.
 802
 803 **/
 804 EFI_STATUS
 805 EFIAPI
 806 IdeInitSubmitData (
 807   IN EFI_IDE_CONTROLLER_INIT_PROTOCOL   *This,
 808   IN UINT8                              Channel,
 809   IN UINT8                              Device,
 810   IN EFI_IDENTIFY_DATA                  *IdentifyData
 811   )
 812 {
 813   EFI_SATA_CONTROLLER_PRIVATE_DATA  *SataPrivateData;
 814   UINTN                             DeviceIndex;
 815
 816   SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);
 817   ASSERT (SataPrivateData != NULL);
 818
 819   if ((Channel >= This->ChannelCount) || (Device >= SataPrivateData->DeviceCount)) {
 820     return EFI_INVALID_PARAMETER;
 821   }
 822
 823   DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device);
 824
 825   //
 826   // Make a local copy of device's IdentifyData and mark the valid flag
 827   //
 828   if (IdentifyData != NULL) {
 829     CopyMem (
 830       &(SataPrivateData->IdentifyData[DeviceIndex]),
 831       IdentifyData,
 832       sizeof (EFI_IDENTIFY_DATA)
 833       );
 834
 835     SataPrivateData->IdentifyValid[DeviceIndex] = TRUE;
 836   } else {
 837     SataPrivateData->IdentifyValid[DeviceIndex] = FALSE;
 838   }
 839
 840   return EFI_SUCCESS;
 841 }
 842
 843 /**
 844   Disqualifies specific modes for an IDE device.
 845
 846   This function allows the driver entity or other drivers (such as platform
 847   drivers) to reject certain timing modes and request the IDE controller driver
 848   to recalculate modes. This function allows the driver entity and the IDE
 849   controller driver to negotiate the timings on a per-device basis. This function
 850   is useful in the case of drives that lie about their capabilities. An example
 851   is when the IDE device fails to accept the timing modes that are calculated
 852   by the IDE controller driver based on the response to the Identify Drive command.
 853
 854   If the driver entity does not want to limit the ATA timing modes and leave that
 855   decision to the IDE controller driver, it can either not call this function for
 856   the given device or call this function and set the Valid flag to FALSE for all
 857   modes that are listed in EFI_ATA_COLLECTIVE_MODE.
 858
 859   The driver entity may disqualify modes for a device in any order and any number
 860   of times.
 861
 862   This function can be called multiple times to invalidate multiple modes of the
 863   same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI
 864   specification for more information on PIO modes.
 865
 866   For Serial ATA (SATA) controllers, this member function can be used to disqualify
 867   a higher transfer rate mode on a given channel. For example, a platform driver
 868   may inform the IDE controller driver to not use second-generation (Gen2) speeds
 869   for a certain SATA drive.
 870
 871   @param[in] This       The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
 872   @param[in] Channel    The zero-based channel number.
 873   @param[in] Device     The zero-based device number on the Channel.
 874   @param[in] BadModes   The modes that the device does not support and that
 875                         should be disqualified.
 876
 877   @retval EFI_SUCCESS             The modes were accepted without any errors.
 878   @retval EFI_INVALID_PARAMETER   Channel is invalid (Channel >= ChannelCount).
 879   @retval EFI_INVALID_PARAMETER   Device is invalid.
 880   @retval EFI_INVALID_PARAMETER   IdentifyData is NULL.
 881
 882 **/
 883 EFI_STATUS
 884 EFIAPI
 885 IdeInitDisqualifyMode (
 886   IN EFI_IDE_CONTROLLER_INIT_PROTOCOL   *This,
 887   IN UINT8                              Channel,
 888   IN UINT8                              Device,
 889   IN EFI_ATA_COLLECTIVE_MODE            *BadModes
 890   )
 891 {
 892   EFI_SATA_CONTROLLER_PRIVATE_DATA  *SataPrivateData;
 893   UINTN                             DeviceIndex;
 894
 895   SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);
 896   ASSERT (SataPrivateData != NULL);
 897
 898   if ((Channel >= This->ChannelCount) || (BadModes == NULL) || (Device >= SataPrivateData->DeviceCount)) {
 899     return EFI_INVALID_PARAMETER;
 900   }
 901
 902   DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device);
 903
 904   //
 905   // Record the disqualified modes per channel per device. From ATA/ATAPI spec,
 906   // if a mode is not supported, the modes higher than it is also not supported.
 907   //
 908   CopyMem (
 909     &(SataPrivateData->DisqualifiedModes[DeviceIndex]),
 910     BadModes,
 911     sizeof (EFI_ATA_COLLECTIVE_MODE)
 912     );
 913
 914   return EFI_SUCCESS;
 915 }
 916
 917 /**
 918   Returns the information about the optimum modes for the specified IDE device.
 919
 920   This function is used by the driver entity to obtain the optimum ATA modes for
 921   a specific device.  The IDE controller driver takes into account the following
 922   while calculating the mode:
 923     - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
 924     - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode()
 925
 926   The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
 927   for all the devices that belong to an enumeration group before calling
 928   EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group.
 929
 930   The IDE controller driver will use controller- and possibly platform-specific
 931   algorithms to arrive at SupportedModes.  The IDE controller may base its
 932   decision on user preferences and other considerations as well. This function
 933   may be called multiple times because the driver entity may renegotiate the mode
 934   with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode().
 935
 936   The driver entity may collect timing information for various devices in any
 937   order. The driver entity is responsible for making sure that all the dependencies
 938   are satisfied. For example, the SupportedModes information for device A that
 939   was previously returned may become stale after a call to
 940   EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.
 941
 942   The buffer SupportedModes is allocated by the callee because the caller does
 943   not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE
 944   is defined in a way that allows for future extensibility and can be of variable
 945   length. This memory pool should be deallocated by the caller when it is no
 946   longer necessary.
 947
 948   The IDE controller driver for a Serial ATA (SATA) controller can use this
 949   member function to force a lower speed (first-generation [Gen1] speeds on a
 950   second-generation [Gen2]-capable hardware).  The IDE controller driver can
 951   also allow the driver entity to stay with the speed that has been negotiated
 952   by the physical layer.
 953
 954   @param[in]  This             The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
 955   @param[in]  Channel          A zero-based channel number.
 956   @param[in]  Device           A zero-based device number on the Channel.
 957   @param[out] SupportedModes   The optimum modes for the device.
 958
 959   @retval EFI_SUCCESS             SupportedModes was returned.
 960   @retval EFI_INVALID_PARAMETER   Channel is invalid (Channel >= ChannelCount).
 961   @retval EFI_INVALID_PARAMETER   Device is invalid.
 962   @retval EFI_INVALID_PARAMETER   SupportedModes is NULL.
 963   @retval EFI_NOT_READY           Modes cannot be calculated due to a lack of
 964                                   data.  This error may happen if
 965                                   EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
 966                                   and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData()
 967                                   were not called for at least one drive in the
 968                                   same enumeration group.
 969
 970 **/
 971 EFI_STATUS
 972 EFIAPI
 973 IdeInitCalculateMode (
 974   IN EFI_IDE_CONTROLLER_INIT_PROTOCOL   *This,
 975   IN UINT8                              Channel,
 976   IN UINT8                              Device,
 977   OUT EFI_ATA_COLLECTIVE_MODE           **SupportedModes
 978   )
 979 {
 980   EFI_SATA_CONTROLLER_PRIVATE_DATA  *SataPrivateData;
 981   EFI_IDENTIFY_DATA                 *IdentifyData;
 982   BOOLEAN                           IdentifyValid;
 983   EFI_ATA_COLLECTIVE_MODE           *DisqualifiedModes;
 984   UINT16                            SelectedMode;
 985   EFI_STATUS                        Status;
 986   UINTN                             DeviceIndex;
 987
 988   SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);
 989   ASSERT (SataPrivateData != NULL);
 990
 991   if ((Channel >= This->ChannelCount) || (SupportedModes == NULL) || (Device >= SataPrivateData->DeviceCount)) {
 992     return EFI_INVALID_PARAMETER;
 993   }
 994
 995   *SupportedModes = AllocateZeroPool (sizeof (EFI_ATA_COLLECTIVE_MODE));
 996   if (*SupportedModes == NULL) {
 997     ASSERT (*SupportedModes != NULL);
 998     return EFI_OUT_OF_RESOURCES;
 999   }
1000
1001   DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device);
1002
1003   IdentifyData = &(SataPrivateData->IdentifyData[DeviceIndex]);
1004   IdentifyValid = SataPrivateData->IdentifyValid[DeviceIndex];
1005   DisqualifiedModes = &(SataPrivateData->DisqualifiedModes[DeviceIndex]);
1006
1007   //
1008   // Make sure we've got the valid identify data of the device from SubmitData()
1009   //
1010   if (!IdentifyValid) {
1011     FreePool (*SupportedModes);
1012     return EFI_NOT_READY;
1013   }
1014
1015   Status = CalculateBestPioMode (
1016             IdentifyData,
1017             (DisqualifiedModes->PioMode.Valid ? ((UINT16 *) &(DisqualifiedModes->PioMode.Mode)) : NULL),
1018             &SelectedMode
1019             );
1020   if (!EFI_ERROR (Status)) {
1021     (*SupportedModes)->PioMode.Valid = TRUE;
1022     (*SupportedModes)->PioMode.Mode = SelectedMode;
1023
1024   } else {
1025     (*SupportedModes)->PioMode.Valid = FALSE;
1026   }
1027   DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: PioMode = %x\n", (*SupportedModes)->PioMode.Mode));
1028
1029   Status = CalculateBestUdmaMode (
1030             IdentifyData,
1031             (DisqualifiedModes->UdmaMode.Valid ? ((UINT16 *) &(DisqualifiedModes->UdmaMode.Mode)) : NULL),
1032             &SelectedMode
1033             );
1034
1035   if (!EFI_ERROR (Status)) {
1036     (*SupportedModes)->UdmaMode.Valid = TRUE;
1037     (*SupportedModes)->UdmaMode.Mode  = SelectedMode;
1038
1039   } else {
1040     (*SupportedModes)->UdmaMode.Valid = FALSE;
1041   }
1042   DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: UdmaMode = %x\n", (*SupportedModes)->UdmaMode.Mode));
1043
1044   //
1045   // The modes other than PIO and UDMA are not supported
1046   //
1047   return EFI_SUCCESS;
1048 }
1049
1050 /**
1051   Commands the IDE controller driver to program the IDE controller hardware
1052   so that the specified device can operate at the specified mode.
1053
1054   This function is used by the driver entity to instruct the IDE controller
1055   driver to program the IDE controller hardware to the specified modes. This
1056   function can be called only once for a particular device. For a Serial ATA
1057   (SATA) Advanced Host Controller Interface (AHCI) controller, no controller-
1058   specific programming may be required.
1059
1060   @param[in] This      Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
1061   @param[in] Channel   Zero-based channel number.
1062   @param[in] Device    Zero-based device number on the Channel.
1063   @param[in] Modes     The modes to set.
1064
1065   @retval EFI_SUCCESS             The command was accepted without any errors.
1066   @retval EFI_INVALID_PARAMETER   Channel is invalid (Channel >= ChannelCount).
1067   @retval EFI_INVALID_PARAMETER   Device is invalid.
1068   @retval EFI_NOT_READY           Modes cannot be set at this time due to lack of data.
1069   @retval EFI_DEVICE_ERROR        Modes cannot be set due to hardware failure.
1070                                   The driver entity should not use this device.
1071
1072 **/
1073 EFI_STATUS
1074 EFIAPI
1075 IdeInitSetTiming (
1076   IN EFI_IDE_CONTROLLER_INIT_PROTOCOL   *This,
1077   IN UINT8                              Channel,
1078   IN UINT8                              Device,
1079   IN EFI_ATA_COLLECTIVE_MODE            *Modes
1080   )
1081 {
1082   return EFI_SUCCESS;
1083 }