DisplayUpdateProgressLib.h File Reference

#include <Protocol/GraphicsOutput.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	DisplayUpdateProgress (IN UINTN Completion, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION *Color OPTIONAL)

Detailed Description

Provides services to display completion progress when processing a firmware update that updates the firmware image in a firmware device. A platform may provide its own instance of this library class to custoimize how a user is informed of completion progress.

Copyright (c) 2016, Microsoft Corporation Copyright (c) 2018, Intel Corporation. All rights reserved.

All rights reserved. SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DisplayUpdateProgressLib.h.

Function Documentation

DisplayUpdateProgress()

EFI_STATUS EFIAPI DisplayUpdateProgress	(	IN UINTN	Completion,
		IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION *Color	OPTIONAL
	)

Indicates the current completion progress of a firmware update.

Parameters

[in]	Completion	A value between 0 and 100 indicating the current completion progress of a firmware update. This value must the the same or higher than previous calls to this service. The first call of 0 or a value of 0 after reaching a value of 100 resets the progress indicator to 0.
[in]	Color	Color of the progress indicator. Only used when Completion is 0 to set the color of the progress indicator. If Color is NULL, then the default color is used.

Return values

EFI_SUCCESS	Progress displayed successfully.
EFI_INVALID_PARAMETER	Completion is not in range 0..100.
EFI_INVALID_PARAMETER	Completion is less than Completion value from a previous call to this service.
EFI_NOT_READY	The device used to indicate progress is not available.

Function indicates the current completion progress of a firmware update. Platform may override with its own specific function.

Parameters

[in]	Completion	A value between 0 and 100 indicating the current completion progress of a firmware update. This value must the the same or higher than previous calls to this service. The first call of 0 or a value of 0 after reaching a value of 100 resets the progress indicator to 0.
[in]	Color	Color of the progress indicator. Only used when Completion is 0 to set the color of the progress indicator. If Color is NULL, then the default color is used.

Return values

EFI_SUCCESS	Progress displayed successfully.
EFI_INVALID_PARAMETER	Completion is not in range 0..100.
EFI_INVALID_PARAMETER	Completion is less than Completion value from a previous call to this service.
EFI_NOT_READY	The device used to indicate progress is not available.

Definition at line 337 of file DisplayUpdateProgressLibGraphics.c.