]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/BlockIo2.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / BlockIo2.h
index 5fad1078430c135c47b573001392b17ca6da91b0..1ffe322eee53e8019229316af794a8a5fa3343ad 100644 (file)
@@ -5,14 +5,14 @@
   enables the ability to read and write data at a block level in a non-blocking\r
   manner.\r
 \r
-  Copyright (c) 2011, 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) 2011 - 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
@@ -69,7 +69,7 @@ EFI_STATUS
 \r
 /**\r
   Read BufferSize bytes from Lba into Buffer.\r
-  \r
+\r
   This function reads the requested number of blocks from the device. All the\r
   blocks are read, or an error is returned.\r
   If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_or EFI_MEDIA_CHANGED is returned and\r
@@ -77,13 +77,13 @@ EFI_STATUS
   not be signaled.\r
 \r
   @param[in]       This       Indicates a pointer to the calling context.\r
-  @param[in]       MediaId    Id of the media, changes every time the media is \r
+  @param[in]       MediaId    Id of the media, changes every time the media is\r
                               replaced.\r
   @param[in]       Lba        The starting Logical Block Address to read from.\r
-  @param[in, out]  Token           A pointer to the token associated with the transaction.\r
-  @param[in]       BufferSize Size of Buffer, must be a multiple of device block size.  \r
-  @param[out]      Buffer     A pointer to the destination buffer for the data. The \r
-                              caller is responsible for either having implicit or \r
+  @param[in, out]  Token      A pointer to the token associated with the transaction.\r
+  @param[in]       BufferSize Size of Buffer, must be a multiple of device block size.\r
+  @param[out]      Buffer     A pointer to the destination buffer for the data. The\r
+                              caller is responsible for either having implicit or\r
                               explicit ownership of the buffer.\r
 \r
   @retval EFI_SUCCESS           The read request was queued if Token->Event is\r
@@ -95,7 +95,7 @@ EFI_STATUS
   @retval EFI_MEDIA_CHANGED     The MediaId is not for the current media.\r
   @retval EFI_BAD_BUFFER_SIZE   The BufferSize parameter is not a multiple of the\r
                                 intrinsic block size of the device.\r
-  @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, \r
+  @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack\r
                                 of resources.\r
@@ -136,7 +136,7 @@ EFI_STATUS
   @retval EFI_MEDIA_CHNAGED     The MediaId does not matched the current device.\r
   @retval EFI_DEVICE_ERROR      The device reported an error while performing the write.\r
   @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
-  @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, \r
+  @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,\r
                                 or the buffer is not on proper alignment.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack\r
                                 of resources.\r
@@ -155,10 +155,10 @@ EFI_STATUS
 \r
 /**\r
   Flush the Block Device.\r
\r
+\r
   If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED\r
   is returned and non-blocking I/O is being used, the Event associated with\r
-  this request will not be signaled.  \r
+  this request will not be signaled.\r
 \r
   @param[in]      This     Indicates a pointer to the calling context.\r
   @param[in,out]  Token    A pointer to the token associated with the transaction\r
@@ -189,9 +189,9 @@ EFI_STATUS
 ///\r
 struct _EFI_BLOCK_IO2_PROTOCOL {\r
   ///\r
-  /// A pointer to the EFI_BLOCK_IO_MEDIA data for this device. \r
+  /// A pointer to the EFI_BLOCK_IO_MEDIA data for this device.\r
   /// Type EFI_BLOCK_IO_MEDIA is defined in BlockIo.h.\r
-  ///  \r
+  ///\r
   EFI_BLOCK_IO_MEDIA      *Media;\r
 \r
   EFI_BLOCK_RESET_EX      Reset;\r