127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** @file 227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Header file for Sata Controller driver. 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#ifndef _SATA_CONTROLLER_H_ 1627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define _SATA_CONTROLLER_H_ 1727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 1827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Uefi.h> 1927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Protocol/ComponentName.h> 2027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Protocol/DriverBinding.h> 2127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Protocol/PciIo.h> 2227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Protocol/IdeControllerInit.h> 2327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Library/UefiDriverEntryPoint.h> 2427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Library/DebugLib.h> 2527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Library/UefiLib.h> 2627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Library/BaseLib.h> 2727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Library/BaseMemoryLib.h> 2827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Library/MemoryAllocationLib.h> 2927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <Library/UefiBootServicesTableLib.h> 3027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#include <IndustryStandard/Pci.h> 3127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 3227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 3327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// Global Variables definitions 3427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 3527f3015903bf30b9ca0e72c0174e9ef787d79659lzengextern EFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding; 3627f3015903bf30b9ca0e72c0174e9ef787d79659lzengextern EFI_COMPONENT_NAME_PROTOCOL gSataControllerComponentName; 3727f3015903bf30b9ca0e72c0174e9ef787d79659lzengextern EFI_COMPONENT_NAME2_PROTOCOL gSataControllerComponentName2; 3827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 3927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define AHCI_BAR_INDEX 0x05 4027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define R_AHCI_CAP 0x0 4127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define B_AHCI_CAP_NPS (BIT4 | BIT3 | BIT2 | BIT1 | BIT0) // Number of Ports 4227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define B_AHCI_CAP_SPM BIT17 // Supports Port Multiplier 4327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 4427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 4527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// AHCI each channel can have up to 1 device 4627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 4727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define AHCI_MAX_DEVICES 0x01 4827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 4927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 5027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// AHCI each channel can have 15 devices in the presence of a multiplier 5127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 5227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define AHCI_MULTI_MAX_DEVICES 0x0F 5327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 5427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 5527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// IDE supports 2 channel max 5627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 5727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define IDE_MAX_CHANNEL 0x02 5827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 5927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 6027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// IDE supports 2 devices max 6127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/// 6227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define IDE_MAX_DEVICES 0x02 6327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 6427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define SATA_ENUMER_ALL FALSE 6527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 6627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 6727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// Sata Controller driver private data structure 6827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 6927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 7027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define SATA_CONTROLLER_SIGNATURE SIGNATURE_32('S','A','T','A') 7127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 7227f3015903bf30b9ca0e72c0174e9ef787d79659lzengtypedef struct _EFI_SATA_CONTROLLER_PRIVATE_DATA { 7327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 7427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Standard signature used to identify Sata Controller private data 7527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 7627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT32 Signature; 7727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 7827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 7927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Protocol instance of IDE_CONTROLLER_INIT produced by this driver 8027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 8127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_IDE_CONTROLLER_INIT_PROTOCOL IdeInit; 8227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 8327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 8427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // Copy of protocol pointers used by this driver 8527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 8627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_PCI_IO_PROTOCOL *PciIo; 8727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 8827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 8927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // The number of devices that are supported by this channel 9027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 9127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng UINT8 DeviceCount; 9227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 9327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 9427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // The highest disqulified mode for each attached device, 9527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // From ATA/ATAPI spec, if a mode is not supported, 9627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // the modes higher than it is also not supported 9727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 98d80e8c459ab29d198a4718bec9fd77d3fa2db1eeLaszlo Ersek EFI_ATA_COLLECTIVE_MODE *DisqualifiedModes; 9927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 10027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 10127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // A copy of EFI_IDENTIFY_DATA data for each attached SATA device and its flag 10227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng // 10327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_IDENTIFY_DATA *IdentifyData; 10427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng BOOLEAN *IdentifyValid; 10527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng} EFI_SATA_CONTROLLER_PRIVATE_DATA; 10627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 10727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#define SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS(a) CR(a, EFI_SATA_CONTROLLER_PRIVATE_DATA, IdeInit, SATA_CONTROLLER_SIGNATURE) 10827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 10927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 11027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// Driver binding functions declaration 11127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 11227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 11327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Supported function of Driver Binding protocol for this driver. 11427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Test to see if this driver supports ControllerHandle. 11527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 11627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This Protocol instance pointer. 11727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Controller Handle of device to test. 11827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param RemainingDevicePath A pointer to the device path. Should be ignored by 11927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng device driver. 12027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 12127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS This driver supports this device. 12227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_ALREADY_STARTED This driver is already running on this device. 12327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval other This driver does not support this device. 12427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 12527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 12627f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 12727f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 12827f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerSupported ( 12927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DRIVER_BINDING_PROTOCOL *This, 13027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE Controller, 13127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath 13227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 13327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 13427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 13527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 13627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This routine is called right after the .Supported() called and 13727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Start this driver on ControllerHandle. 13827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 13927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This Protocol instance pointer. 14027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Controller Handle of device to bind driver to. 14127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param RemainingDevicePath A pointer to the device path. Should be ignored by 14227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng device driver. 14327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 14427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS This driver is added to this device. 14527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_ALREADY_STARTED This driver is already running on this device. 14627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval other Some error occurs when binding this driver to this device. 14727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 14827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 14927f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 15027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 15127f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerStart ( 15227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DRIVER_BINDING_PROTOCOL *This, 15327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE Controller, 15427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath 15527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 15627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 15727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 15827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 15927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Stop this driver on ControllerHandle. 16027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 16127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This Protocol instance pointer. 16227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Controller Handle of device to stop driver on. 16327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param NumberOfChildren Not used. 16427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param ChildHandleBuffer Not used. 16527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 16627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS This driver is removed from this device. 16727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval other Some error occurs when removing this driver from this device. 16827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 16927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 17027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 17127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 17227f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerStop ( 17327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_DRIVER_BINDING_PROTOCOL *This, 17427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE Controller, 17527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINTN NumberOfChildren, 17627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE *ChildHandleBuffer 17727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 17827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 17927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 18027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 18127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// IDE controller init functions declaration 18227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 18327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 18480d6c273d47f139e366ad35d9414b83d0d78e82berictian Returns the information about the specified IDE channel. 18580d6c273d47f139e366ad35d9414b83d0d78e82berictian 18680d6c273d47f139e366ad35d9414b83d0d78e82berictian This function can be used to obtain information about a particular IDE channel. 18780d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity uses this information during the enumeration process. 18880d6c273d47f139e366ad35d9414b83d0d78e82berictian 18980d6c273d47f139e366ad35d9414b83d0d78e82berictian If Enabled is set to FALSE, the driver entity will not scan the channel. Note 19080d6c273d47f139e366ad35d9414b83d0d78e82berictian that it will not prevent an operating system driver from scanning the channel. 19180d6c273d47f139e366ad35d9414b83d0d78e82berictian 19280d6c273d47f139e366ad35d9414b83d0d78e82berictian For most of today's controllers, MaxDevices will either be 1 or 2. For SATA 19380d6c273d47f139e366ad35d9414b83d0d78e82berictian controllers, this value will always be 1. SATA configurations can contain SATA 19480d6c273d47f139e366ad35d9414b83d0d78e82berictian port multipliers. SATA port multipliers behave like SATA bridges and can support 19580d6c273d47f139e366ad35d9414b83d0d78e82berictian up to 16 devices on the other side. If a SATA port out of the IDE controller 19680d6c273d47f139e366ad35d9414b83d0d78e82berictian is connected to a port multiplier, MaxDevices will be set to the number of SATA 19780d6c273d47f139e366ad35d9414b83d0d78e82berictian devices that the port multiplier supports. Because today's port multipliers 19880d6c273d47f139e366ad35d9414b83d0d78e82berictian support up to fifteen SATA devices, this number can be as large as fifteen. The IDE 19980d6c273d47f139e366ad35d9414b83d0d78e82berictian bus driver is required to scan for the presence of port multipliers behind an SATA 20080d6c273d47f139e366ad35d9414b83d0d78e82berictian controller and enumerate up to MaxDevices number of devices behind the port 20180d6c273d47f139e366ad35d9414b83d0d78e82berictian multiplier. 20280d6c273d47f139e366ad35d9414b83d0d78e82berictian 20380d6c273d47f139e366ad35d9414b83d0d78e82berictian In this context, the devices behind a port multiplier constitute a channel. 20480d6c273d47f139e366ad35d9414b83d0d78e82berictian 20580d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 20680d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 20780d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[out] Enabled TRUE if this channel is enabled. Disabled channels 20880d6c273d47f139e366ad35d9414b83d0d78e82berictian are not scanned to see if any devices are present. 20980d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[out] MaxDevices The maximum number of IDE devices that the bus driver 21080d6c273d47f139e366ad35d9414b83d0d78e82berictian can expect on this channel. For the ATA/ATAPI 21180d6c273d47f139e366ad35d9414b83d0d78e82berictian specification, version 6, this number will either be 21280d6c273d47f139e366ad35d9414b83d0d78e82berictian one or two. For Serial ATA (SATA) configurations with a 21380d6c273d47f139e366ad35d9414b83d0d78e82berictian port multiplier, this number can be as large as fifteen. 21480d6c273d47f139e366ad35d9414b83d0d78e82berictian 21580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS Information was returned without any errors. 21680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 21780d6c273d47f139e366ad35d9414b83d0d78e82berictian 21827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 21927f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 22027f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 22127f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitGetChannelInfo ( 22227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 22327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 22427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT BOOLEAN *Enabled, 22527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT UINT8 *MaxDevices 22627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 22727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 22827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 22927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 23080d6c273d47f139e366ad35d9414b83d0d78e82berictian The notifications from the driver entity that it is about to enter a certain 23180d6c273d47f139e366ad35d9414b83d0d78e82berictian phase of the IDE channel enumeration process. 23280d6c273d47f139e366ad35d9414b83d0d78e82berictian 23380d6c273d47f139e366ad35d9414b83d0d78e82berictian This function can be used to notify the IDE controller driver to perform 23480d6c273d47f139e366ad35d9414b83d0d78e82berictian specific actions, including any chipset-specific initialization, so that the 23580d6c273d47f139e366ad35d9414b83d0d78e82berictian chipset is ready to enter the next phase. Seven notification points are defined 23680d6c273d47f139e366ad35d9414b83d0d78e82berictian at this time. 23780d6c273d47f139e366ad35d9414b83d0d78e82berictian 23880d6c273d47f139e366ad35d9414b83d0d78e82berictian More synchronization points may be added as required in the future. 23980d6c273d47f139e366ad35d9414b83d0d78e82berictian 24080d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 24180d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Phase The phase during enumeration. 24280d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 24380d6c273d47f139e366ad35d9414b83d0d78e82berictian 24480d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The notification was accepted without any errors. 24580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_UNSUPPORTED Phase is not supported. 24680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 24780d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_NOT_READY This phase cannot be entered at this time; for 24880d6c273d47f139e366ad35d9414b83d0d78e82berictian example, an attempt was made to enter a Phase 24980d6c273d47f139e366ad35d9414b83d0d78e82berictian without having entered one or more previous 25080d6c273d47f139e366ad35d9414b83d0d78e82berictian Phase. 25127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 25227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 25327f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 25427f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 25527f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitNotifyPhase ( 25627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 25727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase, 25827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel 25927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 26027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 26127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 26227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 26380d6c273d47f139e366ad35d9414b83d0d78e82berictian Submits the device information to the IDE controller driver. 26480d6c273d47f139e366ad35d9414b83d0d78e82berictian 26580d6c273d47f139e366ad35d9414b83d0d78e82berictian This function is used by the driver entity to pass detailed information about 26680d6c273d47f139e366ad35d9414b83d0d78e82berictian a particular device to the IDE controller driver. The driver entity obtains 26780d6c273d47f139e366ad35d9414b83d0d78e82berictian this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData 26880d6c273d47f139e366ad35d9414b83d0d78e82berictian is the pointer to the response data buffer. The IdentifyData buffer is owned 26980d6c273d47f139e366ad35d9414b83d0d78e82berictian by the driver entity, and the IDE controller driver must make a local copy 27080d6c273d47f139e366ad35d9414b83d0d78e82berictian of the entire buffer or parts of the buffer as needed. The original IdentifyData 27180d6c273d47f139e366ad35d9414b83d0d78e82berictian buffer pointer may not be valid when 27280d6c273d47f139e366ad35d9414b83d0d78e82berictian 27380d6c273d47f139e366ad35d9414b83d0d78e82berictian - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or 27480d6c273d47f139e366ad35d9414b83d0d78e82berictian - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point. 27580d6c273d47f139e366ad35d9414b83d0d78e82berictian 27680d6c273d47f139e366ad35d9414b83d0d78e82berictian The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to 27780d6c273d47f139e366ad35d9414b83d0d78e82berictian compute the optimum mode for the device. These fields are not limited to the 27880d6c273d47f139e366ad35d9414b83d0d78e82berictian timing information. For example, an implementation of the IDE controller driver 27980d6c273d47f139e366ad35d9414b83d0d78e82berictian may examine the vendor and type/mode field to match known bad drives. 28080d6c273d47f139e366ad35d9414b83d0d78e82berictian 28180d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity may submit drive information in any order, as long as it 28280d6c273d47f139e366ad35d9414b83d0d78e82berictian submits information for all the devices belonging to the enumeration group 28380d6c273d47f139e366ad35d9414b83d0d78e82berictian before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device 28480d6c273d47f139e366ad35d9414b83d0d78e82berictian in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 28580d6c273d47f139e366ad35d9414b83d0d78e82berictian should be called with IdentifyData set to NULL. The IDE controller driver may 28680d6c273d47f139e366ad35d9414b83d0d78e82berictian not have any other mechanism to know whether a device is present or not. Therefore, 28780d6c273d47f139e366ad35d9414b83d0d78e82berictian setting IdentifyData to NULL does not constitute an error condition. 28880d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a 28980d6c273d47f139e366ad35d9414b83d0d78e82berictian given (Channel, Device) pair. 29080d6c273d47f139e366ad35d9414b83d0d78e82berictian 29180d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 29280d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 29380d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device Zero-based device number on the Channel. 29480d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command. 29580d6c273d47f139e366ad35d9414b83d0d78e82berictian 29680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The information was accepted without any errors. 29780d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 29880d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 29927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 30027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 30127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 30227f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 30327f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitSubmitData ( 30427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 30527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 30627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 30727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDENTIFY_DATA *IdentifyData 30827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 30927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 31027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 31127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 31280d6c273d47f139e366ad35d9414b83d0d78e82berictian Disqualifies specific modes for an IDE device. 31380d6c273d47f139e366ad35d9414b83d0d78e82berictian 31480d6c273d47f139e366ad35d9414b83d0d78e82berictian This function allows the driver entity or other drivers (such as platform 31580d6c273d47f139e366ad35d9414b83d0d78e82berictian drivers) to reject certain timing modes and request the IDE controller driver 31680d6c273d47f139e366ad35d9414b83d0d78e82berictian to recalculate modes. This function allows the driver entity and the IDE 31780d6c273d47f139e366ad35d9414b83d0d78e82berictian controller driver to negotiate the timings on a per-device basis. This function 31880d6c273d47f139e366ad35d9414b83d0d78e82berictian is useful in the case of drives that lie about their capabilities. An example 31980d6c273d47f139e366ad35d9414b83d0d78e82berictian is when the IDE device fails to accept the timing modes that are calculated 32080d6c273d47f139e366ad35d9414b83d0d78e82berictian by the IDE controller driver based on the response to the Identify Drive command. 32180d6c273d47f139e366ad35d9414b83d0d78e82berictian 32280d6c273d47f139e366ad35d9414b83d0d78e82berictian If the driver entity does not want to limit the ATA timing modes and leave that 32380d6c273d47f139e366ad35d9414b83d0d78e82berictian decision to the IDE controller driver, it can either not call this function for 32480d6c273d47f139e366ad35d9414b83d0d78e82berictian the given device or call this function and set the Valid flag to FALSE for all 32580d6c273d47f139e366ad35d9414b83d0d78e82berictian modes that are listed in EFI_ATA_COLLECTIVE_MODE. 32680d6c273d47f139e366ad35d9414b83d0d78e82berictian 32780d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity may disqualify modes for a device in any order and any number 32880d6c273d47f139e366ad35d9414b83d0d78e82berictian of times. 32980d6c273d47f139e366ad35d9414b83d0d78e82berictian 33080d6c273d47f139e366ad35d9414b83d0d78e82berictian This function can be called multiple times to invalidate multiple modes of the 33180d6c273d47f139e366ad35d9414b83d0d78e82berictian same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI 33280d6c273d47f139e366ad35d9414b83d0d78e82berictian specification for more information on PIO modes. 33380d6c273d47f139e366ad35d9414b83d0d78e82berictian 33480d6c273d47f139e366ad35d9414b83d0d78e82berictian For Serial ATA (SATA) controllers, this member function can be used to disqualify 33580d6c273d47f139e366ad35d9414b83d0d78e82berictian a higher transfer rate mode on a given channel. For example, a platform driver 33680d6c273d47f139e366ad35d9414b83d0d78e82berictian may inform the IDE controller driver to not use second-generation (Gen2) speeds 33780d6c273d47f139e366ad35d9414b83d0d78e82berictian for a certain SATA drive. 33880d6c273d47f139e366ad35d9414b83d0d78e82berictian 33980d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 34080d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel The zero-based channel number. 34180d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device The zero-based device number on the Channel. 34280d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] BadModes The modes that the device does not support and that 34380d6c273d47f139e366ad35d9414b83d0d78e82berictian should be disqualified. 34480d6c273d47f139e366ad35d9414b83d0d78e82berictian 34580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The modes were accepted without any errors. 34680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 34780d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 34880d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER IdentifyData is NULL. 34980d6c273d47f139e366ad35d9414b83d0d78e82berictian 35027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 35127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 35227f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 35327f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitDisqualifyMode ( 35427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 35527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 35627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 35727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_ATA_COLLECTIVE_MODE *BadModes 35827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 35927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 36027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 36127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 36280d6c273d47f139e366ad35d9414b83d0d78e82berictian Returns the information about the optimum modes for the specified IDE device. 36380d6c273d47f139e366ad35d9414b83d0d78e82berictian 36480d6c273d47f139e366ad35d9414b83d0d78e82berictian This function is used by the driver entity to obtain the optimum ATA modes for 36580d6c273d47f139e366ad35d9414b83d0d78e82berictian a specific device. The IDE controller driver takes into account the following 36680d6c273d47f139e366ad35d9414b83d0d78e82berictian while calculating the mode: 36780d6c273d47f139e366ad35d9414b83d0d78e82berictian - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 36880d6c273d47f139e366ad35d9414b83d0d78e82berictian - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() 36980d6c273d47f139e366ad35d9414b83d0d78e82berictian 37080d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 37180d6c273d47f139e366ad35d9414b83d0d78e82berictian for all the devices that belong to an enumeration group before calling 37280d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group. 37380d6c273d47f139e366ad35d9414b83d0d78e82berictian 37480d6c273d47f139e366ad35d9414b83d0d78e82berictian The IDE controller driver will use controller- and possibly platform-specific 37580d6c273d47f139e366ad35d9414b83d0d78e82berictian algorithms to arrive at SupportedModes. The IDE controller may base its 37680d6c273d47f139e366ad35d9414b83d0d78e82berictian decision on user preferences and other considerations as well. This function 37780d6c273d47f139e366ad35d9414b83d0d78e82berictian may be called multiple times because the driver entity may renegotiate the mode 37880d6c273d47f139e366ad35d9414b83d0d78e82berictian with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode(). 37980d6c273d47f139e366ad35d9414b83d0d78e82berictian 38080d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity may collect timing information for various devices in any 38180d6c273d47f139e366ad35d9414b83d0d78e82berictian order. The driver entity is responsible for making sure that all the dependencies 38280d6c273d47f139e366ad35d9414b83d0d78e82berictian are satisfied. For example, the SupportedModes information for device A that 38380d6c273d47f139e366ad35d9414b83d0d78e82berictian was previously returned may become stale after a call to 38480d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B. 38580d6c273d47f139e366ad35d9414b83d0d78e82berictian 38680d6c273d47f139e366ad35d9414b83d0d78e82berictian The buffer SupportedModes is allocated by the callee because the caller does 38780d6c273d47f139e366ad35d9414b83d0d78e82berictian not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE 38880d6c273d47f139e366ad35d9414b83d0d78e82berictian is defined in a way that allows for future extensibility and can be of variable 38980d6c273d47f139e366ad35d9414b83d0d78e82berictian length. This memory pool should be deallocated by the caller when it is no 39080d6c273d47f139e366ad35d9414b83d0d78e82berictian longer necessary. 39180d6c273d47f139e366ad35d9414b83d0d78e82berictian 39280d6c273d47f139e366ad35d9414b83d0d78e82berictian The IDE controller driver for a Serial ATA (SATA) controller can use this 39380d6c273d47f139e366ad35d9414b83d0d78e82berictian member function to force a lower speed (first-generation [Gen1] speeds on a 39480d6c273d47f139e366ad35d9414b83d0d78e82berictian second-generation [Gen2]-capable hardware). The IDE controller driver can 39580d6c273d47f139e366ad35d9414b83d0d78e82berictian also allow the driver entity to stay with the speed that has been negotiated 39680d6c273d47f139e366ad35d9414b83d0d78e82berictian by the physical layer. 39780d6c273d47f139e366ad35d9414b83d0d78e82berictian 39880d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 39980d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel A zero-based channel number. 40080d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device A zero-based device number on the Channel. 40180d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[out] SupportedModes The optimum modes for the device. 40280d6c273d47f139e366ad35d9414b83d0d78e82berictian 40380d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS SupportedModes was returned. 40480d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 40580d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 40680d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER SupportedModes is NULL. 40780d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_NOT_READY Modes cannot be calculated due to a lack of 40880d6c273d47f139e366ad35d9414b83d0d78e82berictian data. This error may happen if 40980d6c273d47f139e366ad35d9414b83d0d78e82berictian EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() 41080d6c273d47f139e366ad35d9414b83d0d78e82berictian and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData() 41180d6c273d47f139e366ad35d9414b83d0d78e82berictian were not called for at least one drive in the 41280d6c273d47f139e366ad35d9414b83d0d78e82berictian same enumeration group. 41327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 41427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 41527f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 41627f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 41727f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitCalculateMode ( 41827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 41927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 42027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 42127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes 42227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 42327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 42427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 42527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 42680d6c273d47f139e366ad35d9414b83d0d78e82berictian Commands the IDE controller driver to program the IDE controller hardware 42780d6c273d47f139e366ad35d9414b83d0d78e82berictian so that the specified device can operate at the specified mode. 42880d6c273d47f139e366ad35d9414b83d0d78e82berictian 42980d6c273d47f139e366ad35d9414b83d0d78e82berictian This function is used by the driver entity to instruct the IDE controller 43080d6c273d47f139e366ad35d9414b83d0d78e82berictian driver to program the IDE controller hardware to the specified modes. This 43180d6c273d47f139e366ad35d9414b83d0d78e82berictian function can be called only once for a particular device. For a Serial ATA 43280d6c273d47f139e366ad35d9414b83d0d78e82berictian (SATA) Advanced Host Controller Interface (AHCI) controller, no controller- 43380d6c273d47f139e366ad35d9414b83d0d78e82berictian specific programming may be required. 43480d6c273d47f139e366ad35d9414b83d0d78e82berictian 43580d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. 43680d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Channel Zero-based channel number. 43780d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Device Zero-based device number on the Channel. 43880d6c273d47f139e366ad35d9414b83d0d78e82berictian @param[in] Modes The modes to set. 43980d6c273d47f139e366ad35d9414b83d0d78e82berictian 44080d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_SUCCESS The command was accepted without any errors. 44180d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount). 44280d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_INVALID_PARAMETER Device is invalid. 44380d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data. 44480d6c273d47f139e366ad35d9414b83d0d78e82berictian @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure. 44580d6c273d47f139e366ad35d9414b83d0d78e82berictian The driver entity should not use this device. 44627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 44727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 44827f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 44927f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 45027f3015903bf30b9ca0e72c0174e9ef787d79659lzengIdeInitSetTiming ( 45127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, 45227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Channel, 45327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN UINT8 Device, 45427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_ATA_COLLECTIVE_MODE *Modes 45527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 45627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 45727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 45827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 45927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// Forward reference declaration 46027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng// 46127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 46227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Retrieves a Unicode string that is the user readable name of the UEFI Driver. 46327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 46427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance. 46527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Language A pointer to a three character ISO 639-2 language identifier. 46627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This is the language of the driver name that that the caller 46727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng is requesting, and it must match one of the languages specified 46827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng in SupportedLanguages. The number of languages supported by a 46927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng driver is up to the driver writer. 47027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param DriverName A pointer to the Unicode string to return. This Unicode string 47127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng is the name of the driver specified by This in the language 47227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng specified by Language. 47327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 47427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS The Unicode string for the Driver specified by This 47527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng and the language specified by Language was returned 47627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng in DriverName. 47727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_INVALID_PARAMETER Language is NULL. 47827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_INVALID_PARAMETER DriverName is NULL. 47927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_UNSUPPORTED The driver specified by This does not support the 48027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng language specified by Language. 48127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 48227f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 48327f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 48427f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerComponentNameGetDriverName ( 48527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_COMPONENT_NAME_PROTOCOL *This, 48627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN CHAR8 *Language, 48727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT CHAR16 **DriverName 48827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 48927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 49027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 49127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng/** 49227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng Retrieves a Unicode string that is the user readable name of the controller 49327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng that is being managed by an UEFI Driver. 49427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 49527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance. 49627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param ControllerHandle The handle of a controller that the driver specified by 49727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng This is managing. This handle specifies the controller 49827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng whose name is to be returned. 49927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param OPTIONAL ChildHandle The handle of the child controller to retrieve the name 50027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng of. This is an optional parameter that may be NULL. It 50127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng will be NULL for device drivers. It will also be NULL 50227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng for a bus drivers that wish to retrieve the name of the 50327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng bus controller. It will not be NULL for a bus driver 50427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng that wishes to retrieve the name of a child controller. 50527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param Language A pointer to a three character ISO 639-2 language 50627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng identifier. This is the language of the controller name 50727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng that that the caller is requesting, and it must match one 50827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng of the languages specified in SupportedLanguages. The 50927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng number of languages supported by a driver is up to the 51027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng driver writer. 51127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @param ControllerName A pointer to the Unicode string to return. This Unicode 51227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng string is the name of the controller specified by 51327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ControllerHandle and ChildHandle in the language 51427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng specified by Language from the point of view of the 51527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng driver specified by This. 51627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 51727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_SUCCESS The Unicode string for the user readable name in the 51827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng language specified by Language for the driver 51927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng specified by This was returned in DriverName. 52027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. 52127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid 52227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng EFI_HANDLE. 52327f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_INVALID_PARAMETER Language is NULL. 52427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_INVALID_PARAMETER ControllerName is NULL. 52527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_UNSUPPORTED The driver specified by This is not currently 52627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng managing the controller specified by 52727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ControllerHandle and ChildHandle. 52827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng @retval EFI_UNSUPPORTED The driver specified by This does not support the 52927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng language specified by Language. 53027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng**/ 53127f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFI_STATUS 53227f3015903bf30b9ca0e72c0174e9ef787d79659lzengEFIAPI 53327f3015903bf30b9ca0e72c0174e9ef787d79659lzengSataControllerComponentNameGetControllerName ( 53427f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_COMPONENT_NAME_PROTOCOL *This, 53527f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE ControllerHandle, 53627f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN EFI_HANDLE ChildHandle OPTIONAL, 53727f3015903bf30b9ca0e72c0174e9ef787d79659lzeng IN CHAR8 *Language, 53827f3015903bf30b9ca0e72c0174e9ef787d79659lzeng OUT CHAR16 **ControllerName 53927f3015903bf30b9ca0e72c0174e9ef787d79659lzeng ) 54027f3015903bf30b9ca0e72c0174e9ef787d79659lzeng; 54127f3015903bf30b9ca0e72c0174e9ef787d79659lzeng 54227f3015903bf30b9ca0e72c0174e9ef787d79659lzeng#endif 543