projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| d1f95000 | 1 | /** @file\r |
| 0f82bd55 | 2 | Variable Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r |
| d1f95000 | 3 | \r |
| 9095d37b LG |
4 | This provides the services required to get and set environment variables. This\r |
| 5 | protocol must be produced by a runtime DXE driver and may be consumed only by\r | |
| 6 | the DXE Foundation. The DXE driver that produces this protocol must be a runtime\r | |
| 7 | driver. This driver is responsible for initializing the GetVariable(),\r | |
| 8377875b | 8 | GetNextVariableName(), and SetVariable() fields of the UEFI Runtime Services Table.\r |
| d1f95000 | 9 | \r |
| 9095d37b LG |
10 | After the three fields of the UEFI Runtime Services Table have been initialized,\r |
| 11 | the driver must install the EFI_VARIABLE_ARCH_PROTOCOL_GUID on a new handle with\r | |
| 12 | a NULL interface pointer. The installation of this protocol informs the DXE Foundation\r | |
| 13 | that the read-only and the volatile environment variable related services are\r | |
| 14 | now available and that the DXE Foundation must update the 32-bit CRC of the UEFI\r | |
| 15 | Runtime Services Table. The full complement of environment variable services are\r | |
| 16 | not available until both this protocol and EFI_VARIABLE_WRITE_ARCH_PROTOCOL are\r | |
| 17 | installed. DXE drivers that require read-only access or read/write access to volatile\r | |
| 18 | environment variables must have this architectural protocol in their dependency\r | |
| 19 | expressions. DXE drivers that require write access to nonvolatile environment\r | |
| 20 | variables must have the EFI_VARIABLE_WRITE_ARCH_PROTOCOL in their dependency\r | |
| 8377875b | 21 | expressions.\r |
| d1f95000 | 22 | \r |
| 9095d37b LG |
23 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 24 | This program and the accompanying materials\r | |
| 25 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 26 | which accompanies this distribution. The full text of the license may be found at\r | |
| 27 | http://opensource.org/licenses/bsd-license.php\r | |
| d1f95000 | 28 | \r |
| 9095d37b LG |
29 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
| 30 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| d1f95000 | 31 | \r |
| d1f95000 | 32 | **/\r |
| 33 | \r | |
| 34 | #ifndef __ARCH_PROTOCOL_VARIABLE_ARCH_H__\r | |
| 35 | #define __ARCH_PROTOCOL_VARIABLE_ARCH_H__\r | |
| 36 | \r | |
| 99e8ed21 | 37 | ///\r |
| 38 | /// Global ID for the Variable Architectural Protocol\r | |
| 39 | ///\r | |
| d1f95000 | 40 | #define EFI_VARIABLE_ARCH_PROTOCOL_GUID \\r |
| 41 | { 0x1e5668e2, 0x8481, 0x11d4, {0xbc, 0xf1, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r | |
| 42 | \r | |
| 43 | extern EFI_GUID gEfiVariableArchProtocolGuid;\r | |
| 44 | \r | |
| 9095d37b | 45 | #endif\r |