git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1459 6f19259b...

[mirror_edk2.git] / EdkModulePkg / Bus / Pci / IdeBus / Dxe / idebus.h

diff --git a/EdkModulePkg/Bus/Pci/IdeBus/Dxe/idebus.h b/EdkModulePkg/Bus/Pci/IdeBus/Dxe/idebus.h
index 428dffa65d42373e75c865728f08058120096e8e..d1721b956fc3b5a474956fac7a9601c222d7595b 100644 (file)
--- a/EdkModulePkg/Bus/Pci/IdeBus/Dxe/idebus.h
+++ b/EdkModulePkg/Bus/Pci/IdeBus/Dxe/idebus.h
@@ -1,25 +1,17 @@
-/*++\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
+/** @file\r
+  Header file for IDE Bus Driver.\r
 \r
-Module Name:\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
-    idebus.h\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
-Abstract:\r
+**/\r
 \r
-    Header file for IDE Bus Driver.\r
-\r
-Revision History\r
-++*/\r
-\r
-// TODO: fix comment to end with --*/\r
 #ifndef _IDE_BUS_H\r
 #define _IDE_BUS_H\r
 \r
@@ -94,30 +86,33 @@ extern EFI_DRIVER_BINDING_PROTOCOL  gIDEBusDriverBinding;
 // Prototypes\r
 // Driver model protocol interface\r
 //\r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  ImageHandle TODO: add argument description\r
+  @param  SystemTable TODO: add argument description\r
+\r
+  TODO: add return values\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBusControllerDriverEntryPoint (\r
   IN EFI_HANDLE                   ImageHandle,\r
   IN EFI_SYSTEM_TABLE             *SystemTable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \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
+  @param  This TODO: add argument description\r
+  @param  Controller TODO: add argument description\r
+  @param  RemainingDevicePath TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBusDriverBindingSupported (\r
@@ -125,25 +120,18 @@ IDEBusDriverBindingSupported (
   IN EFI_HANDLE                   Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This                - TODO: add argument description\r
-  Controller          - TODO: add argument description\r
-  RemainingDevicePath - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Controller TODO: add argument description\r
+  @param  RemainingDevicePath TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBusDriverBindingStart (\r
@@ -151,25 +139,19 @@ IDEBusDriverBindingStart (
   IN EFI_HANDLE                   Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This                - TODO: add argument description\r
-  Controller          - TODO: add argument description\r
-  RemainingDevicePath - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Controller TODO: add argument description\r
+  @param  NumberOfChildren TODO: add argument description\r
+  @param  ChildHandleBuffer TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBusDriverBindingStop (\r
@@ -178,53 +160,40 @@ IDEBusDriverBindingStop (
   IN  UINTN                       NumberOfChildren,\r
   IN  EFI_HANDLE                  *ChildHandleBuffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+//\r
+// Block I/O Protocol Interface\r
+//\r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This              - TODO: add argument description\r
-  Controller        - TODO: add argument description\r
-  NumberOfChildren  - TODO: add argument description\r
-  ChildHandleBuffer - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  ExtendedVerification TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
-//\r
-// Block I/O Protocol Interface\r
-//\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBlkIoReset (\r
   IN  EFI_BLOCK_IO_PROTOCOL       *This,\r
   IN  BOOLEAN                     ExtendedVerification\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This                  - TODO: add argument description\r
-  ExtendedVerification  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  MediaId TODO: add argument description\r
+  @param  LBA TODO: add argument description\r
+  @param  BufferSize TODO: add argument description\r
+  @param  Buffer TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBlkIoReadBlocks (\r
@@ -234,27 +203,20 @@ IDEBlkIoReadBlocks (
   IN  UINTN                       BufferSize,\r
   OUT VOID                        *Buffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This        - TODO: add argument description\r
-  MediaId     - TODO: add argument description\r
-  LBA         - TODO: add argument description\r
-  BufferSize  - TODO: add argument description\r
-  Buffer      - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  MediaId TODO: add argument description\r
+  @param  LBA TODO: add argument description\r
+  @param  BufferSize TODO: add argument description\r
+  @param  Buffer TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBlkIoWriteBlocks (\r
@@ -264,72 +226,49 @@ IDEBlkIoWriteBlocks (
   IN  UINTN                       BufferSize,\r
   IN  VOID                        *Buffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This        - TODO: add argument description\r
-  MediaId     - TODO: add argument description\r
-  LBA         - TODO: add argument description\r
-  BufferSize  - TODO: add argument description\r
-  Buffer      - 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
 IDEBlkIoFlushBlocks (\r
   IN  EFI_BLOCK_IO_PROTOCOL       *This\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  PciIo TODO: add argument description\r
+  @param  Enable TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 IDERegisterDecodeEnableorDisable (\r
   IN  EFI_PCI_IO_PROTOCOL         *PciIo,\r
   IN  BOOLEAN                     Enable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  PciIo   - TODO: add argument description\r
-  Enable  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  InquiryData TODO: add argument description\r
+  @param  IntquiryDataSize TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEDiskInfoInquiry (\r
@@ -337,25 +276,18 @@ IDEDiskInfoInquiry (
   IN OUT VOID                     *InquiryData,\r
   IN OUT UINT32                   *IntquiryDataSize\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This              - TODO: add argument description\r
-  InquiryData       - TODO: add argument description\r
-  IntquiryDataSize  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  IdentifyData TODO: add argument description\r
+  @param  IdentifyDataSize TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEDiskInfoIdentify (\r
@@ -363,25 +295,19 @@ IDEDiskInfoIdentify (
   IN OUT VOID                     *IdentifyData,\r
   IN OUT UINT32                   *IdentifyDataSize\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This              - TODO: add argument description\r
-  IdentifyData      - TODO: add argument description\r
-  IdentifyDataSize  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  SenseData TODO: add argument description\r
+  @param  SenseDataSize TODO: add argument description\r
+  @param  SenseDataNumber TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEDiskInfoSenseData (\r
@@ -390,26 +316,18 @@ IDEDiskInfoSenseData (
   IN OUT UINT32                   *SenseDataSize,\r
   OUT UINT8                       *SenseDataNumber\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This            - TODO: add argument description\r
-  SenseData       - TODO: add argument description\r
-  SenseDataSize   - TODO: add argument description\r
-  SenseDataNumber - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  IdeChannel TODO: add argument description\r
+  @param  IdeDevice TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEDiskInfoWhichIde (\r
@@ -417,23 +335,6 @@ IDEDiskInfoWhichIde (
   OUT UINT32                      *IdeChannel,\r
   OUT UINT32                      *IdeDevice\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  This        - TODO: add argument description\r
-  IdeChannel  - TODO: add argument description\r
-  IdeDevice   - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 \r
 #endif\r