ArmPlatformPkg/Bds: Added TFTP boot option update
authorRonald Cron <ronald.cron@arm.com>
Tue, 29 Jul 2014 14:17:05 +0000 (14:17 +0000)
committeroliviermartin <oliviermartin@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 29 Jul 2014 14:17:05 +0000 (14:17 +0000)
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
Reviewed-By: Olivier Martin <olivier.martin@arm.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15715 6f19259b-4bc3-4df7-8a09-765794883524

ArmPlatformPkg/Bds/BootOptionSupport.c

index 42ddba34a5a13a2584cb846d63f753da143633b4..3eab0da83bfd5aea535238d0eb3173bca95089aa 100644 (file)
@@ -895,15 +895,184 @@ BdsLoadOptionTftpCreateDevicePath (
   return Status;\r
 }\r
 \r
+/**\r
+  Update the parameters of a TFTP boot option\r
+\r
+  The function asks sequentially to update the IPv4 parameters as well as the boot file path,\r
+  providing the previously set value if any.\r
+\r
+  @param[in]   OldDevicePath  Current complete device path of the Tftp boot option.\r
+                              This has to be a valid complete Tftp boot option path.\r
+                              By complete, we mean that it is not only the Tftp\r
+                              specific end part built by the\r
+                              "BdsLoadOptionTftpCreateDevicePath()" function.\r
+                              This path is handled as read only.\r
+  @param[in]   FileName       Description of the file the path is asked for\r
+  @param[out]  NewDevicePath  Pointer to the new complete device path.\r
+\r
+  @retval  EFI_SUCCESS            Update completed\r
+  @retval  EFI_ABORTED            Update aborted by the user\r
+  @retval  EFI_OUT_OF_RESOURCES   Fail to perform the update due to lack of resource\r
+**/\r
 EFI_STATUS\r
 BdsLoadOptionTftpUpdateDevicePath (\r
-  IN EFI_DEVICE_PATH            *OldDevicePath,\r
-  IN CHAR16*                    FileName,\r
-  OUT EFI_DEVICE_PATH_PROTOCOL  **NewDevicePath\r
+  IN   EFI_DEVICE_PATH            *OldDevicePath,\r
+  IN   CHAR16                     *FileName,\r
+  OUT  EFI_DEVICE_PATH_PROTOCOL  **NewDevicePath\r
   )\r
 {\r
-  ASSERT (0);\r
-  return EFI_UNSUPPORTED;\r
+  EFI_STATUS             Status;\r
+  EFI_DEVICE_PATH       *DevicePath;\r
+  EFI_DEVICE_PATH       *DevicePathNode;\r
+  UINT8                 *Ipv4NodePtr;\r
+  IPv4_DEVICE_PATH       Ipv4Node;\r
+  BOOLEAN                IsDHCP;\r
+  EFI_IP_ADDRESS         OldIp;\r
+  EFI_IP_ADDRESS         LocalIp;\r
+  EFI_IP_ADDRESS         RemoteIp;\r
+  UINT8                 *FileNodePtr;\r
+  CHAR16                 BootFilePath[BOOT_DEVICE_FILEPATH_MAX];\r
+  UINTN                  PathSize;\r
+  UINTN                  BootFilePathSize;\r
+  FILEPATH_DEVICE_PATH  *NewFilePathNode;\r
+\r
+  Ipv4NodePtr = NULL;\r
+\r
+  //\r
+  // Make a copy of the complete device path that is made of :\r
+  // the device path of the device that support the Simple Network protocol\r
+  // followed by an IPv4 node (type IPv4_DEVICE_PATH),\r
+  // followed by a file path node (type FILEPATH_DEVICE_PATH) and ended up\r
+  // by an end node. The IPv6 case is not handled yet.\r
+  //\r
+\r
+  DevicePath = DuplicateDevicePath (OldDevicePath);\r
+  if (DevicePath == NULL) {\r
+    Status = EFI_OUT_OF_RESOURCES;\r
+    goto ErrorExit;\r
+  }\r
+\r
+  //\r
+  // Because of the check done by "BdsLoadOptionTftpIsSupported()" prior to the\r
+  // call to this function, we know that the device path ends with an IPv4 node\r
+  // followed by a file path node and finally an end node. To get the address of\r
+  // the last IPv4 node, we loop over the whole device path, noting down the\r
+  // address of each encountered IPv4 node.\r
+  //\r
+\r
+  for (DevicePathNode = DevicePath;\r
+       !IsDevicePathEnd (DevicePathNode);\r
+       DevicePathNode = NextDevicePathNode (DevicePathNode))\r
+  {\r
+    if (IS_DEVICE_PATH_NODE (DevicePathNode, MESSAGING_DEVICE_PATH, MSG_IPv4_DP)) {\r
+      Ipv4NodePtr = (UINT8*)DevicePathNode;\r
+    }\r
+  }\r
+\r
+  // Copy for alignment of the IPv4 node data\r
+  CopyMem (&Ipv4Node, Ipv4NodePtr, sizeof (IPv4_DEVICE_PATH));\r
+\r
+  Print (L"Get the IP address from DHCP: ");\r
+  Status = GetHIInputBoolean (&IsDHCP);\r
+  if (EFI_ERROR (Status)) {\r
+    goto ErrorExit;\r
+  }\r
+\r
+  if (!IsDHCP) {\r
+    Print (L"Local static IP address: ");\r
+    if (Ipv4Node.StaticIpAddress) {\r
+      // Copy local IPv4 address into IPv4 or IPv6 union\r
+      CopyMem (&OldIp.v4, &Ipv4Node.LocalIpAddress, sizeof (EFI_IPv4_ADDRESS));\r
+\r
+      Status = EditHIInputIP (&OldIp, &LocalIp);\r
+    } else {\r
+      Status = GetHIInputIP (&LocalIp);\r
+    }\r
+    if (EFI_ERROR (Status)) {\r
+      goto ErrorExit;\r
+    }\r
+  }\r
+\r
+  Print (L"TFTP server IP address: ");\r
+  // Copy remote IPv4 address into IPv4 or IPv6 union\r
+  CopyMem (&OldIp.v4, &Ipv4Node.RemoteIpAddress, sizeof (EFI_IPv4_ADDRESS));\r
+\r
+  Status = EditHIInputIP (&OldIp, &RemoteIp);\r
+  if (EFI_ERROR (Status)) {\r
+    goto ErrorExit;\r
+  }\r
+\r
+  // Get the path of the boot file and its size in number of bytes\r
+  FileNodePtr = Ipv4NodePtr + sizeof (IPv4_DEVICE_PATH);\r
+  BootFilePathSize = DevicePathNodeLength (FileNodePtr) - SIZE_OF_FILEPATH_DEVICE_PATH;\r
+\r
+  //\r
+  // Ask for update of the boot file path\r
+  //\r
+  do {\r
+    // Copy for 2-byte alignment of the Unicode string\r
+    CopyMem (\r
+      BootFilePath, FileNodePtr + SIZE_OF_FILEPATH_DEVICE_PATH,\r
+      MIN (BootFilePathSize, BOOT_DEVICE_FILEPATH_MAX)\r
+      );\r
+    BootFilePath[BOOT_DEVICE_FILEPATH_MAX - 1] = L'\0';\r
+\r
+    Print (L"File path of the %s: ", FileName);\r
+    Status = EditHIInputStr (BootFilePath, BOOT_DEVICE_FILEPATH_MAX);\r
+    if (EFI_ERROR (Status)) {\r
+      goto ErrorExit;\r
+    }\r
+    PathSize = StrSize (BootFilePath);\r
+    if (PathSize > 2) {\r
+      break;\r
+    }\r
+    // Empty string, give the user another try\r
+    Print (L"Empty string - Invalid path\n");\r
+  } while (PathSize <= 2) ;\r
+\r
+  //\r
+  // Update the IPv4 node. IPv6 case not handled yet.\r
+  //\r
+  if (IsDHCP == TRUE) {\r
+    Ipv4Node.StaticIpAddress = FALSE;\r
+  } else {\r
+    Ipv4Node.StaticIpAddress = TRUE;\r
+  }\r
+  CopyMem (&Ipv4Node.LocalIpAddress, &LocalIp.v4, sizeof (EFI_IPv4_ADDRESS));\r
+  CopyMem (&Ipv4Node.RemoteIpAddress, &RemoteIp.v4, sizeof (EFI_IPv4_ADDRESS));\r
+  CopyMem (Ipv4NodePtr, &Ipv4Node, sizeof (IPv4_DEVICE_PATH));\r
+\r
+  //\r
+  // Create the new file path node\r
+  //\r
+  NewFilePathNode = (FILEPATH_DEVICE_PATH*)AllocatePool (\r
+                                             SIZE_OF_FILEPATH_DEVICE_PATH +\r
+                                             PathSize\r
+                                             );\r
+  NewFilePathNode->Header.Type    = MEDIA_DEVICE_PATH;\r
+  NewFilePathNode->Header.SubType = MEDIA_FILEPATH_DP;\r
+  SetDevicePathNodeLength (\r
+    NewFilePathNode,\r
+    SIZE_OF_FILEPATH_DEVICE_PATH + PathSize\r
+    );\r
+  CopyMem (NewFilePathNode->PathName, BootFilePath, PathSize);\r
+\r
+  //\r
+  // Generate the new Device Path by replacing the file path node at address\r
+  // "FileNodePtr" by the new one "NewFilePathNode" and return its address.\r
+  //\r
+  SetDevicePathEndNode (FileNodePtr);\r
+  *NewDevicePath = AppendDevicePathNode (\r
+                     DevicePath,\r
+                     (CONST EFI_DEVICE_PATH_PROTOCOL*)NewFilePathNode\r
+                     );\r
+\r
+ErrorExit:\r
+  if (DevicePath != NULL) {\r
+    FreePool (DevicePath) ;\r
+  }\r
+\r
+  return Status;\r
 }\r
 \r
 BOOLEAN\r