Update to use DOS format

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

diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h
index a59b61ec179752fb2d643bd5e8c3c2e01c553b7c..d63f056c5aa5f2d7048eebb0b928e8a095026067 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
@@ -10,8 +12,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:  ScsiPassThruExt.h\r
-\r
 **/\r
 \r
 #ifndef __EXT_SCSI_PASS_THROUGH_PROTOCOL_H__\r
@@ -19,7 +19,7 @@
 \r
 #define EFI_EXT_SCSI_PASS_THRU_PROTOCOL_GUID \\r
   { \\r
-    0x1d3de7f0, 0x0807, 0x424f, {0xaa, 0x69, 0x11, 0xa5, 0x4e, 0x19, 0xa4, 0x6f } \\r
+    0x143b7632, 0xb81b, 0x4cb7, {0xab, 0xd3, 0xb6, 0x25, 0xa5, 0xb9, 0xbf, 0xfe } \\r
   }\r
 \r
 typedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL;\r
@@ -129,14 +129,13 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EXT_SCSI_PASS_THRU_PASSTHRU) (\r
+(EFIAPI *EFI_EXT_SCSI_PASS_THRU_PASSTHRU)(\r
   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
   IN UINT8                                          *Target,\r
   IN UINT64                                         Lun,\r
   IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
   IN EFI_EVENT                                      Event     OPTIONAL\r
-  )\r
-;      \r
+  );      \r
 \r
 /**\r
   Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These       \r
@@ -166,12 +165,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET_LUN) (\r
+(EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET_LUN)(\r
   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                *This,\r
   IN OUT UINT8                                      **Target,\r
   IN OUT UINT64                                     *Lun\r
-  )\r
-;   \r
+  );   \r
 \r
 /**\r
   Used to allocate and build a device path node for a SCSI device on a SCSI channel.\r
@@ -202,13 +200,12 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EXT_SCSI_PASS_THRU_BUILD_DEVICE_PATH) (\r
+(EFIAPI *EFI_EXT_SCSI_PASS_THRU_BUILD_DEVICE_PATH)(\r
   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL               *This,\r
   IN UINT8                                         *Target,\r
   IN UINT64                                        Lun,\r
   IN OUT EFI_DEVICE_PATH_PROTOCOL                  **DevicePath\r
-  )\r
-;     \r
+  );\r
 \r
 /**\r
   Used to translate a device path node to a Target ID and LUN.\r
@@ -231,13 +228,12 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_TARGET_LUN) (\r
+(EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_TARGET_LUN)(\r
   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL               *This,\r
   IN EFI_DEVICE_PATH_PROTOCOL                      *DevicePath,\r
   OUT UINT8                                        **Target,\r
   OUT UINT64                                       *Lun\r
-  )\r
-;       \r
+  );       \r
 \r
 /**\r
   Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.\r
@@ -252,10 +248,9 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_CHANNEL) (\r
+(EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_CHANNEL)(\r
   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL               *This\r
-  )\r
-;    \r
+  );    \r
   \r
 /**\r
   Resets a SCSI logical unit that is connected to a SCSI channel.\r
@@ -278,12 +273,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_TARGET_LUN) (\r
+(EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_TARGET_LUN)(\r
   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL               *This,\r
   IN UINT8                                         *Target,\r
   IN UINT64                                        Lun\r
-  )\r
-;         \r
+  );         \r
 \r
 /**\r
   Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either     \r
@@ -309,13 +303,21 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET) (\r
+(EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET)(\r
   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL               *This,\r
   IN OUT UINT8                                     **Target\r
-  )\r
-;          \r
-  \r
+  );          \r
+\r
+///\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
 struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL {\r
+  ///\r
+  /// A pointer to the EFI_EXT_SCSI_PASS_THRU_MODE data for this SCSI channel.\r
+  ///\r
   EFI_EXT_SCSI_PASS_THRU_MODE                *Mode;\r
   EFI_EXT_SCSI_PASS_THRU_PASSTHRU            PassThru;\r
   EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET_LUN GetNextTargetLun;\r