xref: /rk3399_rockchip-uboot/include/android_avb/avb_chain_partition_descriptor.h (revision ab608f806ee1d7fa63a18cc035e8ea62b67634e5)
1*5b69db07SJason Zhu /*
2*5b69db07SJason Zhu  * Copyright (C) 2016 The Android Open Source Project
3*5b69db07SJason Zhu  *
4*5b69db07SJason Zhu  * Permission is hereby granted, free of charge, to any person
5*5b69db07SJason Zhu  * obtaining a copy of this software and associated documentation
6*5b69db07SJason Zhu  * files (the "Software"), to deal in the Software without
7*5b69db07SJason Zhu  * restriction, including without limitation the rights to use, copy,
8*5b69db07SJason Zhu  * modify, merge, publish, distribute, sublicense, and/or sell copies
9*5b69db07SJason Zhu  * of the Software, and to permit persons to whom the Software is
10*5b69db07SJason Zhu  * furnished to do so, subject to the following conditions:
11*5b69db07SJason Zhu  *
12*5b69db07SJason Zhu  * The above copyright notice and this permission notice shall be
13*5b69db07SJason Zhu  * included in all copies or substantial portions of the Software.
14*5b69db07SJason Zhu  *
15*5b69db07SJason Zhu  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16*5b69db07SJason Zhu  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17*5b69db07SJason Zhu  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18*5b69db07SJason Zhu  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19*5b69db07SJason Zhu  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20*5b69db07SJason Zhu  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21*5b69db07SJason Zhu  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22*5b69db07SJason Zhu  * SOFTWARE.
23*5b69db07SJason Zhu  */
24*5b69db07SJason Zhu 
25*5b69db07SJason Zhu /*
26*5b69db07SJason Zhu #if !defined(AVB_INSIDE_LIBAVB_H) && !defined(AVB_COMPILATION)
27*5b69db07SJason Zhu #error "Never include this file directly, include libavb.h instead."
28*5b69db07SJason Zhu #endif
29*5b69db07SJason Zhu */
30*5b69db07SJason Zhu 
31*5b69db07SJason Zhu #ifndef AVB_CHAIN_PARTITION_DESCRIPTOR_H_
32*5b69db07SJason Zhu #define AVB_CHAIN_PARTITION_DESCRIPTOR_H_
33*5b69db07SJason Zhu 
34*5b69db07SJason Zhu #include <android_avb/avb_descriptor.h>
35*5b69db07SJason Zhu 
36*5b69db07SJason Zhu #ifdef __cplusplus
37*5b69db07SJason Zhu extern "C" {
38*5b69db07SJason Zhu #endif
39*5b69db07SJason Zhu 
40*5b69db07SJason Zhu /* A descriptor containing a pointer to signed integrity data stored
41*5b69db07SJason Zhu  * on another partition. The descriptor contains the partition name in
42*5b69db07SJason Zhu  * question (without the A/B suffix), the public key used to sign the
43*5b69db07SJason Zhu  * integrity data, and rollback index location to use for rollback
44*5b69db07SJason Zhu  * protection.
45*5b69db07SJason Zhu  *
46*5b69db07SJason Zhu  * Following this struct are |partition_name_len| bytes of the
47*5b69db07SJason Zhu  * partition name (UTF-8 encoded) and |public_key_len| bytes of the
48*5b69db07SJason Zhu  * public key.
49*5b69db07SJason Zhu  *
50*5b69db07SJason Zhu  * The |reserved| field is for future expansion and must be set to NUL
51*5b69db07SJason Zhu  * bytes.
52*5b69db07SJason Zhu  */
53*5b69db07SJason Zhu typedef struct AvbChainPartitionDescriptor {
54*5b69db07SJason Zhu   AvbDescriptor parent_descriptor;
55*5b69db07SJason Zhu   uint32_t rollback_index_location;
56*5b69db07SJason Zhu   uint32_t partition_name_len;
57*5b69db07SJason Zhu   uint32_t public_key_len;
58*5b69db07SJason Zhu   uint8_t reserved[64];
59*5b69db07SJason Zhu } AVB_ATTR_PACKED AvbChainPartitionDescriptor;
60*5b69db07SJason Zhu 
61*5b69db07SJason Zhu /* Copies |src| to |dest| and validates, byte-swapping fields in the
62*5b69db07SJason Zhu  * process if needed. Returns true if valid, false if invalid.
63*5b69db07SJason Zhu  *
64*5b69db07SJason Zhu  * Data following the struct is not validated nor copied.
65*5b69db07SJason Zhu  */
66*5b69db07SJason Zhu bool avb_chain_partition_descriptor_validate_and_byteswap(
67*5b69db07SJason Zhu     const AvbChainPartitionDescriptor* src,
68*5b69db07SJason Zhu     AvbChainPartitionDescriptor* dest) AVB_ATTR_WARN_UNUSED_RESULT;
69*5b69db07SJason Zhu 
70*5b69db07SJason Zhu #ifdef __cplusplus
71*5b69db07SJason Zhu }
72*5b69db07SJason Zhu #endif
73*5b69db07SJason Zhu 
74*5b69db07SJason Zhu #endif /* AVB_CHAIN_PARTITION_DESCRIPTOR_H_ */
75