1 /* 2 * Copyright (C) 2016 The Android Open Source Project 3 * 4 * Permission is hereby granted, free of charge, to any person 5 * obtaining a copy of this software and associated documentation 6 * files (the "Software"), to deal in the Software without 7 * restriction, including without limitation the rights to use, copy, 8 * modify, merge, publish, distribute, sublicense, and/or sell copies 9 * of the Software, and to permit persons to whom the Software is 10 * furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice shall be 13 * included in all copies or substantial portions of the Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 25 /* 26 #if !defined(AVB_INSIDE_LIBAVB_H) && !defined(AVB_COMPILATION) 27 #error "Never include this file directly, include libavb.h instead." 28 #endif 29 */ 30 31 #ifndef AVB_FOOTER_H_ 32 #define AVB_FOOTER_H_ 33 34 #include <android_avb/avb_sysdeps.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /* Magic for the footer. */ 41 #define AVB_FOOTER_MAGIC "AVBf" 42 #define AVB_FOOTER_MAGIC_LEN 4 43 44 /* Size of the footer. */ 45 #define AVB_FOOTER_SIZE 64 46 47 /* The current footer version used - keep in sync with avbtool. */ 48 #define AVB_FOOTER_VERSION_MAJOR 1 49 #define AVB_FOOTER_VERSION_MINOR 0 50 51 /* The struct used as a footer used on partitions, used to find the 52 * AvbVBMetaImageHeader struct. This struct is always stored at the 53 * end of a partition. 54 */ 55 typedef struct AvbFooter { 56 /* 0: Four bytes equal to "AVBf" (AVB_FOOTER_MAGIC). */ 57 uint8_t magic[AVB_FOOTER_MAGIC_LEN]; 58 /* 4: The major version of the footer struct. */ 59 uint32_t version_major; 60 /* 8: The minor version of the footer struct. */ 61 uint32_t version_minor; 62 63 /* 12: The original size of the image on the partition. */ 64 uint64_t original_image_size; 65 66 /* 20: The offset of the |AvbVBMetaImageHeader| struct. */ 67 uint64_t vbmeta_offset; 68 69 /* 28: The size of the vbmeta block (header + auth + aux blocks). */ 70 uint64_t vbmeta_size; 71 72 /* 36: Padding to ensure struct is size AVB_FOOTER_SIZE bytes. This 73 * must be set to zeroes. 74 */ 75 uint8_t reserved[28]; 76 } AVB_ATTR_PACKED AvbFooter; 77 78 /* Copies |src| to |dest| and validates, byte-swapping fields in the 79 * process if needed. Returns true if valid, false if invalid. 80 */ 81 bool avb_footer_validate_and_byteswap(const AvbFooter* src, AvbFooter* dest) 82 AVB_ATTR_WARN_UNUSED_RESULT; 83 84 #ifdef __cplusplus 85 } 86 #endif 87 88 #endif /* AVB_FOOTER_H_ */ 89