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