]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/AtaPassThru.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / AtaPassThru.h
index c0545547bd004014d1cf69c4e2634d3d0437449d..6d9b9f10b421df5f8c0d7cb6768092136b70d860 100644 (file)
@@ -3,14 +3,14 @@
   to send ATA Command Blocks to any ATA device attached to that ATA controller. The information\r
   includes the attributes of the ATA controller.\r
 \r
-  Copyright (c) 2009 - 2016, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2009 - 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
+  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
+  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
 **/\r
 \r
@@ -56,7 +56,7 @@ typedef struct _EFI_ATA_COMMAND_BLOCK {
   UINT8 AtaDeviceHead;\r
   UINT8 AtaSectorNumberExp;\r
   UINT8 AtaCylinderLowExp;\r
-  UINT8 AtaCylinderHighExp; \r
+  UINT8 AtaCylinderHighExp;\r
   UINT8 AtaFeaturesExp;\r
   UINT8 AtaSectorCount;\r
   UINT8 AtaSectorCountExp;\r
@@ -73,7 +73,7 @@ typedef struct _EFI_ATA_STATUS_BLOCK {
   UINT8 AtaDeviceHead;\r
   UINT8 AtaSectorNumberExp;\r
   UINT8 AtaCylinderLowExp;\r
-  UINT8 AtaCylinderHighExp; \r
+  UINT8 AtaCylinderHighExp;\r
   UINT8 Reserved2;\r
   UINT8 AtaSectorCount;\r
   UINT8 AtaSectorCountExp;\r
@@ -156,7 +156,7 @@ typedef struct {
   ///\r
   /// On Input, the size, in bytes of OutDataBuffer. On Output, the Number of bytes\r
   /// transferred between ATA Controller and the ATA device. If OutTransferLength is\r
-  /// larger than the ATA controller can handle, no data will be transferred, \r
+  /// larger than the ATA controller can handle, no data will be transferred,\r
   /// OutTransferLength will be updated to contain the number of bytes that the ATA\r
   /// controller is able to transfer, and EFI_BAD_BUFFER_SIZE will be returned.\r
   ///\r
@@ -177,8 +177,8 @@ typedef struct {
   supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required,\r
   and the non-blocking I/O functionality is optional.\r
 \r
-  @param[in]     This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. \r
-  @param[in]     Port                The port number of the ATA device to send the command. \r
+  @param[in]     This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
+  @param[in]     Port                The port number of the ATA device to send the command.\r
   @param[in]     PortMultiplierPort  The port multiplier port number of the ATA device to send the command.\r
                                      If there is no port multiplier, then specify 0xFFFF.\r
   @param[in,out] Packet              A pointer to the ATA command to send to the ATA device specified by Port\r
@@ -188,11 +188,11 @@ typedef struct {
                                      Event is not NULL and non blocking I/O is supported, then non-blocking\r
                                      I/O is performed, and Event will be signaled when the ATA command completes.\r
 \r
-  @retval EFI_SUCCESS                The ATA command was sent by the host. For bi-directional commands, \r
+  @retval EFI_SUCCESS                The ATA command was sent by the host. For bi-directional commands,\r
                                      InTransferLength bytes were transferred from InDataBuffer. For write and\r
                                      bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.\r
   @retval EFI_BAD_BUFFER_SIZE        The ATA command was not executed. The number of bytes that could be transferred\r
-                                     is returned in InTransferLength. For write and bi-directional commands, \r
+                                     is returned in InTransferLength. For write and bi-directional commands,\r
                                      OutTransferLength bytes were transferred by OutDataBuffer.\r
   @retval EFI_NOT_READY              The ATA command could not be sent because there are too many ATA commands\r
                                      already queued. The caller may retry again later.\r
@@ -230,7 +230,7 @@ EFI_STATUS
   If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is\r
   returned.\r
 \r
-  @param[in]     This           A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance. \r
+  @param[in]     This           A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
   @param[in,out] Port           On input, a pointer to the port number on the ATA controller.\r
                                 On output, a pointer to the next port number on the ATA\r
                                 controller. An input value of 0xFFFF retrieves the first port\r
@@ -250,36 +250,36 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA \r
-  controller. These can either be the list of port multiplier ports where ATA devices are actually \r
-  present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this \r
-  function must probe the port number and port multiplier port number returned to see if an ATA \r
+  Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA\r
+  controller. These can either be the list of port multiplier ports where ATA devices are actually\r
+  present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this\r
+  function must probe the port number and port multiplier port number returned to see if an ATA\r
   device is actually present.\r
 \r
-  The GetNextDevice() function retrieves the port multiplier port number of an ATA device \r
+  The GetNextDevice() function retrieves the port multiplier port number of an ATA device\r
   present on a port of an ATA controller.\r
-  \r
-  If PortMultiplierPort points to a port multiplier port number value that was returned on a \r
+\r
+  If PortMultiplierPort points to a port multiplier port number value that was returned on a\r
   previous call to GetNextDevice(), then the port multiplier port number of the next ATA device\r
   on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is\r
   returned.\r
-  \r
-  If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first \r
-  ATA device on port of the ATA controller is returned in PortMultiplierPort and \r
+\r
+  If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first\r
+  ATA device on port of the ATA controller is returned in PortMultiplierPort and\r
   EFI_SUCCESS is returned.\r
-  \r
+\r
   If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort\r
   was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER\r
   is returned.\r
-  \r
-  If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of \r
+\r
+  If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of\r
   the ATA controller, then EFI_NOT_FOUND is returned.\r
 \r
   @param[in]     This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
   @param[in]     Port                The port number present on the ATA controller.\r
   @param[in,out] PortMultiplierPort  On input, a pointer to the port multiplier port number of an\r
-                                     ATA device present on the ATA controller. \r
-                                     If on input a PortMultiplierPort of 0xFFFF is specified, \r
+                                     ATA device present on the ATA controller.\r
+                                     If on input a PortMultiplierPort of 0xFFFF is specified,\r
                                      then the port multiplier port number of the first ATA device\r
                                      is returned. On output, a pointer to the port multiplier port\r
                                      number of the next ATA device present on an ATA controller.\r
@@ -345,7 +345,7 @@ EFI_STATUS
 \r
   The GetDevice() function determines the port and port multiplier port number associated with\r
   the ATA device described by DevicePath. If DevicePath is a device path node type that the\r
-  ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents \r
+  ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents\r
   DevicePath into a port number and port multiplier port number.\r
 \r
   If this translation is successful, then that port number and port multiplier port number are returned\r
@@ -353,11 +353,11 @@ EFI_STATUS
 \r
   If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.\r
 \r
-  If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then \r
+  If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then\r
   EFI_UNSUPPORTED is returned.\r
 \r
-  If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not \r
-  a valid translation from DevicePath to a port number and port multiplier port number, then \r
+  If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not\r
+  a valid translation from DevicePath to a port number and port multiplier port number, then\r
   EFI_NOT_FOUND is returned.\r
 \r
   @param[in]  This                A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.\r
@@ -423,7 +423,7 @@ EFI_STATUS
   If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is\r
   returned.\r
 \r
-  If Port or PortMultiplierPort are not in a valid range for this ATA controller, then \r
+  If Port or PortMultiplierPort are not in a valid range for this ATA controller, then\r
   EFI_INVALID_PARAMETER is returned.\r
 \r
   If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR\r