QemuFwCfgLib.h File Reference

#include <IndustryStandard/QemuFwCfg.h>

Go to the source code of this file.

Functions
BOOLEAN EFIAPI	QemuFwCfgIsAvailable (VOID)
VOID EFIAPI	QemuFwCfgSelectItem (IN FIRMWARE_CONFIG_ITEM QemuFwCfgItem)
VOID EFIAPI	QemuFwCfgReadBytes (IN UINTN Size, IN VOID *Buffer OPTIONAL)
VOID EFIAPI	QemuFwCfgWriteBytes (IN UINTN Size, IN VOID *Buffer)
VOID EFIAPI	QemuFwCfgSkipBytes (IN UINTN Size)
UINT8 EFIAPI	QemuFwCfgRead8 (VOID)
UINT16 EFIAPI	QemuFwCfgRead16 (VOID)
UINT32 EFIAPI	QemuFwCfgRead32 (VOID)
UINT64 EFIAPI	QemuFwCfgRead64 (VOID)
RETURN_STATUS EFIAPI	QemuFwCfgFindFile (IN CONST CHAR8 *Name, OUT FIRMWARE_CONFIG_ITEM *Item, OUT UINTN *Size)

Detailed Description

QEMU/KVM Firmware Configuration access

Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.
Copyright (C) 2013, Red Hat, Inc.

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

Definition in file QemuFwCfgLib.h.

Function Documentation

QemuFwCfgFindFile()

RETURN_STATUS EFIAPI QemuFwCfgFindFile	(	IN CONST CHAR8 *	Name,
		OUT FIRMWARE_CONFIG_ITEM *	Item,
		OUT UINTN *	Size
	)

Find the configuration item corresponding to the firmware configuration file.

Parameters

[in]	Name	- Name of file to look up.
[out]	Item	- Configuration item corresponding to the file, to be passed to QemuFwCfgSelectItem ().
[out]	Size	- Number of bytes in the file.

Returns

RETURN_SUCCESS If file is found. RETURN_NOT_FOUND If file is not found. RETURN_UNSUPPORTED If firmware configuration is unavailable.

Find the configuration item corresponding to the firmware configuration file.

Parameters

[in]	Name	Name of file to look up.
[out]	Item	Configuration item corresponding to the file, to be passed to QemuFwCfgSelectItem ().
[out]	Size	Number of bytes in the file.

Return values

RETURN_SUCCESS	If file is found.
RETURN_NOT_FOUND	If file is not found.
RETURN_UNSUPPORTED	If firmware configuration is unavailable.

Definition at line 250 of file QemuFwCfgLib.c.

QemuFwCfgIsAvailable()

BOOLEAN EFIAPI QemuFwCfgIsAvailable

(

VOID

)

Returns a boolean indicating if the firmware configuration interface is available or not.

This function may change fw_cfg state.

Return values

TRUE	The interface is available
FALSE	The interface is not available

Definition at line 44 of file QemuFwCfgDxe.c.

QemuFwCfgRead16()

UINT16 EFIAPI QemuFwCfgRead16

(

VOID

)

Reads a UINT16 firmware configuration value

Returns

Value of Firmware Configuration item read

Definition at line 186 of file QemuFwCfgLib.c.

QemuFwCfgRead32()

UINT32 EFIAPI QemuFwCfgRead32

(

VOID

)

Reads a UINT32 firmware configuration value

Returns

Value of Firmware Configuration item read

Definition at line 205 of file QemuFwCfgLib.c.

QemuFwCfgRead64()

UINT64 EFIAPI QemuFwCfgRead64

(

VOID

)

Reads a UINT64 firmware configuration value

Returns

Value of Firmware Configuration item read

Definition at line 224 of file QemuFwCfgLib.c.

QemuFwCfgRead8()

UINT8 EFIAPI QemuFwCfgRead8

(

VOID

)

Reads a UINT8 firmware configuration value

Returns

Value of Firmware Configuration item read

Definition at line 167 of file QemuFwCfgLib.c.

QemuFwCfgReadBytes()

VOID EFIAPI QemuFwCfgReadBytes	(	IN UINTN	Size,
		IN VOID *Buffer	OPTIONAL
	)

Reads firmware configuration bytes into a buffer

If called multiple times, then the data read will continue at the offset of the firmware configuration item where the previous read ended.

Parameters

[in]	Size	- Size in bytes to read
[in]	Buffer	- Buffer to store data into

Definition at line 66 of file QemuFwCfgNull.c.

QemuFwCfgSelectItem()

VOID EFIAPI QemuFwCfgSelectItem

(

IN FIRMWARE_CONFIG_ITEM

QemuFwCfgItem

)

Selects a firmware configuration item for reading.

Following this call, any data read from this item will start from the beginning of the configuration item's data.

Parameters

[in]

QemuFwCfgItem

- Firmware Configuration item to read

Selects a firmware configuration item for reading.

Following this call, any data read from this item will start from the beginning of the configuration item's data.

Parameters

[in]

QemuFwCfgItem

Firmware Configuration item to read

Definition at line 33 of file QemuFwCfgLib.c.

QemuFwCfgSkipBytes()

VOID EFIAPI QemuFwCfgSkipBytes

(

IN UINTN

Size

)

Skip bytes in the firmware configuration item.

Increase the offset of the firmware configuration item without transferring bytes between the item and a caller-provided buffer. Subsequent read, write or skip operations will commence at the increased offset.

Parameters

[in]

Size

Number of bytes to skip.

Definition at line 127 of file QemuFwCfgLib.c.

QemuFwCfgWriteBytes()

VOID EFIAPI QemuFwCfgWriteBytes	(	IN UINTN	Size,
		IN VOID *	Buffer
	)

Writes firmware configuration bytes from a buffer

If called multiple times, then the data written will continue at the offset of the firmware configuration item where the previous write ended.

Parameters

[in]	Size	- Size in bytes to write
[in]	Buffer	- Buffer to read data from

Write firmware configuration bytes from a buffer

If called multiple times, then the data written will continue at the offset of the firmware configuration item where the previous write ended.

Parameters

[in]	Size	- Size in bytes to write
[in]	Buffer	- Buffer to read data from

Write firmware configuration bytes from a buffer

If called multiple times, then the data written will continue at the offset of the firmware configuration item where the previous write ended.

Parameters

[in]	Size	Size in bytes to write
[in]	Buffer	Buffer to read data from

Definition at line 101 of file QemuFwCfgLib.c.