Add variablePei module into MdeModulePkg.

[mirror_edk2.git] / MdeModulePkg / Universal / VariablePei / Variable.h

diff --git a/MdeModulePkg/Universal/VariablePei/Variable.h b/MdeModulePkg/Universal/VariablePei/Variable.h
new file mode 100644 (file)
index 0000000..5cebff8
--- /dev/null
+++ b/MdeModulePkg/Universal/VariablePei/Variable.h
@@ -0,0 +1,184 @@
+/*++\r
+\r
+Copyright (c) 2006 - 2007, Intel Corporation\r
+All rights reserved. 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
+Module Name:\r
+\r
+  Variable.h\r
+\r
+Abstract:\r
+\r
+  Tiano PEIM to provide the variable functionality\r
+\r
+--*/\r
+\r
+#ifndef _PEI_VARIABLE_H\r
+#define _PEI_VARIABLE_H\r
+\r
+//\r
+// BugBug: We need relcate the head file.\r
+//\r
+#include <Common/Variable.h>\r
+#include <VarMachine.h>\r
+\r
+//\r
+// Define GET_PAD_SIZE to optimize compiler\r
+//\r
+#if ((ALIGNMENT == 0) || (ALIGNMENT == 1))\r
+#define GET_PAD_SIZE(a) (0)\r
+#else\r
+#define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))\r
+#endif\r
+\r
+#define GET_VARIABLE_NAME_PTR(a)  (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))\r
+\r
+#define GET_VARIABLE_DATA_PTR(a) \\r
+  (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (a) + (a)->NameSize + GET_PAD_SIZE ((a)->NameSize))\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
+typedef struct {\r
+  UINT16          Length;\r
+  UINT16          GoneThrough;\r
+  VARIABLE_HEADER *EndPtr;\r
+  VARIABLE_HEADER *StartPtr;\r
+  UINT16          Index[VARIABLE_INDEX_TABLE_VOLUME];\r
+} VARIABLE_INDEX_TABLE;\r
+\r
+\r
+//\r
+// Functions\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+PeimInitializeVariableServices (\r
+  IN EFI_FFS_FILE_HEADER       *FfsHeader,\r
+  IN EFI_PEI_SERVICES          **PeiServices\r
+  )\r
+/*++\r
+\r
+Routine Description:\r
+\r
+  TODO: Add function description\r
+\r
+Arguments:\r
+\r
+  FfsHeader   - TODO: add argument description\r
+  PeiServices - TODO: add argument description\r
+\r
+Returns:\r
+\r
+  TODO: add return values\r
+\r
+--*/\r
+;\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetVariable (\r
+  IN EFI_PEI_SERVICES             **PeiServices,\r
+  IN CHAR16                       *VariableName,\r
+  IN EFI_GUID                     * VendorGuid,\r
+  OUT UINT32                      *Attributes OPTIONAL,\r
+  IN OUT UINTN                    *DataSize,\r
+  OUT VOID                        *Data\r
+  )\r
+/*++\r
+\r
+Routine Description:\r
+\r
+  TODO: Add function description\r
+\r
+Arguments:\r
+\r
+  PeiServices   - TODO: add argument description\r
+  VariableName  - TODO: add argument description\r
+  VendorGuid    - TODO: add argument description\r
+  Attributes    - TODO: add argument description\r
+  DataSize      - TODO: add argument description\r
+  Data          - TODO: add argument description\r
+\r
+Returns:\r
+\r
+  TODO: add return values\r
+\r
+--*/\r
+;\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+PeiGetNextVariableName (\r
+  IN EFI_PEI_SERVICES             **PeiServices,\r
+  IN OUT UINTN                    *VariableNameSize,\r
+  IN OUT CHAR16                   *VariableName,\r
+  IN OUT EFI_GUID                 *VendorGuid\r
+  )\r
+/*++\r
+\r
+Routine Description:\r
+\r
+  TODO: Add function description\r
+\r
+Arguments:\r
+\r
+  PeiServices       - TODO: add argument description\r
+  VariableNameSize  - TODO: add argument description\r
+  VariableName      - TODO: add argument description\r
+  VendorGuid        - TODO: add argument description\r
+\r
+Returns:\r
+\r
+  TODO: add return values\r
+\r
+--*/\r
+;\r
+\r
+/**\r
+  Get one variable by the index count.\r
+\r
+  @param  IndexTable  The pointer to variable index table.\r
+  @param  Count       The index count of variable in index table.\r
+\r
+  @return The pointer to variable header indexed by count.\r
+\r
+**/\r
+VARIABLE_HEADER *\r
+GetVariableByIndex (\r
+  IN VARIABLE_INDEX_TABLE        *IndexTable,\r
+  IN UINT32                      Count\r
+  );\r
+\r
+/**\r
+  Record Variable in VariableIndex HOB.\r
+\r
+  Record Variable in VariableIndex HOB and update the length of variable index table.\r
+\r
+  @param  IndexTable  The pointer to variable index table.\r
+  @param  Variable    The pointer to the variable that will be recorded.\r
+\r
+  @retval VOID\r
+\r
+**/\r
+VOID\r
+VariableIndexTableUpdate (\r
+  IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,\r
+  IN      VARIABLE_HEADER        *Variable\r
+  );\r
+\r
+#endif // _PEI_VARIABLE_H\r