Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Protocol / ScsiPassThru.h

diff --git a/MdePkg/Include/Protocol/ScsiPassThru.h b/MdePkg/Include/Protocol/ScsiPassThru.h
index a5aa6c47c0e25530ec41b238efb01a79ae2bade5..2192e9bf4951c36416389d136454bc42c77db3ea 100644 (file)
--- a/MdePkg/Include/Protocol/ScsiPassThru.h
+++ b/MdePkg/Include/Protocol/ScsiPassThru.h
@@ -1,7 +1,14 @@
 /** @file\r
-  SCSI Pass Through protocol.\r
-\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  SCSI Pass Through protocol as defined in EFI 1.1.\r
+  This protocol allows information about a SCSI channel to be collected, \r
+  and allows SCSI Request Packets to be sent to any SCSI devices on a SCSI\r
+  channel even if those devices are not boot devices. This protocol is attached \r
+  to the device handle of each SCSI channel in a system that the protocol \r
+  supports, and can be used for diagnostics. It may also be used to build \r
+  a Block I/O driver for SCSI hard drives and SCSI CD-ROM or DVD drives to\r
+  allow those devices to become boot devices.\r
+\r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -10,8 +17,6 @@
   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
-  Module Name:  ScsiPassThru.h\r
-\r
 **/\r
 \r
 #ifndef __SCSI_PASS_THROUGH_H__\r
@@ -107,7 +112,7 @@ typedef struct {
                                     DataBuffer.See HostAdapterStatus, TargetStatus,\r
                                     SenseDataLength,and SenseData in that order\r
                                     for additional status information.\r
-  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the\r
+  @retval EFI_BAD_BUFFER_SIZE       The SCSI Request Packet was executed, but the\r
                                     entire DataBuffer could not be transferred.\r
                                     The actual number of bytes transferred is returned\r
                                     in TransferLength. See HostAdapterStatus,\r
@@ -135,7 +140,7 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_PASSTHRU) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_PASSTHRU)(\r
   IN EFI_SCSI_PASS_THRU_PROTOCOL                          *This,\r
   IN UINT32                                               Target,\r
   IN UINT64                                               Lun,\r
@@ -170,7 +175,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_GET_NEXT_DEVICE) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_GET_NEXT_DEVICE)(\r
   IN EFI_SCSI_PASS_THRU_PROTOCOL            *This,\r
   IN OUT UINT32                             *Target,\r
   IN OUT UINT64                             *Lun\r
@@ -206,7 +211,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_BUILD_DEVICE_PATH) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_BUILD_DEVICE_PATH)(\r
   IN EFI_SCSI_PASS_THRU_PROTOCOL            *This,\r
   IN     UINT32                             Target,\r
   IN     UINT64                             Lun,\r
@@ -239,7 +244,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_GET_TARGET_LUN) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_GET_TARGET_LUN)(\r
   IN EFI_SCSI_PASS_THRU_PROTOCOL            *This,\r
   IN  EFI_DEVICE_PATH_PROTOCOL              *DevicePath,\r
   OUT UINT32                                *Target,\r
@@ -264,7 +269,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_RESET_CHANNEL) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_RESET_CHANNEL)(\r
   IN EFI_SCSI_PASS_THRU_PROTOCOL             *This\r
   )\r
 ;\r
@@ -290,13 +295,44 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SCSI_PASS_THRU_RESET_TARGET) (\r
+(EFIAPI *EFI_SCSI_PASS_THRU_RESET_TARGET)(\r
   IN EFI_SCSI_PASS_THRU_PROTOCOL             *This,\r
   IN UINT32                                  Target,\r
   IN UINT64                                  Lun\r
   )\r
 ;\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel and\r
+  the ability to send SCI Request Packets to any SCSI device attached to that SCSI channel. The\r
+  information includes the Target ID of the host controller on the SCSI channel, the attributes of\r
+  the SCSI channel, the printable name for the SCSI controller, and the printable name of the\r
+  SCSI channel.\r
+\r
+  @param Mode \r
+  A pointer to the EFI_SCSI_PASS_THRU_MODE data for this SCSI channel.\r
+\r
+  @param PassThru \r
+  Sends a SCSI Request Packet to a SCSI device that is connected to the SCSI channel.\r
+\r
+  @param GetNextDevice \r
+  Used to retrieve the list of legal Target IDs and LUNs for the\r
+  SCSI devices on a SCSI channel. \r
+\r
+  @param BuildDevicePath \r
+  Used to allocate and build a device path node for a SCSI device on a SCSI channel.\r
+\r
+  @param GetTargetLun \r
+  Used to translate a device path node to a Target ID and LUN.\r
+\r
+  @param ResetChannel \r
+  Resets the SCSI channel. This operation resets all the SCSI\r
+  devices connected to the SCSI channel.\r
+\r
+  @param ResetTarget \r
+  Resets a SCSI device that is connected to the SCSI channel. \r
+**/\r
 struct _EFI_SCSI_PASS_THRU_PROTOCOL {\r
   EFI_SCSI_PASS_THRU_MODE               *Mode;\r
   EFI_SCSI_PASS_THRU_PASSTHRU           PassThru;\r