MdeModulePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  The variable data structures are related to EDK II-specific implementation of UEFI variables.\r
  VariableFormat.h defines variable data headers and variable storage region headers.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __VARIABLE_INDEX_TABLE_H__\r
#define __VARIABLE_INDEX_TABLE_H__\r
\r
typedef struct {\r
  VARIABLE_HEADER *CurrPtr;\r
  VARIABLE_HEADER *EndPtr;\r
  VARIABLE_HEADER *StartPtr;\r
} VARIABLE_POINTER_TRACK;\r
\r
#define VARIABLE_INDEX_TABLE_VOLUME 122\r
\r
#define EFI_VARIABLE_INDEX_TABLE_GUID \\r
  { 0x8cfdb8c8, 0xd6b2, 0x40f3, { 0x8e, 0x97, 0x02, 0x30, 0x7c, 0xc9, 0x8b, 0x7c } }\r
\r
extern EFI_GUID gEfiVariableIndexTableGuid;\r
\r
///\r
/// Use this data structure to store variable-related info, which can decrease\r
/// the cost of access to NV.\r
///\r
typedef struct {\r
  UINT16          Length;\r
  UINT16          GoneThrough;\r
  VARIABLE_HEADER *EndPtr;\r
  VARIABLE_HEADER *StartPtr;\r
  ///\r
  /// This field is used to store the distance of two neighbouring VAR_ADDED type variables.\r
  /// The meaning of the field is implement-dependent.\r
  UINT16          Index[VARIABLE_INDEX_TABLE_VOLUME];\r
} VARIABLE_INDEX_TABLE;\r
\r
#endif // __VARIABLE_INDEX_TABLE_H__\r