Add function doxygen header for PciBus module.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciCommand.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciCommand.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciCommand.h
index e63d0d15254b0c460d94a81ff31a80e92d062563..f838395ea8b83a97a3e134831f81a1ab0b030e19 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciCommand.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciCommand.h
@@ -1,4 +1,4 @@
-/*++\r
+/**@file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -9,17 +9,8 @@ http://opensource.org/licenses/bsd-license.php
 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
-  \r
-    PciCommand.h\r
-  \r
-Abstract:\r
-\r
-  PCI Bus Driver\r
-\r
-Revision History\r
+**/\r
 \r
---*/\r
 \r
 #ifndef _EFI_PCI_COMMAND_H\r
 #define _EFI_PCI_COMMAND_H\r
@@ -70,6 +61,17 @@ Revision History
 #define EFI_ENABLE_REGISTER   3\r
 #define EFI_DISABLE_REGISTER  4\r
 \r
+/**\r
+  Operate the PCI register via PciIo function interface.\r
+  \r
+  @param PciIoDevice    Pointer to instance of PCI_IO_DEVICE\r
+  @param Command        Operator command\r
+  @param Offset         The address within the PCI configuration space for the PCI controller.\r
+  @param Operation      Type of Operation\r
+  @param PtrCommand     Return buffer holding old PCI command, if operation is not EFI_SET_REGISTER\r
+  \r
+  @return status of PciIo operation\r
+**/\r
 EFI_STATUS\r
 PciOperateRegister (\r
   IN  PCI_IO_DEVICE *PciIoDevice,\r
@@ -78,48 +80,34 @@ PciOperateRegister (
   IN  UINT8         Operation,\r
   OUT UINT16        *PtrCommand\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciIoDevice - TODO: add argument description\r
-  Command     - TODO: add argument description\r
-  Offset      - TODO: add argument description\r
-  Operation   - TODO: add argument description\r
-  PtrCommand  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 \r
+/**\r
+  check the cpability of this device supports\r
+  \r
+  @param PciIoDevice  Pointer to instance of PCI_IO_DEVICE\r
+  \r
+  @retval TRUE  Support\r
+  @retval FALSE Not support\r
+**/\r
 BOOLEAN\r
 PciCapabilitySupport (\r
   IN PCI_IO_DEVICE  *PciIoDevice\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciIoDevice - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 \r
+/**\r
+  Locate cap reg.\r
+  \r
+  @param PciIoDevice         - A pointer to the PCI_IO_DEVICE.\r
+  @param CapId               - The cap ID.\r
+  @param Offset              - A pointer to the offset.\r
+  @param NextRegBlock        - A pointer to the next block.\r
+  \r
+  @retval EFI_UNSUPPORTED  Pci device does not support\r
+  @retval EFI_NOT_FOUND    Pci device support but can not find register block.\r
+  @retval EFI_SUCCESS      Success to locate capability register block\r
+**/\r
 EFI_STATUS\r
 LocateCapabilityRegBlock (\r
   IN PCI_IO_DEVICE  *PciIoDevice,\r
@@ -127,24 +115,6 @@ LocateCapabilityRegBlock (
   IN OUT UINT8      *Offset,\r
   OUT UINT8         *NextRegBlock OPTIONAL\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciIoDevice   - TODO: add argument description\r
-  CapId         - TODO: add argument description\r
-  Offset        - TODO: add argument description\r
-  NextRegBlock  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 \r
 \r