Refine soma code to make code run safely.

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

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
index 92b303976e0a9826ffde9b9614f21b9f7a203eba..77754b896ab8bcacdb8c06339947505fa1d8d8db 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
@@ -1,7 +1,8 @@
-/*++\r
+/** @file\r
+  The header file of IScsiDhcp.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r
+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
@@ -9,13 +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
-  IScsiDhcp.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _ISCSI_DHCP_H_\r
 #define _ISCSI_DHCP_H_\r
@@ -31,25 +26,36 @@ Abstract:
 #define ISCSI_ROOT_PATH_ID              "iscsi:"\r
 #define ISCSI_ROOT_PATH_FIELD_DELIMITER ':'\r
 \r
-enum {\r
-  RP_FIELD_IDX_SERVERNAME = 0,\r
-  RP_FIELD_IDX_PROTOCOL,\r
-  RP_FIELD_IDX_PORT,\r
-  RP_FIELD_IDX_LUN,\r
-  RP_FIELD_IDX_TARGETNAME,\r
-  RP_FIELD_IDX_MAX\r
-};\r
+#define RP_FIELD_IDX_SERVERNAME         0\r
+#define RP_FIELD_IDX_PROTOCOL           1\r
+#define RP_FIELD_IDX_PORT               2\r
+#define RP_FIELD_IDX_LUN                3\r
+#define RP_FIELD_IDX_TARGETNAME         4\r
+#define RP_FIELD_IDX_MAX                5\r
 \r
 typedef struct _ISCSI_ROOT_PATH_FIELD {\r
   CHAR8 *Str;\r
   UINT8 Len;\r
 } ISCSI_ROOT_PATH_FIELD;\r
 \r
+/**\r
+  Parse the DHCP ACK to get the address configuration and DNS information.\r
+  \r
+  @param[in]       Image            The handle of the driver image.\r
+  @param[in]       Controller       The handle of the controller;\r
+  @param[in, out]  ConfigData       The session configuration data.\r
+\r
+  @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.\r
+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory.\r
+  @retval EFI_NO_MEDIA          There was a media error.\r
+  @retval Others                Other errors as indicated.\r
+\r
+**/\r
 EFI_STATUS\r
 IScsiDoDhcp (\r
-  IN EFI_HANDLE                 Image,\r
-  IN EFI_HANDLE                 Controller,\r
-  IN ISCSI_SESSION_CONFIG_DATA  *ConfigData\r
+  IN     EFI_HANDLE                 Image,\r
+  IN     EFI_HANDLE                 Controller,\r
+  IN OUT ISCSI_SESSION_CONFIG_DATA  *ConfigData\r
   );\r
 \r
 #endif\r