MdeModulePkg/Bds: More user-friendly network boot option description

The patch enhances the UefiBootManagerLib to use more user-friendly
network boot option description.
It builds description like below:
 "PXEv6 (MAC:112233445566 VLAN1)"
 "HTTPv4 (MAC:112233445566)"

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Siyuan Fu <siyuan.fu@intel.com>

diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c b/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c
index 5c77e86006057178b1ea42ad08999aeaa4918a23..69a2914d560e53f20db36c2f4c0eb2045cf3b363 100644 (file)
--- a/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c
+++ b/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c
@@ -28,24 +28,19 @@ LIST_ENTRY mPlatformBootDescriptionHandlers = INITIALIZE_LIST_HEAD_VARIABLE (mPl
 /**\r
   For a bootable Device path, return its boot type.\r
 \r
 /**\r
   For a bootable Device path, return its boot type.\r
 \r

-  @param  DevicePath                   The bootable device Path to check\r
-\r
-  @retval AcpiFloppyBoot               If given device path contains ACPI_DEVICE_PATH type device path node\r
-                                       which HID is floppy device.\r
-  @retval MessageAtapiBoot             If given device path contains MESSAGING_DEVICE_PATH type device path node\r
-                                       and its last device path node's subtype is MSG_ATAPI_DP.\r
-  @retval MessageSataBoot              If given device path contains MESSAGING_DEVICE_PATH type device path node\r
-                                       and its last device path node's subtype is MSG_SATA_DP.\r
-  @retval MessageScsiBoot              If given device path contains MESSAGING_DEVICE_PATH type device path node\r
-                                       and its last device path node's subtype is MSG_SCSI_DP.\r
-  @retval MessageUsbBoot               If given device path contains MESSAGING_DEVICE_PATH type device path node\r
-                                       and its last device path node's subtype is MSG_USB_DP.\r
-  @retval MessageNetworkBoot           If given device path contains MESSAGING_DEVICE_PATH type device path node\r
-                                       and its last device path node's subtype is MSG_MAC_ADDR_DP, MSG_VLAN_DP,\r
-                                       MSG_IPv4_DP or MSG_IPv6_DP.\r
-  @retval MessageHttpBoot              If given device path contains MESSAGING_DEVICE_PATH type device path node\r
-                                       and its last device path node's subtype is MSG_URI_DP.\r
-  @retval UnsupportedBoot              If tiven device path doesn't match the above condition, it's not supported.\r
+  @param  DevicePath        The bootable device Path to check\r
+\r
+  @retval AcpiFloppyBoot    If given device path contains ACPI_DEVICE_PATH type device path node\r
+                            which HID is floppy device.\r
+  @retval MessageAtapiBoot  If given device path contains MESSAGING_DEVICE_PATH type device path node\r
+                            and its last device path node's subtype is MSG_ATAPI_DP.\r
+  @retval MessageSataBoot   If given device path contains MESSAGING_DEVICE_PATH type device path node\r
+                            and its last device path node's subtype is MSG_SATA_DP.\r
+  @retval MessageScsiBoot   If given device path contains MESSAGING_DEVICE_PATH type device path node\r
+                            and its last device path node's subtype is MSG_SCSI_DP.\r
+  @retval MessageUsbBoot    If given device path contains MESSAGING_DEVICE_PATH type device path node\r
+                            and its last device path node's subtype is MSG_USB_DP.\r
+  @retval BmMiscBoot        If tiven device path doesn't match the above condition.\r

 \r
 **/\r
 BM_BOOT_TYPE\r
 \r
 **/\r
 BM_BOOT_TYPE\r


@@ -108,17 +103,6 @@ BmDevicePathType (
         case MSG_SCSI_DP:\r
           return BmMessageScsiBoot;\r
           break;\r
         case MSG_SCSI_DP:\r
           return BmMessageScsiBoot;\r
           break;\r

-\r
-        case MSG_MAC_ADDR_DP:\r
-        case MSG_VLAN_DP:\r
-        case MSG_IPv4_DP:\r
-        case MSG_IPv6_DP:\r
-          return BmMessageNetworkBoot;\r
-          break;\r
-\r
-        case MSG_URI_DP:\r
-          return BmMessageHttpBoot;\r
-          break;\r

         }\r
     }\r
   }\r
         }\r
     }\r
   }\r


