From patchwork Sun Apr 7 22:02:05 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eugeniu Rosca X-Patchwork-Id: 1080394 X-Patchwork-Delegate: xypron.glpk@gmx.de Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=lists.denx.de (client-ip=81.169.180.215; helo=lists.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="Q66+9cEo"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 44cnbq5Hgzz9s7T for ; Mon, 8 Apr 2019 08:02:47 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 6E675C21DE8; Sun, 7 Apr 2019 22:02:46 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on lists.denx.de X-Spam-Level: X-Spam-Status: No, score=0.0 required=5.0 tests=FREEMAIL_FROM, KHOP_BIG_TO_CC, RCVD_IN_MSPIKE_H2, T_DKIM_INVALID autolearn=unavailable autolearn_force=no version=3.4.0 Received: from lists.denx.de (localhost [IPv6:::1]) by lists.denx.de (Postfix) with ESMTP id 094E0C21DC1; Sun, 7 Apr 2019 22:02:44 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 85350C21DED; Sun, 7 Apr 2019 22:02:34 +0000 (UTC) Received: from mail-wr1-f66.google.com (mail-wr1-f66.google.com [209.85.221.66]) by lists.denx.de (Postfix) with ESMTPS id B4FF4C21DFA for ; Sun, 7 Apr 2019 22:02:29 +0000 (UTC) Received: by mail-wr1-f66.google.com with SMTP id s15so13985127wra.12 for ; Sun, 07 Apr 2019 15:02:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=SvNYlTGun+NK3dgWgW2sqTKR4d1U+74mBkIlUhpvadA=; b=Q66+9cEoGEH+3mdoR/RoeHJ5aSDfzD2VBK0dJfran+00yhc5poz+Zhes1GIGy56NwX 7EmZIt6BU008Tey5KWkOSwuqL13EyLHkPBpZSJ1bMqBoHy7PzsPE9iFpMPUeAdsBLX+o +QdgISA8ST6xrMtg1Tevu6C0CKKzQn5C2DZmcQSaRHR6ctS166F6+iUTWqQSKRnhv8x0 xx5JhUzeLYSf6BhcXNQsPA8xbDP/ZU7yLmiOwP8Hqap7kTGXuintTcybjviMZm/Gn/aW J48KxrKDBu/192UpmFnzcIt/zvw23GKmPOWjWqFytYYPKA8Cgur+edm83nH7KMzR62A8 m75A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=SvNYlTGun+NK3dgWgW2sqTKR4d1U+74mBkIlUhpvadA=; b=VvMNov4Mv2Tuz3Uac7x9O4xZ0wvMz1bYY/NeM5oKwLrxhBoYTxYYtcpGj3SEktw6Xw nN4ab8pXoOQ1l3Hzcs79LQ/pQI10czSOMGLfn60O67hTZBZAdMen+n5H9XI2GhHKx12D ZL1KPh9jluu1++DJQWB5t+ldXU64NZGuHwu+nbX3Bb+BMDdE7tV4oT/XJKcqiuLtXHp1 I7V4o6RBTzFa0Ot123TjbDM1PQC97snvyY1Qoy3LYRxBMH/8C8VJ89Pp/63nlTEAhhNZ 2N/5ZyEWZpRd1T3fRZycug+dQEd526fvkmk3pX+NyQElhJT16/s3qaVx6sk1ePUVe2lE WdVw== X-Gm-Message-State: APjAAAU81ujPe+XaR88yafysQU6PeME7+p/V6hHnPvNWehmAqKw3Ndl6 Z4hvOu6A7NaOH0zm/iKel5I= X-Google-Smtp-Source: APXvYqxq3UdQWIr2IdRs3xp19A0Ly1aUt+FX8kHtpBWJzrXxXZGnig0g4ztwB4f2qhuf5majoNGZvw== X-Received: by 2002:adf:ef0c:: with SMTP id e12mr15729373wro.170.1554674549200; Sun, 07 Apr 2019 15:02:29 -0700 (PDT) Received: from localhost.localdomain (ipb218f597.dynamic.kabel-deutschland.de. [178.24.245.151]) by smtp.gmail.com with ESMTPSA id 7sm96313748wrc.81.2019.04.07.15.02.27 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 07 Apr 2019 15:02:28 -0700 (PDT) From: Eugeniu Rosca X-Google-Original-From: Eugeniu Rosca To: Igor Opaniuk , Marek Vasut , Simon Glass , Sam Protsenko , Alex Kiernan , Alex Deymo , Praneeth Bajjuri , Alistair Strachan , Joe Hershberger , Michal Simek , Chris Packham , Heinrich Schuchardt , Miquel Raynal , Mario Six , Adam Ford , Stefan Roese , Tom Rini , u-boot@lists.denx.de Date: Mon, 8 Apr 2019 00:02:05 +0200 Message-Id: <20190407220206.7655-2-erosca@de.adit-jv.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190407220206.7655-1-erosca@de.adit-jv.com> References: <20190407220206.7655-1-erosca@de.adit-jv.com> MIME-Version: 1.0 Cc: Eugeniu Rosca , Eugeniu Rosca Subject: [U-Boot] [PATCH 1/2] include: android_bl_msg.h: Initial import X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.18 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" Import the bootloader_message.h (former bootloader.h) from AOSP. Repository: https://android.googlesource.com/platform/bootable/recovery Commit: 8e0821e6907d6016c19565b83319aff90ad1a034 Author: Tao Bao Date: Wed Apr 3 23:48:21 2019 +0000 The bootloader_message.h basically defines the flash layout of a dedicated partition (usually called 'misc') and is needed in U-Boot in order to be able to implement a subset of Android Bootloader Requirements [1], specifically dealing with: - Communication between the bootloader and recovery - Handling of A/B (Seamless) System Updates [2] With respect to the in-tree vs out-of-tree file differences: - license matches https://patchwork.ozlabs.org/patch/1003998/ - filename is changed to android_bl_msg.h, as per Simon's comment [3] - the struct/macro names have been shaped by [3-4], where the two main criterias are: - Improve the syntax/readability in the global U-Boot namespace - Minimize the future integration/update efforts from the source. Particularly, the __UBOOT__ macro helps with isolating the U-Boot-unrelated parts (e.g. includes/function prototypes/etc) [1] https://source.android.com/devices/bootloader [2] https://source.android.com/devices/tech/ota/ab/ [3] https://patchwork.ozlabs.org/patch/1003998/#2046141 [4] https://patchwork.ozlabs.org/patch/1003998/#2144955 Signed-off-by: Eugeniu Rosca --- include/android_bl_msg.h | 273 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 273 insertions(+) create mode 100644 include/android_bl_msg.h diff --git a/include/android_bl_msg.h b/include/android_bl_msg.h new file mode 100644 index 000000000000..c48a1de2762b --- /dev/null +++ b/include/android_bl_msg.h @@ -0,0 +1,273 @@ +// SPDX-License-Identifier: BSD-2-Clause +/* + * This file was taken from the AOSP Project. + * Repository: https://android.googlesource.com/platform/bootable/recovery/ + * File: bootloader_message/include/bootloader_message/bootloader_message.h + * Commit: see U-Boot commit importing/updating the file in-tree + * + * Copyright (C) 2008 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef _BOOTLOADER_MESSAGE_H +#define _BOOTLOADER_MESSAGE_H + +#ifndef __UBOOT__ +#include +#include +#include +#else +#include +#include +#endif + +#ifdef __UBOOT__ +/* U-Boot-specific types for improved syntax/readability */ +typedef struct bootloader_message andr_bl_msg; +typedef struct bootloader_message_ab andr_bl_msg_ab; +typedef struct bootloader_control andr_bl_control; +#endif + +// Spaces used by misc partition are as below: +// 0 - 2K For bootloader_message +// 2K - 16K Used by Vendor's bootloader (the 2K - 4K range may be optionally used +// as bootloader_message_ab struct) +// 16K - 64K Used by uncrypt and recovery to store wipe_package for A/B devices +// Note that these offsets are admitted by bootloader,recovery and uncrypt, so they +// are not configurable without changing all of them. + +#ifndef __UBOOT__ +static const size_t BOOTLOADER_MESSAGE_OFFSET_IN_MISC = 0; +static const size_t WIPE_PACKAGE_OFFSET_IN_MISC = 16 * 1024; +#else +#define ANDROID_MISC_BM_OFFSET 0 +#define ANDROID_MISC_WIPE_OFFSET SZ_16K +#endif + +/* Bootloader Message (2-KiB) + * + * This structure describes the content of a block in flash + * that is used for recovery and the bootloader to talk to + * each other. + * + * The command field is updated by linux when it wants to + * reboot into recovery or to update radio or bootloader firmware. + * It is also updated by the bootloader when firmware update + * is complete (to boot into recovery for any final cleanup) + * + * The status field was used by the bootloader after the completion + * of an "update-radio" or "update-hboot" command, which has been + * deprecated since Froyo. + * + * The recovery field is only written by linux and used + * for the system to send a message to recovery or the + * other way around. + * + * The stage field is written by packages which restart themselves + * multiple times, so that the UI can reflect which invocation of the + * package it is. If the value is of the format "#/#" (eg, "1/3"), + * the UI will add a simple indicator of that status. + * + * We used to have slot_suffix field for A/B boot control metadata in + * this struct, which gets unintentionally cleared by recovery or + * uncrypt. Move it into struct bootloader_message_ab to avoid the + * issue. + */ +struct bootloader_message { + char command[32]; + char status[32]; + char recovery[768]; + + // The 'recovery' field used to be 1024 bytes. It has only ever + // been used to store the recovery command line, so 768 bytes + // should be plenty. We carve off the last 256 bytes to store the + // stage string (for multistage packages) and possible future + // expansion. + char stage[32]; + + // The 'reserved' field used to be 224 bytes when it was initially + // carved off from the 1024-byte recovery field. Bump it up to + // 1184-byte so that the entire bootloader_message struct rounds up + // to 2048-byte. + char reserved[1184]; +}; + +/** + * We must be cautious when changing the bootloader_message struct size, + * because A/B-specific fields may end up with different offsets. + */ +#ifndef __UBOOT__ +#if (__STDC_VERSION__ >= 201112L) || defined(__cplusplus) +static_assert(sizeof(struct bootloader_message) == 2048, + "struct bootloader_message size changes, which may break A/B devices"); +#endif +#endif + +/** + * The A/B-specific bootloader message structure (4-KiB). + * + * We separate A/B boot control metadata from the regular bootloader + * message struct and keep it here. Everything that's A/B-specific + * stays after struct bootloader_message, which should be managed by + * the A/B-bootloader or boot control HAL. + * + * The slot_suffix field is used for A/B implementations where the + * bootloader does not set the androidboot.ro.boot.slot_suffix kernel + * commandline parameter. This is used by fs_mgr to mount /system and + * other partitions with the slotselect flag set in fstab. A/B + * implementations are free to use all 32 bytes and may store private + * data past the first NUL-byte in this field. It is encouraged, but + * not mandatory, to use 'struct bootloader_control' described below. + * + * The update_channel field is used to store the Omaha update channel + * if update_engine is compiled with Omaha support. + */ +struct bootloader_message_ab { + struct bootloader_message message; + char slot_suffix[32]; + char update_channel[128]; + + // Round up the entire struct to 4096-byte. + char reserved[1888]; +}; + +/** + * Be cautious about the struct size change, in case we put anything post + * bootloader_message_ab struct (b/29159185). + */ +#ifndef __UBOOT__ +#if (__STDC_VERSION__ >= 201112L) || defined(__cplusplus) +static_assert(sizeof(struct bootloader_message_ab) == 4096, + "struct bootloader_message_ab size changes"); +#endif +#endif + +#define BOOT_CTRL_MAGIC 0x42414342 /* Bootloader Control AB */ +#define BOOT_CTRL_VERSION 1 + +struct slot_metadata { + // Slot priority with 15 meaning highest priority, 1 lowest + // priority and 0 the slot is unbootable. + uint8_t priority : 4; + // Number of times left attempting to boot this slot. + uint8_t tries_remaining : 3; + // 1 if this slot has booted successfully, 0 otherwise. + uint8_t successful_boot : 1; + // 1 if this slot is corrupted from a dm-verity corruption, 0 + // otherwise. + uint8_t verity_corrupted : 1; + // Reserved for further use. + uint8_t reserved : 7; +} __attribute__((packed)); + +/* Bootloader Control AB + * + * This struct can be used to manage A/B metadata. It is designed to + * be put in the 'slot_suffix' field of the 'bootloader_message' + * structure described above. It is encouraged to use the + * 'bootloader_control' structure to store the A/B metadata, but not + * mandatory. + */ +struct bootloader_control { + // NUL terminated active slot suffix. + char slot_suffix[4]; + // Bootloader Control AB magic number (see BOOT_CTRL_MAGIC). + uint32_t magic; + // Version of struct being used (see BOOT_CTRL_VERSION). + uint8_t version; + // Number of slots being managed. + uint8_t nb_slot : 3; + // Number of times left attempting to boot recovery. + uint8_t recovery_tries_remaining : 3; + // Ensure 4-bytes alignment for slot_info field. + uint8_t reserved0[2]; + // Per-slot information. Up to 4 slots. + struct slot_metadata slot_info[4]; + // Reserved for further use. + uint8_t reserved1[8]; + // CRC32 of all 28 bytes preceding this field (little endian + // format). + uint32_t crc32_le; +} __attribute__((packed)); + +#ifndef __UBOOT__ +#if (__STDC_VERSION__ >= 201112L) || defined(__cplusplus) +static_assert(sizeof(struct bootloader_control) == + sizeof(((struct bootloader_message_ab *)0)->slot_suffix), + "struct bootloader_control has wrong size"); +#endif +#endif + +#ifndef __UBOOT__ +#ifdef __cplusplus + +#include +#include + +// Return the block device name for the bootloader message partition and waits +// for the device for up to 10 seconds. In case of error returns the empty +// string. +std::string get_bootloader_message_blk_device(std::string* err); + +// Read bootloader message into boot. Error message will be set in err. +bool read_bootloader_message(bootloader_message* boot, std::string* err); + +// Read bootloader message from the specified misc device into boot. +bool read_bootloader_message_from(bootloader_message* boot, const std::string& misc_blk_device, + std::string* err); + +// Write bootloader message to BCB. +bool write_bootloader_message(const bootloader_message& boot, std::string* err); + +// Write bootloader message to the specified BCB device. +bool write_bootloader_message_to(const bootloader_message& boot, + const std::string& misc_blk_device, std::string* err); + +// Write bootloader message (boots into recovery with the options) to BCB. Will +// set the command and recovery fields, and reset the rest. +bool write_bootloader_message(const std::vector& options, std::string* err); + +// Update bootloader message (boots into recovery with the options) to BCB. Will +// only update the command and recovery fields. +bool update_bootloader_message(const std::vector& options, std::string* err); + +// Update bootloader message (boots into recovery with the |options|) in |boot|. Will only update +// the command and recovery fields. +bool update_bootloader_message_in_struct(bootloader_message* boot, + const std::vector& options); + +// Clear BCB. +bool clear_bootloader_message(std::string* err); + +// Writes the reboot-bootloader reboot reason to the bootloader_message. +bool write_reboot_bootloader(std::string* err); + +// Read the wipe package from BCB (from offset WIPE_PACKAGE_OFFSET_IN_MISC). +bool read_wipe_package(std::string* package_data, size_t size, std::string* err); + +// Write the wipe package into BCB (to offset WIPE_PACKAGE_OFFSET_IN_MISC). +bool write_wipe_package(const std::string& package_data, std::string* err); + +#else + +#include + +// C Interface. +bool write_bootloader_message(const char* options); +bool write_reboot_bootloader(void); + +#endif // ifdef __cplusplus +#endif + +#endif // _BOOTLOADER_MESSAGE_H