4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file declares EFI IDE Controller Init Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI_IDE_CONTROLLER_INIT_PROTOCOL provides the chipset-specific information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the driver entity. This protocol is mandatory for IDE controllers if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IDE devices behind the controller are to be enumerated by a driver entity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync There can only be one instance of EFI_IDE_CONTROLLER_INIT_PROTOCOL for each IDE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller in a system. It is installed on the handle that corresponds to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IDE controller. A driver entity that wishes to manage an IDE bus and possibly
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IDE devices in a system will have to retrieve the EFI_IDE_CONTROLLER_INIT_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance that is associated with the controller to be managed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A device handle for an IDE controller must contain an EFI_DEVICE_PATH_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is defined in UEFI Platform Initialization Specification 1.2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Volume 5: Standards.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Global ID for the EFI_IDE_CONTROLLER_INIT_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xa1e37052, 0x80d9, 0x4e65, {0xa3, 0x17, 0x3e, 0x9a, 0x55, 0xc4, 0x3e, 0xc9 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Forward declaration for EFI_IDE_CONTROLLER_INIT_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL EFI_IDE_CONTROLLER_INIT_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The phase of the IDE Controller enumeration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The driver entity is about to begin enumerating the devices
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// behind the specified channel. This notification can be used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// perform any chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The driver entity has completed enumerating the devices
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// behind the specified channel. This notification can be used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// perform any chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The driver entity is about to reset the devices behind the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specified channel. This notification can be used to perform any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The driver entity has completed resetting the devices behind
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the specified channel. This notification can be used to perform
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// any chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The driver entity is about to detect the presence of devices
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// behind the specified channel. This notification can be used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// set up the bus signals to default levels or for implementing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// predelays.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The driver entity is done with detecting the presence of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// devices behind the specified channel. This notification can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// used to perform any chipset-specific programming.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The IDE bus is requesting the IDE controller driver to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// reprogram the IDE controller hardware and thereby reset all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the mode and timing settings to default settings.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This extended mode describes the SATA physical protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// SATA physical layers can operate at different speeds.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// These speeds are defined below. Various PATA protocols
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and associated modes are not applicable to SATA devices.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Automatically detects the optimum SATA speed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Indicates a first-generation (Gen1) SATA speed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Indicates a second-generation (Gen2) SATA speed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_ATA_MODE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Mode; ///< The actual ATA mode. This field is not a bit map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_ATA_EXTENDED_MODE structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An enumeration defining various transfer protocols other than the protocols
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that exist at the time this specification was developed (i.e., PIO, single
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// word DMA, multiword DMA, and UDMA). Each transfer protocol is associated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// with a mode. The various transfer protocols are defined by the ATA/ATAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specification. This enumeration makes the interface extensible because we
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// can support new transport protocols beyond UDMA. Type EFI_ATA_EXT_TRANSFER_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is defined below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The mode for operating the transfer protocol that is identified by TransferProtocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_ATA_COLLECTIVE_MODE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field specifies the PIO mode. PIO modes are defined in the ATA/ATAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specification. The ATA/ATAPI specification defines the enumeration. In
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// other words, a value of 1 in this field means PIO mode 1. The actual meaning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of PIO mode 1 is governed by the ATA/ATAPI specification. Type EFI_ATA_MODE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is defined below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field specifies the single word DMA mode. Single word DMA modes are defined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// in the ATA/ATAPI specification, versions 1 and 2. Single word DMA support was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// obsoleted in the ATA/ATAPI specification, version 3. Therefore, most devices and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// controllers will not support this transfer mode. The ATA/ATAPI specification defines
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the enumeration. In other words, a value of 1 in this field means single word DMA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// mode 1. The actual meaning of single word DMA mode 1 is governed by the ATA/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ATAPI specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field specifies the multiword DMA mode. Various multiword DMA modes are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// defined in the ATA/ATAPI specification. A value of 1 in this field means multiword
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// DMA mode 1. The actual meaning of multiword DMA mode 1 is governed by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ATA/ATAPI specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field specifies the ultra DMA (UDMA) mode. UDMA modes are defined in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ATA/ATAPI specification. A value of 1 in this field means UDMA mode 1. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// actual meaning of UDMA mode 1 is governed by the ATA/ATAPI specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of extended-mode bitmap entries. Extended modes describe transfer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// protocols beyond PIO, single word DMA, multiword DMA, and UDMA. This field
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// can be zero and provides extensibility.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ExtModeCount number of entries. Each entry represents a transfer protocol other
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// than the ones defined above (i.e., PIO, single word DMA, multiword DMA, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UDMA). This field is defined for extensibility. At this time, only one extended
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// transfer protocol is defined to cover SATA transfers. Type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_ATA_EXTENDED_MODE is defined below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_ATA_IDENTIFY_DATA & EFI_ATAPI_IDENTIFY_DATA structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The definition of these two structures is not part of the protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// definition because the ATA/ATAPI Specification controls the definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// of all the fields. The ATA/ATAPI Specification can obsolete old fields
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// or redefine existing fields.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef ATAPI_IDENTIFY_DATA EFI_ATAPI_IDENTIFY_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This flag indicates whether the IDENTIFY data is a response from an ATA device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// (EFI_ATA_IDENTIFY_DATA) or response from an ATAPI device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// (EFI_ATAPI_IDENTIFY_DATA). According to the ATA/ATAPI specification,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IDENTIFY_DATA is for an ATA device if bit 15 of the Config field is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The Config field is common to both EFI_ATA_IDENTIFY_DATA and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_ATAPI_IDENTIFY_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IDENTIFY_DATA structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The data that is returned by an ATA device upon successful completion
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of the ATA IDENTIFY_DEVICE command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The data that is returned by an ATAPI device upon successful completion
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of the ATA IDENTIFY_PACKET_DEVICE command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the information about the specified IDE channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function can be used to obtain information about a particular IDE channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The driver entity uses this information during the enumeration process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Enabled is set to FALSE, the driver entity will not scan the channel. Note
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that it will not prevent an operating system driver from scanning the channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For most of today's controllers, MaxDevices will either be 1 or 2. For SATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controllers, this value will always be 1. SATA configurations can contain SATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync port multipliers. SATA port multipliers behave like SATA bridges and can support
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync up to 16 devices on the other side. If a SATA port out of the IDE controller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is connected to a port multiplier, MaxDevices will be set to the number of SATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync devices that the port multiplier supports. Because today's port multipliers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support up to fifteen SATA devices, this number can be as large as fifteen. The IDE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bus driver is required to scan for the presence of port multipliers behind an SATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller and enumerate up to MaxDevices number of devices behind the port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync multiplier.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In this context, the devices behind a port multiplier constitute a channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Channel Zero-based channel number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Enabled TRUE if this channel is enabled. Disabled channels
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are not scanned to see if any devices are present.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] MaxDevices The maximum number of IDE devices that the bus driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can expect on this channel. For the ATA/ATAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specification, version 6, this number will either be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync one or two. For Serial ATA (SATA) configurations with a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync port multiplier, this number can be as large as fifteen.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Information was returned without any errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The notifications from the driver entity that it is about to enter a certain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync phase of the IDE channel enumeration process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function can be used to notify the IDE controller driver to perform
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specific actions, including any chipset-specific initialization, so that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync chipset is ready to enter the next phase. Seven notification points are defined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync at this time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync More synchronization points may be added as required in the future.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Phase The phase during enumeration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Channel Zero-based channel number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The notification was accepted without any errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Phase is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY This phase cannot be entered at this time; for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync example, an attempt was made to enter a Phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync without having entered one or more previous
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Submits the device information to the IDE controller driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used by the driver entity to pass detailed information about
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a particular device to the IDE controller driver. The driver entity obtains
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is the pointer to the response data buffer. The IdentifyData buffer is owned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the driver entity, and the IDE controller driver must make a local copy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the entire buffer or parts of the buffer as needed. The original IdentifyData
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer pointer may not be valid when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync compute the optimum mode for the device. These fields are not limited to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timing information. For example, an implementation of the IDE controller driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may examine the vendor and type/mode field to match known bad drives.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The driver entity may submit drive information in any order, as long as it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync submits information for all the devices belonging to the enumeration group
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should be called with IdentifyData set to NULL. The IDE controller driver may
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not have any other mechanism to know whether a device is present or not. Therefore,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync setting IdentifyData to NULL does not constitute an error condition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync given (Channel, Device) pair.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Channel Zero-based channel number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Device Zero-based device number on the Channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The information was accepted without any errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Device is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disqualifies specific modes for an IDE device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allows the driver entity or other drivers (such as platform
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync drivers) to reject certain timing modes and request the IDE controller driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to recalculate modes. This function allows the driver entity and the IDE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller driver to negotiate the timings on a per-device basis. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is useful in the case of drives that lie about their capabilities. An example
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is when the IDE device fails to accept the timing modes that are calculated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the IDE controller driver based on the response to the Identify Drive command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the driver entity does not want to limit the ATA timing modes and leave that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync decision to the IDE controller driver, it can either not call this function for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the given device or call this function and set the Valid flag to FALSE for all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync modes that are listed in EFI_ATA_COLLECTIVE_MODE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The driver entity may disqualify modes for a device in any order and any number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function can be called multiple times to invalidate multiple modes of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specification for more information on PIO modes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For Serial ATA (SATA) controllers, this member function can be used to disqualify
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a higher transfer rate mode on a given channel. For example, a platform driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may inform the IDE controller driver to not use second-generation (Gen2) speeds
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for a certain SATA drive.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Channel The zero-based channel number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Device The zero-based device number on the Channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BadModes The modes that the device does not support and that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should be disqualified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The modes were accepted without any errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Device is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER IdentifyData is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the information about the optimum modes for the specified IDE device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used by the driver entity to obtain the optimum ATA modes for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a specific device. The IDE controller driver takes into account the following
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while calculating the mode:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for all the devices that belong to an enumeration group before calling
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The IDE controller driver will use controller- and possibly platform-specific
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync algorithms to arrive at SupportedModes. The IDE controller may base its
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync decision on user preferences and other considerations as well. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may be called multiple times because the driver entity may renegotiate the mode
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The driver entity may collect timing information for various devices in any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync order. The driver entity is responsible for making sure that all the dependencies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are satisfied. For example, the SupportedModes information for device A that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was previously returned may become stale after a call to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The buffer SupportedModes is allocated by the callee because the caller does
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is defined in a way that allows for future extensibility and can be of variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync length. This memory pool should be deallocated by the caller when it is no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync longer necessary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The IDE controller driver for a Serial ATA (SATA) controller can use this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync member function to force a lower speed (first-generation [Gen1] speeds on a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync second-generation [Gen2]-capable hardware). The IDE controller driver can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync also allow the driver entity to stay with the speed that has been negotiated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the physical layer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Channel A zero-based channel number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Device A zero-based device number on the Channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] SupportedModes The optimum modes for the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS SupportedModes was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Device is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER SupportedModes is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY Modes cannot be calculated due to a lack of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data. This error may happen if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync were not called for at least one drive in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync same enumeration group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Commands the IDE controller driver to program the IDE controller hardware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync so that the specified device can operate at the specified mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used by the driver entity to instruct the IDE controller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver to program the IDE controller hardware to the specified modes. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function can be called only once for a particular device. For a Serial ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (SATA) Advanced Host Controller Interface (AHCI) controller, no controller-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specific programming may be required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Channel Zero-based channel number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Device Zero-based device number on the Channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Modes The modes to set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command was accepted without any errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Device is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The driver entity should not use this device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides the basic interfaces to abstract an IDE controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Returns the information about a specific channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IDE_CONTROLLER_GET_CHANNEL_INFO GetChannelInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The notification that the driver entity is about to enter the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specified phase during the enumeration process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Submits the Drive Identify data that was returned by the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Submits information about modes that should be disqualified. The specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IDE device does not support these modes and these modes should not be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// returned by EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Calculates and returns the optimum mode for a particular IDE device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Programs the IDE controller hardware to the default timing or per the modes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that were returned by the last call to EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE if the enumeration group includes all the channels that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// produced by this controller. Set to FALSE if an enumeration group consists of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// only one channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of channels that are produced by this controller. Parallel ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// (PATA) controllers can support up to two channels. Advanced Host Controller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Interface (AHCI) Serial ATA (SATA) controllers can support up to 32 channels,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// each of which can have up to one device. In the presence of a multiplier,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// each channel can have fifteen devices.