/** @file\r
Header file for IDE controller driver.\r
\r
- Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
//\r
/**\r
Returns the information about the specified IDE channel.\r
- \r
+\r
This function can be used to obtain information about a particular IDE channel.\r
- The driver entity uses this information during the enumeration process. \r
- \r
- If Enabled is set to FALSE, the driver entity will not scan the channel. Note \r
+ The driver entity uses this information during the enumeration process.\r
+\r
+ If Enabled is set to FALSE, the driver entity will not scan the channel. Note\r
that it will not prevent an operating system driver from scanning the channel.\r
- \r
- For most of today's controllers, MaxDevices will either be 1 or 2. For SATA \r
- controllers, this value will always be 1. SATA configurations can contain SATA \r
+\r
+ For most of today's controllers, MaxDevices will either be 1 or 2. For SATA\r
+ controllers, this value will always be 1. SATA configurations can contain SATA\r
port multipliers. SATA port multipliers behave like SATA bridges and can support\r
- up to 16 devices on the other side. If a SATA port out of the IDE controller \r
- is connected to a port multiplier, MaxDevices will be set to the number of SATA \r
- devices that the port multiplier supports. Because today's port multipliers \r
- support up to fifteen SATA devices, this number can be as large as fifteen. The IDE \r
- bus driver is required to scan for the presence of port multipliers behind an SATA \r
- controller and enumerate up to MaxDevices number of devices behind the port \r
- multiplier. \r
- \r
- In this context, the devices behind a port multiplier constitute a channel. \r
- \r
+ up to 16 devices on the other side. If a SATA port out of the IDE controller\r
+ is connected to a port multiplier, MaxDevices will be set to the number of SATA\r
+ devices that the port multiplier supports. Because today's port multipliers\r
+ support up to fifteen SATA devices, this number can be as large as fifteen. The IDE\r
+ bus driver is required to scan for the presence of port multipliers behind an SATA\r
+ controller and enumerate up to MaxDevices number of devices behind the port\r
+ multiplier.\r
+\r
+ In this context, the devices behind a port multiplier constitute a channel.\r
+\r
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel Zero-based channel number.\r
- @param[out] Enabled TRUE if this channel is enabled. Disabled channels \r
+ @param[out] Enabled TRUE if this channel is enabled. Disabled channels\r
are not scanned to see if any devices are present.\r
@param[out] MaxDevices The maximum number of IDE devices that the bus driver\r
- can expect on this channel. For the ATA/ATAPI \r
- specification, version 6, this number will either be \r
- one or two. For Serial ATA (SATA) configurations with a \r
+ can expect on this channel. For the ATA/ATAPI\r
+ specification, version 6, this number will either be\r
+ one or two. For Serial ATA (SATA) configurations with a\r
port multiplier, this number can be as large as fifteen.\r
\r
@retval EFI_SUCCESS Information was returned without any errors.\r
/**\r
The notifications from the driver entity that it is about to enter a certain\r
phase of the IDE channel enumeration process.\r
- \r
- This function can be used to notify the IDE controller driver to perform \r
- specific actions, including any chipset-specific initialization, so that the \r
- chipset is ready to enter the next phase. Seven notification points are defined \r
- at this time. \r
- \r
- More synchronization points may be added as required in the future. \r
+\r
+ This function can be used to notify the IDE controller driver to perform\r
+ specific actions, including any chipset-specific initialization, so that the\r
+ chipset is ready to enter the next phase. Seven notification points are defined\r
+ at this time.\r
+\r
+ More synchronization points may be added as required in the future.\r
\r
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Phase The phase during enumeration.\r
@retval EFI_SUCCESS The notification was accepted without any errors.\r
@retval EFI_UNSUPPORTED Phase is not supported.\r
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
- @retval EFI_NOT_READY This phase cannot be entered at this time; for \r
- example, an attempt was made to enter a Phase \r
- without having entered one or more previous \r
+ @retval EFI_NOT_READY This phase cannot be entered at this time; for\r
+ example, an attempt was made to enter a Phase\r
+ without having entered one or more previous\r
Phase.\r
\r
**/\r
/**\r
Submits the device information to the IDE controller driver.\r
\r
- This function is used by the driver entity to pass detailed information about \r
- a particular device to the IDE controller driver. The driver entity obtains \r
+ This function is used by the driver entity to pass detailed information about\r
+ a particular device to the IDE controller driver. The driver entity obtains\r
this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData\r
- is the pointer to the response data buffer. The IdentifyData buffer is owned \r
- by the driver entity, and the IDE controller driver must make a local copy \r
- of the entire buffer or parts of the buffer as needed. The original IdentifyData \r
+ is the pointer to the response data buffer. The IdentifyData buffer is owned\r
+ by the driver entity, and the IDE controller driver must make a local copy\r
+ of the entire buffer or parts of the buffer as needed. The original IdentifyData\r
buffer pointer may not be valid when\r
- \r
+\r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or\r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point.\r
- \r
- The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to \r
- compute the optimum mode for the device. These fields are not limited to the \r
- timing information. For example, an implementation of the IDE controller driver \r
- may examine the vendor and type/mode field to match known bad drives. \r
- \r
- The driver entity may submit drive information in any order, as long as it \r
- submits information for all the devices belonging to the enumeration group \r
+\r
+ The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to\r
+ compute the optimum mode for the device. These fields are not limited to the\r
+ timing information. For example, an implementation of the IDE controller driver\r
+ may examine the vendor and type/mode field to match known bad drives.\r
+\r
+ The driver entity may submit drive information in any order, as long as it\r
+ submits information for all the devices belonging to the enumeration group\r
before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device\r
in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r
- should be called with IdentifyData set to NULL. The IDE controller driver may \r
- not have any other mechanism to know whether a device is present or not. Therefore, \r
- setting IdentifyData to NULL does not constitute an error condition. \r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a \r
- given (Channel, Device) pair. \r
- \r
+ should be called with IdentifyData set to NULL. The IDE controller driver may\r
+ not have any other mechanism to know whether a device is present or not. Therefore,\r
+ setting IdentifyData to NULL does not constitute an error condition.\r
+ EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a\r
+ given (Channel, Device) pair.\r
+\r
@param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel Zero-based channel number.\r
@param[in] Device Zero-based device number on the Channel.\r
/**\r
Disqualifies specific modes for an IDE device.\r
\r
- This function allows the driver entity or other drivers (such as platform \r
+ This function allows the driver entity or other drivers (such as platform\r
drivers) to reject certain timing modes and request the IDE controller driver\r
- to recalculate modes. This function allows the driver entity and the IDE \r
- controller driver to negotiate the timings on a per-device basis. This function \r
- is useful in the case of drives that lie about their capabilities. An example \r
- is when the IDE device fails to accept the timing modes that are calculated \r
+ to recalculate modes. This function allows the driver entity and the IDE\r
+ controller driver to negotiate the timings on a per-device basis. This function\r
+ is useful in the case of drives that lie about their capabilities. An example\r
+ is when the IDE device fails to accept the timing modes that are calculated\r
by the IDE controller driver based on the response to the Identify Drive command.\r
\r
- If the driver entity does not want to limit the ATA timing modes and leave that \r
- decision to the IDE controller driver, it can either not call this function for \r
- the given device or call this function and set the Valid flag to FALSE for all \r
+ If the driver entity does not want to limit the ATA timing modes and leave that\r
+ decision to the IDE controller driver, it can either not call this function for\r
+ the given device or call this function and set the Valid flag to FALSE for all\r
modes that are listed in EFI_ATA_COLLECTIVE_MODE.\r
- \r
- The driver entity may disqualify modes for a device in any order and any number \r
+\r
+ The driver entity may disqualify modes for a device in any order and any number\r
of times.\r
- \r
- This function can be called multiple times to invalidate multiple modes of the \r
- same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI \r
- specification for more information on PIO modes. \r
- \r
+\r
+ This function can be called multiple times to invalidate multiple modes of the\r
+ same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI\r
+ specification for more information on PIO modes.\r
+\r
For Serial ATA (SATA) controllers, this member function can be used to disqualify\r
a higher transfer rate mode on a given channel. For example, a platform driver\r
- may inform the IDE controller driver to not use second-generation (Gen2) speeds \r
+ may inform the IDE controller driver to not use second-generation (Gen2) speeds\r
for a certain SATA drive.\r
- \r
+\r
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel The zero-based channel number.\r
@param[in] Device The zero-based device number on the Channel.\r
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
@retval EFI_INVALID_PARAMETER Device is invalid.\r
@retval EFI_INVALID_PARAMETER IdentifyData is NULL.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
Returns the information about the optimum modes for the specified IDE device.\r
\r
This function is used by the driver entity to obtain the optimum ATA modes for\r
- a specific device. The IDE controller driver takes into account the following \r
+ a specific device. The IDE controller driver takes into account the following\r
while calculating the mode:\r
- The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r
- The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode()\r
\r
- The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() \r
- for all the devices that belong to an enumeration group before calling \r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group. \r
- \r
- The IDE controller driver will use controller- and possibly platform-specific \r
- algorithms to arrive at SupportedModes. The IDE controller may base its \r
- decision on user preferences and other considerations as well. This function \r
- may be called multiple times because the driver entity may renegotiate the mode \r
+ The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r
+ for all the devices that belong to an enumeration group before calling\r
+ EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group.\r
+\r
+ The IDE controller driver will use controller- and possibly platform-specific\r
+ algorithms to arrive at SupportedModes. The IDE controller may base its\r
+ decision on user preferences and other considerations as well. This function\r
+ may be called multiple times because the driver entity may renegotiate the mode\r
with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode().\r
- \r
- The driver entity may collect timing information for various devices in any \r
+\r
+ The driver entity may collect timing information for various devices in any\r
order. The driver entity is responsible for making sure that all the dependencies\r
- are satisfied. For example, the SupportedModes information for device A that \r
- was previously returned may become stale after a call to \r
+ are satisfied. For example, the SupportedModes information for device A that\r
+ was previously returned may become stale after a call to\r
EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.\r
- \r
- The buffer SupportedModes is allocated by the callee because the caller does \r
- not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE \r
- is defined in a way that allows for future extensibility and can be of variable \r
- length. This memory pool should be deallocated by the caller when it is no \r
- longer necessary. \r
- \r
- The IDE controller driver for a Serial ATA (SATA) controller can use this \r
- member function to force a lower speed (first-generation [Gen1] speeds on a \r
- second-generation [Gen2]-capable hardware). The IDE controller driver can \r
- also allow the driver entity to stay with the speed that has been negotiated \r
+\r
+ The buffer SupportedModes is allocated by the callee because the caller does\r
+ not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE\r
+ is defined in a way that allows for future extensibility and can be of variable\r
+ length. This memory pool should be deallocated by the caller when it is no\r
+ longer necessary.\r
+\r
+ The IDE controller driver for a Serial ATA (SATA) controller can use this\r
+ member function to force a lower speed (first-generation [Gen1] speeds on a\r
+ second-generation [Gen2]-capable hardware). The IDE controller driver can\r
+ also allow the driver entity to stay with the speed that has been negotiated\r
by the physical layer.\r
- \r
+\r
@param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel A zero-based channel number.\r
@param[in] Device A zero-based device number on the Channel.\r
\r
@retval EFI_SUCCESS SupportedModes was returned.\r
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
- @retval EFI_INVALID_PARAMETER Device is invalid. \r
+ @retval EFI_INVALID_PARAMETER Device is invalid.\r
@retval EFI_INVALID_PARAMETER SupportedModes is NULL.\r
- @retval EFI_NOT_READY Modes cannot be calculated due to a lack of \r
- data. This error may happen if \r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() \r
- and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData() \r
- were not called for at least one drive in the \r
+ @retval EFI_NOT_READY Modes cannot be calculated due to a lack of\r
+ data. This error may happen if\r
+ EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r
+ and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData()\r
+ were not called for at least one drive in the\r
same enumeration group.\r
\r
**/\r
Commands the IDE controller driver to program the IDE controller hardware\r
so that the specified device can operate at the specified mode.\r
\r
- This function is used by the driver entity to instruct the IDE controller \r
- driver to program the IDE controller hardware to the specified modes. This \r
- function can be called only once for a particular device. For a Serial ATA \r
+ This function is used by the driver entity to instruct the IDE controller\r
+ driver to program the IDE controller hardware to the specified modes. This\r
+ function can be called only once for a particular device. For a Serial ATA\r
(SATA) Advanced Host Controller Interface (AHCI) controller, no controller-\r
specific programming may be required.\r
\r
projects / mirror_edk2.git / blobdiff