MemoryAttribute.h File Reference

Go to the source code of this file.

Data Structures
struct	_EFI_MEMORY_ATTRIBUTE_PROTOCOL

Macros
#define	EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID

Typedefs
typedef struct _EFI_MEMORY_ATTRIBUTE_PROTOCOL	EFI_MEMORY_ATTRIBUTE_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_SET_MEMORY_ATTRIBUTES) (IN EFI_MEMORY_ATTRIBUTE_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)
typedef EFI_STATUS(EFIAPI *	EFI_CLEAR_MEMORY_ATTRIBUTES) (IN EFI_MEMORY_ATTRIBUTE_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)
typedef EFI_STATUS(EFIAPI *	EFI_GET_MEMORY_ATTRIBUTES) (IN EFI_MEMORY_ATTRIBUTE_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, OUT UINT64 *Attributes)

Variables
EFI_GUID	gEfiMemoryAttributeProtocolGuid

Detailed Description

EFI Memory Attribute Protocol provides retrieval and update service for memory attributes in EFI environment.

Copyright (c) 2021, Intel Corporation. All rights reserved.
Copyright (c) 2023, Google LLC. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file MemoryAttribute.h.

Macro Definition Documentation

EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID

#define EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID

Value:

  { \
    0xf4560cf6, 0x40ec, 0x4b4a, { 0xa1, 0x92, 0xbf, 0x1d, 0x57, 0xd0, 0xb1, 0x89 } \
  }

Definition at line 15 of file MemoryAttribute.h.

Typedef Documentation

EFI_CLEAR_MEMORY_ATTRIBUTES

typedef EFI_STATUS(EFIAPI * EFI_CLEAR_MEMORY_ATTRIBUTES) (IN EFI_MEMORY_ATTRIBUTE_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)

This function clears given attributes of the memory region specified by BaseAddress and Length.

The valid Attributes is EFI_MEMORY_RP, EFI_MEMORY_XP, and EFI_MEMORY_RO.

Parameters

This	The EFI_MEMORY_ATTRIBUTE_PROTOCOL instance.
BaseAddress	The physical address that is the start address of a memory region.
Length	The size in bytes of the memory region.
Attributes	The bit mask of attributes to clear for the memory region.

Return values

EFI_SUCCESS	The attributes were cleared for the memory region.
EFI_INVALID_PARAMETER	Length is zero. Attributes specified an illegal combination of attributes that cannot be cleared together.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length. The bit mask of attributes is not supported for the memory resource range specified by BaseAddress and Length.
EFI_OUT_OF_RESOURCES	Requested attributes cannot be applied due to lack of system resources.
EFI_ACCESS_DENIED	Attributes for the requested memory region are controlled by system firmware and cannot be updated via the protocol.

Definition at line 92 of file MemoryAttribute.h.

EFI_GET_MEMORY_ATTRIBUTES

typedef EFI_STATUS(EFIAPI * EFI_GET_MEMORY_ATTRIBUTES) (IN EFI_MEMORY_ATTRIBUTE_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, OUT UINT64 *Attributes)

This function retrieves the attributes of the memory region specified by BaseAddress and Length. If different attributes are obtained from different parts of the memory region, EFI_NO_MAPPING will be returned.

Parameters

This	The EFI_MEMORY_ATTRIBUTE_PROTOCOL instance.
BaseAddress	The physical address that is the start address of a memory region.
Length	The size in bytes of the memory region.
Attributes	Pointer to attributes returned.

Return values

EFI_SUCCESS	The attributes got for the memory region.
EFI_INVALID_PARAMETER	Length is zero. Attributes is NULL.
EFI_NO_MAPPING	Attributes are not consistent cross the memory region.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length.

Definition at line 122 of file MemoryAttribute.h.

EFI_MEMORY_ATTRIBUTE_PROTOCOL

typedef struct _EFI_MEMORY_ATTRIBUTE_PROTOCOL EFI_MEMORY_ATTRIBUTE_PROTOCOL

Definition at line 20 of file MemoryAttribute.h.

EFI_SET_MEMORY_ATTRIBUTES

typedef EFI_STATUS(EFIAPI * EFI_SET_MEMORY_ATTRIBUTES) (IN EFI_MEMORY_ATTRIBUTE_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)

This function set given attributes of the memory region specified by BaseAddress and Length.

The valid Attributes is EFI_MEMORY_RP, EFI_MEMORY_XP, and EFI_MEMORY_RO.

Parameters

This	The EFI_MEMORY_ATTRIBUTE_PROTOCOL instance.
BaseAddress	The physical address that is the start address of a memory region.
Length	The size in bytes of the memory region.
Attributes	The bit mask of attributes to set for the memory region.

Return values

EFI_SUCCESS	The attributes were set for the memory region.
EFI_INVALID_PARAMETER	Length is zero. Attributes specified an illegal combination of attributes that cannot be set together.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length. The bit mask of attributes is not supported for the memory resource range specified by BaseAddress and Length.
EFI_OUT_OF_RESOURCES	Requested attributes cannot be applied due to lack of system resources.
EFI_ACCESS_DENIED	Attributes for the requested memory region are controlled by system firmware and cannot be updated via the protocol.

Definition at line 53 of file MemoryAttribute.h.