Check in patch to refine DevicePath Module and USB2HostController Module.

[mirror_edk2.git] / EdkModulePkg / Bus / Pci / AtapiPassThru / Dxe / AtapiPassThru.h

diff --git a/EdkModulePkg/Bus/Pci/AtapiPassThru/Dxe/AtapiPassThru.h b/EdkModulePkg/Bus/Pci/AtapiPassThru/Dxe/AtapiPassThru.h
index d705c65949ff286ade6b496aae355edb9fa37c32..659b37c87601256bc44b60fb2590599aaf7f4ace 100644 (file)
--- a/EdkModulePkg/Bus/Pci/AtapiPassThru/Dxe/AtapiPassThru.h
+++ b/EdkModulePkg/Bus/Pci/AtapiPassThru/Dxe/AtapiPassThru.h
@@ -1,23 +1,16 @@
-/*++\r
+/** @file\r
+  Copyright (c) 2006, 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
+  http://opensource.org/licenses/bsd-license.php                                            \r
 \r
-Copyright (c) 2006, 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
-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
-Module Name:\r
+  Module Name:  AtapiPassThru.h\r
 \r
-    AtapiPassThru.h\r
-    \r
-Abstract: \r
-    \r
-\r
-Revision History\r
---*/\r
+**/\r
 \r
 #ifndef _APT_H\r
 #define _APT_H\r
@@ -25,12 +18,13 @@ Revision History
 \r
 #include <IndustryStandard/pci22.h>\r
 \r
-//\r
-// bit definition\r
-//\r
+///\r
+/// bit definition\r
+///\r
 #define bit(a)        1 << (a)\r
 \r
 #define MAX_TARGET_ID 4\r
+\r
 //\r
 // IDE Registers\r
 //\r
@@ -49,9 +43,9 @@ typedef union {
   UINT16  DeviceControl;  /* when write */\r
 } IDE_AltStatus_OR_DeviceControl;\r
 \r
