X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FLibrary%2FUefiBootManagerLib%2FBmBootDescription.c;h=501a0cc25520ec4b569f937767110eef42395102;hp=050647d8f186e09eb9ad861898e801d76705f06a;hb=54127af53d43c143ee4da734f5472acd085c5b58;hpb=dd4eaf1573d7c6b01bb4de2b5055c5ccc30730c8

diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c b/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c
index 050647d8f1..501a0cc255 100644
--- a/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c
+++ b/MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c
@@ -1,7 +1,7 @@
 /** @file
   Library functions which relate with boot option description.
 
-Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>
 (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
@@ -500,6 +500,107 @@ BmGetLoadFileDescription (
   return NULL;
 }
 
+/**
+  Return the boot description for NVME boot device.
+
+  @param Handle                Controller handle.
+
+  @return  The description string.
+**/
+CHAR16 *
+BmGetNvmeDescription (
+  IN EFI_HANDLE                      Handle
+  )
+{
+  EFI_STATUS                               Status;
+  EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL       *NvmePassthru;
+  EFI_DEV_PATH_PTR                         DevicePath;
+  EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;
+  EFI_NVM_EXPRESS_COMMAND                  Command;
+  EFI_NVM_EXPRESS_COMPLETION               Completion;
+  NVME_ADMIN_CONTROLLER_DATA               ControllerData;
+  CHAR16                                   *Description;
+  CHAR16                                   *Char;
+  UINTN                                    Index;
+
+  Status = gBS->HandleProtocol (Handle, &gEfiDevicePathProtocolGuid, (VOID **) &DevicePath.DevPath);
+  if (EFI_ERROR (Status)) {
+    return NULL;
+  }
+
+  Status = gBS->LocateDevicePath (&gEfiNvmExpressPassThruProtocolGuid, &DevicePath.DevPath, &Handle);
+  if (EFI_ERROR (Status) ||
+      (DevicePathType (DevicePath.DevPath) != MESSAGING_DEVICE_PATH) ||
+      (DevicePathSubType (DevicePath.DevPath) != MSG_NVME_NAMESPACE_DP)) {
+    //
+    // Do not return description when the Handle is not a child of NVME controller.
+    //
+    return NULL;
+  }
+
+  //
+  // Send ADMIN_IDENTIFY command to NVME controller to get the model and serial number.
+  //
+  Status = gBS->HandleProtocol (Handle, &gEfiNvmExpressPassThruProtocolGuid, (VOID **) &NvmePassthru);
+  ASSERT_EFI_ERROR (Status);
+
+  ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));
+  ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));
+  ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));
+
+  Command.Cdw0.Opcode = NVME_ADMIN_IDENTIFY_CMD;
+  //
+  // According to Nvm Express 1.1 spec Figure 38, When not used, the field shall be cleared to 0h.
+  // For the Identify command, the Namespace Identifier is only used for the Namespace data structure.
+  //
+  Command.Nsid        = 0;
+  CommandPacket.NvmeCmd        = &Command;
+  CommandPacket.NvmeCompletion = &Completion;
+  CommandPacket.TransferBuffer = &ControllerData;
+  CommandPacket.TransferLength = sizeof (ControllerData);
+  CommandPacket.CommandTimeout = EFI_TIMER_PERIOD_SECONDS (5);
+  CommandPacket.QueueType      = NVME_ADMIN_QUEUE;
+  //
+  // Set bit 0 (Cns bit) to 1 to identify a controller
+  //
+  Command.Cdw10                = 1;
+  Command.Flags                = CDW10_VALID;
+
+  Status = NvmePassthru->PassThru (
+                               NvmePassthru,
+                               0,
+                               &CommandPacket,
+                               NULL
+                               );
+  if (EFI_ERROR (Status)) {
+    return NULL;
+  }
+
+  Description = AllocateZeroPool (
+                  (ARRAY_SIZE (ControllerData.Mn) + 1
+                   + ARRAY_SIZE (ControllerData.Sn) + 1
+                   + MAXIMUM_VALUE_CHARACTERS + 1
+                   ) * sizeof (CHAR16));
+  if (Description != NULL) {
+    Char = Description;
+    for (Index = 0; Index < ARRAY_SIZE (ControllerData.Mn); Index++) {
+      *(Char++) = (CHAR16) ControllerData.Mn[Index];
+    }
+    *(Char++) = L' ';
+    for (Index = 0; Index < ARRAY_SIZE (ControllerData.Sn); Index++) {
+      *(Char++) = (CHAR16) ControllerData.Sn[Index];
+    }
+    *(Char++) = L' ';
+    UnicodeValueToStringS (
+      Char, sizeof (CHAR16) * (MAXIMUM_VALUE_CHARACTERS + 1),
+      0, DevicePath.NvmeNamespace->NamespaceId, 0
+      );
+    BmEliminateExtraSpaces (Description);
+  }
+
+  return Description;
+}
+
 /**
   Return the boot description for the controller based on the type.
 
@@ -606,6 +707,7 @@ BM_GET_BOOT_DESCRIPTION mBmBootDescriptionHandlers[] = {
   BmGetDescriptionFromDiskInfo,
   BmGetNetworkDescription,
   BmGetLoadFileDescription,
+  BmGetNvmeDescription,
   BmGetMiscDescription
 };