]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/IdeControllerInit.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / IdeControllerInit.h
index 023090c07122dac834a3befe0f553c3569d0d60e..be0e079c902197838a4441c1c0e1710e627dde0a 100644 (file)
@@ -1,31 +1,31 @@
 /** @file\r
   This file declares EFI IDE Controller Init Protocol\r
-  \r
+\r
   The EFI_IDE_CONTROLLER_INIT_PROTOCOL provides the chipset-specific information\r
   to the driver entity. This protocol is mandatory for IDE controllers if the\r
   IDE devices behind the controller are to be enumerated by a driver entity.\r
-  \r
+\r
   There can only be one instance of EFI_IDE_CONTROLLER_INIT_PROTOCOL for each IDE\r
   controller in a system. It is installed on the handle that corresponds to the\r
   IDE controller. A driver entity that wishes to manage an IDE bus and possibly\r
   IDE devices in a system will have to retrieve the EFI_IDE_CONTROLLER_INIT_PROTOCOL\r
   instance that is associated with the controller to be managed.\r
-  \r
+\r
   A device handle for an IDE controller must contain an EFI_DEVICE_PATH_PROTOCOL.\r
 \r
-Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
 The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php.                                          \r
-    \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+http://opensource.org/licenses/bsd-license.php.\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
-  This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r
+  This Protocol is defined in UEFI Platform Initialization Specification 1.2\r
   Volume 5: Standards.\r
-  \r
+\r
 **/\r
 \r
 #ifndef _EFI_IDE_CONTROLLER_INIT_PROTOCOL_H_\r
