update file header

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

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
index c3c664d449293eb3c52c72aabf3d262e97ec23f8..e4f2645d310f4b8a38811fbe88b4dfc04a5fccaf 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
@@ -1,6 +1,7 @@
-/*++\r
+/** @file\r
+  The header file of IScsiConfig.c.\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,14 +10,7 @@ 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
-  IScsiConfig.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _ISCSI_CONFIG_H_\r
 #define _ISCSI_CONFIG_H_\r
@@ -28,7 +22,6 @@ Abstract:
 #include <Library/DebugLib.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/NetLib.h>\r
-#include "IScsiConfigNVDataStruc.h"\r
 \r
 extern UINT8  IScsiConfigDxeBin[];\r
 extern UINT8  IScsiDxeStrings[];\r
@@ -65,8 +58,8 @@ typedef struct _ISCSI_CONFIG_FORM_ENTRY {
   LIST_ENTRY                    Link;\r
   EFI_HANDLE                    Controller;\r
   CHAR16                        MacString[95];\r
-  STRING_REF                    PortTitleToken;\r
-  STRING_REF                    PortTitleHelpToken;\r
+  EFI_STRING_ID                 PortTitleToken;\r
+  EFI_STRING_ID                 PortTitleHelpToken;\r
 \r
   ISCSI_SESSION_CONFIG_NVDATA   SessionConfigData;\r
   ISCSI_CHAP_AUTH_CONFIG_NVDATA AuthConfigData;\r
@@ -84,6 +77,18 @@ typedef struct _ISCSI_FORM_CALLBACK_INFO {
   ISCSI_CONFIG_FORM_ENTRY          *Current;\r
 } ISCSI_FORM_CALLBACK_INFO;\r
 \r
+/**\r
+  Updates the iSCSI configuration form to add/delete an entry for the iSCSI\r
+  device specified by the Controller.\r
+\r
+  @param[in]  DriverBindingHandle The driverbinding handle.\r
+  @param[in]  Controller          The controller handle of the iSCSI device.\r
+  @param[in]  AddForm             Whether to add or delete a form entry.\r
+\r
+  @retval EFI_SUCCESS             The iSCSI configuration form is updated.\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
+  @retval Others                  Some unexpected errors happened.\r
+**/\r
 EFI_STATUS\r
 IScsiConfigUpdateForm (\r
   IN EFI_HANDLE  DriverBindingHandle,\r
@@ -91,11 +96,30 @@ IScsiConfigUpdateForm (
   IN BOOLEAN     AddForm\r
   );\r
 \r
+/**\r
+  Initialize the iSCSI configuration form.\r
+\r
+  @param[in]  DriverBindingHandle  The iSCSI driverbinding handle.\r
+\r
+  @retval EFI_SUCCESS              The iSCSI configuration form is initialized.\r
+  @retval EFI_OUT_OF_RESOURCES     Failed to allocate memory.\r
+  @retval Others                   Some unexpected error happened.\r
+**/\r
 EFI_STATUS\r
 IScsiConfigFormInit (\r
   IN EFI_HANDLE  DriverBindingHandle\r
   );\r
 \r
+/**\r
+  Unload the iSCSI configuration form, this includes: delete all the iSCSI\r
+  device configuration entries, uninstall the form callback protocol and\r
+  free the resources used.\r
+\r
+  @param[in]  DriverBindingHandle The iSCSI driverbinding handle.\r
+  \r
+  @retval EFI_SUCCESS             The iSCSI configuration form is unloaded.\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
+**/\r
 EFI_STATUS\r
 IScsiConfigFormUnload (\r
   IN EFI_HANDLE  DriverBindingHandle\r