Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h
index 14c176296bc25c586b3ead31aae38542ad03a89e..7635818ff82fae7855b0f2bf9dcf96d6c9295c50 100644 (file)
--- a/MdePkg/Include/Protocol/ScsiPassThruExt.h
+++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h
@@ -1,7 +1,9 @@
 /** @file\r
   EFI_EXT_SCSI_PASS_THRU_PROTOCOL as defined in UEFI 2.0.\r
+  This protocol provides services that allow SCSI Pass Thru commands \r
+  to be sent to SCSI devices attached to a SCSI channel.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
@@ -312,7 +314,38 @@ EFI_STATUS
   IN OUT UINT8                                     **Target\r
   )\r
 ;          \r
-  \r
+\r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel \r
+  and the ability to send SCI Request Packets to any SCSI device attached to \r
+  that SCSI channel. The information includes the Target ID of the host controller \r
+  on the SCSI channel and the attributes of the SCSI channel.\r
+\r
+  @param Mode \r
+  A pointer to the EFI_EXT_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 GetNextTargetLun \r
+  Retrieves the list of legal Target IDs and LUNs for the SCSI devices on a SCSI channel. \r
+\r
+  @param BuildDevicePath \r
+  Allocates and builds a device path node for a SCSI Device on a SCSI channel. \r
+\r
+  @param GetTargetLun\r
+  Translates 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 devices connected to the SCSI channel. \r
+\r
+  @param ResetTargetLun\r
+  Resets a SCSI device that is connected to the SCSI channel. \r
+\r
+  @param GetNextTartget \r
+  Retrieves the list of legal Target IDs for the SCSI devices on a SCSI channel. \r
+**/  \r
 struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL {\r
   EFI_EXT_SCSI_PASS_THRU_MODE                *Mode;\r
   EFI_EXT_SCSI_PASS_THRU_PASSTHRU            PassThru;\r