update file header

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

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c
index 78a1e075f080f07fbaccda56e6b5886d3390f781..127fe9f733989ebb0362766a170733f4badb811a 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c
@@ -1,7 +1,7 @@
 /** @file\r
   Implementation for iSCSI Boot Firmware Table publication.\r
 \r
-Copyright (c) 2004 - 2008, 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
@@ -10,14 +10,6 @@ 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.c\r
-\r
-Abstract:\r
-\r
-  Implementation for iSCSI Boot Firmware Table publication.\r
-\r
 **/\r
 \r
 #include "IScsiImpl.h"\r
@@ -25,10 +17,7 @@ Abstract:
 /**\r
   Initialize the header of the iSCSI Boot Firmware Table.\r
   \r
-  @param  Header[in] The header of the iSCSI Boot Firmware Table.\r
-\r
-  @retval None.\r
-\r
+  @param[in]  Header The header of the iSCSI Boot Firmware Table.\r
 **/\r
 VOID\r
 IScsiInitIbfTableHeader (\r
@@ -52,13 +41,9 @@ IScsiInitIbfTableHeader (
 /**\r
   Initialize the control section of the iSCSI Boot Firmware Table.\r
   \r
-  @param  Table[in]       The ACPI table.\r
-\r
-  @param  HandleCount[in] The number of the handles associated with iSCSI sessions, it's\r
+  @param[in]  Table       The ACPI table.\r
+  @param[in]  HandleCount The number of the handles associated with iSCSI sessions, it's\r
                           equal to the number of iSCSI sessions.\r
-\r
-  @retval None.\r
-\r
 **/\r
 VOID\r
 IScsiInitControlSection (\r
@@ -94,15 +79,10 @@ IScsiInitControlSection (
 /**\r
   Add one item into the heap.\r
 \r
-  @param  Heap[in][out] On input, the current address of the heap; On output, the address of\r
-                        the heap after the item is added.\r
-\r
-  @param  Data[in]      The data to add into the heap.\r
-\r
-  @param  Len[in]       Length of the Data in byte.\r
-\r
-  @retval None.\r
-\r
+  @param[in, out]  Heap  On input, the current address of the heap; On output, the address of\r
+                         the heap after the item is added.\r
+  @param[in]       Data  The data to add into the heap.\r
+  @param[in]       Len   Length of the Data in byte.\r
 **/\r
 VOID\r
 IScsiAddHeapItem (\r
@@ -123,14 +103,9 @@ IScsiAddHeapItem (
 /**\r
   Fill the Initiator section of the iSCSI Boot Firmware Table.\r
 \r
-  @param  Table[in]     The ACPI table.\r
-\r
-  @param  Heap[in][out] The heap.\r
-\r
-  @param  Handle[in]    The handle associated with the iSCSI session.\r
-\r
-  @retval None.\r
-\r
+  @param[in]       Table    The ACPI table.\r
+  @param[in, out]  Heap     The heap.\r
+  @param[in]       Handle   The handle associated with the iSCSI session.\r
 **/\r
 VOID\r
 IScsiFillInitiatorSection (\r
@@ -186,12 +161,8 @@ IScsiFillInitiatorSection (
 /**\r
   Map the v4 IP address into v6 IP address.\r
 \r
-  @param  V4 The v4 IP address.\r
-\r
-  @param  V6 The v6 IP address.\r
-\r
-  @retval None.\r
-\r
+  @param[in]   V4 The v4 IP address.\r
+  @param[out]  V6 The v6 IP address.\r
 **/\r
 VOID\r
 IScsiMapV4ToV6Addr (\r
@@ -215,10 +186,10 @@ IScsiMapV4ToV6Addr (
   Get the NIC's PCI location and return it accroding to the composited\r
   format defined in iSCSI Boot Firmware Table.\r
 \r
-  @param  Controller[in]  The handle of the controller.\r
-\r
-  @retval UINT16          The composited representation of the NIC PCI location.\r
+  @param[in]  Controller  The handle of the controller.\r
 \r
+  @return UINT16          The composited representation of the NIC PCI location.\r
+  @retval 0               Some unexpected error happened.\r
 **/\r
 UINT16\r
 IScsiGetNICPciLocation (\r
@@ -268,10 +239,9 @@ IScsiGetNICPciLocation (
 /**\r
   Get the MAC address of the controller.\r
   \r
-  @param  Controller[in]    The handle of the controller.\r
-\r
-  @retval EFI_MAC_ADDRESS * The mac address.\r
+  @param[in]  Controller    The handle of the controller.\r
 \r
+  @return EFI_MAC_ADDRESS * The mac address.\r
 **/\r
 EFI_MAC_ADDRESS *\r
 IScsiGetMacAddress (\r
@@ -294,16 +264,10 @@ IScsiGetMacAddress (
 /**\r
   Fill the NIC and target sections in iSCSI Boot Firmware Table.\r
 \r
-  @param  Table[in]       The buffer of the ACPI table.\r
-\r
-  @param  Heap[in][out]   The heap buffer used to store the variable length parameters such as iSCSI name.\r
-\r
-  @param  HandleCount[in] The number of handles having iSCSI private protocol installed.\r
-\r
-  @param  Handles[in]     The handle buffer.\r
-\r
-  @retval None.\r
-\r
+  @param[in]       Table       The buffer of the ACPI table.\r
+  @param[in, out]  Heap        The heap buffer used to store the variable length parameters such as iSCSI name.\r
+  @param[in]       HandleCount Count The number of handles having iSCSI private protocol installed.\r
+  @param[in]       Handles     The handle buffer.\r
 **/\r
 VOID\r
 IScsiFillNICAndTargetSections (\r
@@ -469,15 +433,10 @@ IScsiFillNICAndTargetSections (
 /**\r
   Publish and remove the iSCSI Boot Firmware Table according to the iSCSI\r
   session status.\r
-\r
-  @param  None.\r
-\r
-  @retval None.\r
-\r
 **/\r
 VOID\r
 IScsiPublishIbft (\r
-  IN VOID\r
+  VOID  \r
   )\r
 {\r
   EFI_STATUS                                Status;\r