-//\r
-// IDE registers set\r
-//\r
+///\r
+/// IDE registers set\r
+///\r
 typedef struct {\r
   UINT16                          Data;\r
   IDE_ERROR_OR_FEATURE            Reg1;\r
@@ -167,21 +161,21 @@ typedef struct {
 //\r
 // ATA Err Reg bitmap\r
 //\r
-#define BBK_ERR   bit (7) /* Bad block detected */\r
-#define UNC_ERR   bit (6) /* Uncorrectable Data */\r
-#define MC_ERR    bit (5) /* Media Change */\r
-#define IDNF_ERR  bit (4) /* ID Not Found */\r
-#define MCR_ERR   bit (3) /* Media Change Requested */\r
-#define ABRT_ERR  bit (2) /* Aborted Command */\r
-#define TK0NF_ERR bit (1) /* Track 0 Not Found */\r
-#define AMNF_ERR  bit (0) /* Address Mark Not Found */\r
+#define BBK_ERR   bit (7) ///< Bad block detected\r
+#define UNC_ERR   bit (6) ///< Uncorrectable Data\r
+#define MC_ERR    bit (5) ///< Media Change\r
+#define IDNF_ERR  bit (4) ///< ID Not Found\r
+#define MCR_ERR   bit (3) ///< Media Change Requested\r
+#define ABRT_ERR  bit (2) ///< Aborted Command\r
+#define TK0NF_ERR bit (1) ///< Track 0 Not Found\r
+#define AMNF_ERR  bit (0) ///< Address Mark Not Found\r
 \r
 //\r
 // ATAPI Err Reg bitmap\r
 //\r
 #define SENSE_KEY_ERR (bit (7) | bit (6) | bit (5) | bit (4))\r
-#define EOM_ERR bit (1) /* End of Media Detected */\r
-#define ILI_ERR bit (0) /* Illegal Length Indication */\r
+#define EOM_ERR bit (1) ///< End of Media Detected\r
+#define ILI_ERR bit (0) ///< Illegal Length Indication\r
 \r
 //\r
 // Device/Head Reg\r
@@ -201,21 +195,21 @@ typedef struct {
 //\r
 // Status Reg\r
 //\r
-#define BSY   bit (7) /* Controller Busy */\r
-#define DRDY  bit (6) /* Drive Ready */\r
-#define DWF   bit (5) /* Drive Write Fault */\r
-#define DSC   bit (4) /* Disk Seek Complete */\r
-#define DRQ   bit (3) /* Data Request */\r
-#define CORR  bit (2) /* Corrected Data */\r
-#define IDX   bit (1) /* Index */\r
-#define ERR   bit (0) /* Error */\r
-#define CHECK bit (0) /* Check bit for ATAPI Status Reg */\r
+#define BSY   bit (7) ///< Controller Busy\r
+#define DRDY  bit (6) ///< Drive Ready\r
+#define DWF   bit (5) ///< Drive Write Fault\r
+#define DSC   bit (4) ///< Disk Seek Complete\r
+#define DRQ   bit (3) ///< Data Request\r
+#define CORR  bit (2) ///< Corrected Data\r
+#define IDX   bit (1) ///< Index\r
+#define ERR   bit (0) ///< Error\r
+#define CHECK bit (0) ///< Check bit for ATAPI Status Reg\r
 \r
 //\r
 // Device Control Reg\r
 //\r
-#define SRST  bit (2) /* Software Reset */\r
-#define IEN_L bit (1) /* Interrupt Enable #*/\r
+#define SRST  bit (2) ///< Software Reset\r
+#define IEN_L bit (1) ///< Interrupt Enable\r
 \r
 //\r
 // ATAPI Feature Register\r
@@ -242,55 +236,63 @@ typedef struct {
 //\r
 // function prototype\r
 //\r
+/**\r
+  AtapiScsiPassThruDriverEntryPoint\r
+\r
+  @param ImageHandle\r
+  @param SystemTable\r
+\r
+  @todo Add function description\r
+  @todo ImageHandle - add argument description\r
+  @todo SystemTable - add argument description\r
+  @todo add return values\r
+--*/\r
 EFI_STATUS\r
 EFIAPI\r
 AtapiScsiPassThruDriverEntryPoint (\r
   IN EFI_HANDLE         ImageHandle,\r
   IN EFI_SYSTEM_TABLE   *SystemTable\r
   )\r
- /*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ImageHandle - TODO: add argument description\r
-  SystemTable - TODO: add argument description\r
-\r
-Returns:\r
+;\r
 \r
-  TODO: add return values\r
+/**\r
+  RegisterAtapiScsiPassThru\r
 \r
---*/\r
-;\r
+  @param  This\r
+  @param  Controller\r
+  @param  PciIo\r
 \r
+  @todo Add function description\r
+  @todo This add argument description\r
+  @todo Controller add argument description\r
+  @todo PciIo add argument description\r
+  @todo add return values\r
+**/\r
 EFI_STATUS\r
 RegisterAtapiScsiPassThru (\r
   IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN  EFI_HANDLE                  Controller,\r
   IN  EFI_PCI_IO_PROTOCOL         *PciIo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  This        - TODO: add argument description\r
-  Controller  - TODO: add argument description\r
-  PciIo       - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 \r
+/**\r
+  AtapiScsiPassThruFunction\r
+\r
+  @param  This\r
+  @param  Target\r
+  @param  Lun\r
+  @param  Packet\r
+  @param  Event\r
+\r
+  @todo Add function description\r
+  @todo  This - add argument description\r
+  @todo  Target - add argument description\r
+  @todo  Lun - add argument description\r
+  @todo  Packet - add argument description\r
+  @todo  Event - add argument description\r
+  @todo add return values\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 AtapiScsiPassThruFunction (\r
@@ -300,27 +302,20 @@ AtapiScsiPassThruFunction (
   IN OUT EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET         *Packet,\r
   IN EFI_EVENT                                          Event OPTIONAL\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AtapiScsiPassThruGetNextDevice\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This    - TODO: add argument description\r
-  Target  - TODO: add argument description\r
-  Lun     - TODO: add argument description\r
-  Packet  - TODO: add argument description\r
-  Event   - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Target TODO: add argument description\r
+  @param  Lun TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 AtapiScsiPassThruGetNextDevice (\r
@@ -328,25 +323,21 @@ AtapiScsiPassThruGetNextDevice (
   IN OUT UINT32                      *Target,\r
   IN OUT UINT64                      *Lun\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AtapiScsiPassThruBuildDevicePath\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This    - TODO: add argument description\r
-  Target  - TODO: add argument description\r
-  Lun     - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Target TODO: add argument description\r
+  @param  Lun TODO: add argument description\r
+  @param  DevicePath TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 AtapiScsiPassThruBuildDevicePath (\r
@@ -355,26 +346,21 @@ AtapiScsiPassThruBuildDevicePath (
   IN     UINT64                         Lun,\r
   IN OUT EFI_DEVICE_PATH_PROTOCOL       **DevicePath\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AtapiScsiPassThruGetTargetLun\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This        - TODO: add argument description\r
-  Target      - TODO: add argument description\r
-  Lun         - TODO: add argument description\r
-  DevicePath  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  DevicePath TODO: add argument description\r
+  @param  Target TODO: add argument description\r
+  @param  Lun TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 AtapiScsiPassThruGetTargetLun (\r
@@ -383,48 +369,37 @@ AtapiScsiPassThruGetTargetLun (
   OUT UINT32                         *Target,\r
   OUT UINT64                         *Lun\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AtapiScsiPassThruResetChannel\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This        - TODO: add argument description\r
-  DevicePath  - TODO: add argument description\r
-  Target      - TODO: add argument description\r
-  Lun         - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 AtapiScsiPassThruResetChannel (\r
   IN  EFI_SCSI_PASS_THRU_PROTOCOL   *This\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AtapiScsiPassThruResetTarget\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Target TODO: add argument description\r
+  @param  Lun TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 AtapiScsiPassThruResetTarget (\r
@@ -432,92 +407,74 @@ AtapiScsiPassThruResetTarget (
   IN UINT32                         Target,\r
   IN UINT64                         Lun\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  CheckSCSIRequestPacket\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This    - TODO: add argument description\r
-  Target  - TODO: add argument description\r
-  Lun     - TODO: add argument description\r
-\r
-Returns:\r
+  @param  Packet TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 CheckSCSIRequestPacket (\r
   EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET      *Packet\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  SubmitBlockingIoCommand\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  Packet  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  Target TODO: add argument description\r
+  @param  Packet TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 SubmitBlockingIoCommand (\r
   ATAPI_SCSI_PASS_THRU_DEV                  *AtapiScsiPrivate,\r
   UINT32                                    Target,\r
   EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET    *Packet\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  IsCommandValid\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate  - TODO: add argument description\r
-  Target            - TODO: add argument description\r
-  Packet            - TODO: add argument description\r
+  @param Packet  - TODO: add argument description\r
 \r
-Returns:\r
-\r
-  TODO: add return values\r
+  @return TODO: add return values\r
 \r
 --*/\r
-;\r
-\r
 BOOLEAN\r
 IsCommandValid (\r
   EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET   *Packet\r
   )\r
- /*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  RequestSenseCommand\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  Packet  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  Target TODO: add argument description\r
+  @param  Timeout TODO: add argument description\r
+  @param  SenseData TODO: add argument description\r
+  @param  SenseDataLength TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 RequestSenseCommand (\r
   ATAPI_SCSI_PASS_THRU_DEV    *AtapiScsiPrivate,\r
@@ -526,27 +483,24 @@ RequestSenseCommand (
   VOID                        *SenseData,\r
   UINT8                       *SenseDataLength\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AtapiPacketCommand\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate  - TODO: add argument description\r
-  Target            - TODO: add argument description\r
-  Timeout           - TODO: add argument description\r
-  SenseData         - TODO: add argument description\r
-  SenseDataLength   - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  Target TODO: add argument description\r
+  @param  PacketCommand TODO: add argument description\r
+  @param  Buffer TODO: add argument description\r
+  @param  ByteCount TODO: add argument description\r
+  @param  Direction TODO: add argument description\r
+  @param  TimeOutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 AtapiPacketCommand (\r
   ATAPI_SCSI_PASS_THRU_DEV                  *AtapiScsiPrivate,\r
@@ -557,313 +511,236 @@ AtapiPacketCommand (
   DATA_DIRECTION                            Direction,\r
   UINT64                                    TimeOutInMicroSeconds\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
-  TODO: Add function description\r
 \r
-Arguments:\r
+/**\r
+  ReadPortB\r
 \r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  Target                - TODO: add argument description\r
-  PacketCommand         - TODO: add argument description\r
-  Buffer                - TODO: add argument description\r
-  ByteCount             - TODO: add argument description\r
-  Direction             - TODO: add argument description\r
-  TimeOutInMicroSeconds - TODO: add argument description\r
+  TODO: Add function description\r
 \r
-Returns:\r
+  @param  PciIo TODO: add argument description\r
+  @param  Port TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
-\r
+**/\r
 UINT8\r
 ReadPortB (\r
   IN  EFI_PCI_IO_PROTOCOL   *PciIo,\r
   IN  UINT16                Port\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
-  TODO: Add function description\r
 \r
-Arguments:\r
+/**\r
+  ReadPortW\r
 \r
-  PciIo - TODO: add argument description\r
-  Port  - TODO: add argument description\r
+  TODO: Add function description\r
 \r
-Returns:\r
+  @param  PciIo TODO: add argument description\r
+  @param  Port TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
-\r
+**/\r
 UINT16\r
 ReadPortW (\r
   IN  EFI_PCI_IO_PROTOCOL   *PciIo,\r
   IN  UINT16                Port\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
-  TODO: Add function description\r
 \r
-Arguments:\r
+/**\r
+  WritePortB\r
 \r
-  PciIo - TODO: add argument description\r
-  Port  - TODO: add argument description\r
+  TODO: Add function description\r
 \r
-Returns:\r
+  @param  PciIo TODO: add argument description\r
+  @param  Port TODO: add argument description\r
+  @param  Data TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
-\r
+**/\r
 VOID\r
 WritePortB (\r
   IN  EFI_PCI_IO_PROTOCOL   *PciIo,\r
   IN  UINT16                Port,\r
   IN  UINT8                 Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
-  TODO: Add function description\r
 \r
-Arguments:\r
+/**\r
+  WritePortW\r
 \r
-  PciIo - TODO: add argument description\r
-  Port  - TODO: add argument description\r
-  Data  - TODO: add argument description\r
+  TODO: Add function description\r
 \r
-Returns:\r
+  @param  PciIo TODO: add argument description\r
+  @param  Port TODO: add argument description\r
+  @param  Data TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
-\r
+**/\r
 VOID\r
 WritePortW (\r
   IN  EFI_PCI_IO_PROTOCOL   *PciIo,\r
   IN  UINT16                Port,\r
   IN  UINT16                Data\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  StatusDRQClear\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  PciIo - TODO: add argument description\r
-  Port  - TODO: add argument description\r
-  Data  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeOutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 StatusDRQClear (\r
   ATAPI_SCSI_PASS_THRU_DEV        *AtapiScsiPrivate,\r
   UINT64                          TimeOutInMicroSeconds\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AltStatusDRQClear\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeOutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeOutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 AltStatusDRQClear (\r
   ATAPI_SCSI_PASS_THRU_DEV        *AtapiScsiPrivate,\r
   UINT64                          TimeOutInMicroSeconds\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  StatusDRQReady\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeOutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeOutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 StatusDRQReady (\r
   ATAPI_SCSI_PASS_THRU_DEV        *AtapiScsiPrivate,\r
   UINT64                          TimeOutInMicroSeconds\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
+/**\r
+  AltStatusDRQReady\r
 \r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeOutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeOutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 AltStatusDRQReady (\r
   ATAPI_SCSI_PASS_THRU_DEV        *AtapiScsiPrivate,\r
   UINT64                          TimeOutInMicroSeconds\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeOutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeoutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 StatusWaitForBSYClear (\r
   ATAPI_SCSI_PASS_THRU_DEV    *AtapiScsiPrivate,\r
   UINT64                      TimeoutInMicroSeconds\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeoutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeoutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 AltStatusWaitForBSYClear (\r
   ATAPI_SCSI_PASS_THRU_DEV    *AtapiScsiPrivate,\r
   UINT64                      TimeoutInMicroSeconds\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeoutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeoutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 StatusDRDYReady (\r
   ATAPI_SCSI_PASS_THRU_DEV    *AtapiScsiPrivate,\r
   UINT64                      TimeoutInMicroSeconds\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeoutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  TimeoutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 AltStatusDRDYReady (\r
   ATAPI_SCSI_PASS_THRU_DEV    *AtapiScsiPrivate,\r
   UINT64                      TimeoutInMicroSeconds\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  TimeoutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
+  @param  Buffer TODO: add argument description\r
+  @param  ByteCount TODO: add argument description\r
+  @param  Direction TODO: add argument description\r
+  @param  TimeOutInMicroSeconds TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 AtapiPassThruPioReadWriteData (\r
   ATAPI_SCSI_PASS_THRU_DEV  *AtapiScsiPrivate,\r
@@ -872,45 +749,19 @@ AtapiPassThruPioReadWriteData (
   DATA_DIRECTION            Direction,\r
   UINT64                    TimeOutInMicroSeconds\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  AtapiScsiPrivate      - TODO: add argument description\r
-  Buffer                - TODO: add argument description\r
-  ByteCount             - TODO: add argument description\r
-  Direction             - TODO: add argument description\r
-  TimeOutInMicroSeconds - TODO: add argument description\r
-\r
-Returns:\r
+  @param  AtapiScsiPrivate TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 AtapiPassThruCheckErrorStatus (\r
   ATAPI_SCSI_PASS_THRU_DEV        *AtapiScsiPrivate\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  AtapiScsiPrivate  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 #endif\r