TianoCore EDK2 master
Loading...
Searching...
No Matches
DisplayUpdateProgressLibText.c File Reference

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)
 

Variables

UINTN mPreviousProgress = 100
 
UINTN mProgressBarForegroundColor
 

Detailed Description

Provides services to display completion progress of a firmware update on a text console.

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

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DisplayUpdateProgressLibText.c.

Function Documentation

◆ DisplayUpdateProgress()

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

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

Parameters
[in]CompletionA 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]ColorColor 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_SUCCESSProgress displayed successfully.
EFI_INVALID_PARAMETERCompletion is not in range 0..100.
EFI_INVALID_PARAMETERCompletion is less than Completion value from a previous call to this service.
EFI_NOT_READYThe device used to indicate progress is not available.

Definition at line 51 of file DisplayUpdateProgressLibText.c.

Variable Documentation

◆ mPreviousProgress

UINTN mPreviousProgress = 100

Definition at line 20 of file DisplayUpdateProgressLibText.c.

◆ mProgressBarForegroundColor

UINTN mProgressBarForegroundColor

Definition at line 25 of file DisplayUpdateProgressLibText.c.