projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 3eb9473e | 1 | /*++\r |
| 2 | \r | |
| f57387d5 HT |
3 | Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>\r |
| 4 | This program and the accompanying materials \r | |
| 3eb9473e | 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 | VariableStore.h\r | |
| 15 | \r | |
| 16 | Abstract:\r | |
| 17 | \r | |
| 18 | Revision History\r | |
| 19 | \r | |
| 20 | --*/\r | |
| 21 | \r | |
| 22 | #ifndef _VARIABLE_STORE_H\r | |
| 23 | #define _VARIABLE_STORE_H\r | |
| 24 | \r | |
| 25 | //\r | |
| 26 | // The variable store protocol interface is specific to the reference\r | |
| 27 | // implementation. The initialization code adds variable store devices\r | |
| 28 | // to the system, and the FW connects to the devices to provide the\r | |
| 29 | // variable store interfaces through these devices.\r | |
| 30 | //\r | |
| 31 | \r | |
| 32 | //\r | |
| 33 | // Variable Store Device protocol\r | |
| 34 | //\r | |
| 35 | #define EFI_VARIABLE_STORE_PROTOCOL_GUID \\r | |
| 7ccf38a3 | 36 | { 0xf088cd91, 0xa046, 0x11d2, {0x8e, 0x42, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }\r |
| 3eb9473e | 37 | \r |
| 38 | EFI_FORWARD_DECLARATION (EFI_VARIABLE_STORE_PROTOCOL);\r | |
| 39 | \r | |
| 40 | typedef\r | |
| 41 | EFI_STATUS\r | |
| 42 | (EFIAPI *EFI_CLEAR_STORE) (\r | |
| 43 | IN EFI_VARIABLE_STORE_PROTOCOL *This,\r | |
| 44 | IN OUT VOID *Scratch\r | |
| 45 | );\r | |
| 46 | \r | |
| 47 | typedef\r | |
| 48 | EFI_STATUS\r | |
| 49 | (EFIAPI *EFI_READ_STORE) (\r | |
| 50 | IN EFI_VARIABLE_STORE_PROTOCOL *This,\r | |
| 51 | IN UINTN Offset,\r | |
| 52 | IN UINTN BufferSize,\r | |
| 53 | OUT VOID *Buffer\r | |
| 54 | );\r | |
| 55 | \r | |
| 56 | typedef\r | |
| 57 | EFI_STATUS\r | |
| 58 | (EFIAPI *EFI_UPDATE_STORE) (\r | |
| 59 | IN EFI_VARIABLE_STORE_PROTOCOL *This,\r | |
| 60 | IN UINTN Offset,\r | |
| 61 | IN UINTN BufferSize,\r | |
| 62 | IN VOID *Buffer\r | |
| 63 | );\r | |
| 64 | \r | |
| 65 | typedef\r | |
| 66 | EFI_STATUS\r | |
| 67 | (EFIAPI *EFI_CLEANUP_STORE) (\r | |
| 68 | IN EFI_VARIABLE_STORE_PROTOCOL *This\r | |
| 69 | );\r | |
| 70 | \r | |
| 9c092841 | 71 | struct _EFI_VARIABLE_STORE_PROTOCOL {\r |
| 3eb9473e | 72 | \r |
| 73 | //\r | |
| 74 | // Number of banks and bank size\r | |
| 75 | //\r | |
| 76 | UINT32 Attributes;\r | |
| 77 | UINT32 BankSize;\r | |
| 78 | \r | |
| 79 | //\r | |
| 80 | // Functions to access the storage banks\r | |
| 81 | //\r | |
| 82 | EFI_CLEAR_STORE ClearStore;\r | |
| 83 | EFI_READ_STORE ReadStore;\r | |
| 84 | EFI_UPDATE_STORE UpdateStore;\r | |
| 85 | EFI_CLEANUP_STORE CleanupStore;\r | |
| 86 | \r | |
| 9c092841 | 87 | };\r |
| 3eb9473e | 88 | \r |
| 89 | //\r | |
| 90 | //\r | |
| 91 | // ClearStore() - A function to clear the requested storage bank. A cleared\r | |
| 92 | // bank contains all "on" bits.\r | |
| 93 | //\r | |
| 94 | // ReadStore() - Read data from the requested store.\r | |
| 95 | //\r | |
| 96 | // UpdateStore() - Updates data on the requested store. The FW will only\r | |
| 97 | // ever issue updates to clear bits in the store. Updates must \r | |
| 98 | // be performed in LSb to MSb order of the update buffer.\r | |
| 99 | //\r | |
| 100 | // CleanupStore() - Do garbage collection and reclaim operation.\r | |
| 101 | //\r | |
| 102 | \r | |
| 103 | extern EFI_GUID gEfiVariableStoreProtocolGuid;\r | |
| 104 | \r | |
| 105 | #endif // _VARIABLE_STORE_H\r |