xref: /OK3568_Linux_fs/u-boot/include/android_avb/avb_user_verification.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (C) 2017 The Android Open Source Project
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Permission is hereby granted, free of charge, to any person
5*4882a593Smuzhiyun  * obtaining a copy of this software and associated documentation
6*4882a593Smuzhiyun  * files (the "Software"), to deal in the Software without
7*4882a593Smuzhiyun  * restriction, including without limitation the rights to use, copy,
8*4882a593Smuzhiyun  * modify, merge, publish, distribute, sublicense, and/or sell copies
9*4882a593Smuzhiyun  * of the Software, and to permit persons to whom the Software is
10*4882a593Smuzhiyun  * furnished to do so, subject to the following conditions:
11*4882a593Smuzhiyun  *
12*4882a593Smuzhiyun  * The above copyright notice and this permission notice shall be
13*4882a593Smuzhiyun  * included in all copies or substantial portions of the Software.
14*4882a593Smuzhiyun  *
15*4882a593Smuzhiyun  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16*4882a593Smuzhiyun  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17*4882a593Smuzhiyun  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18*4882a593Smuzhiyun  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19*4882a593Smuzhiyun  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20*4882a593Smuzhiyun  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21*4882a593Smuzhiyun  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22*4882a593Smuzhiyun  * SOFTWARE.
23*4882a593Smuzhiyun  */
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #ifndef AVB_USER_VERIFICATION_H_
26*4882a593Smuzhiyun #define AVB_USER_VERIFICATION_H_
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #include <android_avb/libavb.h>
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun #ifdef __cplusplus
31*4882a593Smuzhiyun extern "C" {
32*4882a593Smuzhiyun #endif
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun /* Function to enable or disable verification for an entire slot. The
35*4882a593Smuzhiyun  * passed in |ops| should be obtained via avb_ops_user_new(). The
36*4882a593Smuzhiyun  * |ab_suffix| parameter should specify the slot to modify including
37*4882a593Smuzhiyun  * the leading underscore (e.g. "_a" or "_b"). The
38*4882a593Smuzhiyun  * |enable_verification| parameter should be set to |true| to enable
39*4882a593Smuzhiyun  * dm-verification and |false| to disable.
40*4882a593Smuzhiyun  *
41*4882a593Smuzhiyun  * Returns |true| if the operation succeeded, otherwise |false|.
42*4882a593Smuzhiyun  */
43*4882a593Smuzhiyun bool avb_user_verification_set(AvbOps* ops,
44*4882a593Smuzhiyun                                const char* ab_suffix,
45*4882a593Smuzhiyun                                bool enable_verification);
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun /* Gets whether verification is enabled for an entire slot. The passed
48*4882a593Smuzhiyun  * in |ops| should be obtained via avb_ops_user_new(). The |ab_suffix|
49*4882a593Smuzhiyun  * parameter should specify the slot to query including the leading
50*4882a593Smuzhiyun  * underscore (e.g. "_a" or "_b"). The result is returned in the
51*4882a593Smuzhiyun  * |out_verification_enabled| parameter.
52*4882a593Smuzhiyun  *
53*4882a593Smuzhiyun  * Returns |true| if the operation succeeded, otherwise |false|.
54*4882a593Smuzhiyun  */
55*4882a593Smuzhiyun bool avb_user_verification_get(AvbOps* ops,
56*4882a593Smuzhiyun                                const char* ab_suffix,
57*4882a593Smuzhiyun                                bool* out_verification_enabled);
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun #ifdef __cplusplus
60*4882a593Smuzhiyun }
61*4882a593Smuzhiyun #endif
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun #endif /* AVB_USER_VERIFICATION_H_ */
64