[Description]

[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..8f48be9a1402e5ef17af1b0493cd1fe05587bf94 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\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
@@ -15,8 +16,9 @@ Module Name:
 \r
 Abstract:\r
 \r
+  The header file of IScsiConfig.c\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _ISCSI_CONFIG_H_\r
 #define _ISCSI_CONFIG_H_\r
@@ -84,6 +86,21 @@ 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  DriverBindingHandle[in] The driverbinding handle.\r
+\r
+  @param  Controller[in]          The controller handle of the iSCSI device.\r
+\r
+  @param  AddForm[in]             Whether to add or delete a form entry.\r
+\r
+  @retval EFI_SUCCESS             The iSCSI configuration form is updated.\r
+\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
+\r
+**/\r
 EFI_STATUS\r
 IScsiConfigUpdateForm (\r
   IN EFI_HANDLE  DriverBindingHandle,\r
@@ -91,11 +108,33 @@ IScsiConfigUpdateForm (
   IN BOOLEAN     AddForm\r
   );\r
 \r
+/**\r
+  Initialize the iSCSI configuration form.\r
+\r
+  @param  DriverBindingHandle[in] The iSCSI driverbinding handle.\r
+\r
+  @retval EFI_SUCCESS             The iSCSI configuration form is initialized.\r
+\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
+\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  DriverBindingHandle[in] The iSCSI driverbinding handle.\r
+\r
+  @retval EFI_SUCCESS             The iSCSI configuration form is unloaded.\r
+\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
+\r
+**/\r
 EFI_STATUS\r
 IScsiConfigFormUnload (\r
   IN EFI_HANDLE  DriverBindingHandle\r