This check-in add Pci23.h, Pci30.h, EfiPci.h and take those originally put in Pci22...

[mirror_edk2.git] / MdePkg / Include / Ppi / BlockIo.h

diff --git a/MdePkg/Include/Ppi/BlockIo.h b/MdePkg/Include/Ppi/BlockIo.h
index debcc0c8e491aff5d4078c04cd578b2deac066c7..5809c478e26bc5864a5e292c9267ce51596738c9 100644 (file)
--- a/MdePkg/Include/Ppi/BlockIo.h
+++ b/MdePkg/Include/Ppi/BlockIo.h
@@ -48,10 +48,8 @@ typedef struct {
 /**\r
   Gets the count of block I/O devices that one specific block driver detects.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM.\r
-  \r
-  @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
-  \r
+  @param  PeiServices        General-purpose services that are available to every PEIM.\r
+  @param  This               Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
   @param  NumberBlockDevices The number of block I/O devices discovered.\r
 \r
   @return Status code\r
@@ -66,23 +64,19 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Gets a block device¡¯s media information.\r
-\r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance. \r
-  \r
-  @param  DeviceIndex Specifies the block device to which the function \r
-  wants to talk. Because the driver that implements Block I/O PPIs \r
-  will manage multiple block devices, the PPIs that want to talk to a single \r
-  device must specify the device index that was assigned during the enumeration \r
-  process. This index is a number from one to NumberBlockDevices.\r
-  \r
-  @param  MediaInfo The media information of the specified block media.\r
-\r
-  @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.\r
-  \r
-  @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.\r
+  Gets a block device's media information.\r
+\r
+  @param  PeiServices    General-purpose services that are available to every PEIM\r
+  @param  This           Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
+  @param  DeviceIndex    Specifies the block device to which the function\r
+                         wants to talk. Because the driver that implements Block I/O PPIs\r
+                         will manage multiple block devices, the PPIs that want to talk to a single\r
+                         device must specify the device index that was assigned during the enumeration\r
+                         process. This index is a number from one to NumberBlockDevices.\r
+  @param  MediaInfo      The media information of the specified block media.\r
+\r
+  @retval EFI_SUCCESS           Media information about the specified block device was obtained successfully.\r
+  @retval EFI_DEVICE_ERROR      Cannot get the media information due to a hardware error.\r
 \r
 **/\r
 typedef\r
@@ -97,31 +91,22 @@ EFI_STATUS
 /**\r
   Reads the requested number of blocks from the specified block device.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM.\r
-  \r
-  @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
-  \r
-  @param  DeviceIndex Specifies the block device to which the function wants to talk.\r
-  \r
-  @param  StartLBA The starting logical block address (LBA) to read from on the device\r
-  \r
-  @param  BufferSize The size of the Buffer in bytes. This number must \r
-  be a multiple of the intrinsic block size of the device.\r
-  \r
-  @param  Buffer A pointer to the destination buffer for the data.\r
-  The caller is responsible for the ownership of the buffer.\r
-\r
-  @retval EFI_SUCCESS The data was read correctly from the device.\r
-  \r
-  @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.\r
-  \r
+  @param  PeiServices    General-purpose services that are available to every PEIM.\r
+  @param  This           Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
+  @param  DeviceIndex    Specifies the block device to which the function wants to talk.\r
+  @param  StartLBA       The starting logical block address (LBA) to read from on the device\r
+  @param  BufferSize     The size of the Buffer in bytes. This number must\r
+                         be a multiple of the intrinsic block size of the device.\r
+  @param  Buffer         A pointer to the destination buffer for the data.\r
+                         The caller is responsible for the ownership of the buffer.\r
+\r
+  @retval EFI_SUCCESS           The data was read correctly from the device.\r
+  @retval EFI_DEVICE_ERROR      The device reported an error while attempting to perform the read operation.\r
   @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,\r
-  or the buffer is not properly aligned.\r
-  \r
-  @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of \r
-  the intrinsic block size of the device.\r
-  \r
-  @retval EFI_NO_MEDIA There is no media in the device.\r
+                                or the buffer is not properly aligned.\r
+  @retval EFI_BAD_BUFFER_SIZE   The BufferSize parameter is not a multiple of\r
+                                the intrinsic block size of the device.\r
+  @retval EFI_NO_MEDIA          There is no media in the device.\r
 \r
 **/\r
 typedef\r