1*4882a593Smuzhiyun /* 2*4882a593Smuzhiyun * Copyright (C) 2016 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 /* 26*4882a593Smuzhiyun #if !defined(AVB_INSIDE_LIBAVB_H) && !defined(AVB_COMPILATION) 27*4882a593Smuzhiyun #error "Never include this file directly, include libavb.h instead." 28*4882a593Smuzhiyun #endif 29*4882a593Smuzhiyun */ 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun #ifndef AVB_FOOTER_H_ 32*4882a593Smuzhiyun #define AVB_FOOTER_H_ 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun #include <android_avb/avb_sysdeps.h> 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun #ifdef __cplusplus 37*4882a593Smuzhiyun extern "C" { 38*4882a593Smuzhiyun #endif 39*4882a593Smuzhiyun 40*4882a593Smuzhiyun /* Magic for the footer. */ 41*4882a593Smuzhiyun #define AVB_FOOTER_MAGIC "AVBf" 42*4882a593Smuzhiyun #define AVB_FOOTER_MAGIC_LEN 4 43*4882a593Smuzhiyun 44*4882a593Smuzhiyun /* Size of the footer. */ 45*4882a593Smuzhiyun #define AVB_FOOTER_SIZE 64 46*4882a593Smuzhiyun 47*4882a593Smuzhiyun /* The current footer version used - keep in sync with avbtool. */ 48*4882a593Smuzhiyun #define AVB_FOOTER_VERSION_MAJOR 1 49*4882a593Smuzhiyun #define AVB_FOOTER_VERSION_MINOR 0 50*4882a593Smuzhiyun 51*4882a593Smuzhiyun /* The struct used as a footer used on partitions, used to find the 52*4882a593Smuzhiyun * AvbVBMetaImageHeader struct. This struct is always stored at the 53*4882a593Smuzhiyun * end of a partition. 54*4882a593Smuzhiyun */ 55*4882a593Smuzhiyun typedef struct AvbFooter { 56*4882a593Smuzhiyun /* 0: Four bytes equal to "AVBf" (AVB_FOOTER_MAGIC). */ 57*4882a593Smuzhiyun uint8_t magic[AVB_FOOTER_MAGIC_LEN]; 58*4882a593Smuzhiyun /* 4: The major version of the footer struct. */ 59*4882a593Smuzhiyun uint32_t version_major; 60*4882a593Smuzhiyun /* 8: The minor version of the footer struct. */ 61*4882a593Smuzhiyun uint32_t version_minor; 62*4882a593Smuzhiyun 63*4882a593Smuzhiyun /* 12: The original size of the image on the partition. */ 64*4882a593Smuzhiyun uint64_t original_image_size; 65*4882a593Smuzhiyun 66*4882a593Smuzhiyun /* 20: The offset of the |AvbVBMetaImageHeader| struct. */ 67*4882a593Smuzhiyun uint64_t vbmeta_offset; 68*4882a593Smuzhiyun 69*4882a593Smuzhiyun /* 28: The size of the vbmeta block (header + auth + aux blocks). */ 70*4882a593Smuzhiyun uint64_t vbmeta_size; 71*4882a593Smuzhiyun 72*4882a593Smuzhiyun /* 36: Padding to ensure struct is size AVB_FOOTER_SIZE bytes. This 73*4882a593Smuzhiyun * must be set to zeroes. 74*4882a593Smuzhiyun */ 75*4882a593Smuzhiyun uint8_t reserved[28]; 76*4882a593Smuzhiyun } AVB_ATTR_PACKED AvbFooter; 77*4882a593Smuzhiyun 78*4882a593Smuzhiyun /* Copies |src| to |dest| and validates, byte-swapping fields in the 79*4882a593Smuzhiyun * process if needed. Returns true if valid, false if invalid. 80*4882a593Smuzhiyun */ 81*4882a593Smuzhiyun bool avb_footer_validate_and_byteswap(const AvbFooter* src, AvbFooter* dest) 82*4882a593Smuzhiyun AVB_ATTR_WARN_UNUSED_RESULT; 83*4882a593Smuzhiyun 84*4882a593Smuzhiyun #ifdef __cplusplus 85*4882a593Smuzhiyun } 86*4882a593Smuzhiyun #endif 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun #endif /* AVB_FOOTER_H_ */ 89