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 #ifndef AVB_OPS_USER_H_ 26*4882a593Smuzhiyun #define AVB_OPS_USER_H_ 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun #include <android_avb/libavb.h> 29*4882a593Smuzhiyun #include <android_avb/avb_ab_flow.h> 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun #ifdef __cplusplus 32*4882a593Smuzhiyun extern "C" { 33*4882a593Smuzhiyun #endif 34*4882a593Smuzhiyun 35*4882a593Smuzhiyun /* Allocates an AvbOps instance suitable for use in Android userspace 36*4882a593Smuzhiyun * on the device. Returns NULL on OOM. 37*4882a593Smuzhiyun * 38*4882a593Smuzhiyun * The returned AvbOps has the following characteristics: 39*4882a593Smuzhiyun * 40*4882a593Smuzhiyun * - The read_from_partition(), write_to_partition(), and 41*4882a593Smuzhiyun * get_size_of_partition() operations are implemented, however for 42*4882a593Smuzhiyun * these operations to work the fstab file on the device must have a 43*4882a593Smuzhiyun * /misc entry using a by-name device file scheme and the containing 44*4882a593Smuzhiyun * by-name/ subdirectory must have files for other partitions. 45*4882a593Smuzhiyun * 46*4882a593Smuzhiyun * - The remaining operations are implemented and never fails and 47*4882a593Smuzhiyun * return the following values: 48*4882a593Smuzhiyun * - validate_vbmeta_public_key(): always returns |true|. 49*4882a593Smuzhiyun * - read_rollback_index(): returns 0 for any roolback index. 50*4882a593Smuzhiyun * - write_rollback_index(): no-op. 51*4882a593Smuzhiyun * - read_is_device_unlocked(): always returns |true|. 52*4882a593Smuzhiyun * - get_unique_guid_for_partition(): always returns the empty string. 53*4882a593Smuzhiyun * 54*4882a593Smuzhiyun * - The |ab_ops| member will point to a valid AvbABOps instance 55*4882a593Smuzhiyun * implemented via libavb_ab/. This should only be used if the AVB 56*4882a593Smuzhiyun * A/B stack is used on the device. This is what is used in 57*4882a593Smuzhiyun * bootctrl.avb boot control implementation. 58*4882a593Smuzhiyun * 59*4882a593Smuzhiyun * Free with avb_ops_user_free(). 60*4882a593Smuzhiyun */ 61*4882a593Smuzhiyun AvbOps* avb_ops_user_new(void); 62*4882a593Smuzhiyun 63*4882a593Smuzhiyun /* Frees an AvbOps instance previously allocated with avb_ops_device_new(). */ 64*4882a593Smuzhiyun void avb_ops_user_free(AvbOps* ops); 65*4882a593Smuzhiyun 66*4882a593Smuzhiyun struct preloaded_partition { 67*4882a593Smuzhiyun uint8_t *addr; 68*4882a593Smuzhiyun size_t size; // 0 means the partition hasn't yet been preloaded 69*4882a593Smuzhiyun }; 70*4882a593Smuzhiyun 71*4882a593Smuzhiyun struct AvbOpsData { 72*4882a593Smuzhiyun struct AvbOps *ops; 73*4882a593Smuzhiyun const char *iface; 74*4882a593Smuzhiyun const char *devnum; 75*4882a593Smuzhiyun const char *slot_suffix; 76*4882a593Smuzhiyun struct preloaded_partition boot; 77*4882a593Smuzhiyun struct preloaded_partition vendor_boot; 78*4882a593Smuzhiyun struct preloaded_partition init_boot; 79*4882a593Smuzhiyun struct preloaded_partition resource; 80*4882a593Smuzhiyun }; 81*4882a593Smuzhiyun 82*4882a593Smuzhiyun #ifdef __cplusplus 83*4882a593Smuzhiyun } 84*4882a593Smuzhiyun #endif 85*4882a593Smuzhiyun 86*4882a593Smuzhiyun #endif /* AVB_OPS_USER_H_ */ 87