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_KERNEL_CMDLINE_DESCRIPTOR_H_ 32 #define AVB_KERNEL_CMDLINE_DESCRIPTOR_H_ 33 34 #include <android_avb/avb_descriptor.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /* Flags for kernel command-line descriptors. 41 * 42 * AVB_KERNEL_CMDLINE_FLAGS_USE_ONLY_IF_HASHTREE_NOT_DISABLED: The 43 * cmdline will only be applied if hashtree verification is not 44 * disabled (cf. AVB_VBMETA_IMAGE_FLAGS_HASHTREE_DISABLED). 45 * 46 * AVB_KERNEL_CMDLINE_FLAGS_USE_ONLY_IF_HASHTREE_DISABLED: The cmdline 47 * will only be applied if hashtree verification is disabled 48 * (cf. AVB_VBMETA_IMAGE_FLAGS_HASHTREE_DISABLED). 49 */ 50 typedef enum { 51 AVB_KERNEL_CMDLINE_FLAGS_USE_ONLY_IF_HASHTREE_NOT_DISABLED = (1 << 0), 52 AVB_KERNEL_CMDLINE_FLAGS_USE_ONLY_IF_HASHTREE_DISABLED = (1 << 1) 53 } AvbKernelCmdlineFlags; 54 55 /* A descriptor containing information to be appended to the kernel 56 * command-line. 57 * 58 * The |flags| field contains flags from the AvbKernelCmdlineFlags 59 * enumeration. 60 * 61 * Following this struct are |kernel_cmdline_len| bytes with the 62 * kernel command-line (UTF-8 encoded). 63 */ 64 typedef struct AvbKernelCmdlineDescriptor { 65 AvbDescriptor parent_descriptor; 66 uint32_t flags; 67 uint32_t kernel_cmdline_length; 68 } AVB_ATTR_PACKED AvbKernelCmdlineDescriptor; 69 70 /* Copies |src| to |dest| and validates, byte-swapping fields in the 71 * process if needed. Returns true if valid, false if invalid. 72 * 73 * Data following the struct is not validated nor copied. 74 */ 75 bool avb_kernel_cmdline_descriptor_validate_and_byteswap( 76 const AvbKernelCmdlineDescriptor* src, 77 AvbKernelCmdlineDescriptor* dest) AVB_ATTR_WARN_UNUSED_RESULT; 78 79 #ifdef __cplusplus 80 } 81 #endif 82 83 #endif /* AVB_KERNEL_CMDLINE_DESCRIPTOR_H_ */ 84