/** @file Header file for chipset Serial ATA controller driver. @copyright INTEL CONFIDENTIAL Copyright 2014 - 2016 Intel Corporation. The source code contained or described herein and all documents related to the source code ("Material") are owned by Intel Corporation or its suppliers or licensors. Title to the Material remains with Intel Corporation or its suppliers and licensors. The Material may contain trade secrets and proprietary and confidential information of Intel Corporation and its suppliers and licensors, and is protected by worldwide copyright and trade secret laws and treaty provisions. No part of the Material may be used, copied, reproduced, modified, published, uploaded, posted, transmitted, distributed, or disclosed in any way without Intel's prior express written permission. No license under any patent, copyright, trade secret or other intellectual property right is granted to or conferred upon you by disclosure or delivery of the Materials, either expressly, by implication, inducement, estoppel or otherwise. Any license under such intellectual property rights must be express and approved by Intel in writing. Unless otherwise agreed by Intel in writing, you may not remove or alter this notice or any other notice embedded in Materials by Intel or Intel's suppliers or licensors in any way. This file contains a 'Sample Driver' and is licensed as such under the terms of your license agreement with Intel or your vendor. This file may be modified by the user, subject to the additional terms of the license agreement. @par Specification **/ #ifndef _SERIAL_ATA_CONTROLLER_H_ #define _SERIAL_ATA_CONTROLLER_H_ // // External include files do NOT need to be explicitly specified in real EDKII // environment // #include #include #include #include #include #include #include #include #include #include // // Global Variables definitions // extern EFI_DRIVER_BINDING_PROTOCOL mSataControllerDriverBinding; extern EFI_COMPONENT_NAME_PROTOCOL mSataControllerComponentName; extern EFI_COMPONENT_NAME2_PROTOCOL mSataControllerComponentName2; #define SATA_ENUMER_ALL FALSE #define EFI_AHCI_BAR_INDEX 0x05 #define R_AHCI_CAPABILITY 0x00 #define R_AHCI_PI 0x0C #define SATA_SUB_CLASS_CODE_AHCI 0x06 #define AHCI_MAX_DEVICES 1 // // Driver binding functions declaration // /** This function checks to see if the driver supports a device specified by "Controller handle" parameter. It is called by DXE Core StartImage() or ConnectController() routines. The driver uses 'device path' and/or 'services' from the Bus I/O abstraction attached to the controller handle to determine if the driver support this controller handle. Note: In the BDS (Boot Device Selection) phase, the DXE core enumerate all devices (or, controller) and assigns GUIDs to them. @param[in] This A pointer points to the Binding Protocol instance @param[in] Controller The handle of controller to be tested. @param[in] RemainingDevicePath A pointer to the device path. Ignored by device driver but used by bus driver @retval EFI_SUCCESS The device is supported @exception EFI_UNSUPPORTED The device is not supported **/ EFI_STATUS EFIAPI SataControllerSupported ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ); /** This routine is called right after the .Supported() is called and returns EFI_SUCCESS. Notes: The supported protocols are checked but the Protocols are closed. @param[in] This A pointer points to the Binding Protocol instance @param[in] Controller The handle of controller to be tested. Parameter passed by the caller @param[in] RemainingDevicePath A pointer to the device path. Should be ignored by device driver @retval EFI_SUCCESS The device is started @retval Other values Something error happened **/ EFI_STATUS EFIAPI SataControllerStart ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ); /** Stop managing the target device @param[in] This A pointer pointing to the Binding Protocol instance @param[in] Controller The handle of controller to be stopped @param[in] NumberOfChildren Number of child devices @param[in] ChildHandleBuffer Buffer holding child device handles @retval EFI_SUCCESS The target device is stopped **/ EFI_STATUS EFIAPI SataControllerStop ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer ); // // IDE controller init functions declaration // /** This function can be used to obtain information about a specified channel. It's usually used by IDE Bus driver during enumeration process. @param[in] This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel Channel number (0 based, either 0 or 1) @param[out] Enabled TRUE if the channel is enabled. If the channel is disabled, then it will no be enumerated. @param[out] MaxDevices The Max number of IDE devices that the bus driver can expect on this channel. For ATA/ATAPI, this number is either 1 or 2. @retval EFI_SUCCESS Function completes successfully @retval Other Values Something error happened @retval EFI_INVALID_PARAMETER The Channel parameter is invalid **/ EFI_STATUS EFIAPI IdeInitGetChannelInfo ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, OUT BOOLEAN *Enabled, OUT UINT8 *MaxDevices ); /** This function is called by IdeBus driver before executing certain actions. This allows IDE Controller Init to prepare for each action. @param[in] This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Phase phase indicator defined by IDE_CONTROLLER_INIT protocol @param[out] Channel Channel number (0 based, either 0 or 1) @retval EFI_SUCCESS Function completes successfully @retval EFI_INVALID_PARAMETER Channel parameter is out of range @exception EFI_UNSUPPORTED Phase is not supported **/ EFI_STATUS EFIAPI IdeInitNotifyPhase ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase, OUT UINT8 Channel ); /** This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure obtained from IDE deivce. This structure is used to set IDE timing @param[in] This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel IDE channel number (0 based, either 0 or 1) @param[in] Device IDE device number @param[in] IdentifyData A pointer to EFI_IDENTIFY_DATA data structure @retval EFI_SUCCESS Function completes successfully @retval EFI_INVALID_PARAMETER Channel or Device parameter is out of range **/ EFI_STATUS EFIAPI IdeInitSubmitData ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, IN EFI_IDENTIFY_DATA *IdentifyData ); /** This function is called by IdeBus driver to disqualify unsupported operation mode on specfic IDE device @param[in] This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel IDE channel number (0 based, either 0 or 1) @param[in] Device IDE device number @param[in] BadModes Operation mode indicator @retval EFI_SUCCESS Function completes successfully @retval EFI_INVALID_PARAMETER Channel parameter or Devicde parameter is out of range, or BadModes is NULL **/ EFI_STATUS EFIAPI IdeInitDisqualifyMode ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, IN EFI_ATA_COLLECTIVE_MODE *BadModes ); /** This function is called by IdeBus driver to calculate the best operation mode supported by specific IDE device @param[in] This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel IDE channel number (0 based, either 0 or 1) @param[in] Device IDE device number @param[in, out] SupportedModes Modes collection supported by IDE device @retval EFI_SUCCESS Function completes successfully @retval EFI_INVALID_PARAMETER Channel parameter or Device parameter is out of range; Or SupportedModes is NULL @retval EFI_NOT_READY Identify data is not valid @retval EFI_OUT_OF_RESOURCES SupportedModes is out of range **/ EFI_STATUS EFIAPI IdeInitCalculateMode ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, IN OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes ); /** This function is called by IdeBus driver to set appropriate timing on IDE controller according supported operation mode @param[in] This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. @param[in] Channel IDE channel number (0 based, either 0 or 1) @param[in] Device IDE device number @param[in] Modes Operation modes @retval EFI_SUCCESS This function always returns EFI_SUCCESS **/ EFI_STATUS EFIAPI IdeInitSetTiming ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, IN EFI_ATA_COLLECTIVE_MODE *Modes ); EFI_STATUS EFIAPI SataControllerComponentNameGetDriverName ( IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName ); EFI_STATUS EFIAPI SataControllerComponentNameGetControllerName ( IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 *Language, OUT CHAR16 **ControllerName ); #endif