/** @file\r
- Capsule Runtime Drivers produces two UEFI capsule runtime services.\r
+ Capsule Runtime Driver produces two UEFI capsule runtime services.\r
(UpdateCapsule, QueryCapsuleCapabilities)\r
+ It installs the Capsule Architectural Protocol defined in PI1.0a to signify \r
+ the capsule runtime services are ready.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2006 - 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
\r
**/\r
\r
-#include "CapsuleService.h"\r
+#include <Uefi.h>\r
+\r
+#include <Protocol/Capsule.h>\r
+#include <Guid/CapsuleVendor.h>\r
+\r
+#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/CapsuleLib.h>\r
+#include <Library/UefiDriverEntryPoint.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/UefiRuntimeServicesTableLib.h>\r
+#include <Library/UefiRuntimeLib.h>\r
+\r
+//\r
+// Handle for the installation of Capsule Architecture Protocol.\r
+//\r
+EFI_HANDLE mNewHandle = NULL;\r
\r
/**\r
Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r
CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the\r
capsule has been successfully processed by the firmware.\r
@retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r
- @retval EFI_INVALID_PARAMETER CapsuleCount is Zero, or CapsuleImage is not valid.\r
- For across reset capsule image, ScatterGatherList is NULL.\r
+ @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were\r
+ set in the capsule header.\r
+ @retval EFI_INVALID_PARAMETER CapsuleCount is Zero.\r
+ @retval EFI_INVALID_PARAMETER For across reset capsule image, ScatterGatherList is NULL.\r
@retval EFI_UNSUPPORTED CapsuleImage is not recognized by the firmware.\r
\r
**/\r
UINTN ArrayNumber;\r
EFI_STATUS Status;\r
EFI_CAPSULE_HEADER *CapsuleHeader;\r
+ BOOLEAN NeedReset;\r
+ BOOLEAN InitiateReset;\r
\r
//\r
// Capsule Count can't be less than one.\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- CapsuleHeader = NULL;\r
+ NeedReset = FALSE;\r
+ InitiateReset = FALSE;\r
+ CapsuleHeader = NULL;\r
\r
for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {\r
//\r
return EFI_INVALID_PARAMETER;\r
}\r
//\r
+ // A capsule which has the CAPSULE_FLAGS_INITIATE_RESET flag must have\r
+ // CAPSULE_FLAGS_PERSIST_ACROSS_RESET set in its header as well.\r
+ //\r
+ if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_INITIATE_RESET)) == CAPSULE_FLAGS_INITIATE_RESET) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ //\r
// Check Capsule image without populate flag by firmware support capsule function \r
//\r
if (((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) && \r
}\r
\r
//\r
- // Assume that capsules have the same flags on reseting or not.\r
- //\r
- CapsuleHeader = CapsuleHeaderArray[0];\r
- \r
+ // Walk through all capsules, record whether there is a capsule needs reset\r
+ // or initiate reset. And then process capsules which has no reset flag directly.\r
//\r
- // Process across reset capsule image.\r
- //\r
- if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) != 0) {\r
- //\r
- // Check if the platform supports update capsule across a system reset\r
- //\r
- if (!FeaturePcdGet(PcdSupportUpdateCapsuleRest)) {\r
- return EFI_UNSUPPORTED;\r
- }\r
+ for (ArrayNumber = 0; ArrayNumber < CapsuleCount ; ArrayNumber++) {\r
+ CapsuleHeader = CapsuleHeaderArray[ArrayNumber];\r
//\r
- // ScatterGatherList is only referenced if the capsules are defined to persist across\r
- // system reset. \r
+ // Here should be in the boot-time for non-reset capsule image\r
+ // Platform specific update for the non-reset capsule image.\r
//\r
- if (ScatterGatherList == (EFI_PHYSICAL_ADDRESS) (UINTN) NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- } else {\r
- //\r
- // ScatterGatherList is only referenced if the capsules are defined to persist across\r
- // system reset. Set its value into NV storage to let pre-boot driver to pick it up \r
- // after coming through a system reset.\r
- //\r
- Status = EfiSetVariable (\r
- EFI_CAPSULE_VARIABLE_NAME,\r
- &gEfiCapsuleVendorGuid,\r
- EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
- sizeof (UINTN),\r
- (VOID *) &ScatterGatherList\r
- );\r
- if (Status != EFI_SUCCESS) {\r
+ if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) == 0) {\r
+ if (EfiAtRuntime ()) { \r
+ Status = EFI_UNSUPPORTED;\r
+ } else {\r
+ Status = ProcessCapsuleImage(CapsuleHeader);\r
+ }\r
+ if (EFI_ERROR(Status)) {\r
return Status;\r
}\r
- //\r
- // Successfully set the capsule image address into EFI variable.\r
- //\r
- return EFI_SUCCESS;\r
+ } else {\r
+ NeedReset = TRUE;\r
+ if ((CapsuleHeader->Flags & CAPSULE_FLAGS_INITIATE_RESET) != 0) {\r
+ InitiateReset = TRUE;\r
+ }\r
}\r
}\r
+ \r
+ //\r
+ // After launching all capsules who has no reset flag, if no more capsules claims\r
+ // for a system reset just return.\r
+ //\r
+ if (!NeedReset) {\r
+ return EFI_SUCCESS;\r
+ }\r
\r
//\r
- // Process the non-reset capsule image.\r
+ // ScatterGatherList is only referenced if the capsules are defined to persist across\r
+ // system reset. \r
//\r
- if (EfiAtRuntime ()) {\r
- //\r
- // Runtime mode doesn't support the non-reset capsule image.\r
- //\r
- return EFI_UNSUPPORTED;\r
+ if (ScatterGatherList == (EFI_PHYSICAL_ADDRESS) (UINTN) NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
}\r
\r
//\r
- // Here should be in the boot-time for non-reset capsule image\r
- // Platform specific update for the non-reset capsule image.\r
+ // Check if the platform supports update capsule across a system reset\r
//\r
- for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {\r
- Status = ProcessCapsuleImage (CapsuleHeaderArray[ArrayNumber]);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
+ if (!FeaturePcdGet(PcdSupportUpdateCapsuleReset)) {\r
+ return EFI_UNSUPPORTED;\r
}\r
\r
- return EFI_SUCCESS;\r
+ //\r
+ // ScatterGatherList is only referenced if the capsules are defined to persist across\r
+ // system reset. Set its value into NV storage to let pre-boot driver to pick it up \r
+ // after coming through a system reset.\r
+ //\r
+ Status = gRT->SetVariable (\r
+ EFI_CAPSULE_VARIABLE_NAME,\r
+ &gEfiCapsuleVendorGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (UINTN),\r
+ (VOID *) &ScatterGatherList\r
+ );\r
+ if (!EFI_ERROR (Status) && InitiateReset) {\r
+ //\r
+ // Firmware that encounters a capsule which has the CAPSULE_FLAGS_INITIATE_RESET Flag set in its header\r
+ // will initiate a reset of the platform which is compatible with the passed-in capsule request and will \r
+ // not return back to the caller.\r
+ //\r
+ gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
+ }\r
+ return Status;\r
}\r
\r
/**\r
}\r
\r
//\r
- // Check whether input paramter is valid\r
+ // Check whether input parameter is valid\r
//\r
if ((MaxiumCapsuleSize == NULL) ||(ResetType == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
return EFI_INVALID_PARAMETER;\r
}\r
//\r
+ // A capsule which has the CAPSULE_FLAGS_INITIATE_RESET flag must have\r
+ // CAPSULE_FLAGS_PERSIST_ACROSS_RESET set in its header as well.\r
+ //\r
+ if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_INITIATE_RESET)) == CAPSULE_FLAGS_INITIATE_RESET) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ //\r
// Check Capsule image without populate flag is supported by firmware\r
//\r
if (((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) && \r
//\r
//Check if the platform supports update capsule across a system reset\r
//\r
- if (!FeaturePcdGet(PcdSupportUpdateCapsuleRest)) {\r
+ if (!FeaturePcdGet(PcdSupportUpdateCapsuleReset)) {\r
return EFI_UNSUPPORTED;\r
}\r
- *ResetType = EfiResetWarm;\r
- *MaxiumCapsuleSize = FixedPcdGet32(PcdMaxSizePopulateCapsule);\r
+ *ResetType = EfiResetWarm; \r
} else {\r
//\r
// For non-reset capsule image.\r
//\r
*ResetType = EfiResetCold;\r
- *MaxiumCapsuleSize = FixedPcdGet32(PcdMaxSizeNonPopulateCapsule);\r
}\r
+ \r
+ //\r
+ // The support max capsule image size\r
+ //\r
+ if ((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) != 0) {\r
+ *MaxiumCapsuleSize = PcdGet32(PcdMaxSizePopulateCapsule);\r
+ } else {\r
+ *MaxiumCapsuleSize = PcdGet32(PcdMaxSizeNonPopulateCapsule);\r
+ }\r
+\r
return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
\r
- This code is to install UEFI capsule runtime service.\r
+ This code installs UEFI capsule runtime service.\r
\r
@param ImageHandle The firmware allocated handle for the EFI image. \r
@param SystemTable A pointer to the EFI System Table.\r
)\r
{\r
EFI_STATUS Status;\r
- EFI_HANDLE NewHandle;\r
\r
//\r
// Install capsule runtime services into UEFI runtime service tables.\r
//\r
- SystemTable->RuntimeServices->UpdateCapsule = UpdateCapsule;\r
- SystemTable->RuntimeServices->QueryCapsuleCapabilities = QueryCapsuleCapabilities;\r
+ gRT->UpdateCapsule = UpdateCapsule;\r
+ gRT->QueryCapsuleCapabilities = QueryCapsuleCapabilities;\r
\r
//\r
// Install the Capsule Architectural Protocol on a new handle\r
// to signify the capsule runtime services are ready.\r
//\r
- NewHandle = NULL;\r
-\r
Status = gBS->InstallMultipleProtocolInterfaces (\r
- &NewHandle,\r
+ &mNewHandle,\r
&gEfiCapsuleArchProtocolGuid,\r
NULL,\r
NULL\r
);\r
ASSERT_EFI_ERROR (Status);\r
\r
- return EFI_SUCCESS;\r
+ return Status;\r
}\r
projects / mirror_edk2.git / blobdiff