@@ -71,7 +71,7 @@ typedef enum {
   ///\r
   /// The driver entity has completed resetting the devices behind\r
   /// the specified channel. This notification can be used to perform\r
-  /// any chipset-specific programming.  \r
+  /// any chipset-specific programming.\r
   ///\r
   EfiIdeAfterChannelReset,\r
   ///\r
@@ -84,13 +84,13 @@ typedef enum {
   ///\r
   /// The driver entity is done with detecting the presence of\r
   /// devices behind the specified channel. This notification can be\r
-  /// used to perform any chipset-specific programming.  \r
+  /// used to perform any chipset-specific programming.\r
   ///\r
   EfiIdeBusAfterDevicePresenceDetection,\r
   ///\r
   /// The IDE bus is requesting the IDE controller driver to\r
   /// reprogram the IDE controller hardware and thereby reset all\r
-  /// the mode and timing settings to default settings.  \r
+  /// the mode and timing settings to default settings.\r
   ///\r
   EfiIdeResetMode,\r
   EfiIdeBusPhaseMaximum\r
@@ -135,11 +135,11 @@ typedef struct {
 typedef struct {\r
   ///\r
   /// An enumeration defining various transfer protocols other than the protocols\r
-  /// that exist at the time this specification was developed (i.e., PIO, single \r
-  /// word DMA, multiword DMA, and UDMA). Each transfer protocol is associated \r
-  /// with a mode. The various transfer protocols are defined by the ATA/ATAPI \r
-  /// specification. This enumeration makes the interface extensible because we \r
-  /// can support new transport protocols beyond UDMA. Type EFI_ATA_EXT_TRANSFER_PROTOCOL \r
+  /// that exist at the time this specification was developed (i.e., PIO, single\r
+  /// word DMA, multiword DMA, and UDMA). Each transfer protocol is associated\r
+  /// with a mode. The various transfer protocols are defined by the ATA/ATAPI\r
+  /// specification. This enumeration makes the interface extensible because we\r
+  /// can support new transport protocols beyond UDMA. Type EFI_ATA_EXT_TRANSFER_PROTOCOL\r
   /// is defined below.\r
   ///\r
   EFI_ATA_EXT_TRANSFER_PROTOCOL  TransferProtocol;\r
@@ -155,7 +155,7 @@ typedef struct {
 typedef struct {\r
   ///\r
   /// This field specifies the PIO mode. PIO modes are defined in the ATA/ATAPI\r
-  /// specification. The ATA/ATAPI specification defines the enumeration.  In \r
+  /// specification. The ATA/ATAPI specification defines the enumeration.  In\r
   /// other words, a value of 1 in this field means PIO mode 1. The actual meaning\r
   /// of PIO mode 1 is governed by the ATA/ATAPI specification. Type EFI_ATA_MODE\r
   /// is defined below.\r
@@ -168,26 +168,26 @@ typedef struct {
   /// controllers will not support this transfer mode. The ATA/ATAPI specification defines\r
   /// the enumeration. In other words, a value of 1 in this field means single word DMA\r
   /// mode 1. The actual meaning of single word DMA mode 1 is governed by the ATA/\r
-  /// ATAPI specification.  \r
+  /// ATAPI specification.\r
   ///\r
   EFI_ATA_MODE           SingleWordDmaMode;\r
   ///\r
   /// This field specifies the multiword DMA mode. Various multiword DMA modes are\r
   /// defined in the ATA/ATAPI specification. A value of 1 in this field means multiword\r
   /// DMA mode 1. The actual meaning of multiword DMA mode 1 is governed by the\r
-  /// ATA/ATAPI specification.  \r
+  /// ATA/ATAPI specification.\r
   ///\r
   EFI_ATA_MODE           MultiWordDmaMode;\r
   ///\r
   /// This field specifies the ultra DMA (UDMA) mode. UDMA modes are defined in the\r
   /// ATA/ATAPI specification. A value of 1 in this field means UDMA mode 1. The\r
-  /// actual meaning of UDMA mode 1 is governed by the ATA/ATAPI specification.  \r
+  /// actual meaning of UDMA mode 1 is governed by the ATA/ATAPI specification.\r
   ///\r
   EFI_ATA_MODE           UdmaMode;\r
   ///\r
   /// The number of extended-mode bitmap entries. Extended modes describe transfer\r
   /// protocols beyond PIO, single word DMA, multiword DMA, and UDMA. This field\r
-  /// can be zero and provides extensibility.  \r
+  /// can be zero and provides extensibility.\r
   ///\r
   UINT32                 ExtModeCount;\r
   ///\r
@@ -195,7 +195,7 @@ typedef struct {
   /// than the ones defined above (i.e., PIO, single word DMA, multiword DMA, and\r
   /// UDMA). This field is defined for extensibility. At this time, only one extended\r
   /// transfer protocol is defined to cover SATA transfers. Type\r
-  /// EFI_ATA_EXTENDED_MODE is defined below.  \r
+  /// EFI_ATA_EXTENDED_MODE is defined below.\r
   ///\r
   EFI_ATA_EXTENDED_MODE  ExtMode[1];\r
 } EFI_ATA_COLLECTIVE_MODE;\r
@@ -206,16 +206,16 @@ typedef struct {
 /// The definition of these two structures is not part of the protocol\r
 /// definition because the ATA/ATAPI Specification controls the definition\r
 /// of all the fields. The ATA/ATAPI Specification can obsolete old fields\r
-/// or redefine existing fields. \r
+/// or redefine existing fields.\r
 typedef ATA_IDENTIFY_DATA   EFI_ATA_IDENTIFY_DATA;\r
 typedef ATAPI_IDENTIFY_DATA EFI_ATAPI_IDENTIFY_DATA;\r
 \r
 ///\r
 /// This flag indicates whether the IDENTIFY data is a response from an ATA device\r
-/// (EFI_ATA_IDENTIFY_DATA) or response from an ATAPI device \r
+/// (EFI_ATA_IDENTIFY_DATA) or response from an ATAPI device\r
 /// (EFI_ATAPI_IDENTIFY_DATA).  According to the ATA/ATAPI specification,\r
-/// EFI_IDENTIFY_DATA is for an ATA device if bit 15 of the Config field is zero. \r
-/// The Config field is common to both EFI_ATA_IDENTIFY_DATA and \r
+/// EFI_IDENTIFY_DATA is for an ATA device if bit 15 of the Config field is zero.\r
+/// The Config field is common to both EFI_ATA_IDENTIFY_DATA and\r
 /// EFI_ATAPI_IDENTIFY_DATA.\r
 ///\r
 #define   EFI_ATAPI_DEVICE_IDENTIFY_DATA  0x8000\r
@@ -225,8 +225,8 @@ typedef ATAPI_IDENTIFY_DATA EFI_ATAPI_IDENTIFY_DATA;
 ///\r
 typedef union {\r
   ///\r
-  /// The data that is returned by an ATA device upon successful completion \r
-  /// of the ATA IDENTIFY_DEVICE command. \r
+  /// The data that is returned by an ATA device upon successful completion\r
+  /// of the ATA IDENTIFY_DEVICE command.\r
   ///\r
   EFI_ATA_IDENTIFY_DATA       AtaData;\r
   ///\r
@@ -238,34 +238,34 @@ typedef union {
 \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
@@ -284,13 +284,13 @@ EFI_STATUS
 /**\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
@@ -299,9 +299,9 @@ EFI_STATUS
   @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
@@ -316,32 +316,32 @@ EFI_STATUS
 /**\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
@@ -364,31 +364,31 @@ EFI_STATUS
 /**\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
@@ -399,7 +399,7 @@ EFI_STATUS
   @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
 typedef\r
 EFI_STATUS\r
@@ -414,39 +414,39 @@ EFI_STATUS
   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
@@ -454,13 +454,13 @@ EFI_STATUS
 \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
@@ -477,9 +477,9 @@ EFI_STATUS
   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
@@ -513,48 +513,48 @@ struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL {
   /// Returns the information about a specific channel.\r
   ///\r
   EFI_IDE_CONTROLLER_GET_CHANNEL_INFO    GetChannelInfo;\r
-  \r
+\r
   ///\r
   /// The notification that the driver entity is about to enter the\r
-  /// specified phase during the enumeration process.  \r
+  /// specified phase during the enumeration process.\r
   ///\r
   EFI_IDE_CONTROLLER_NOTIFY_PHASE        NotifyPhase;\r
-  \r
+\r
   ///\r
   /// Submits the Drive Identify data that was returned by the device.\r
   ///\r
   EFI_IDE_CONTROLLER_SUBMIT_DATA         SubmitData;\r
-  \r
+\r
   ///\r
-  /// Submits information about modes that should be disqualified.  The specified \r
-  /// IDE device does not support these modes and these modes should not be \r
+  /// Submits information about modes that should be disqualified.  The specified\r
+  /// IDE device does not support these modes and these modes should not be\r
   /// returned by EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode()\r
   ///\r
   EFI_IDE_CONTROLLER_DISQUALIFY_MODE     DisqualifyMode;\r
-  \r
+\r
   ///\r
   /// Calculates and returns the optimum mode for a particular IDE device.\r
   ///\r
   EFI_IDE_CONTROLLER_CALCULATE_MODE      CalculateMode;\r
-  \r
+\r
   ///\r
   /// Programs the IDE controller hardware to the default timing or per the modes\r
-  /// that were returned by the last call to EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode().  \r
+  /// that were returned by the last call to EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode().\r
   ///\r
   EFI_IDE_CONTROLLER_SET_TIMING          SetTiming;\r
-  \r
+\r
   ///\r
   /// Set to TRUE if the enumeration group includes all the channels that are\r
   /// produced by this controller. Set to FALSE if an enumeration group consists of\r
-  /// only one channel.  \r
+  /// only one channel.\r
   ///\r
   BOOLEAN                                EnumAll;\r
-  \r
+\r
   ///\r
   /// The number of channels that are produced by this controller. Parallel ATA\r
-  /// (PATA) controllers can support up to two channels. Advanced Host Controller \r
+  /// (PATA) controllers can support up to two channels. Advanced Host Controller\r
   /// Interface (AHCI) Serial ATA (SATA) controllers can support up to 32 channels,\r
-  /// each of which can have up to one device. In the presence of a multiplier, \r
+  /// each of which can have up to one device. In the presence of a multiplier,\r
   /// each channel can have fifteen devices.\r
   ///\r
   UINT8                                  ChannelCount;\r