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