/** @file\r
Library functions which relate with boot option description.\r
\r
-Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
\r
//\r
// The PXE device path is like:\r
- // ....../Mac(...)[/Vlan(...)]\r
- // ....../Mac(...)[/Vlan(...)]/IPv4(...)\r
- // ....../Mac(...)[/Vlan(...)]/IPv6(...)\r
+ // ....../Mac(...)[/Vlan(...)][/Wi-Fi(...)]\r
+ // ....../Mac(...)[/Vlan(...)][/Wi-Fi(...)]/IPv4(...)\r
+ // ....../Mac(...)[/Vlan(...)][/Wi-Fi(...)]/IPv6(...)\r
//\r
// The HTTP device path is like:\r
- // ....../Mac(...)[/Vlan(...)]/IPv4(...)/Uri(...)\r
- // ....../Mac(...)[/Vlan(...)]/IPv6(...)/Uri(...)\r
+ // ....../Mac(...)[/Vlan(...)][/Wi-Fi(...)]/IPv4(...)/Uri(...)\r
+ // ....../Mac(...)[/Vlan(...)][/Wi-Fi(...)]/IPv6(...)/Uri(...)\r
//\r
while (!IsDevicePathEnd (DevicePath) &&\r
((DevicePathType (DevicePath) != MESSAGING_DEVICE_PATH) ||\r
Mac = (MAC_ADDR_DEVICE_PATH *) DevicePath;\r
DevicePath = NextDevicePathNode (DevicePath);\r
\r
+ //\r
+ // Locate the optional Vlan node\r
+ //\r
if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&\r
(DevicePathSubType (DevicePath) == MSG_VLAN_DP)\r
) {\r
Vlan = NULL;\r
}\r
\r
+ //\r
+ // Skip the optional Wi-Fi node\r
+ //\r
+ if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&\r
+ (DevicePathSubType (DevicePath) == MSG_WIFI_DP)\r
+ ) {\r
+ DevicePath = NextDevicePathNode (DevicePath);\r
+ }\r
+\r
+ //\r
+ // Locate the IP node\r
+ //\r
if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&\r
((DevicePathSubType (DevicePath) == MSG_IPv4_DP) ||\r
(DevicePathSubType (DevicePath) == MSG_IPv6_DP))\r
Ip = NULL;\r
}\r
\r
+ //\r
+ // Locate the URI node\r
+ //\r
if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&\r
(DevicePathSubType (DevicePath) == MSG_URI_DP)\r
) {\r
return Description;\r
}\r
\r
+/**\r
+ Return the boot description for LoadFile\r
+\r
+ @param Handle Controller handle.\r
+\r
+ @return The description string.\r
+**/\r
+CHAR16 *\r
+BmGetLoadFileDescription (\r
+ IN EFI_HANDLE Handle\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_DEVICE_PATH_PROTOCOL *FilePath;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePathNode;\r
+ CHAR16 *Description;\r
+ EFI_LOAD_FILE_PROTOCOL *LoadFile;\r
+\r
+ Status = gBS->HandleProtocol (Handle, &gEfiLoadFileProtocolGuid, (VOID **)&LoadFile);\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
+\r
+ //\r
+ // Get the file name\r
+ //\r
+ Description = NULL;\r
+ Status = gBS->HandleProtocol (Handle, &gEfiDevicePathProtocolGuid, (VOID **)&FilePath);\r
+ if (!EFI_ERROR (Status)) {\r
+ DevicePathNode = FilePath;\r
+ while (!IsDevicePathEnd (DevicePathNode)) {\r
+ if (DevicePathNode->Type == MEDIA_DEVICE_PATH && DevicePathNode->SubType == MEDIA_FILEPATH_DP) {\r
+ Description = (CHAR16 *)(DevicePathNode + 1);\r
+ break;\r
+ }\r
+ DevicePathNode = NextDevicePathNode (DevicePathNode);\r
+ }\r
+ }\r
+\r
+ if (Description != NULL) {\r
+ return AllocateCopyPool (StrSize (Description), Description);\r
+ }\r
+\r
+ return NULL;\r
+}\r
+\r
+/**\r
+ Return the boot description for NVME boot device.\r
+\r
+ @param Handle Controller handle.\r
+\r
+ @return The description string.\r
+**/\r
+CHAR16 *\r
+BmGetNvmeDescription (\r
+ IN EFI_HANDLE Handle\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL *NvmePassthru;\r
+ EFI_DEV_PATH_PTR DevicePath;\r
+ EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET CommandPacket;\r
+ EFI_NVM_EXPRESS_COMMAND Command;\r
+ EFI_NVM_EXPRESS_COMPLETION Completion;\r
+ NVME_ADMIN_CONTROLLER_DATA ControllerData;\r
+ CHAR16 *Description;\r
+ CHAR16 *Char;\r
+ UINTN Index;\r
+\r
+ Status = gBS->HandleProtocol (Handle, &gEfiDevicePathProtocolGuid, (VOID **) &DevicePath.DevPath);\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
+\r
+ Status = gBS->LocateDevicePath (&gEfiNvmExpressPassThruProtocolGuid, &DevicePath.DevPath, &Handle);\r
+ if (EFI_ERROR (Status) ||\r
+ (DevicePathType (DevicePath.DevPath) != MESSAGING_DEVICE_PATH) ||\r
+ (DevicePathSubType (DevicePath.DevPath) != MSG_NVME_NAMESPACE_DP)) {\r
+ //\r
+ // Do not return description when the Handle is not a child of NVME controller.\r
+ //\r
+ return NULL;\r
+ }\r
+\r
+ //\r
+ // Send ADMIN_IDENTIFY command to NVME controller to get the model and serial number.\r
+ //\r
+ Status = gBS->HandleProtocol (Handle, &gEfiNvmExpressPassThruProtocolGuid, (VOID **) &NvmePassthru);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ ZeroMem (&CommandPacket, sizeof(EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET));\r
+ ZeroMem (&Command, sizeof(EFI_NVM_EXPRESS_COMMAND));\r
+ ZeroMem (&Completion, sizeof(EFI_NVM_EXPRESS_COMPLETION));\r
+\r
+ Command.Cdw0.Opcode = NVME_ADMIN_IDENTIFY_CMD;\r
+ //\r
+ // According to Nvm Express 1.1 spec Figure 38, When not used, the field shall be cleared to 0h.\r
+ // For the Identify command, the Namespace Identifier is only used for the Namespace data structure.\r
+ //\r
+ Command.Nsid = 0;\r
+ CommandPacket.NvmeCmd = &Command;\r
+ CommandPacket.NvmeCompletion = &Completion;\r
+ CommandPacket.TransferBuffer = &ControllerData;\r
+ CommandPacket.TransferLength = sizeof (ControllerData);\r
+ CommandPacket.CommandTimeout = EFI_TIMER_PERIOD_SECONDS (5);\r
+ CommandPacket.QueueType = NVME_ADMIN_QUEUE;\r
+ //\r
+ // Set bit 0 (Cns bit) to 1 to identify a controller\r
+ //\r
+ Command.Cdw10 = 1;\r
+ Command.Flags = CDW10_VALID;\r
+\r
+ Status = NvmePassthru->PassThru (\r
+ NvmePassthru,\r
+ 0,\r
+ &CommandPacket,\r
+ NULL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return NULL;\r
+ }\r
+\r
+ Description = AllocateZeroPool (\r
+ (ARRAY_SIZE (ControllerData.Mn) + 1\r
+ + ARRAY_SIZE (ControllerData.Sn) + 1\r
+ + MAXIMUM_VALUE_CHARACTERS + 1\r
+ ) * sizeof (CHAR16));\r
+ if (Description != NULL) {\r
+ Char = Description;\r
+ for (Index = 0; Index < ARRAY_SIZE (ControllerData.Mn); Index++) {\r
+ *(Char++) = (CHAR16) ControllerData.Mn[Index];\r
+ }\r
+ *(Char++) = L' ';\r
+ for (Index = 0; Index < ARRAY_SIZE (ControllerData.Sn); Index++) {\r
+ *(Char++) = (CHAR16) ControllerData.Sn[Index];\r
+ }\r
+ *(Char++) = L' ';\r
+ UnicodeValueToStringS (\r
+ Char, sizeof (CHAR16) * (MAXIMUM_VALUE_CHARACTERS + 1),\r
+ 0, DevicePath.NvmeNamespace->NamespaceId, 0\r
+ );\r
+ BmEliminateExtraSpaces (Description);\r
+ }\r
+\r
+ return Description;\r
+}\r
+\r
/**\r
Return the boot description for the controller based on the type.\r
\r
BmGetUsbDescription,\r
BmGetDescriptionFromDiskInfo,\r
BmGetNetworkDescription,\r
+ BmGetLoadFileDescription,\r
+ BmGetNvmeDescription,\r
BmGetMiscDescription\r
};\r
\r
// Firstly get the default boot description\r
//\r
DefaultDescription = NULL;\r
- for (Index = 0; Index < sizeof (mBmBootDescriptionHandlers) / sizeof (mBmBootDescriptionHandlers[0]); Index++) {\r
+ for (Index = 0; Index < ARRAY_SIZE (mBmBootDescriptionHandlers); Index++) {\r
DefaultDescription = mBmBootDescriptionHandlers[Index] (Handle);\r
if (DefaultDescription != NULL) {\r
//\r
projects / mirror_edk2.git / blobdiff