]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
retire FvbServiceLib class in MdeModulePkg, and also remove the two instances in...
[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / Variable.h
1 /** @file
2
3 The internal header file includes the common header files, defines
4 internal structure and functions used by RuntimeVariable module.
5
6 Copyright (c) 2006 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 **/
16
17 #ifndef _VARIABLE_H_
18 #define _VARIABLE_H_
19
20 #include <PiDxe.h>
21 #include <Protocol/VariableWrite.h>
22 #include <Protocol/FaultTolerantWrite.h>
23 #include <Protocol/FirmwareVolumeBlock.h>
24 #include <Protocol/Variable.h>
25 #include <Library/PcdLib.h>
26 #include <Library/UefiDriverEntryPoint.h>
27 #include <Library/DxeServicesTableLib.h>
28 #include <Library/UefiRuntimeLib.h>
29 #include <Library/DebugLib.h>
30 #include <Library/BaseMemoryLib.h>
31 #include <Library/UefiBootServicesTableLib.h>
32 #include <Library/UefiLib.h>
33 #include <Library/BaseLib.h>
34 #include <Library/SynchronizationLib.h>
35 #include <Library/MemoryAllocationLib.h>
36 #include <Guid/GlobalVariable.h>
37 #include <Guid/EventGroup.h>
38 #include <Guid/VariableFormat.h>
39
40 #define VARIABLE_RECLAIM_THRESHOLD (1024)
41
42 typedef struct {
43 VARIABLE_HEADER *CurrPtr;
44 VARIABLE_HEADER *EndPtr;
45 VARIABLE_HEADER *StartPtr;
46 BOOLEAN Volatile;
47 } VARIABLE_POINTER_TRACK;
48
49 typedef struct {
50 EFI_PHYSICAL_ADDRESS VolatileVariableBase;
51 EFI_PHYSICAL_ADDRESS NonVolatileVariableBase;
52 EFI_LOCK VariableServicesLock;
53 UINT32 ReentrantState;
54 } VARIABLE_GLOBAL;
55
56 typedef struct {
57 VARIABLE_GLOBAL VariableGlobal;
58 UINTN VolatileLastVariableOffset;
59 UINTN NonVolatileLastVariableOffset;
60 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbInstance;
61 } VARIABLE_MODULE_GLOBAL;
62
63 typedef struct {
64 EFI_GUID *Guid;
65 CHAR16 *Name;
66 UINT32 Attributes;
67 UINTN DataSize;
68 VOID *Data;
69 } VARIABLE_CACHE_ENTRY;
70
71 /**
72 Writes a buffer to variable storage space, in the working block.
73
74 This function writes a buffer to variable storage space into firmware
75 volume block device. The destination is specified by parameter
76 VariableBase. Fault Tolerant Write protocol is used for writing.
77
78 @param VariableBase Base address of variable to write
79 @param Buffer Point to the data buffer
80 @param BufferSize The number of bytes of the data Buffer
81
82 @retval EFI_SUCCESS The function completed successfully
83 @retval EFI_NOT_FOUND Fail to locate Fault Tolerant Write protocol
84 @retval EFI_ABORTED The function could not complete successfully
85
86 **/
87 EFI_STATUS
88 FtwVariableSpace (
89 IN EFI_PHYSICAL_ADDRESS VariableBase,
90 IN UINT8 *Buffer,
91 IN UINTN BufferSize
92 );
93
94
95 #endif