127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** @file 227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This driver module produces IDE_CONTROLLER_INIT protocol for Sata Controllers. 327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Copyright (c) 2011, Intel Corporation. All rights reserved.<BR> 527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This program and the accompanying materials 627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng are licensed and made available under the terms and conditions of the BSD License 727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng which accompanies this distribution. The full text of the license may be found at 827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng http://opensource.org/licenses/bsd-license.php 927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 1027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 1127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 1227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 1327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 1427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 1527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include "SataController.h" 1627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 1727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 1827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// EFI_DRIVER_BINDING_PROTOCOL instance 1927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 2027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding = { 2127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataControllerSupported, 2227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataControllerStart, 2327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataControllerStop, 2427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 0xa, 2527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng NULL, 2627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng NULL 2727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng}; 2827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 2927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 3027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Read AHCI Operation register. 3127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 3227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param PciIo The PCI IO protocol instance. 3327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Offset The operation register offset. 3427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 3527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @return The register content read. 3627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 3727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 3827f3015903bf30b9ca0e72c0174e9ef787d79659lzengUINT32 3927f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 4027f3015903bf30b9ca0e72c0174e9ef787d79659lzengAhciReadReg ( 4127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_PCI_IO_PROTOCOL *PciIo, 4227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT32 Offset 4327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 4427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 4527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT32 Data; 4627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 4727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT (PciIo != NULL); 4827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 4927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Data = 0; 5027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 5127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciIo->Mem.Read ( 5227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciIo, 5327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EfiPciIoWidthUint32, 5427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng AHCI_BAR_INDEX, 5527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (UINT64) Offset, 5627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 1, 5727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &Data 5827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 5927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 6027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return Data; 6127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 6227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 6327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 6427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Write AHCI Operation register. 6527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 6627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param PciIo The PCI IO protocol instance. 6727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Offset The operation register offset. 6827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Data The data used to write down. 6927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 7027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 7127f3015903bf30b9ca0e72c0174e9ef787d79659lzengVOID 7227f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 7327f3015903bf30b9ca0e72c0174e9ef787d79659lzengAhciWriteReg ( 7427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_PCI_IO_PROTOCOL *PciIo, 7527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT32 Offset, 7627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT32 Data 7727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 7827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 7927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT (PciIo != NULL); 8027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 8127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciIo->Mem.Write ( 8227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciIo, 8327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EfiPciIoWidthUint32, 8427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng AHCI_BAR_INDEX, 8527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (UINT64) Offset, 8627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 1, 8727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &Data 8827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 8927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 9027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return; 9127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 9227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 9327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 9427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This function is used to calculate the best PIO mode supported by specific IDE device 9527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 9627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param IdentifyData The identify data of specific IDE device. 9727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param DisPioMode Disqualified PIO modes collection. 9827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param SelectedMode Available PIO modes collection. 9927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 10027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS Best PIO modes are returned. 10127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_UNSUPPORTED The device doesn't support PIO mode, 10227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng or all supported modes have been disqualified. 10327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 10427f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 10527f3015903bf30b9ca0e72c0174e9ef787d79659lzengCalculateBestPioMode ( 10627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDENTIFY_DATA *IdentifyData, 10727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT16 *DisPioMode OPTIONAL, 10827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT UINT16 *SelectedMode 10927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 11027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 11127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 PioMode; 11227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 AdvancedPioMode; 11327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 Temp; 11427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 Index; 11527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 MinimumPioCycleTime; 11627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 11727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Temp = 0xff; 11827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 11927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode = (UINT8) (((ATA5_IDENTIFY_DATA *) (&(IdentifyData->AtaData)))->pio_cycle_timing >> 8); 12027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 12127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 12227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // See whether Identify Data word 64 - 70 are valid 12327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 12427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if ((IdentifyData->AtaData.field_validity & 0x02) == 0x02) { 12527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 12627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng AdvancedPioMode = IdentifyData->AtaData.advanced_pio_modes; 12727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DEBUG ((EFI_D_INFO, "CalculateBestPioMode: AdvancedPioMode = %x\n", AdvancedPioMode)); 12827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 12927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng for (Index = 0; Index < 8; Index++) { 13027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if ((AdvancedPioMode & 0x01) != 0) { 13127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Temp = Index; 13227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 13327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 13427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng AdvancedPioMode >>= 1; 13527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 13627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 13727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 13827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // If Temp is modified, mean the advanced_pio_modes is not zero; 13927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // if Temp is not modified, mean there is no advanced PIO mode supported, 14027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // the best PIO Mode is the value in pio_cycle_timing. 14127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 14227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (Temp != 0xff) { 14327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng AdvancedPioMode = (UINT16) (Temp + 3); 14427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 14527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng AdvancedPioMode = PioMode; 14627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 14727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 14827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 14927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Limit the PIO mode to at most PIO4. 15027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 15127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode = (UINT16) MIN (AdvancedPioMode, 4); 15227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 15327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng MinimumPioCycleTime = IdentifyData->AtaData.min_pio_cycle_time_with_flow_control; 15427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 15527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (MinimumPioCycleTime <= 120) { 15627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode = (UINT16) MIN (4, PioMode); 15727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else if (MinimumPioCycleTime <= 180) { 15827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode = (UINT16) MIN (3, PioMode); 15927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else if (MinimumPioCycleTime <= 240) { 16027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode = (UINT16) MIN (2, PioMode); 16127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 16227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode = 0; 16327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 16427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 16527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 16627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Degrade the PIO mode if the mode has been disqualified 16727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 16827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (DisPioMode != NULL) { 16927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (*DisPioMode < 2) { 17027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2 17127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 17227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 17327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (PioMode >= *DisPioMode) { 17427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode = (UINT16) (*DisPioMode - 1); 17527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 17627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 17727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 17827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (PioMode < 2) { 17927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *SelectedMode = 1; // ATA_PIO_MODE_BELOW_2; 18027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 18127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *SelectedMode = PioMode; // ATA_PIO_MODE_2 to ATA_PIO_MODE_4; 18227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 18327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 18427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 18527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 18627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Identify Data word 64 - 70 are not valid 18727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Degrade the PIO mode if the mode has been disqualified 18827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 18927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (DisPioMode != NULL) { 19027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (*DisPioMode < 2) { 19127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2 19227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 19327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 19427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (PioMode == *DisPioMode) { 19527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PioMode--; 19627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 19727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 19827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 19927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (PioMode < 2) { 20027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *SelectedMode = 1; // ATA_PIO_MODE_BELOW_2; 20127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 20227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *SelectedMode = 2; // ATA_PIO_MODE_2; 20327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 20427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 20527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 20627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 20727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 20827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 20927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 21027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 21127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This function is used to calculate the best UDMA mode supported by specific IDE device 21227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 21327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param IdentifyData The identify data of specific IDE device. 21427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param DisUDmaMode Disqualified UDMA modes collection. 21527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param SelectedMode Available UDMA modes collection. 21627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 21727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS Best UDMA modes are returned. 21827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_UNSUPPORTED The device doesn't support UDMA mode, 21927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng or all supported modes have been disqualified. 22027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 22127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 22227f3015903bf30b9ca0e72c0174e9ef787d79659lzengCalculateBestUdmaMode ( 22327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDENTIFY_DATA *IdentifyData, 22427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT16 *DisUDmaMode OPTIONAL, 22527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT UINT16 *SelectedMode 22627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 22727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 22827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 TempMode; 22927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 DeviceUDmaMode; 23027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 23127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DeviceUDmaMode = 0; 23227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 23327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 23427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Check whether the WORD 88 (supported UltraDMA by drive) is valid 23527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 23627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if ((IdentifyData->AtaData.field_validity & 0x04) == 0x00) { 23727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_UNSUPPORTED; 23827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 23927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 24027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DeviceUDmaMode = IdentifyData->AtaData.ultra_dma_mode; 24127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DEBUG ((EFI_D_INFO, "CalculateBestUdmaMode: DeviceUDmaMode = %x\n", DeviceUDmaMode)); 24227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DeviceUDmaMode &= 0x3f; 24327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng TempMode = 0; // initialize it to UDMA-0 24427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 24527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng while ((DeviceUDmaMode >>= 1) != 0) { 24627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng TempMode++; 24727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 24827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 24927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 25027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Degrade the UDMA mode if the mode has been disqualified 25127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 25227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (DisUDmaMode != NULL) { 25327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (*DisUDmaMode == 0) { 25427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *SelectedMode = 0; 25527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_UNSUPPORTED; // no mode below ATA_UDMA_MODE_0 25627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 25727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 25827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (TempMode >= *DisUDmaMode) { 25927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng TempMode = (UINT16) (*DisUDmaMode - 1); 26027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 26127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 26227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 26327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 26427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Possible returned mode is between ATA_UDMA_MODE_0 and ATA_UDMA_MODE_5 26527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 26627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *SelectedMode = TempMode; 26727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 26827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 26927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 27027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 27127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 27227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng The Entry Point of module. It follows the standard UEFI driver model. 27327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 27427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param[in] ImageHandle The firmware allocated handle for the EFI image. 27527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param[in] SystemTable A pointer to the EFI System Table. 27627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 27727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS The entry point is executed successfully. 27827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval other Some error occurs when executing this entry point. 27927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 28027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 28127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 28227f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 28327f3015903bf30b9ca0e72c0174e9ef787d79659lzengInitializeSataControllerDriver ( 28427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE ImageHandle, 28527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_SYSTEM_TABLE *SystemTable 28627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 28727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 28827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_STATUS Status; 28927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 29027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 29127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Install driver model protocol(s). 29227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 29327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = EfiLibInstallDriverBindingComponentName2 ( 29427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ImageHandle, 29527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SystemTable, 29627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gSataControllerDriverBinding, 29727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ImageHandle, 29827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gSataControllerComponentName, 29927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gSataControllerComponentName2 30027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 30127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT_EFI_ERROR (Status); 30227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 30327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return Status; 30427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 30527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 30627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 30727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Supported function of Driver Binding protocol for this driver. 30827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Test to see if this driver supports ControllerHandle. 30927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 31027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This Protocol instance pointer. 31127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Controller Handle of device to test. 31227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param RemainingDevicePath A pointer to the device path. 31327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng it should be ignored by device driver. 31427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 31527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS This driver supports this device. 31627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_ALREADY_STARTED This driver is already running on this device. 31727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval other This driver does not support this device. 31827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 31927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 32027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 32127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 32227f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerSupported ( 32327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DRIVER_BINDING_PROTOCOL *This, 32427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE Controller, 32527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath 32627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 32727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 32827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_STATUS Status; 32927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_PCI_IO_PROTOCOL *PciIo; 33027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PCI_TYPE00 PciData; 33127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 33227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 33327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Attempt to open PCI I/O Protocol 33427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 33527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = gBS->OpenProtocol ( 33627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 33727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gEfiPciIoProtocolGuid, 33827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (VOID **) &PciIo, 33927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This->DriverBindingHandle, 34027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 34127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_OPEN_PROTOCOL_GET_PROTOCOL 34227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 34327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (EFI_ERROR (Status)) { 34427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return Status; 34527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 34627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 34727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 34827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Now further check the PCI header: Base Class (offset 0x0B) and 34927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Sub Class (offset 0x0A). This controller should be an SATA controller 35027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 35127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = PciIo->Pci.Read ( 35227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciIo, 35327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EfiPciIoWidthUint8, 35427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PCI_CLASSCODE_OFFSET, 35527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng sizeof (PciData.Hdr.ClassCode), 35627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciData.Hdr.ClassCode 35727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 35827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (EFI_ERROR (Status)) { 35927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_UNSUPPORTED; 36027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 36127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 36227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (IS_PCI_IDE (&PciData) || IS_PCI_SATADPA (&PciData)) { 36327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 36427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 36527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 36627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_UNSUPPORTED; 36727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 36827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 36927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 37027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This routine is called right after the .Supported() called and 37127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Start this driver on ControllerHandle. 37227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 37327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This Protocol instance pointer. 37427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Controller Handle of device to bind driver to. 37527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param RemainingDevicePath A pointer to the device path. 37627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng it should be ignored by device driver. 37727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 37827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS This driver is added to this device. 37927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_ALREADY_STARTED This driver is already running on this device. 38027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval other Some error occurs when binding this driver to this device. 38127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 38227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 38327f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 38427f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 38527f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerStart ( 38627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DRIVER_BINDING_PROTOCOL *This, 38727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE Controller, 38827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath 38927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 39027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 39127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_STATUS Status; 39227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_PCI_IO_PROTOCOL *PciIo; 39327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PCI_TYPE00 PciData; 39427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData; 39527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT32 Data32; 39627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINTN ChannelDeviceCount; 39727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 39827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DEBUG ((EFI_D_INFO, "SataControllerStart START\n")); 39927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 40027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData = NULL; 40127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 40227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 40327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Now test and open PCI I/O Protocol 40427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 40527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = gBS->OpenProtocol ( 40627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 40727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gEfiPciIoProtocolGuid, 40827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (VOID **) &PciIo, 40927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This->DriverBindingHandle, 41027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 41127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_OPEN_PROTOCOL_BY_DRIVER 41227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 41327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (EFI_ERROR (Status)) { 41427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DEBUG ((EFI_D_ERROR, "SataControllerStart error return status = %r\n", Status)); 41527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return Status; 41627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 41727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 41827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 41927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Allocate Sata Private Data structure 42027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 42127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData = AllocateZeroPool (sizeof (EFI_SATA_CONTROLLER_PRIVATE_DATA)); 42227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData == NULL) { 42327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = EFI_OUT_OF_RESOURCES; 42427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng goto Done; 42527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 42627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 42727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 42827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Initialize Sata Private Data 42927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 43027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->Signature = SATA_CONTROLLER_SIGNATURE; 43127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->PciIo = PciIo; 43227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.GetChannelInfo = IdeInitGetChannelInfo; 43327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.NotifyPhase = IdeInitNotifyPhase; 43427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.SubmitData = IdeInitSubmitData; 43527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.DisqualifyMode = IdeInitDisqualifyMode; 43627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.CalculateMode = IdeInitCalculateMode; 43727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.SetTiming = IdeInitSetTiming; 43827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.EnumAll = SATA_ENUMER_ALL; 43927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 44027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = PciIo->Pci.Read ( 44127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciIo, 44227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EfiPciIoWidthUint8, 44327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PCI_CLASSCODE_OFFSET, 44427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng sizeof (PciData.Hdr.ClassCode), 44527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng PciData.Hdr.ClassCode 44627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 44727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT_EFI_ERROR (Status); 44827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 44927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (IS_PCI_IDE (&PciData)) { 45027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdeInit.ChannelCount = IDE_MAX_CHANNEL; 45127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->DeviceCount = IDE_MAX_DEVICES; 45227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else if (IS_PCI_SATADPA (&PciData)) { 45327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 45427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Read Host Capability Register(CAP) to get Number of Ports(NPS) and Supports Port Multiplier(SPM) 45527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // NPS is 0's based value indicating the maximum number of ports supported by the HBA silicon. 45627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // A maximum of 32 ports can be supported. A value of '0h', indicating one port, is the minimum requirement. 45727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 45827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Data32 = AhciReadReg (PciIo, R_AHCI_CAP); 459271c79012d7a7f2ab8fe4a75e06decf3c9488c10lzeng SataPrivateData->IdeInit.ChannelCount = (UINT8) ((Data32 & B_AHCI_CAP_NPS) + 1); 46027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->DeviceCount = AHCI_MAX_DEVICES; 46127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if ((Data32 & B_AHCI_CAP_SPM) == B_AHCI_CAP_SPM) { 46227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->DeviceCount = AHCI_MULTI_MAX_DEVICES; 46327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 46427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 46527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 46627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ChannelDeviceCount = (UINTN) (SataPrivateData->IdeInit.ChannelCount) * (UINTN) (SataPrivateData->DeviceCount); 467d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek SataPrivateData->DisqualifiedModes = AllocateZeroPool ((sizeof (EFI_ATA_COLLECTIVE_MODE)) * ChannelDeviceCount); 468d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek if (SataPrivateData->DisqualifiedModes == NULL) { 46927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = EFI_OUT_OF_RESOURCES; 47027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng goto Done; 47127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 47227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 47327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdentifyData = AllocateZeroPool ((sizeof (EFI_IDENTIFY_DATA)) * ChannelDeviceCount); 47427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData->IdentifyData == NULL) { 47527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = EFI_OUT_OF_RESOURCES; 47627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng goto Done; 47727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 47827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 47927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData->IdentifyValid = AllocateZeroPool ((sizeof (BOOLEAN)) * ChannelDeviceCount); 48027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData->IdentifyValid == NULL) { 48127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = EFI_OUT_OF_RESOURCES; 48227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng goto Done; 48327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 48427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 48527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 48627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Install IDE Controller Init Protocol to this instance 48727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 48827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = gBS->InstallMultipleProtocolInterfaces ( 48927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &Controller, 49027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gEfiIdeControllerInitProtocolGuid, 49127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &(SataPrivateData->IdeInit), 49227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng NULL 49327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 49427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 49527f3015903bf30b9ca0e72c0174e9ef787d79659lzengDone: 49627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (EFI_ERROR (Status)) { 49727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 49827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng gBS->CloseProtocol ( 49927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 50027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gEfiPciIoProtocolGuid, 50127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This->DriverBindingHandle, 50227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller 50327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 50427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData != NULL) { 505d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek if (SataPrivateData->DisqualifiedModes != NULL) { 506d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek FreePool (SataPrivateData->DisqualifiedModes); 50727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 50827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData->IdentifyData != NULL) { 50927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng FreePool (SataPrivateData->IdentifyData); 51027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 51127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData->IdentifyValid != NULL) { 51227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng FreePool (SataPrivateData->IdentifyValid); 51327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 51427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng FreePool (SataPrivateData); 51527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 51627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 51727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 51827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DEBUG ((EFI_D_INFO, "SataControllerStart END status = %r\n", Status)); 51927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 52027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return Status; 52127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 52227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 52327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 52427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Stop this driver on ControllerHandle. 52527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 52627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This Protocol instance pointer. 52727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Controller Handle of device to stop driver on. 52827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param NumberOfChildren Not used. 52927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param ChildHandleBuffer Not used. 53027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 53127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS This driver is removed from this device. 53227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval other Some error occurs when removing this driver from this device. 53327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 53427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 53527f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 53627f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 53727f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerStop ( 53827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DRIVER_BINDING_PROTOCOL *This, 53927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE Controller, 54027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINTN NumberOfChildren, 54127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE *ChildHandleBuffer 54227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 54327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 54427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_STATUS Status; 54527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeInit; 54627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData; 54727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 54827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 54927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Open the produced protocol 55027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 55127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = gBS->OpenProtocol ( 55227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 55327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gEfiIdeControllerInitProtocolGuid, 55427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (VOID **) &IdeInit, 55527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This->DriverBindingHandle, 55627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 55727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_OPEN_PROTOCOL_GET_PROTOCOL 55827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 55927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (EFI_ERROR (Status)) { 56027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_UNSUPPORTED; 56127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 56227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 56327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (IdeInit); 56427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT (SataPrivateData != NULL); 56527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 56627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 56727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Uninstall the IDE Controller Init Protocol from this instance 56827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 56927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = gBS->UninstallMultipleProtocolInterfaces ( 57027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 57127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gEfiIdeControllerInitProtocolGuid, 57227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &(SataPrivateData->IdeInit), 57327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng NULL 57427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 57527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (EFI_ERROR (Status)) { 57627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return Status; 57727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 57827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 57927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData != NULL) { 580d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek if (SataPrivateData->DisqualifiedModes != NULL) { 581d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek FreePool (SataPrivateData->DisqualifiedModes); 58227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 58327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData->IdentifyData != NULL) { 58427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng FreePool (SataPrivateData->IdentifyData); 58527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 58627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (SataPrivateData->IdentifyValid != NULL) { 58727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng FreePool (SataPrivateData->IdentifyValid); 58827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 58927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng FreePool (SataPrivateData); 59027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 59127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 59227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 59327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Close protocols opened by Sata Controller driver 59427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 59527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return gBS->CloseProtocol ( 59627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller, 59727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &gEfiPciIoProtocolGuid, 59827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This->DriverBindingHandle, 59927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Controller 60027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 60127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 60227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 60383be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek/** 60483be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek Calculate the flat array subscript of a (Channel, Device) pair. 60583be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 60683be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek @param[in] SataPrivateData The private data structure corresponding to the 60783be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek SATA controller that attaches the device for 60883be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek which the flat array subscript is being 60983be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek calculated. 61083be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 61183be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek @param[in] Channel The channel (ie. port) number on the SATA 61283be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek controller that the device is attached to. 61383be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 61483be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek @param[in] Device The device number on the channel. 61583be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 61683be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek @return The flat array subscript suitable for indexing DisqualifiedModes, 61783be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek IdentifyData, and IdentifyValid. 61883be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek**/ 61983be6beea56f9f6e93c04f316e91be18e44654f0Laszlo ErsekSTATIC 62083be6beea56f9f6e93c04f316e91be18e44654f0Laszlo ErsekUINTN 62183be6beea56f9f6e93c04f316e91be18e44654f0Laszlo ErsekFlatDeviceIndex ( 62283be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek IN CONST EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData, 62383be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek IN UINTN Channel, 62483be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek IN UINTN Device 62583be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek ) 62683be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek{ 62783be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek ASSERT (SataPrivateData != NULL); 62883be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek ASSERT (Channel < SataPrivateData->IdeInit.ChannelCount); 62983be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek ASSERT (Device < SataPrivateData->DeviceCount); 63083be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 63183be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek return Channel * SataPrivateData->DeviceCount + Device; 63283be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek} 63383be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 63427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 63527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// Interface functions of IDE_CONTROLLER_INIT protocol 63627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 63727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 63880d6c273d47f139e366ad35d9414b83d0d78e82berictian Returns the information about the specified IDE channel. 63980d6c273d47f139e366ad35d9414b83d0d78e82berictian 64080d6c273d47f139e366ad35d9414b83d0d78e82berictian This function can be used to obtain information about a particular IDE channel. 64180d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity uses this information during the enumeration process. 64280d6c273d47f139e366ad35d9414b83d0d78e82berictian 64380d6c273d47f139e366ad35d9414b83d0d78e82berictian If Enabled is set to FALSE, the driver entity will not scan the channel. Note 64480d6c273d47f139e366ad35d9414b83d0d78e82berictian that it will not prevent an operating system driver from scanning the channel. 64580d6c273d47f139e366ad35d9414b83d0d78e82berictian 64680d6c273d47f139e366ad35d9414b83d0d78e82berictian For most of today's controllers, MaxDevices will either be 1 or 2. For SATA 64780d6c273d47f139e366ad35d9414b83d0d78e82berictian controllers, this value will always be 1. SATA configurations can contain SATA 64880d6c273d47f139e366ad35d9414b83d0d78e82berictian port multipliers. SATA port multipliers behave like SATA bridges and can support 64980d6c273d47f139e366ad35d9414b83d0d78e82berictian up to 16 devices on the other side. If a SATA port out of the IDE controller 65080d6c273d47f139e366ad35d9414b83d0d78e82berictian is connected to a port multiplier, MaxDevices will be set to the number of SATA 65180d6c273d47f139e366ad35d9414b83d0d78e82berictian devices that the port multiplier supports. Because today's port multipliers 65280d6c273d47f139e366ad35d9414b83d0d78e82berictian support up to fifteen SATA devices, this number can be as large as fifteen. The IDE 65380d6c273d47f139e366ad35d9414b83d0d78e82berictian bus driver is required to scan for the presence of port multipliers behind an SATA 65480d6c273d47f139e366ad35d9414b83d0d78e82berictian controller and enumerate up to MaxDevices number of devices behind the port 65580d6c273d47f139e366ad35d9414b83d0d78e82berictian multiplier. 65680d6c273d47f139e366ad35d9414b83d0d78e82berictian 65780d6c273d47f139e366ad35d9414b83d0d78e82berictian In this context, the devices behind a port multiplier constitute a channel. 65880d6c273d47f139e366ad35d9414b83d0d78e82berictian 65980d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 66080d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 66180d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[out] Enabled TRUE if this channel is enabled. Disabled channels 66280d6c273d47f139e366ad35d9414b83d0d78e82berictian are not scanned to see if any devices are present. 66380d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[out] MaxDevices The maximum number of IDE devices that the bus driver 66480d6c273d47f139e366ad35d9414b83d0d78e82berictian can expect on this channel. For the ATA/ATAPI 66580d6c273d47f139e366ad35d9414b83d0d78e82berictian specification, version 6, this number will either be 66680d6c273d47f139e366ad35d9414b83d0d78e82berictian one or two. For Serial ATA (SATA) configurations with a 66780d6c273d47f139e366ad35d9414b83d0d78e82berictian port multiplier, this number can be as large as fifteen. 66880d6c273d47f139e366ad35d9414b83d0d78e82berictian 66980d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS Information was returned without any errors. 67080d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 67180d6c273d47f139e366ad35d9414b83d0d78e82berictian 67227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 67327f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 67427f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 67527f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitGetChannelInfo ( 67627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 67727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 67827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT BOOLEAN *Enabled, 67927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT UINT8 *MaxDevices 68027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 68127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 68227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData; 68327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This); 68427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT (SataPrivateData != NULL); 68527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 68627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (Channel < This->ChannelCount) { 68727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *Enabled = TRUE; 68827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *MaxDevices = SataPrivateData->DeviceCount; 68927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 69027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 69127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 69227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *Enabled = FALSE; 69327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_INVALID_PARAMETER; 69427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 69527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 69627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 69780d6c273d47f139e366ad35d9414b83d0d78e82berictian The notifications from the driver entity that it is about to enter a certain 69880d6c273d47f139e366ad35d9414b83d0d78e82berictian phase of the IDE channel enumeration process. 69980d6c273d47f139e366ad35d9414b83d0d78e82berictian 70080d6c273d47f139e366ad35d9414b83d0d78e82berictian This function can be used to notify the IDE controller driver to perform 70180d6c273d47f139e366ad35d9414b83d0d78e82berictian specific actions, including any chipset-specific initialization, so that the 70280d6c273d47f139e366ad35d9414b83d0d78e82berictian chipset is ready to enter the next phase. Seven notification points are defined 70380d6c273d47f139e366ad35d9414b83d0d78e82berictian at this time. 70480d6c273d47f139e366ad35d9414b83d0d78e82berictian 70580d6c273d47f139e366ad35d9414b83d0d78e82berictian More synchronization points may be added as required in the future. 70680d6c273d47f139e366ad35d9414b83d0d78e82berictian 70780d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 70880d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Phase The phase during enumeration. 70980d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 71027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 71180d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The notification was accepted without any errors. 71280d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_UNSUPPORTED Phase is not supported. 71380d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 71480d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_NOT_READY This phase cannot be entered at this time; for 71580d6c273d47f139e366ad35d9414b83d0d78e82berictian example, an attempt was made to enter a Phase 71680d6c273d47f139e366ad35d9414b83d0d78e82berictian without having entered one or more previous 71780d6c273d47f139e366ad35d9414b83d0d78e82berictian Phase. 71827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 71927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 72027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 72127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 72227f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitNotifyPhase ( 72327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 72427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase, 72527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel 72627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 72727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 72827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 72927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 73027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 73127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 73280d6c273d47f139e366ad35d9414b83d0d78e82berictian Submits the device information to the IDE controller driver. 73380d6c273d47f139e366ad35d9414b83d0d78e82berictian 73480d6c273d47f139e366ad35d9414b83d0d78e82berictian This function is used by the driver entity to pass detailed information about 73580d6c273d47f139e366ad35d9414b83d0d78e82berictian a particular device to the IDE controller driver. The driver entity obtains 73680d6c273d47f139e366ad35d9414b83d0d78e82berictian this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData 73780d6c273d47f139e366ad35d9414b83d0d78e82berictian is the pointer to the response data buffer. The IdentifyData buffer is owned 73880d6c273d47f139e366ad35d9414b83d0d78e82berictian by the driver entity, and the IDE controller driver must make a local copy 73980d6c273d47f139e366ad35d9414b83d0d78e82berictian of the entire buffer or parts of the buffer as needed. The original IdentifyData 74080d6c273d47f139e366ad35d9414b83d0d78e82berictian buffer pointer may not be valid when 74180d6c273d47f139e366ad35d9414b83d0d78e82berictian 74280d6c273d47f139e366ad35d9414b83d0d78e82berictian - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or 74380d6c273d47f139e366ad35d9414b83d0d78e82berictian - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point. 74480d6c273d47f139e366ad35d9414b83d0d78e82berictian 74580d6c273d47f139e366ad35d9414b83d0d78e82berictian The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to 74680d6c273d47f139e366ad35d9414b83d0d78e82berictian compute the optimum mode for the device. These fields are not limited to the 74780d6c273d47f139e366ad35d9414b83d0d78e82berictian timing information. For example, an implementation of the IDE controller driver 74880d6c273d47f139e366ad35d9414b83d0d78e82berictian may examine the vendor and type/mode field to match known bad drives. 74980d6c273d47f139e366ad35d9414b83d0d78e82berictian 75080d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity may submit drive information in any order, as long as it 75180d6c273d47f139e366ad35d9414b83d0d78e82berictian submits information for all the devices belonging to the enumeration group 75280d6c273d47f139e366ad35d9414b83d0d78e82berictian before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device 75380d6c273d47f139e366ad35d9414b83d0d78e82berictian in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 75480d6c273d47f139e366ad35d9414b83d0d78e82berictian should be called with IdentifyData set to NULL. The IDE controller driver may 75580d6c273d47f139e366ad35d9414b83d0d78e82berictian not have any other mechanism to know whether a device is present or not. Therefore, 75680d6c273d47f139e366ad35d9414b83d0d78e82berictian setting IdentifyData to NULL does not constitute an error condition. 75780d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a 75880d6c273d47f139e366ad35d9414b83d0d78e82berictian given (Channel, Device) pair. 75980d6c273d47f139e366ad35d9414b83d0d78e82berictian 76080d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 76180d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 76280d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device Zero-based device number on the Channel. 76380d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command. 76480d6c273d47f139e366ad35d9414b83d0d78e82berictian 76580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The information was accepted without any errors. 76680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 76780d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 76827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 76927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 77027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 77127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 77227f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitSubmitData ( 77327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 77427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 77527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 77627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDENTIFY_DATA *IdentifyData 77727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 77827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 77927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData; 78083be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek UINTN DeviceIndex; 78183be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 78227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This); 78327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT (SataPrivateData != NULL); 78427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 78527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if ((Channel >= This->ChannelCount) || (Device >= SataPrivateData->DeviceCount)) { 78627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_INVALID_PARAMETER; 78727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 78827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 78983be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device); 79083be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 79127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 79227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Make a local copy of device's IdentifyData and mark the valid flag 79327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 79427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (IdentifyData != NULL) { 79527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng CopyMem ( 79683be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek &(SataPrivateData->IdentifyData[DeviceIndex]), 79727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IdentifyData, 79827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng sizeof (EFI_IDENTIFY_DATA) 79927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 80027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 80183be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek SataPrivateData->IdentifyValid[DeviceIndex] = TRUE; 80227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 80383be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek SataPrivateData->IdentifyValid[DeviceIndex] = FALSE; 80427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 80527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 80627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 80727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 80827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 80927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 81080d6c273d47f139e366ad35d9414b83d0d78e82berictian Disqualifies specific modes for an IDE device. 81180d6c273d47f139e366ad35d9414b83d0d78e82berictian 81280d6c273d47f139e366ad35d9414b83d0d78e82berictian This function allows the driver entity or other drivers (such as platform 81380d6c273d47f139e366ad35d9414b83d0d78e82berictian drivers) to reject certain timing modes and request the IDE controller driver 81480d6c273d47f139e366ad35d9414b83d0d78e82berictian to recalculate modes. This function allows the driver entity and the IDE 81580d6c273d47f139e366ad35d9414b83d0d78e82berictian controller driver to negotiate the timings on a per-device basis. This function 81680d6c273d47f139e366ad35d9414b83d0d78e82berictian is useful in the case of drives that lie about their capabilities. An example 81780d6c273d47f139e366ad35d9414b83d0d78e82berictian is when the IDE device fails to accept the timing modes that are calculated 81880d6c273d47f139e366ad35d9414b83d0d78e82berictian by the IDE controller driver based on the response to the Identify Drive command. 81980d6c273d47f139e366ad35d9414b83d0d78e82berictian 82080d6c273d47f139e366ad35d9414b83d0d78e82berictian If the driver entity does not want to limit the ATA timing modes and leave that 82180d6c273d47f139e366ad35d9414b83d0d78e82berictian decision to the IDE controller driver, it can either not call this function for 82280d6c273d47f139e366ad35d9414b83d0d78e82berictian the given device or call this function and set the Valid flag to FALSE for all 82380d6c273d47f139e366ad35d9414b83d0d78e82berictian modes that are listed in EFI_ATA_COLLECTIVE_MODE. 82480d6c273d47f139e366ad35d9414b83d0d78e82berictian 82580d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity may disqualify modes for a device in any order and any number 82680d6c273d47f139e366ad35d9414b83d0d78e82berictian of times. 82780d6c273d47f139e366ad35d9414b83d0d78e82berictian 82880d6c273d47f139e366ad35d9414b83d0d78e82berictian This function can be called multiple times to invalidate multiple modes of the 82980d6c273d47f139e366ad35d9414b83d0d78e82berictian same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI 83080d6c273d47f139e366ad35d9414b83d0d78e82berictian specification for more information on PIO modes. 83180d6c273d47f139e366ad35d9414b83d0d78e82berictian 83280d6c273d47f139e366ad35d9414b83d0d78e82berictian For Serial ATA (SATA) controllers, this member function can be used to disqualify 83380d6c273d47f139e366ad35d9414b83d0d78e82berictian a higher transfer rate mode on a given channel. For example, a platform driver 83480d6c273d47f139e366ad35d9414b83d0d78e82berictian may inform the IDE controller driver to not use second-generation (Gen2) speeds 83580d6c273d47f139e366ad35d9414b83d0d78e82berictian for a certain SATA drive. 83680d6c273d47f139e366ad35d9414b83d0d78e82berictian 83780d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 83880d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel The zero-based channel number. 83980d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device The zero-based device number on the Channel. 84080d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] BadModes The modes that the device does not support and that 84180d6c273d47f139e366ad35d9414b83d0d78e82berictian should be disqualified. 84280d6c273d47f139e366ad35d9414b83d0d78e82berictian 84380d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The modes were accepted without any errors. 84480d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 84580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 84680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER IdentifyData is NULL. 84780d6c273d47f139e366ad35d9414b83d0d78e82berictian 84827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 84927f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 85027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 85127f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitDisqualifyMode ( 85227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 85327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 85427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 85527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_ATA_COLLECTIVE_MODE *BadModes 85627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 85727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 85827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData; 85983be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek UINTN DeviceIndex; 86083be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 86127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This); 86227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT (SataPrivateData != NULL); 86327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 86427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if ((Channel >= This->ChannelCount) || (BadModes == NULL) || (Device >= SataPrivateData->DeviceCount)) { 86527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_INVALID_PARAMETER; 86627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 86727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 86883be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device); 86983be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 87027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 87127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Record the disqualified modes per channel per device. From ATA/ATAPI spec, 87227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // if a mode is not supported, the modes higher than it is also not supported. 87327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 87427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng CopyMem ( 87583be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek &(SataPrivateData->DisqualifiedModes[DeviceIndex]), 87627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng BadModes, 87727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng sizeof (EFI_ATA_COLLECTIVE_MODE) 87827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 87927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 88027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 88127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 88227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 88327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 88480d6c273d47f139e366ad35d9414b83d0d78e82berictian Returns the information about the optimum modes for the specified IDE device. 88580d6c273d47f139e366ad35d9414b83d0d78e82berictian 88680d6c273d47f139e366ad35d9414b83d0d78e82berictian This function is used by the driver entity to obtain the optimum ATA modes for 88780d6c273d47f139e366ad35d9414b83d0d78e82berictian a specific device. The IDE controller driver takes into account the following 88880d6c273d47f139e366ad35d9414b83d0d78e82berictian while calculating the mode: 88980d6c273d47f139e366ad35d9414b83d0d78e82berictian - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 89080d6c273d47f139e366ad35d9414b83d0d78e82berictian - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() 89180d6c273d47f139e366ad35d9414b83d0d78e82berictian 89280d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 89380d6c273d47f139e366ad35d9414b83d0d78e82berictian for all the devices that belong to an enumeration group before calling 89480d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group. 89580d6c273d47f139e366ad35d9414b83d0d78e82berictian 89680d6c273d47f139e366ad35d9414b83d0d78e82berictian The IDE controller driver will use controller- and possibly platform-specific 89780d6c273d47f139e366ad35d9414b83d0d78e82berictian algorithms to arrive at SupportedModes. The IDE controller may base its 89880d6c273d47f139e366ad35d9414b83d0d78e82berictian decision on user preferences and other considerations as well. This function 89980d6c273d47f139e366ad35d9414b83d0d78e82berictian may be called multiple times because the driver entity may renegotiate the mode 90080d6c273d47f139e366ad35d9414b83d0d78e82berictian with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode(). 90180d6c273d47f139e366ad35d9414b83d0d78e82berictian 90280d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity may collect timing information for various devices in any 90380d6c273d47f139e366ad35d9414b83d0d78e82berictian order. The driver entity is responsible for making sure that all the dependencies 90480d6c273d47f139e366ad35d9414b83d0d78e82berictian are satisfied. For example, the SupportedModes information for device A that 90580d6c273d47f139e366ad35d9414b83d0d78e82berictian was previously returned may become stale after a call to 90680d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B. 90780d6c273d47f139e366ad35d9414b83d0d78e82berictian 90880d6c273d47f139e366ad35d9414b83d0d78e82berictian The buffer SupportedModes is allocated by the callee because the caller does 90980d6c273d47f139e366ad35d9414b83d0d78e82berictian not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE 91080d6c273d47f139e366ad35d9414b83d0d78e82berictian is defined in a way that allows for future extensibility and can be of variable 91180d6c273d47f139e366ad35d9414b83d0d78e82berictian length. This memory pool should be deallocated by the caller when it is no 91280d6c273d47f139e366ad35d9414b83d0d78e82berictian longer necessary. 91380d6c273d47f139e366ad35d9414b83d0d78e82berictian 91480d6c273d47f139e366ad35d9414b83d0d78e82berictian The IDE controller driver for a Serial ATA (SATA) controller can use this 91580d6c273d47f139e366ad35d9414b83d0d78e82berictian member function to force a lower speed (first-generation [Gen1] speeds on a 91680d6c273d47f139e366ad35d9414b83d0d78e82berictian second-generation [Gen2]-capable hardware). The IDE controller driver can 91780d6c273d47f139e366ad35d9414b83d0d78e82berictian also allow the driver entity to stay with the speed that has been negotiated 91880d6c273d47f139e366ad35d9414b83d0d78e82berictian by the physical layer. 91980d6c273d47f139e366ad35d9414b83d0d78e82berictian 92080d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 92180d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel A zero-based channel number. 92280d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device A zero-based device number on the Channel. 92380d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[out] SupportedModes The optimum modes for the device. 92480d6c273d47f139e366ad35d9414b83d0d78e82berictian 92580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS SupportedModes was returned. 92680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 92780d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 92880d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER SupportedModes is NULL. 92980d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_NOT_READY Modes cannot be calculated due to a lack of 93080d6c273d47f139e366ad35d9414b83d0d78e82berictian data. This error may happen if 93180d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 93280d6c273d47f139e366ad35d9414b83d0d78e82berictian and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData() 93380d6c273d47f139e366ad35d9414b83d0d78e82berictian were not called for at least one drive in the 93480d6c273d47f139e366ad35d9414b83d0d78e82berictian same enumeration group. 93580d6c273d47f139e366ad35d9414b83d0d78e82berictian 93627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 93727f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 93827f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 93927f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitCalculateMode ( 94027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 94127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 94227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 94327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes 94427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 94527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 94627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData; 94727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_IDENTIFY_DATA *IdentifyData; 94827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng BOOLEAN IdentifyValid; 949d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek EFI_ATA_COLLECTIVE_MODE *DisqualifiedModes; 95027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT16 SelectedMode; 95127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_STATUS Status; 95283be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek UINTN DeviceIndex; 95327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 95427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This); 95527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ASSERT (SataPrivateData != NULL); 95627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 95727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if ((Channel >= This->ChannelCount) || (SupportedModes == NULL) || (Device >= SataPrivateData->DeviceCount)) { 95827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_INVALID_PARAMETER; 95927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 96027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 96127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng *SupportedModes = AllocateZeroPool (sizeof (EFI_ATA_COLLECTIVE_MODE)); 96227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (*SupportedModes == NULL) { 96386702b3fa9437301a6ae02df610ad3ca15fc860aerictian ASSERT (*SupportedModes != NULL); 96427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_OUT_OF_RESOURCES; 96527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 96627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 96783be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device); 96883be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek 96983be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek IdentifyData = &(SataPrivateData->IdentifyData[DeviceIndex]); 97083be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek IdentifyValid = SataPrivateData->IdentifyValid[DeviceIndex]; 97183be6beea56f9f6e93c04f316e91be18e44654f0Laszlo Ersek DisqualifiedModes = &(SataPrivateData->DisqualifiedModes[DeviceIndex]); 97227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 97327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 97427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Make sure we've got the valid identify data of the device from SubmitData() 97527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 97627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (!IdentifyValid) { 97786702b3fa9437301a6ae02df610ad3ca15fc860aerictian FreePool (*SupportedModes); 97827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_NOT_READY; 97927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 98027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 98127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = CalculateBestPioMode ( 98227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IdentifyData, 983d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek (DisqualifiedModes->PioMode.Valid ? ((UINT16 *) &(DisqualifiedModes->PioMode.Mode)) : NULL), 98427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &SelectedMode 98527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 98627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (!EFI_ERROR (Status)) { 98727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (*SupportedModes)->PioMode.Valid = TRUE; 98827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (*SupportedModes)->PioMode.Mode = SelectedMode; 98927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 99027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 99127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (*SupportedModes)->PioMode.Valid = FALSE; 99227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 99327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: PioMode = %x\n", (*SupportedModes)->PioMode.Mode)); 99427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 99527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Status = CalculateBestUdmaMode ( 99627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IdentifyData, 997d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek (DisqualifiedModes->UdmaMode.Valid ? ((UINT16 *) &(DisqualifiedModes->UdmaMode.Mode)) : NULL), 99827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng &SelectedMode 99927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ); 100027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 100127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng if (!EFI_ERROR (Status)) { 100227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (*SupportedModes)->UdmaMode.Valid = TRUE; 100327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (*SupportedModes)->UdmaMode.Mode = SelectedMode; 100427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 100527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } else { 100627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng (*SupportedModes)->UdmaMode.Valid = FALSE; 100727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng } 100827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: UdmaMode = %x\n", (*SupportedModes)->UdmaMode.Mode)); 100927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 101027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 101127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // The modes other than PIO and UDMA are not supported 101227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 101327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 101427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 101527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 101627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 101780d6c273d47f139e366ad35d9414b83d0d78e82berictian Commands the IDE controller driver to program the IDE controller hardware 101880d6c273d47f139e366ad35d9414b83d0d78e82berictian so that the specified device can operate at the specified mode. 101980d6c273d47f139e366ad35d9414b83d0d78e82berictian 102080d6c273d47f139e366ad35d9414b83d0d78e82berictian This function is used by the driver entity to instruct the IDE controller 102180d6c273d47f139e366ad35d9414b83d0d78e82berictian driver to program the IDE controller hardware to the specified modes. This 102280d6c273d47f139e366ad35d9414b83d0d78e82berictian function can be called only once for a particular device. For a Serial ATA 102380d6c273d47f139e366ad35d9414b83d0d78e82berictian (SATA) Advanced Host Controller Interface (AHCI) controller, no controller- 102480d6c273d47f139e366ad35d9414b83d0d78e82berictian specific programming may be required. 102580d6c273d47f139e366ad35d9414b83d0d78e82berictian 102680d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 102780d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 102880d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device Zero-based device number on the Channel. 102980d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Modes The modes to set. 103080d6c273d47f139e366ad35d9414b83d0d78e82berictian 103180d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The command was accepted without any errors. 103280d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 103380d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 103480d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data. 103580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure. 103680d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity should not use this device. 103727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 103827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 103927f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 104027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 104127f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitSetTiming ( 104227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 104327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 104427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 104527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_ATA_COLLECTIVE_MODE *Modes 104627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 104727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng{ 104827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng return EFI_SUCCESS; 104927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} 1050