2 This protocol is used to report and control what BIOS is mapped to the
3 BIOS address space anchored at 4GB boundary.
5 This protocol is EFI compatible.
7 E.G. For current generation ICH, the 4GB-16MB to 4GB range can be mapped
10 Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>
12 This program and the accompanying materials are licensed and made available under
13 the terms and conditions of the BSD License that accompanies this distribution.
14 The full text of the license may be found at
15 http://opensource.org/licenses/bsd-license.php.
17 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
18 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
24 #ifndef _EFI_ACTIVE_BIOS_PROTOCOL_H_
25 #define _EFI_ACTIVE_BIOS_PROTOCOL_H_
28 // Define the protocol GUID
30 #define EFI_ACTIVE_BIOS_PROTOCOL_GUID \
31 { 0xebbe2d1b, 0x1647, 0x4bda, {0xab, 0x9a, 0x78, 0x63, 0xe3, 0x96, 0xd4, 0x1a} }
33 typedef struct _EFI_ACTIVE_BIOS_PROTOCOL EFI_ACTIVE_BIOS_PROTOCOL
;
36 // Protocol definitions
43 } EFI_ACTIVE_BIOS_STATE
;
47 (EFIAPI
*EFI_ACTIVE_BIOS_SET_ACTIVE_BIOS_STATE
) (
48 IN EFI_ACTIVE_BIOS_PROTOCOL
*This
,
49 IN EFI_ACTIVE_BIOS_STATE DesiredState
,
56 Change the current active BIOS settings to the requested state.
57 The caller is responsible for requesting a supported state from
58 the EFI_ACTIVE_BIOS_STATE selections.
60 This will fail if someone has locked the interface and the correct key is
65 This Pointer to the EFI_ACTIVE_BIOS_PROTOCOL instance.
66 DesiredState The requested state to configure the system for.
67 Key If the interface is locked, Key must be the Key
68 returned from the LockState function call.
72 EFI_SUCCESS Command succeed.
73 EFI_ACCESS_DENIED The interface is currently locked.
74 EFI_DEVICE_ERROR Device error, command aborts abnormally.
80 (EFIAPI
*EFI_ACTIVE_BIOS_LOCK_ACTIVE_BIOS_STATE
) (
81 IN EFI_ACTIVE_BIOS_PROTOCOL
*This
,
89 Lock the current active BIOS state from further changes. This allows a
90 caller to implement a critical section. This is optionally supported
91 functionality. Size conscious implementations may choose to require
92 callers cooperate without support from this protocol.
96 This Pointer to the EFI_ACTIVE_BIOS_PROTOCOL instance.
97 Lock TRUE to lock the current state, FALSE to unlock.
98 Key If Lock is TRUE, then a key will be returned. If
99 Lock is FALSE, the key returned from the prior call
100 to lock the protocol must be provided to unlock the
101 protocol. The value of Key is undefined except that it
106 EFI_SUCCESS Command succeed.
107 EFI_UNSUPPORTED The function is not supported.
108 EFI_ACCESS_DENIED The interface is currently locked.
109 EFI_DEVICE_ERROR Device error, command aborts abnormally.
114 // Protocol definition
116 // Note that some functions are optional. This means that they may be NULL.
117 // Caller is required to verify that an optional function is defined by checking
118 // that the value is not NULL.
120 struct _EFI_ACTIVE_BIOS_PROTOCOL
{
121 EFI_ACTIVE_BIOS_STATE State
;
122 EFI_ACTIVE_BIOS_SET_ACTIVE_BIOS_STATE SetState
;
123 EFI_ACTIVE_BIOS_LOCK_ACTIVE_BIOS_STATE LockState
;
127 // Extern the GUID for protocol users.
129 extern EFI_GUID gEfiActiveBiosProtocolGuid
;