MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Guid / SmmVariableCommon.h

/** @file\r
  The file defined some common structures used for communicating between SMM variable module and SMM variable wrapper module.\r
\r
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _SMM_VARIABLE_COMMON_H_\r
#define _SMM_VARIABLE_COMMON_H_\r
\r
#include <Protocol/VarCheck.h>\r
\r
#define EFI_SMM_VARIABLE_WRITE_GUID \\r
  { 0x93ba1826, 0xdffb, 0x45dd, { 0x82, 0xa7, 0xe7, 0xdc, 0xaa, 0x3b, 0xbd, 0xf3 } }\r
\r
extern EFI_GUID gSmmVariableWriteGuid;\r
\r
//\r
// This structure is used for SMM variable. the collected statistics data is saved in SMRAM. It can be got from\r
// SMI handler. The communication buffer should be:\r
// EFI_SMM_COMMUNICATE_HEADER + SMM_VARIABLE_COMMUNICATE_HEADER + payload.\r
//\r
typedef struct {\r
  UINTN       Function;\r
  EFI_STATUS  ReturnStatus;\r
  UINT8       Data[1];\r
} SMM_VARIABLE_COMMUNICATE_HEADER;\r
\r
//\r
// The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r
//\r
#define SMM_VARIABLE_FUNCTION_GET_VARIABLE            1\r
//\r
// The payload for this function is SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME.\r
//\r
#define SMM_VARIABLE_FUNCTION_GET_NEXT_VARIABLE_NAME  2\r
//\r
// The payload for this function is SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE.\r
//\r
#define SMM_VARIABLE_FUNCTION_SET_VARIABLE            3\r
//\r
// The payload for this function is SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO.\r
//\r
#define SMM_VARIABLE_FUNCTION_QUERY_VARIABLE_INFO     4\r
//\r
// It is a notify event, no extra payload for this function.\r
//\r
#define SMM_VARIABLE_FUNCTION_READY_TO_BOOT           5\r
//\r
// It is a notify event, no extra payload for this function.\r
//\r
#define SMM_VARIABLE_FUNCTION_EXIT_BOOT_SERVICE       6\r
//\r
// The payload for this function is VARIABLE_INFO_ENTRY. The GUID in EFI_SMM_COMMUNICATE_HEADER\r
// is gEfiSmmVariableProtocolGuid.\r
//\r
#define SMM_VARIABLE_FUNCTION_GET_STATISTICS          7\r
//\r
// The payload for this function is SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE\r
//\r
#define SMM_VARIABLE_FUNCTION_LOCK_VARIABLE           8\r
\r
#define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_SET  9\r
\r
#define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET  10\r
\r
#define SMM_VARIABLE_FUNCTION_GET_PAYLOAD_SIZE        11\r
\r
///\r
/// Size of SMM communicate header, without including the payload.\r
///\r
#define SMM_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data))\r
\r
///\r
/// Size of SMM variable communicate header, without including the payload.\r
///\r
#define SMM_VARIABLE_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (SMM_VARIABLE_COMMUNICATE_HEADER, Data))\r
\r
///\r
/// This structure is used to communicate with SMI handler by SetVariable and GetVariable.\r
///\r
typedef struct {\r
  EFI_GUID    Guid;\r
  UINTN       DataSize;\r
  UINTN       NameSize;\r
  UINT32      Attributes;\r
  CHAR16      Name[1];\r
} SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE;\r
\r
///\r
/// This structure is used to communicate with SMI handler by GetNextVariableName.\r
///\r
typedef struct {\r
  EFI_GUID    Guid;\r
  UINTN       NameSize;     // Return name buffer size\r
  CHAR16      Name[1];\r
} SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME;\r
\r
///\r
/// This structure is used to communicate with SMI handler by QueryVariableInfo.\r
///\r
typedef struct {\r
  UINT64          MaximumVariableStorageSize;\r
  UINT64          RemainingVariableStorageSize;\r
  UINT64          MaximumVariableSize;\r
  UINT32          Attributes;\r
} SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO;\r
\r
typedef SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE;\r
\r
typedef struct {\r
  EFI_GUID                      Guid;\r
  UINTN                         NameSize;\r
  VAR_CHECK_VARIABLE_PROPERTY   VariableProperty;\r
  CHAR16                        Name[1];\r
} SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY;\r
\r
typedef struct {\r
  UINTN                         VariablePayloadSize;\r
} SMM_VARIABLE_COMMUNICATE_GET_PAYLOAD_SIZE;\r
\r
#endif // _SMM_VARIABLE_COMMON_H_\r