3 Copyright (c) 2004, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #ifndef _VARIABLE_STORE_H
23 #define _VARIABLE_STORE_H
26 // The variable store protocol interface is specific to the reference
27 // implementation. The initialization code adds variable store devices
28 // to the system, and the FW connects to the devices to provide the
29 // variable store interfaces through these devices.
33 // Variable Store Device protocol
35 #define EFI_VARIABLE_STORE_PROTOCOL_GUID \
36 { 0xf088cd91, 0xa046, 0x11d2, {0x8e, 0x42, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
38 EFI_FORWARD_DECLARATION (EFI_VARIABLE_STORE_PROTOCOL
);
42 (EFIAPI
*EFI_CLEAR_STORE
) (
43 IN EFI_VARIABLE_STORE_PROTOCOL
*This
,
49 (EFIAPI
*EFI_READ_STORE
) (
50 IN EFI_VARIABLE_STORE_PROTOCOL
*This
,
58 (EFIAPI
*EFI_UPDATE_STORE
) (
59 IN EFI_VARIABLE_STORE_PROTOCOL
*This
,
67 (EFIAPI
*EFI_CLEANUP_STORE
) (
68 IN EFI_VARIABLE_STORE_PROTOCOL
*This
71 struct _EFI_VARIABLE_STORE_PROTOCOL
{
74 // Number of banks and bank size
80 // Functions to access the storage banks
82 EFI_CLEAR_STORE ClearStore
;
83 EFI_READ_STORE ReadStore
;
84 EFI_UPDATE_STORE UpdateStore
;
85 EFI_CLEANUP_STORE CleanupStore
;
91 // ClearStore() - A function to clear the requested storage bank. A cleared
92 // bank contains all "on" bits.
94 // ReadStore() - Read data from the requested store.
96 // UpdateStore() - Updates data on the requested store. The FW will only
97 // ever issue updates to clear bits in the store. Updates must
98 // be performed in LSb to MSb order of the update buffer.
100 // CleanupStore() - Do garbage collection and reclaim operation.
103 extern EFI_GUID gEfiVariableStoreProtocolGuid
;
105 #endif // _VARIABLE_STORE_H