projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| d2a16030 JY |
1 | /** @file\r |
| 2 | DXE capsule process.\r | |
| 3 | Dummy function for runtime module, because CapsuleDxeRuntime\r | |
| 4 | does not need call ProcessCapsules().\r | |
| 5 | \r | |
| 57476106 | 6 | Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| d2a16030 JY |
7 | This program and the accompanying materials\r |
| 8 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 9 | which accompanies this distribution. The full text of the license may be found at\r | |
| 10 | http://opensource.org/licenses/bsd-license.php\r | |
| 11 | \r | |
| 12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 14 | \r | |
| 15 | **/\r | |
| 16 | \r | |
| 17 | #include <PiDxe.h>\r | |
| 18 | #include <Library/CapsuleLib.h>\r | |
| 19 | \r | |
| 57476106 KM |
20 | /**\r |
| 21 | Function indicate the current completion progress of the firmware\r | |
| 22 | update. Platform may override with own specific progress function.\r | |
| 23 | \r | |
| 24 | @param[in] Completion A value between 1 and 100 indicating the current\r | |
| 25 | completion progress of the firmware update\r | |
| 26 | \r | |
| 27 | @retval EFI_SUCESS The capsule update progress was updated.\r | |
| 28 | @retval EFI_INVALID_PARAMETER Completion is greater than 100%.\r | |
| 29 | **/\r | |
| 30 | EFI_STATUS\r | |
| 31 | EFIAPI\r | |
| 32 | UpdateImageProgress (\r | |
| 33 | IN UINTN Completion\r | |
| 34 | )\r | |
| 35 | {\r | |
| 36 | return EFI_SUCCESS;\r | |
| 37 | }\r | |
| 38 | \r | |
| d2a16030 JY |
39 | /**\r |
| 40 | \r | |
| 41 | This routine is called to process capsules.\r | |
| 42 | \r | |
| 43 | Caution: This function may receive untrusted input.\r | |
| 44 | \r | |
| 45 | The capsules reported in EFI_HOB_UEFI_CAPSULE are processed.\r | |
| 46 | If there is no EFI_HOB_UEFI_CAPSULE, this routine does nothing.\r | |
| 47 | \r | |
| 48 | This routine should be called twice in BDS.\r | |
| 49 | 1) The first call must be before EndOfDxe. The system capsules is processed.\r | |
| 50 | If device capsule FMP protocols are exposted at this time and device FMP\r | |
| 51 | capsule has zero EmbeddedDriverCount, the device capsules are processed.\r | |
| 52 | Each individual capsule result is recorded in capsule record variable.\r | |
| 53 | System may reset in this function, if reset is required by capsule and\r | |
| 54 | all capsules are processed.\r | |
| 55 | If not all capsules are processed, reset will be defered to second call.\r | |
| 56 | \r | |
| 57 | 2) The second call must be after EndOfDxe and after ConnectAll, so that all\r | |
| 58 | device capsule FMP protocols are exposed.\r | |
| 59 | The system capsules are skipped. If the device capsules are NOT processed\r | |
| 60 | in first call, they are processed here.\r | |
| 61 | Each individual capsule result is recorded in capsule record variable.\r | |
| 62 | System may reset in this function, if reset is required by capsule\r | |
| 63 | processed in first call and second call.\r | |
| 64 | \r | |
| 65 | @retval EFI_SUCCESS There is no error when processing capsules.\r | |
| 66 | @retval EFI_OUT_OF_RESOURCES No enough resource to process capsules.\r | |
| 67 | \r | |
| 68 | **/\r | |
| 69 | EFI_STATUS\r | |
| 70 | EFIAPI\r | |
| 71 | ProcessCapsules (\r | |
| 72 | VOID\r | |
| 73 | )\r | |
| 74 | {\r | |
| 75 | return EFI_UNSUPPORTED;\r | |
| 76 | }\r |