@@ -351,6 +335,125 @@ BmGetUsbDescription (
   return Description;\r
 }\r
 \r
   return Description;\r
 }\r
 \r

+/**\r
+  Return the description for network boot device.\r
+\r
+  @param Handle                Controller handle.\r
+\r
+  @return  The description string.\r
+**/\r
+CHAR16 *\r
+BmGetNetworkDescription (\r
+  IN EFI_HANDLE                  Handle\r
+  )\r
+{\r
+  EFI_STATUS                     Status;\r
+  EFI_DEVICE_PATH_PROTOCOL       *DevicePath;\r
+  MAC_ADDR_DEVICE_PATH           *Mac;\r
+  VLAN_DEVICE_PATH               *Vlan;\r
+  EFI_DEVICE_PATH_PROTOCOL       *Ip;\r
+  EFI_DEVICE_PATH_PROTOCOL       *Uri;\r
+  CHAR16                         *Description;\r
+  UINTN                          DescriptionSize;\r
+\r
+  Status = gBS->OpenProtocol (\r
+                  Handle,\r
+                  &gEfiLoadFileProtocolGuid,\r
+                  NULL,\r
+                  gImageHandle,\r
+                  Handle,\r
+                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    return NULL;\r
+  }\r
+\r
+  Status = gBS->OpenProtocol (\r
+                  Handle,\r
+                  &gEfiDevicePathProtocolGuid,\r
+                  (VOID **) &DevicePath,\r
+                  gImageHandle,\r
+                  Handle,\r
+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+                  );\r
+  if (EFI_ERROR (Status) || (DevicePath == NULL)) {\r
+    return NULL;\r
+  }\r
+\r
+  //\r
+  // The PXE device path is like:\r
+  //   ....../Mac(...)[/Vlan(...)]\r
+  //   ....../Mac(...)[/Vlan(...)]/IPv4(...)\r
+  //   ....../Mac(...)[/Vlan(...)]/IPv6(...)\r
+  //\r
+  // The HTTP device path is like:\r
+  //   ....../Mac(...)[/Vlan(...)]/IPv4(...)/Uri(...)\r
+  //   ....../Mac(...)[/Vlan(...)]/IPv6(...)/Uri(...)\r
+  //\r
+  while (!IsDevicePathEnd (DevicePath) &&\r
+         ((DevicePathType (DevicePath) != MESSAGING_DEVICE_PATH) ||\r
+          (DevicePathSubType (DevicePath) != MSG_MAC_ADDR_DP))\r
+         ) {\r
+    DevicePath = NextDevicePathNode (DevicePath);\r
+  }\r
+\r
+  if (IsDevicePathEnd (DevicePath)) {\r
+    return NULL;\r
+  }\r
+\r
+  Mac = (MAC_ADDR_DEVICE_PATH *) DevicePath;\r
+  DevicePath = NextDevicePathNode (DevicePath);\r
+\r
+  if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&\r
+      (DevicePathSubType (DevicePath) == MSG_VLAN_DP)\r
+      ) {\r
+    Vlan = (VLAN_DEVICE_PATH *) DevicePath;\r
+    DevicePath = NextDevicePathNode (DevicePath);\r
+  } else {\r
+    Vlan = NULL;\r
+  }\r
+\r
+  if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&\r
+      ((DevicePathSubType (DevicePath) == MSG_IPv4_DP) ||\r
+       (DevicePathSubType (DevicePath) == MSG_IPv6_DP))\r
+      ) {\r
+    Ip = DevicePath;\r
+    DevicePath = NextDevicePathNode (DevicePath);\r
+  } else {\r
+    Ip = NULL;\r
+  }\r
+\r
+  if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&\r
+      (DevicePathSubType (DevicePath) == MSG_URI_DP)\r
+      ) {\r
+    Uri = DevicePath;\r
+    DevicePath = NextDevicePathNode (DevicePath);\r
+  } else {\r
+    Uri = NULL;\r
+  }\r
+\r
+  //\r
+  // Build description like below:\r
+  //   "PXEv6 (MAC:112233445566 VLAN1)"\r
+  //   "HTTPv4 (MAC:112233445566)"\r
+  //\r
+  DescriptionSize = sizeof (L"HTTPv6 (MAC:112233445566 VLAN65535)");\r
+  Description     = AllocatePool (DescriptionSize);\r
+  ASSERT (Description != NULL);\r
+  UnicodeSPrint (\r
+    Description, DescriptionSize,\r
+    (Vlan == NULL) ?\r
+    L"%sv%d (MAC:%02x%02x%02x%02x%02x%02x)" :\r
+    L"%sv%d (MAC:%02x%02x%02x%02x%02x%02x VLAN%d)",\r
+    (Uri == NULL) ? L"PXE" : L"HTTP",\r
+    ((Ip == NULL) || (DevicePathSubType (Ip) == MSG_IPv4_DP)) ? 4 : 6,\r
+    Mac->MacAddress.Addr[0], Mac->MacAddress.Addr[1], Mac->MacAddress.Addr[2],\r
+    Mac->MacAddress.Addr[3], Mac->MacAddress.Addr[4], Mac->MacAddress.Addr[5],\r
+    (Vlan == NULL) ? 0 : Vlan->VlanId\r
+    );\r
+  return Description;\r
+}\r
+\r

 /**\r
   Return the boot description for the controller based on the type.\r
 \r
 /**\r
   Return the boot description for the controller based on the type.\r
 \r


@@ -400,14 +503,6 @@ BmGetMiscDescription (
     }\r
     break;\r
 \r
     }\r
     break;\r
 \r

-  case BmMessageNetworkBoot:\r
-    Description = L"Network";\r
-    break;\r
-\r
-  case BmMessageHttpBoot:\r
-    Description = L"Http";\r
-    break;\r
-\r

   default:\r
     Status = gBS->HandleProtocol (Handle, &gEfiSimpleFileSystemProtocolGuid, (VOID **) &Fs);\r
     if (!EFI_ERROR (Status)) {\r
   default:\r
     Status = gBS->HandleProtocol (Handle, &gEfiSimpleFileSystemProtocolGuid, (VOID **) &Fs);\r
     if (!EFI_ERROR (Status)) {\r


@@ -463,6 +558,7 @@ EfiBootManagerRegisterBootDescriptionHandler (
 BM_GET_BOOT_DESCRIPTION mBmBootDescriptionHandlers[] = {\r
   BmGetUsbDescription,\r
   BmGetDescriptionFromDiskInfo,\r
 BM_GET_BOOT_DESCRIPTION mBmBootDescriptionHandlers[] = {\r
   BmGetUsbDescription,\r
   BmGetDescriptionFromDiskInfo,\r

+  BmGetNetworkDescription,\r

   BmGetMiscDescription\r
 };\r
 \r
   BmGetMiscDescription\r
 };\r
 \r

diff --git a/MdeModulePkg/Library/UefiBootManagerLib/InternalBm.h b/MdeModulePkg/Library/UefiBootManagerLib/InternalBm.h
index c1514c3ee48171f19858b39224753e2dd2d5a892..b261d769d24eb9baab5a96135db39c185ca1aaeb 100644 (file)
--- a/MdeModulePkg/Library/UefiBootManagerLib/InternalBm.h
+++ b/MdeModulePkg/Library/UefiBootManagerLib/InternalBm.h
@@ -92,8 +92,6 @@ typedef enum {
   BmMessageSataBoot,\r
   BmMessageUsbBoot,\r
   BmMessageScsiBoot,\r
   BmMessageSataBoot,\r
   BmMessageUsbBoot,\r
   BmMessageScsiBoot,\r

-  BmMessageNetworkBoot,\r
-  BmMessageHttpBoot,\r

   BmMiscBoot\r
 } BM_BOOT_TYPE;\r
 \r
   BmMiscBoot\r
 } BM_BOOT_TYPE;\r
 \r