-
Notifications
You must be signed in to change notification settings - Fork 97
/
key_clear_if.H
76 lines (71 loc) · 3.3 KB
/
key_clear_if.H
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/secureboot/key_clear_if.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2019,2020 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file key_clear_if.H
*
* @brief Interfaces to Process Key Clear Requests
*
*/
#ifndef __KEY_CLEAR_H
#define __KEY_CLEAR_H
// -----------------------------------------------
// Includes
// -----------------------------------------------
#include <errl/errlentry.H>
#include <targeting/common/commontargeting.H>
#include <attributeenums.H>
#include <config.h>
namespace SECUREBOOT
{
/**
* @brief Returns Key Clear Request information and if a Physical Presence
* check is requested
*
* @param[out] o_requestPhysPresence - If true, then physical presence
* assertion is requested; otherwise
* false
*
* @param[out] o_keyClearRequests - Struct containing the specifics of
* the key clear requests
*
* @note Any error logs generated will be handled internally
*
* @note The associated ATTR_KEY_CLEAR_REQUEST will also be updated by
* this function
*
* @return errlHndl_t nullptr on success; non-nullptr on error.
*/
void getKeyClearRequest(bool & o_requestPhysPresence,
TARGETING::KEY_CLEAR_REQUEST & o_keyClearRequests);
#ifdef CONFIG_BMC_IPMI
/*
* @brief Clears the Key Clear Sensor
*
* @return errlHndl_t nullptr on success; non-nullptr on error.
*/
errlHndl_t clearKeyClearSensor(void);
#endif
} // namespace SECUREBOOT
#endif // __PHYS_PRESENCE_H