update function header

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiIbft.h

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h
index d07c5b2536df6719dd5578b7915158026cae0202..a21990e3a21ba74a714a2d2c450668786522d281 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h
@@ -1,6 +1,7 @@
-/*++\r
+/** @file\r
+  Some extra definitions for iBFT.\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation.<BR>\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
@@ -9,22 +10,14 @@ 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
-  IScsiIbft.h\r
-\r
-Abstract:\r
-\r
-  Some extra definitions for iBFT.\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _ISCSI_IBFT_H_\r
 #define _ISCSI_IBFT_H_\r
 \r
-#include <industrystandard/IScsiBootFirmwareTable.h>\r
-#include <protocol/AcpiSupport.h>\r
-#include <protocol/PciIo.h>\r
+#include <IndustryStandard/IScsiBootFirmwareTable.h>\r
+#include <Protocol/AcpiSupport.h>\r
+#include <Protocol/PciIo.h>\r
 \r
 #define IBFT_TABLE_VAR_NAME L"iBFT"\r
 #define IBFT_MAX_SIZE       4096\r
@@ -32,9 +25,13 @@ Abstract:
 \r
 #define IBFT_ROUNDUP(size)  NET_ROUNDUP ((size), EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_ALIGNMENT)\r
 \r
+/**\r
+  Publish and remove the iSCSI Boot Firmware Table according to the iSCSI\r
+  session status.\r
+**/\r
 VOID\r
 IScsiPublishIbft (\r
-  IN VOID\r
+  VOID\r
   );\r
 \r
 #endif\r