MdeModulePkg SmmMemoryAttribute.h: Refine some comments

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / SmmMemoryAttribute.h

/** @file\r
  SMM Memory Attribute Protocol provides retrieval and update service\r
  for memory attributes in EFI SMM environment.\r
\r
  Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __SMM_MEMORYATTRIBUTE_H__\r
#define __SMM_MEMORYATTRIBUTE_H__\r
\r
//{69B792EA-39CE-402D-A2A6-F721DE351DFE}\r
#define EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL_GUID \\r
  { \\r
    0x69b792ea, 0x39ce, 0x402d, { 0xa2, 0xa6, 0xf7, 0x21, 0xde, 0x35, 0x1d, 0xfe } \\r
  }\r
\r
typedef struct _EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL;\r
\r
/**\r
  This function set given attributes of the memory region specified by\r
  BaseAddress and Length.\r
\r
  @param  This              The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.\r
  @param  BaseAddress       The physical address that is the start address of\r
                            a memory region.\r
  @param  Length            The size in bytes of the memory region.\r
  @param  Attributes        The bit mask of attributes to set for the memory\r
                            region.\r
\r
  @retval EFI_SUCCESS           The attributes were set for the memory region.\r
  @retval EFI_INVALID_PARAMETER Length is zero.\r
                                Attributes specified an illegal combination of\r
                                attributes that cannot be set together.\r
  @retval EFI_UNSUPPORTED       The processor does not support one or more\r
                                bytes of the memory resource range specified\r
                                by BaseAddress and Length.\r
                                The bit mask of attributes is not supported for\r
                                the memory resource range specified by\r
                                BaseAddress and Length.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_SMM_SET_MEMORY_ATTRIBUTES)(\r
  IN  EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *This,\r
  IN  EFI_PHYSICAL_ADDRESS                BaseAddress,\r
  IN  UINT64                              Length,\r
  IN  UINT64                              Attributes\r
  );\r
\r
/**\r
  This function clears given attributes of the memory region specified by\r
  BaseAddress and Length.\r
\r
  @param  This              The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.\r
  @param  BaseAddress       The physical address that is the start address of\r
                            a memory region.\r
  @param  Length            The size in bytes of the memory region.\r
  @param  Attributes        The bit mask of attributes to clear for the memory\r
                            region.\r
\r
  @retval EFI_SUCCESS           The attributes were cleared for the memory region.\r
  @retval EFI_INVALID_PARAMETER Length is zero.\r
                                Attributes specified an illegal combination of\r
                                attributes that cannot be cleared together.\r
  @retval EFI_UNSUPPORTED       The processor does not support one or more\r
                                bytes of the memory resource range specified\r
                                by BaseAddress and Length.\r
                                The bit mask of attributes is not supported for\r
                                the memory resource range specified by\r
                                BaseAddress and Length.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_SMM_CLEAR_MEMORY_ATTRIBUTES)(\r
  IN  EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *This,\r
  IN  EFI_PHYSICAL_ADDRESS                BaseAddress,\r
  IN  UINT64                              Length,\r
  IN  UINT64                              Attributes\r
  );\r
\r
/**\r
  This function retrieves the attributes of the memory region specified by\r
  BaseAddress and Length. If different attributes are got from different part\r
  of the memory region, EFI_NO_MAPPING will be returned.\r
\r
  @param  This              The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.\r
  @param  BaseAddress       The physical address that is the start address of\r
                            a memory region.\r
  @param  Length            The size in bytes of the memory region.\r
  @param  Attributes        Pointer to attributes returned.\r
\r
  @retval EFI_SUCCESS           The attributes got for the memory region.\r
  @retval EFI_INVALID_PARAMETER Length is zero.\r
                                Attributes is NULL.\r
  @retval EFI_NO_MAPPING        Attributes are not consistent cross the memory\r
                                region.\r
  @retval EFI_UNSUPPORTED       The processor does not support one or more\r
                                bytes of the memory resource range specified\r
                                by BaseAddress and Length.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EDKII_SMM_GET_MEMORY_ATTRIBUTES)(\r
  IN  EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL *This,\r
  IN  EFI_PHYSICAL_ADDRESS                BaseAddress,\r
  IN  UINT64                              Length,\r
  OUT UINT64                              *Attributes\r
  );\r
\r
///\r
/// SMM Memory Attribute Protocol provides services to retrieve or update\r
/// attribute of memory in the EFI SMM environment.\r
///\r
struct _EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL {\r
  EDKII_SMM_GET_MEMORY_ATTRIBUTES       GetMemoryAttributes;\r
  EDKII_SMM_SET_MEMORY_ATTRIBUTES       SetMemoryAttributes;\r
  EDKII_SMM_CLEAR_MEMORY_ATTRIBUTES     ClearMemoryAttributes;\r
};\r
\r
extern EFI_GUID gEdkiiSmmMemoryAttributeProtocolGuid;\r
\r
#endif\r