]>
Commit | Line | Data |
---|---|---|
825d138f MK |
1 | /** @file\r |
2 | Provides services to display completion progress when processing a\r | |
3 | firmware update that updates the firmware image in a firmware device.\r | |
4 | A platform may provide its own instance of this library class to custoimize\r | |
5 | how a user is informed of completion progress.\r | |
6 | \r | |
7 | Copyright (c) 2016, Microsoft Corporation\r | |
8 | Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r | |
9 | \r | |
10 | All rights reserved.\r | |
9d510e61 | 11 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
825d138f MK |
12 | \r |
13 | **/\r | |
14 | \r | |
15 | #ifndef __DISPLAY_PROGRESS_LIB__\r | |
16 | #define __DISPLAY_PROGRESS_LIB__\r | |
17 | \r | |
18 | #include <Protocol/GraphicsOutput.h>\r | |
19 | \r | |
20 | /**\r | |
21 | Indicates the current completion progress of a firmware update.\r | |
22 | \r | |
23 | @param[in] Completion A value between 0 and 100 indicating the current\r | |
24 | completion progress of a firmware update. This\r | |
25 | value must the the same or higher than previous\r | |
26 | calls to this service. The first call of 0 or a\r | |
27 | value of 0 after reaching a value of 100 resets\r | |
28 | the progress indicator to 0.\r | |
29 | @param[in] Color Color of the progress indicator. Only used when\r | |
30 | Completion is 0 to set the color of the progress\r | |
31 | indicator. If Color is NULL, then the default color\r | |
32 | is used.\r | |
33 | \r | |
34 | @retval EFI_SUCCESS Progress displayed successfully.\r | |
35 | @retval EFI_INVALID_PARAMETER Completion is not in range 0..100.\r | |
36 | @retval EFI_INVALID_PARAMETER Completion is less than Completion value from\r | |
37 | a previous call to this service.\r | |
38 | @retval EFI_NOT_READY The device used to indicate progress is not\r | |
39 | available.\r | |
40 | **/\r | |
41 | EFI_STATUS\r | |
42 | EFIAPI\r | |
43 | DisplayUpdateProgress (\r | |
44 | IN UINTN Completion,\r | |
45 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION *Color OPTIONAL\r | |
46 | );\r | |
47 | \r | |
48 | #endif\r |