1. EDK_RELEASE_VERSION removed;

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciPowerManagement.c

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c
index 4584198a9cb01adba53a521e1cbd17e1b4de5faf..5ebbaf910cbbf18878e8456705eda243fc9a1957 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c
@@ -1,54 +1,36 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006 - 2007, 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
+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
 \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
 \r
-Module Name:\r
+#include "PciBus.h"\r
 \r
-  PciPowerManagement.c\r
-\r
-Abstract:\r
-\r
-  PCI Bus Driver\r
-\r
-Revision History\r
-\r
---*/\r
+/**\r
+  This function is intended to turn off PWE assertion and\r
+  put the device to D0 state if the device supports\r
+  PCI Power Management.\r
 \r
-#include "pcibus.h"\r
+  @param PciIoDevice  Pci device instance\r
 \r
+  @retval EFI_UNSUPPORTED Device do not support power management\r
+  @retval EFI_SUCCESS     Success\r
+**/\r
 EFI_STATUS\r
 ResetPowerManagementFeature (\r
   IN PCI_IO_DEVICE *PciIoDevice\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  This function is intended to turn off PWE assertion and\r
-  put the device to D0 state if the device supports\r
-  PCI Power Management.\r
-\r
-Arguments:\r
-\r
-Returns:\r
-  \r
-  None\r
-\r
---*/\r
-// TODO:    PciIoDevice - add argument and description to function comment\r
-// TODO:    EFI_UNSUPPORTED - add return value to function comment\r
-// TODO:    EFI_SUCCESS - add return value to function comment\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       PowerManagementRegBlock;\r
-  UINT16      PMCSR;\r
+  UINT16      PowerManagementCSR;\r
 \r
   PowerManagementRegBlock = 0;\r
 \r
@@ -66,7 +48,7 @@ Returns:
   //\r
   // Turn off the PWE assertion and put the device into D0 State\r
   //\r
-  PMCSR = 0x8000;\r
+  PowerManagementCSR = 0x8000;\r
 \r
   //\r
   // Write PMCSR\r
@@ -76,8 +58,9 @@ Returns:
                EfiPciIoWidthUint16,\r
                PowerManagementRegBlock + 4,\r
                1,\r
-               &PMCSR\r
+               &PowerManagementCSR\r
              );\r
 \r
   return EFI_SUCCESS;\r
 }\r
+\r