]>
Commit | Line | Data |
---|---|---|
9071550e | 1 | /*++\r |
2 | \r | |
b1f700a8 HT |
3 | Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>\r |
4 | This program and the accompanying materials \r | |
9071550e | 5 | are licensed and made available under the terms and conditions of the BSD License \r |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | VariableStorage.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | handles variable store/reads with memory and file\r | |
19 | \r | |
20 | Revision History\r | |
21 | \r | |
22 | --*/\r | |
23 | #ifndef _VARIABLE_STORAGE_H_\r | |
24 | #define _VARIABLE_STORAGE_H_\r | |
25 | \r | |
26 | #define VAR_DEFAULT_VALUE (0xff)\r | |
eea53ce1 | 27 | #define VAR_DEFAULT_VALUE_16 SIGNATURE_16 (VAR_DEFAULT_VALUE, VAR_DEFAULT_VALUE)\r |
28 | #define VAR_DEFAULT_VALUE_32 SIGNATURE_32 (VAR_DEFAULT_VALUE, VAR_DEFAULT_VALUE, \\r | |
9071550e | 29 | VAR_DEFAULT_VALUE, VAR_DEFAULT_VALUE)\r |
30 | \r | |
31 | typedef struct _VARIABLE_STORAGE VARIABLE_STORAGE;\r | |
32 | \r | |
33 | EFI_STATUS\r | |
34 | FileStorageConstructor (\r | |
35 | OUT VARIABLE_STORAGE **VarStore,\r | |
36 | OUT EFI_EVENT_NOTIFY *GoVirtualEvent,\r | |
37 | IN EFI_PHYSICAL_ADDRESS NvStorageBase,\r | |
38 | IN UINTN Size,\r | |
39 | IN UINT32 VolumeId,\r | |
40 | IN CHAR16 *FilePath\r | |
41 | );\r | |
42 | \r | |
43 | EFI_STATUS\r | |
44 | MemStorageConstructor (\r | |
45 | OUT VARIABLE_STORAGE **VarStore,\r | |
46 | OUT EFI_EVENT_NOTIFY *GoVirtualEvent,\r | |
47 | IN UINTN Size\r | |
48 | );\r | |
49 | \r | |
50 | typedef\r | |
51 | EFI_STATUS\r | |
52 | (EFIAPI *ERASE_STORE) (\r | |
53 | IN VARIABLE_STORAGE *This\r | |
54 | );\r | |
55 | \r | |
56 | typedef\r | |
57 | EFI_STATUS\r | |
58 | (EFIAPI *WRITE_STORE) (\r | |
59 | IN VARIABLE_STORAGE *This,\r | |
60 | IN UINTN Offset,\r | |
61 | IN UINTN BufferSize,\r | |
62 | IN VOID *Buffer\r | |
63 | );\r | |
64 | \r | |
65 | struct _VARIABLE_STORAGE {\r | |
66 | \r | |
67 | //\r | |
68 | // Functions to access the storage\r | |
69 | //\r | |
70 | ERASE_STORE Erase;\r | |
71 | WRITE_STORE Write;\r | |
72 | };\r | |
73 | \r | |
74 | typedef struct _VS_FILE_INFO {\r | |
75 | UINT8 *FileData; // local buffer for reading acceleration\r | |
76 | \r | |
77 | EFI_DEVICE_PATH_PROTOCOL *DevicePath; // device having storage file\r | |
78 | UINT32 VolumeId;\r | |
79 | CHAR16 FilePath[256];\r | |
80 | } VS_FILE_INFO;\r | |
81 | \r | |
82 | typedef struct _VS_MEM_INFO {\r | |
83 | UINT8 *MemData;\r | |
84 | } VS_MEM_INFO;\r | |
85 | \r | |
86 | typedef struct _VS_DEV {\r | |
87 | UINT32 Signature;\r | |
88 | VARIABLE_STORAGE VarStore;\r | |
89 | UINTN Size;\r | |
90 | \r | |
91 | union {\r | |
92 | //\r | |
93 | // finally visit FileInfo.FileData or MemInfo.MemData\r | |
94 | //\r | |
95 | UINT8 *Data;\r | |
96 | \r | |
97 | VS_FILE_INFO FileInfo;\r | |
98 | VS_MEM_INFO MemInfo;\r | |
99 | } Info;\r | |
100 | \r | |
101 | } VS_DEV;\r | |
102 | \r | |
3709c4cd | 103 | #define VS_DEV_SIGNATURE SIGNATURE_32 ('$', 'V', 'S', 'D')\r |
104 | #define DEV_FROM_THIS(a) CR (a, VS_DEV, VarStore, VS_DEV_SIGNATURE)\r | |
9071550e | 105 | \r |
106 | #define VAR_DATA_PTR(a) ((a)->Info.Data)\r | |
107 | #define VAR_FILE_DEVICEPATH(a) ((a)->Info.FileInfo.DevicePath)\r | |
108 | #define VAR_FILE_VOLUMEID(a) ((a)->Info.FileInfo.VolumeId)\r | |
109 | #define VAR_FILE_FILEPATH(a) ((a)->Info.FileInfo.FilePath)\r | |
110 | \r | |
111 | \r | |
112 | #endif\r |