BootMode.c File Reference

#include "PeiMain.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	PeiGetBootMode (IN CONST EFI_PEI_SERVICES **PeiServices, IN OUT EFI_BOOT_MODE *BootMode)
EFI_STATUS EFIAPI	PeiSetBootMode (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_BOOT_MODE BootMode)

Detailed Description

This module provide function for ascertaining and updating the boot mode: GetBootMode() SetBootMode() See PI Specification volume I, chapter 9 Boot Paths for additional information on the boot mode.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BootMode.c.

Function Documentation

PeiGetBootMode()

EFI_STATUS EFIAPI PeiGetBootMode	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN OUT EFI_BOOT_MODE *	BootMode
	)

This service enables PEIMs to ascertain the present value of the boot mode.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
BootMode	A pointer to contain the value of the boot mode.

Return values

EFI_SUCCESS	The boot mode was returned successfully.
EFI_INVALID_PARAMETER	BootMode is NULL.

Definition at line 27 of file BootMode.c.

PeiSetBootMode()

EFI_STATUS EFIAPI PeiSetBootMode	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN EFI_BOOT_MODE	BootMode
	)

This service enables PEIMs to update the boot mode variable.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
BootMode	The value of the boot mode to set.

Returns

EFI_SUCCESS The value was successfully updated

Definition at line 60 of file BootMode.c.