]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDhcp.c
Use siaddr in DHCP packet, if zero, use option 54 instead.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcDhcp.c
index c70390ab2e72c9375c78c5b829e84df0e7c7bbd4..5e86cf5779e6cc10e2789bc221dcaaad79820c5e 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2007, Intel Corporation\r
+  Support for PxeBc dhcp functions.\r
+  \r
+Copyright (c) 2007 - 2009, 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,15 +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
-  PxeBcDhcp.c\r
-\r
-Abstract:\r
-\r
-  Support for PxeBc dhcp functions\r
-\r
-\r
 **/\r
 \r
 \r
@@ -38,12 +30,12 @@ UINT8 mInterestedDhcp4Tags[PXEBC_DHCP4_TAG_INDEX_MAX] = {
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  This function initialize the DHCP4 message instance.\r
 \r
-  @param  Seed                  GC_NOTO: add argument description\r
-  @param  Udp4                  GC_NOTO: add argument description\r
-\r
-  @return GC_NOTO: add return values\r
+  This function will pad each item of dhcp4 message packet.\r
+  \r
+  @param  Seed    Pointer to the message instance of the DHCP4 packet.\r
+  @param  Udp4    Pointer to the EFI_UDP4_PROTOCOL instance.\r
 \r
 **/\r
 VOID\r
@@ -74,12 +66,10 @@ PxeBcInitSeedPacket (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
-\r
-  @param  Dst                   GC_NOTO: add argument description\r
-  @param  Src                   GC_NOTO: add argument description\r
+  Copy the DCHP4 packet from srouce to destination.\r
 \r
-  @return GC_NOTO: add return values\r
+  @param  Dst   Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+  @param  Src   Pointer to the EFI_DHCP4_PROTOCOL instance.\r
 \r
 **/\r
 VOID\r
@@ -96,12 +86,11 @@ PxeBcCopyEfiDhcp4Packet (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
-\r
-  @param  Private               GC_NOTO: add argument description\r
-  @param  OfferIndex            GC_NOTO: add argument description\r
+  Copy the dhcp4 packet to the PxeBc private data and parse the dhcp4 packet.\r
 \r
-  @return GC_NOTO: add return values\r
+  @param  Private       Pointer to PxeBc private data.\r
+  @param  OfferIndex    Index of cached packets as complements of pxe mode data,\r
+                        the index is maximum offer number.\r
 \r
 **/\r
 VOID\r
@@ -114,6 +103,7 @@ PxeBcCopyProxyOffer (
   EFI_DHCP4_PACKET        *Offer;\r
 \r
   ASSERT (OfferIndex < Private->NumOffers);\r
+  ASSERT (OfferIndex < PXEBC_MAX_OFFER_NUM);\r
 \r
   Mode  = Private->PxeBc.Mode;\r
   Offer = &Private->Dhcp4Offers[OfferIndex].Packet.Offer;\r
@@ -129,10 +119,10 @@ PxeBcCopyProxyOffer (
 /**\r
   Parse the cached dhcp packet.\r
 \r
-  @param  CachedPacket          Pointer to cached dhcp packet\r
+  @param  CachedPacket  Pointer to cached dhcp packet.\r
 \r
-  @return TRUE  : Success to parse and validation\r
-  @return FALSE : Fail to parse or validation\r
+  @retval TRUE          Succeed to parse and validation.\r
+  @retval FALSE         Fail to parse or validation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -206,7 +196,7 @@ PxeBcParseCachedDhcpPacket (
     // And do not count dhcp option header, or else will destory the serverhostname.\r
     //\r
     Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] = (EFI_DHCP4_PACKET_OPTION *) (&Offer->Dhcp4.Header.BootFileName[0] -\r
-                                            EFI_FIELD_OFFSET (EFI_DHCP4_PACKET_OPTION, Data[0]));\r
+                                            OFFSET_OF (EFI_DHCP4_PACKET_OPTION, Data[0]));\r
 \r
   }\r
 \r
@@ -256,13 +246,16 @@ PxeBcParseCachedDhcpPacket (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  Offer dhcp service with a BINL dhcp offer.\r
 \r
-  @param  Private               GC_NOTO: add argument description\r
-  @param  Index                 GC_NOTO: add argument description\r
-\r
-  @return GC_NOTO: add return values\r
+  @param  Private   Pointer to PxeBc private data.\r
+  @param  Index     Index of cached packets as complements of pxe mode data,\r
+                    the index is maximum offer number.\r
 \r
+  @retval TRUE      Offer the service successfully under priority BINL.\r
+  @retval FALSE     Boot Service failed, parse cached dhcp packet failed or this \r
+                    BINL ack cannot find options set or bootfile name specified.\r
+  \r
 **/\r
 BOOLEAN\r
 PxeBcTryBinl (\r
@@ -276,23 +269,31 @@ PxeBcTryBinl (
   PXEBC_CACHED_DHCP4_PACKET *CachedPacket;\r
   EFI_DHCP4_PACKET          *Reply;\r
 \r
+  ASSERT (Index < PXEBC_MAX_OFFER_NUM);\r
   ASSERT (Private->Dhcp4Offers[Index].OfferType == DHCP4_PACKET_TYPE_BINL);\r
 \r
   Offer = &Private->Dhcp4Offers[Index].Packet.Offer;\r
-  if (Offer->Dhcp4.Header.ServerAddr.Addr[0] == 0) {\r
-    //\r
-    // next server ip address is zero, use server id option instead.\r
-    //\r
+\r
+  //\r
+  // Use siaddr(next server) in DHCPOFFER packet header, if zero, use option 54(server identifier)\r
+  // in DHCPOFFER packet.\r
+  // (It does not comply with PXE Spec, Ver2.1)\r
+  //\r
+  if (EFI_IP4_EQUAL (&Offer->Dhcp4.Header.ServerAddr.Addr, &mZeroIp4Addr)) {\r
     CopyMem (\r
       &ServerIp.Addr[0],\r
       Private->Dhcp4Offers[Index].Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_SERVER_ID]->Data,\r
       sizeof (EFI_IPv4_ADDRESS)\r
       );\r
   } else {\r
-    //\r
-    // use next server ip address.\r
-    //\r
-    CopyMem (&ServerIp.Addr[0], &Offer->Dhcp4.Header.ServerAddr, sizeof (EFI_IPv4_ADDRESS));\r
+    CopyMem (\r
+      &ServerIp.Addr[0], \r
+      &Offer->Dhcp4.Header.ServerAddr, \r
+      sizeof (EFI_IPv4_ADDRESS)\r
+      );\r
+  }\r
+  if (ServerIp.Addr[0] == 0) {\r
+    return FALSE;\r
   }\r
 \r
   CachedPacket = &Private->ProxyOffer;\r
@@ -334,12 +335,13 @@ PxeBcTryBinl (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  Offer dhcp service for each proxy with a BINL dhcp offer.\r
 \r
-  @param  Private               GC_NOTO: add argument description\r
-  @param  OfferIndex            GC_NOTO: add argument description\r
+  @param  Private     Pointer to PxeBc private data\r
+  @param  OfferIndex  Pointer to the index of cached packets as complements of \r
+                      pxe mode data, the index is maximum offer number.\r
 \r
-  @return GC_NOTO: add return values\r
+  @return If there is no service needed offer return FALSE, otherwise TRUE.\r
 \r
 **/\r
 BOOLEAN\r
@@ -366,11 +368,14 @@ PxeBcTryBinlProxy (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  This function is to check the selected proxy offer (include BINL dhcp offer and\r
+  DHCP_ONLY offer ) and set the flag and copy the DHCP packets to the Pxe base code\r
+  mode structure.\r
 \r
-  @param  Private               GC_NOTO: add argument description\r
+  @param  Private          Pointer to PxeBc private data.\r
 \r
-  @return GC_NOTO: add return values\r
+  @retval EFI_SUCCESS      Operational successful.\r
+  @retval EFI_NO_RESPONSE  Offer dhcp service failed.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -401,72 +406,84 @@ PxeBcCheckSelectedOffer (
     if (!PxeBcTryBinl (Private, Private->SelectedOffer - 1)) {\r
       Status = EFI_NO_RESPONSE;\r
     }\r
-  } else if ((SelectedOffer->OfferType == DHCP4_PACKET_TYPE_DHCP_ONLY) &&\r
-           (Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL)) {\r
+  } else if (SelectedOffer->OfferType == DHCP4_PACKET_TYPE_DHCP_ONLY) {\r
     //\r
-    // The selected offer to finish the D.O.R.A. is a DHCP only offer and\r
-    // bootfile name is not provided in this offer, we need try proxy offers\r
-    // to get the bootfile name or the discovery info\r
+    // The selected offer to finish the D.O.R.A. is a DHCP only offer, we need \r
+    // try proxy offers if there are some, othewise the bootfile name must be \r
+    // set in this DHCP only offer.\r
     //\r
-    ProxyOfferIndex = Private->NumOffers;\r
-\r
-    if (Private->SortOffers) {\r
+    if (Private->GotProxyOffer) {\r
       //\r
-      // Choose proxy offer from the type we stored during DHCP offer selection\r
+      // Get rid of the compiler warning.\r
       //\r
-      ASSERT (Private->ProxyIndex[Private->ProxyOfferType] > 0);\r
-\r
-      if (Private->ProxyOfferType == DHCP4_PACKET_TYPE_BINL) {\r
+      ProxyOfferIndex = 0;\r
+      if (Private->SortOffers) {\r
         //\r
-        // We buffer all received BINL proxy offers, try them all one by one\r
+        // The offers are sorted before selecting, the proxy offer type must be\r
+        // already determined.\r
         //\r
-        if (!PxeBcTryBinlProxy (Private, &ProxyOfferIndex)) {\r
-          Status = EFI_NO_RESPONSE;\r
+        ASSERT (Private->ProxyIndex[Private->ProxyOfferType] > 0);\r
+\r
+        if (Private->ProxyOfferType == DHCP4_PACKET_TYPE_BINL) {\r
+          //\r
+          // We buffer all received BINL proxy offers, try them all one by one\r
+          //\r
+          if (!PxeBcTryBinlProxy (Private, &ProxyOfferIndex)) {\r
+            Status = EFI_NO_RESPONSE;\r
+          }\r
+        } else {\r
+          //\r
+          // For other types, only one proxy offer is buffered.\r
+          //\r
+          ProxyOfferIndex = Private->ProxyIndex[Private->ProxyOfferType] - 1;\r
         }\r
       } else {\r
         //\r
-        // For other types, only one proxy offer is buffered.\r
+        // The proxy offer type is not determined, choose proxy offer in the \r
+        // received order.\r
         //\r
-        ProxyOfferIndex = Private->ProxyIndex[Private->ProxyOfferType] - 1;\r
-      }\r
-    } else {\r
-      //\r
-      // Choose proxy offer in the received order.\r
-      //\r
-      Status = EFI_NO_RESPONSE;\r
-\r
-      for (Index = 0; Index < Private->NumOffers; Index++) {\r
+        Status = EFI_NO_RESPONSE;\r
 \r
-        Offer = &Private->Dhcp4Offers[Index].Packet.Offer;\r
-        if (!IS_PROXY_DHCP_OFFER (Offer)) {\r
-          //\r
-          // Skip non proxy dhcp offers.\r
-          //\r
-          continue;\r
-        }\r
+        for (Index = 0; Index < Private->NumOffers; Index++) {\r
 \r
-        if (Private->Dhcp4Offers[Index].OfferType == DHCP4_PACKET_TYPE_BINL) {\r
-          //\r
-          // Try BINL\r
-          //\r
-          if (!PxeBcTryBinl (Private, Index)) {\r
+          Offer = &Private->Dhcp4Offers[Index].Packet.Offer;\r
+          if (!IS_PROXY_DHCP_OFFER (Offer)) {\r
             //\r
-            // Failed, skip to the next offer\r
+            // Skip non proxy dhcp offers.\r
             //\r
             continue;\r
           }\r
-        }\r
 \r
-        Status = EFI_SUCCESS;\r
-        break;\r
+          if (Private->Dhcp4Offers[Index].OfferType == DHCP4_PACKET_TYPE_BINL) {\r
+            //\r
+            // Try BINL\r
+            //\r
+            if (!PxeBcTryBinl (Private, Index)) {\r
+              //\r
+              // Failed, skip to the next offer\r
+              //\r
+              continue;\r
+            }\r
+          }\r
+\r
+          Private->ProxyOfferType = Private->Dhcp4Offers[Index].OfferType;\r
+          ProxyOfferIndex         = Index;\r
+          Status                  = EFI_SUCCESS;\r
+          break;\r
+        }\r
       }\r
-    }\r
 \r
-    if (!EFI_ERROR (Status) && (Private->ProxyOfferType != DHCP4_PACKET_TYPE_BINL)) {\r
+      if (!EFI_ERROR (Status) && (Private->ProxyOfferType != DHCP4_PACKET_TYPE_BINL)) {\r
+        //\r
+        // Copy the proxy offer to Mode and set the flag\r
+        //\r
+        PxeBcCopyProxyOffer (Private, ProxyOfferIndex);\r
+      }\r
+    } else {\r
       //\r
-      // Copy the proxy offer to Mode and set the flag\r
+      // No proxy offer is received, the bootfile name MUST be set.\r
       //\r
-      PxeBcCopyProxyOffer (Private, ProxyOfferIndex);\r
+      ASSERT (Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] != NULL);\r
     }\r
   }\r
 \r
@@ -506,12 +523,10 @@ PxeBcCheckSelectedOffer (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  Cache the Dhcp4 packet offer, Parse and validate each option of the packet.\r
 \r
-  @param  Private               GC_NOTO: add argument description\r
-  @param  RcvdOffer             GC_NOTO: add argument description\r
-\r
-  @return GC_NOTO: add return values\r
+  @param  Private    Pointer to PxeBc private data.\r
+  @param  RcvdOffer  Pointer to the received Dhcp proxy offer packet.\r
 \r
 **/\r
 VOID\r
@@ -540,6 +555,7 @@ PxeBcCacheDhcpOffer (
   }\r
 \r
   OfferType = CachedOffer->OfferType;\r
+  ASSERT (OfferType < DHCP4_PACKET_TYPE_MAX);\r
 \r
   if (OfferType == DHCP4_PACKET_TYPE_BOOTP) {\r
 \r
@@ -560,6 +576,8 @@ PxeBcCacheDhcpOffer (
       //\r
       // It's a proxy dhcp offer with no your address, including pxe10, wfm11a or binl offer.\r
       //\r
+      Private->GotProxyOffer = TRUE;\r
+\r
       if (OfferType == DHCP4_PACKET_TYPE_BINL) {\r
         //\r
         // Cache all binl offers.\r
@@ -581,6 +599,7 @@ PxeBcCacheDhcpOffer (
       //\r
       // It's a dhcp offer with your address.\r
       //\r
+      ASSERT (Private->ServerCount[OfferType] < PXEBC_MAX_OFFER_NUM);\r
       Private->OfferIndex[OfferType][Private->ServerCount[OfferType]] = Private->NumOffers;\r
       Private->ServerCount[OfferType]++;\r
     }\r
@@ -594,11 +613,10 @@ PxeBcCacheDhcpOffer (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
-\r
-  @param  Private               GC_NOTO: add argument description\r
-\r
-  @return GC_NOTO: add return values\r
+  Select the specified proxy offer, such as BINL, DHCP_ONLY and so on.\r
+  If the proxy does not exist, try offers with bootfile.\r
+  \r
+  @param  Private   Pointer to PxeBc private data.\r
 \r
 **/\r
 VOID\r
@@ -609,7 +627,6 @@ PxeBcSelectOffer (
   UINT32            Index;\r
   UINT32            OfferIndex;\r
   EFI_DHCP4_PACKET  *Offer;\r
-  BOOLEAN           GotProxyOffer;\r
 \r
   Private->SelectedOffer = 0;\r
 \r
@@ -688,15 +705,6 @@ PxeBcSelectOffer (
     //\r
     // Try the offers in the received order.\r
     //\r
-    GotProxyOffer = FALSE;\r
-    for (Index = 0; Index < DHCP4_PACKET_TYPE_MAX; Index++) {\r
-\r
-      GotProxyOffer = (BOOLEAN) (Private->ProxyIndex[Index] > 0);\r
-      if (GotProxyOffer) {\r
-        break;\r
-      }\r
-    }\r
-\r
     for (Index = 0; Index < Private->NumOffers; Index++) {\r
 \r
       Offer = &Private->Dhcp4Offers[Index].Packet.Offer;\r
@@ -709,7 +717,7 @@ PxeBcSelectOffer (
       }\r
 \r
       if ((Private->Dhcp4Offers[Index].OfferType == DHCP4_PACKET_TYPE_DHCP_ONLY) &&\r
-          ((!GotProxyOffer) && (Private->Dhcp4Offers[Index].Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL))) {\r
+          ((!Private->GotProxyOffer) && (Private->Dhcp4Offers[Index].Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL))) {\r
         //\r
         // DHCP only offer but no proxy offer received and no bootfile option in this offer\r
         //\r
@@ -724,20 +732,36 @@ PxeBcSelectOffer (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
-\r
-  @param  This                  GC_NOTO: add argument description\r
-  @param  Context               GC_NOTO: add argument description\r
-  @param  CurrentState          GC_NOTO: add argument description\r
-  @param  Dhcp4Event            GC_NOTO: add argument description\r
-  @param  Packet                GC_NOTO: add argument description\r
-  @param  NewPacket             GC_NOTO: add argument description\r
-\r
-  @retval EFI_SUCCESS           GC_NOTO: Add description for return value\r
-  @retval EFI_ABORTED           GC_NOTO: Add description for return value\r
+  Callback routine.\r
+  \r
+  EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver\r
+  to intercept events that occurred in the configuration process. This structure\r
+  provides advanced control of each state transition of the DHCP process. The\r
+  returned status code determines the behavior of the EFI DHCPv4 Protocol driver.\r
+  There are three possible returned values, which are described in the following\r
+  table.\r
+\r
+  @param  This                  Pointer to the EFI DHCPv4 Protocol instance that is used to\r
+                                configure this callback function.\r
+  @param  Context               Pointer to the context that is initialized by\r
+                                EFI_DHCP4_PROTOCOL.Configure().\r
+  @param  CurrentState          The current operational state of the EFI DHCPv4 Protocol\r
+                                driver.\r
+  @param  Dhcp4Event            The event that occurs in the current state, which usually means a\r
+                                state transition.\r
+  @param  Packet                The DHCP packet that is going to be sent or already received.\r
+  @param  NewPacket             The packet that is used to replace the above Packet.\r
+\r
+  @retval EFI_SUCCESS           Tells the EFI DHCPv4 Protocol driver to continue the DHCP process.\r
+  @retval EFI_NOT_READY         Only used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol\r
+                                driver will continue to wait for more DHCPOFFER packets until the retry\r
+                                timeout expires.\r
+  @retval EFI_ABORTED           Tells the EFI DHCPv4 Protocol driver to abort the current process and\r
+                                return to the Dhcp4Init or Dhcp4InitReboot state.\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 PxeBcDhcpCallBack (\r
   IN EFI_DHCP4_PROTOCOL                * This,\r
   IN VOID                              *Context,\r
@@ -874,13 +898,14 @@ PxeBcDhcpCallBack (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  Initialize the DHCP options and build the option list.\r
 \r
-  @param  Private               GC_NOTO: add argument description\r
-  @param  OptList               GC_NOTO: add argument description\r
-  @param  IsDhcpDiscover        GC_NOTO: add argument description\r
+  @param  Private          Pointer to PxeBc private data.\r
+  @param  OptList          Pointer to a DHCP option list.\r
+                           \r
+  @param  IsDhcpDiscover   Discover dhcp option or not.     \r
 \r
-  @return GC_NOTO: add return values\r
+  @return The index item number of the option list.\r
 \r
 **/\r
 UINT32\r
@@ -989,9 +1014,15 @@ PxeBcBuildDhcpOptions (
   OptList[Index]->OpCode  = PXEBC_PXE_DHCP4_TAG_UNDI;\r
   OptList[Index]->Length  = sizeof (PXEBC_DHCP4_OPTION_UNDI);\r
   OptEnt.Undi             = (PXEBC_DHCP4_OPTION_UNDI *) OptList[Index]->Data;\r
-  OptEnt.Undi->Type       = Private->Nii->Type;\r
-  OptEnt.Undi->MajorVer   = Private->Nii->MajorVer;\r
-  OptEnt.Undi->MinorVer   = Private->Nii->MinorVer;\r
+  if (Private->Nii != NULL) {\r
+    OptEnt.Undi->Type       = Private->Nii->Type;\r
+    OptEnt.Undi->MajorVer   = Private->Nii->MajorVer;\r
+    OptEnt.Undi->MinorVer   = Private->Nii->MinorVer;\r
+  } else {\r
+    OptEnt.Undi->Type       = DEFAULT_UNDI_TYPE;\r
+    OptEnt.Undi->MajorVer   = DEFAULT_UNDI_MAJOR;\r
+    OptEnt.Undi->MinorVer   = DEFAULT_UNDI_MINOR;\r
+  }\r
 \r
   Index++;\r
   OptList[Index] = GET_NEXT_DHCP_OPTION (OptList[Index - 1]);\r
@@ -1015,9 +1046,16 @@ PxeBcBuildDhcpOptions (
   OptEnt.Clid             = (PXEBC_DHCP4_OPTION_CLID *) OptList[Index]->Data;\r
   CopyMem (OptEnt.Clid, DEFAULT_CLASS_ID_DATA, sizeof (PXEBC_DHCP4_OPTION_CLID));\r
   CvtNum (SYS_ARCH, OptEnt.Clid->ArchitectureType, sizeof (OptEnt.Clid->ArchitectureType));\r
-  CopyMem (OptEnt.Clid->InterfaceName, Private->Nii->StringId, sizeof (OptEnt.Clid->InterfaceName));\r
-  CvtNum (Private->Nii->MajorVer, OptEnt.Clid->UndiMajor, sizeof (OptEnt.Clid->UndiMajor));\r
-  CvtNum (Private->Nii->MinorVer, OptEnt.Clid->UndiMinor, sizeof (OptEnt.Clid->UndiMinor));\r
+\r
+  if (Private->Nii != NULL) {\r
+    // \r
+    // If NII protocol exists, update DHCP option data\r
+    //\r
+    CopyMem (OptEnt.Clid->InterfaceName, Private->Nii->StringId, sizeof (OptEnt.Clid->InterfaceName));\r
+    CvtNum (Private->Nii->MajorVer, OptEnt.Clid->UndiMajor, sizeof (OptEnt.Clid->UndiMajor));\r
+    CvtNum (Private->Nii->MinorVer, OptEnt.Clid->UndiMinor, sizeof (OptEnt.Clid->UndiMinor));\r
+  }\r
+\r
   Index++;\r
 \r
   return Index;\r
@@ -1025,20 +1063,23 @@ PxeBcBuildDhcpOptions (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
-\r
-  @param  Private               GC_NOTO: add argument description\r
-  @param  Type                  GC_NOTO: add argument description\r
-  @param  Layer                 GC_NOTO: add argument description\r
-  @param  UseBis                GC_NOTO: add argument description\r
-  @param  DestIp                GC_NOTO: add argument description\r
-  @param  IpCount               GC_NOTO: add argument description\r
-  @param  SrvList               GC_NOTO: add argument description\r
-  @param  IsDiscv               GC_NOTO: add argument description\r
-  @param  Reply                 GC_NOTO: add argument description\r
-\r
-  @retval EFI_OUT_OF_RESOURCES  GC_NOTO: Add description for return value\r
-\r
+  Discover the boot of service and initialize the vendor option if exists.\r
+\r
+  @param  Private               Pointer to PxeBc private data.\r
+  @param  Type                  PxeBc option boot item type\r
+  @param  Layer                 PxeBc option boot item layer\r
+  @param  UseBis                Use BIS or not\r
+  @param  DestIp                Ip address for server      \r
+  @param  IpCount               The total count of the server ip address    \r
+  @param  SrvList               Server list\r
+  @param  IsDiscv               Discover the vendor or not\r
+  @param  Reply                 The dhcp4 packet of Pxe reply\r
+\r
+  @retval EFI_SUCCESS           Operation succeeds.\r
+  @retval EFI_OUT_OF_RESOURCES  Allocate memory pool failed.\r
+  @retval EFI_NOT_FOUND         There is no vendor option exists.\r
+  @retval EFI_TIMEOUT           Send Pxe Discover time out. \r
+  \r
 **/\r
 EFI_STATUS\r
 PxeBcDiscvBootService (\r
@@ -1071,7 +1112,7 @@ PxeBcDiscvBootService (
   UINT8                               VendorOptLen;\r
   CHAR8                               *SystemSerialNumber;\r
   EFI_DHCP4_HEADER                    *DhcpHeader;\r
-\r
+  UINT32                              Xid;\r
 \r
   Mode      = Private->PxeBc.Mode;\r
   Dhcp4     = Private->Dhcp4;\r
@@ -1094,6 +1135,7 @@ PxeBcDiscvBootService (
   OptCount = PxeBcBuildDhcpOptions (Private, OptList, FALSE);\r
 \r
   if (IsDiscv) {\r
+    ASSERT (Layer != NULL);\r
     //\r
     // Add vendor option of PXE_BOOT_ITEM\r
     //\r
@@ -1137,14 +1179,15 @@ PxeBcDiscvBootService (
 \r
     DhcpHeader->HwAddrLen = sizeof (EFI_GUID);\r
   }\r
-\r
-  Token.Packet->Dhcp4.Header.Xid      = NET_RANDOM (NetRandomInitSeed ());\r
-  Token.Packet->Dhcp4.Header.Reserved = (UINT16) ((IsBCast) ? 0xf000 : 0x0);\r
+       \r
+  Xid                                 = NET_RANDOM (NetRandomInitSeed ());\r
+  Token.Packet->Dhcp4.Header.Xid      = HTONL(Xid);\r
+  Token.Packet->Dhcp4.Header.Reserved = HTONS((IsBCast) ? 0x8000 : 0);\r
   CopyMem (&Token.Packet->Dhcp4.Header.ClientAddr, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r
 \r
   Token.RemotePort = Sport;\r
 \r
-  if (DestIp == NULL) {\r
+  if (IsBCast) {\r
     SetMem (&Token.RemoteAddress, sizeof (EFI_IPv4_ADDRESS), 0xff);\r
   } else {\r
     CopyMem (&Token.RemoteAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));\r
@@ -1164,7 +1207,8 @@ PxeBcDiscvBootService (
   //\r
   for (TryIndex = 1; TryIndex <= PXEBC_BOOT_REQUEST_RETRIES; TryIndex++) {\r
 \r
-    Token.TimeoutValue  = PXEBC_BOOT_REQUEST_TIMEOUT * TryIndex;\r
+    Token.TimeoutValue                  = (UINT16) (PXEBC_BOOT_REQUEST_TIMEOUT * TryIndex);\r
+    Token.Packet->Dhcp4.Header.Seconds  = (UINT16) (PXEBC_BOOT_REQUEST_TIMEOUT * (TryIndex - 1));\r
 \r
     Status              = Dhcp4->TransmitReceive (Dhcp4, &Token);\r
 \r
@@ -1238,13 +1282,14 @@ PxeBcDiscvBootService (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  Parse interested dhcp options.\r
 \r
-  @param  Buffer                GC_NOTO: add argument description\r
-  @param  Length                GC_NOTO: add argument description\r
-  @param  OptTag                GC_NOTO: add argument description\r
+  @param  Buffer     Pointer to the dhcp options packet.\r
+  @param  Length     The length of the dhcp options.\r
+  @param  OptTag     The option OpCode.\r
 \r
-  @return GC_NOTO: add return values\r
+  @return NULL if the buffer length is 0 and OpCode is not \r
+          PXEBC_DHCP4_TAG_EOP, or the pointer to the buffer.\r
 \r
 **/\r
 EFI_DHCP4_PACKET_OPTION *\r
@@ -1286,8 +1331,7 @@ PxeBcParseExtendOptions (
   @param  Dhcp4Option           Pointer to dhcp options\r
   @param  VendorOption          Pointer to vendor options\r
 \r
-  @return TRUE  : Valid vendor options\r
-  @return FALSE : Invalid vendor options\r
+  @return TRUE if valid for vendor options, or FALSE.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1405,12 +1449,12 @@ PxeBcParseVendorOptions (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
-\r
-  @param  Str                   GC_NOTO: add argument description\r
-  @param  Len                   GC_NOTO: add argument description\r
+  This function display boot item detail.\r
 \r
-  @return GC_NOTO: add return values\r
+  If the length of the boot item string over 70 Char, just display 70 Char. \r
+   \r
+  @param  Str     Pointer to a string (boot item string).\r
+  @param  Len     The length of string.\r
 \r
 **/\r
 VOID\r
@@ -1430,13 +1474,16 @@ PxeBcDisplayBootItem (
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
+  Choose the boot prompt.\r
 \r
-  @param  Private               GC_NOTO: add argument description\r
-\r
-  @retval EFI_SUCCESS           GC_NOTO: Add description for return value\r
-  @retval EFI_TIMEOUT           GC_NOTO: Add description for return value\r
+  @param  Private              Pointer to PxeBc private data.\r
 \r
+  @retval EFI_SUCCESS          Select boot prompt done.\r
+  @retval EFI_TIMEOUT          Select boot prompt time out. \r
+  @retval EFI_NOT_FOUND        The proxy offer is not Pxe10.\r
+  @retval EFI_ABORTED          User cancel the operation.\r
+  @retval EFI_NOT_READY        Read the input key from the keybroad has not finish.\r
+  \r
 **/\r
 EFI_STATUS\r
 PxeBcSelectBootPrompt (\r
@@ -1605,13 +1652,15 @@ ON_EXIT:
 \r
 \r
 /**\r
-  GC_NOTO: Add function description\r
-\r
-  @param  Private               GC_NOTO: add argument description\r
-  @param  Type                  GC_NOTO: add argument description\r
+  Select the boot menu.\r
 \r
-  @retval EFI_ABORTED           GC_NOTO: Add description for return value\r
-  @retval EFI_SUCCESS           GC_NOTO: Add description for return value\r
+  @param  Private         Pointer to PxeBc private data.\r
+  @param  Type            The type of the menu.\r
+  @param  UseDefaultItem  Use default item or not.\r
+  \r
+  @retval EFI_ABORTED     User cancel operation.\r
+  @retval EFI_SUCCESS     Select the boot menu success.\r
+  @retval EFI_NOT_READY   Read the input key from the keybroad has not finish.    \r
 \r
 **/\r
 EFI_STATUS\r
@@ -1661,15 +1710,21 @@ PxeBcSelectBootMenu (
   MenuSize  = VendorOpt->BootMenuLen;\r
   MenuItem  = VendorOpt->BootMenu;\r
 \r
+  if (MenuSize == 0) {\r
+    return EFI_NOT_READY;\r
+  }\r
+\r
   while (MenuSize > 0) {\r
-    MenuArray[Index]  = MenuItem;\r
+    MenuArray[Index++]  = MenuItem;\r
     MenuSize          = (UINT8) (MenuSize - (MenuItem->DescLen + 3));\r
     MenuItem          = (PXEBC_BOOT_MENU_ENTRY *) ((UINT8 *) MenuItem + MenuItem->DescLen + 3);\r
-    Index++;\r
+    if (Index >= PXEBC_MAX_MENU_NUM) {\r
+      break;\r
+    }\r
   }\r
 \r
   if (UseDefaultItem) {\r
-    CopyMem (Type, &MenuArray[0]->Type, sizeof (UINT16));\r
+    *Type = MenuArray[0]->Type;\r
     *Type = NTOHS (*Type);\r
     return EFI_SUCCESS;\r
   }\r
@@ -1683,6 +1738,7 @@ PxeBcSelectBootMenu (
   TopRow  = gST->ConOut->Mode->CursorRow - MenuNum;\r
 \r
   do {\r
+    ASSERT (Select < PXEBC_MAX_MENU_NUM);\r
     //\r
     // highlight selected row\r
     //\r
@@ -1730,7 +1786,7 @@ PxeBcSelectBootMenu (
     switch (InputKey.ScanCode) {\r
     case SCAN_LEFT:\r
     case SCAN_UP:\r
-      if (Select) {\r
+      if (Select > 0) {\r
         --Select;\r
       }\r
 \r