From patchwork Sun Jul 7 13:34:16 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eugeniu Rosca X-Patchwork-Id: 1128662 X-Patchwork-Delegate: trini@ti.com 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="j+02XP2P"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45hV2K4jCkz9s7T for ; Sun, 7 Jul 2019 23:35:21 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 4A844C21DD7; Sun, 7 Jul 2019 13:35:15 +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, 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 0E1F7C21DD7; Sun, 7 Jul 2019 13:35:12 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 0D9F8C21CB1; Sun, 7 Jul 2019 13:35:04 +0000 (UTC) Received: from mail-wr1-f65.google.com (mail-wr1-f65.google.com [209.85.221.65]) by lists.denx.de (Postfix) with ESMTPS id EFD8CC21CB1 for ; Sun, 7 Jul 2019 13:35:00 +0000 (UTC) Received: by mail-wr1-f65.google.com with SMTP id f9so14230675wre.12 for ; Sun, 07 Jul 2019 06:35:00 -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=gNoIBcLUzDWICybwI3zou552SXWJBL1STtEto/CwL8M=; b=j+02XP2Pf6Ikq/pQVkS7B5FM2uDGthGaQAuxyy6+HLfK0GdaePJfIJvSGzvOgKQ72Q 6SUuqQleZ4SENYOjhL/0VtJjW+KyNgEon9ZHQ8aD2lh7o4cMHQHOclsi7ubYDfnc87G6 4MVYaTfa5PsZM8xKxyrZfpMbjqAyF0lAGvaCsJljAcEPkOJHDlh19VO9zERChM1NwPMO F5iSTEpePqY4vgNYVMqyrN94UM2Y7CJz3o7Ice5kUrq+Uw93LfTX8Dswo3rTY8cdxZXC 3vYdKJdUXDgfgRmF0HUxx+KJf+Z77T28dtVvOE8JAaHLokljav6Hr9kV4YoEg2ZHM6Rz f3Ng== 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=gNoIBcLUzDWICybwI3zou552SXWJBL1STtEto/CwL8M=; b=GBDSSs8n9UFjKRcJs2CBrTj15hnVVMoQHbYXXC94gmEaMUiYuCyQXbr5rAU7kvrqga C9yEecEtt+WAYXVIMltMbvL5NGa+fV3cjG8otplueKYEmYByurvsXzyBB70qHZW95Ran XhlmagGN2K/z/+V3SZgqciTmNwkl1GKvfwJR7wIIerKNZPdNoJoKnt03VCDR6s4jzFfv BIEiRfms18iFfvYGpzXrECJqCkMiCNtsoexMgwr8pXTC6p/uBQSMvpfyz1dXV5Q2grTc sFjHiy0SNipXe+Ai5LnVdEak8UsHKUiluSGIL5svVk8EWUIDrUm6AUPMQmPpBX4OhWtk q6AA== X-Gm-Message-State: APjAAAWKsCbLGPc6PMSY9njsIF8FsQc8U9myfllCuSiniu1wnAEaaRsc DlvTWKSL5DRolQxNSp2dVdaLnbfWqHYWOA== X-Google-Smtp-Source: APXvYqyaJeB+1cbbXJVZPVDyTCXLt2tUUrxBvoAIUTBuYQd5uu7SFNbzuoxh/MrLmR8ScsmiLeV1dA== X-Received: by 2002:adf:e841:: with SMTP id d1mr13959378wrn.204.1562506500396; Sun, 07 Jul 2019 06:35:00 -0700 (PDT) Received: from localhost.localdomain (ipb218f489.dynamic.kabel-deutschland.de. [178.24.244.137]) by smtp.gmail.com with ESMTPSA id u186sm11196759wmu.26.2019.07.07.06.34.59 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Sun, 07 Jul 2019 06:34:59 -0700 (PDT) From: Eugeniu Rosca X-Google-Original-From: Eugeniu Rosca To: u-boot@lists.denx.de, Simon Glass , Sam Protsenko , Heinrich Schuchardt , AKASHI Takahiro , Igor Opaniuk , Marek Vasut , Alex Kiernan , Alex Deymo , Praneeth Bajjuri , Alistair Strachan , Joe Hershberger , Michal Simek , Chris Packham , Miquel Raynal , Mario Six , Adam Ford , Stefan Roese , Tom Rini Date: Sun, 7 Jul 2019 15:34:16 +0200 Message-Id: <20190707133419.8335-2-erosca@de.adit-jv.com> X-Mailer: git-send-email 2.22.0 In-Reply-To: <20190707133419.8335-1-erosca@de.adit-jv.com> References: <20190707133419.8335-1-erosca@de.adit-jv.com> MIME-Version: 1.0 Cc: Eugeniu Rosca , Eugeniu Rosca Subject: [U-Boot] [PATCH v4 1/4] include: android_bootloader_message.h: Minimize the diff to AOSP 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" Perform the following updates: - Relocate the commit id from the file to the description of U-Boot commit. The AOSP commit is c784ce50e8c10eaf70e1f97e24e8324aef45faf5. This is done to avoid stale references in the file itself. The reasoning is in https://patchwork.ozlabs.org/patch/1098056/#2170209. - Minimize the diff to AOSP, to decrease the effort of the next AOSP backports. The background can be found in: https://patchwork.ozlabs.org/patch/1080394/#2168454. - Guard the static_assert() calls by #ifndef __UBOOT__ ... #endif, to avoid compilation failures of files including the header. Signed-off-by: Eugeniu Rosca Reviewed-by: Sam Protsenko Reviewed-by: Simon Glass --- v4: - No changes in the contents. - Picked up 'Reviewed-by: Simon Glass' from: https://patchwork.ozlabs.org/patch/1104243/#2200278 v3: - Added 'Reviewed-by: Sam Protsenko' - https://patchwork.ozlabs.org/patch/1104243/ v2: - Newly pushed. No changes. - https://patchwork.ozlabs.org/patch/1101108/ --- include/android_bootloader_message.h | 126 +++++++++++++++------------ 1 file changed, 68 insertions(+), 58 deletions(-) diff --git a/include/android_bootloader_message.h b/include/android_bootloader_message.h index b84789f02227..286d7ab0f31e 100644 --- a/include/android_bootloader_message.h +++ b/include/android_bootloader_message.h @@ -2,7 +2,7 @@ * This is from the Android Project, * Repository: https://android.googlesource.com/platform/bootable/recovery * File: bootloader_message/include/bootloader_message/bootloader_message.h - * Commit: c784ce50e8c10eaf70e1f97e24e8324aef45faf5 + * Commit: See U-Boot commit description * * Copyright (C) 2008 The Android Open Source Project * @@ -12,18 +12,24 @@ #ifndef __ANDROID_BOOTLOADER_MESSAGE_H #define __ANDROID_BOOTLOADER_MESSAGE_H +#ifndef __UBOOT__ +#include +#include +#include +#else /* compiler.h defines the types that otherwise are included from stdint.h and * stddef.h */ #include +#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. */ +// 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. static const size_t BOOTLOADER_MESSAGE_OFFSET_IN_MISC = 0; static const size_t WIPE_PACKAGE_OFFSET_IN_MISC = 16 * 1024; @@ -61,17 +67,17 @@ struct bootloader_message { 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. */ + // 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. */ + // 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]; }; @@ -79,10 +85,12 @@ struct bootloader_message { * 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 /* __UBOOT__ */ /** * The A/B-specific bootloader message structure (4-KiB). @@ -108,7 +116,7 @@ struct bootloader_message_ab { char slot_suffix[32]; char update_channel[128]; - /* Round up the entire struct to 4096-byte. */ + // Round up the entire struct to 4096-byte. char reserved[1888]; }; @@ -116,26 +124,28 @@ struct bootloader_message_ab { * 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 /* __UBOOT__ */ #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. */ + // 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. */ + // Number of times left attempting to boot this slot. uint8_t tries_remaining : 3; - /* 1 if this slot has booted successfully, 0 otherwise. */ + // 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. */ + // 1 if this slot is corrupted from a dm-verity corruption, 0 + // otherwise. uint8_t verity_corrupted : 1; - /* Reserved for further use. */ + // Reserved for further use. uint8_t reserved : 7; } __attribute__((packed)); @@ -148,99 +158,99 @@ struct slot_metadata { * mandatory. */ struct bootloader_control { - /* NUL terminated active slot suffix. */ + // NUL terminated active slot suffix. char slot_suffix[4]; - /* Bootloader Control AB magic number (see BOOT_CTRL_MAGIC). */ + // Bootloader Control AB magic number (see BOOT_CTRL_MAGIC). uint32_t magic; - /* Version of struct being used (see BOOT_CTRL_VERSION). */ + // Version of struct being used (see BOOT_CTRL_VERSION). uint8_t version; - /* Number of slots being managed. */ + // Number of slots being managed. uint8_t nb_slot : 3; - /* Number of times left attempting to boot recovery. */ + // Number of times left attempting to boot recovery. uint8_t recovery_tries_remaining : 3; - /* Ensure 4-bytes alignment for slot_info field. */ + // Ensure 4-bytes alignment for slot_info field. uint8_t reserved0[2]; - /* Per-slot information. Up to 4 slots. */ + // Per-slot information. Up to 4 slots. struct slot_metadata slot_info[4]; - /* Reserved for further use. */ + // Reserved for further use. uint8_t reserved1[8]; - /* CRC32 of all 28 bytes preceding this field (little endian - * format). */ + // 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 /* __UBOOT__ */ #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. */ +// 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. */ +// 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. */ +// 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. */ +// Write bootloader message to BCB. bool write_bootloader_message(const bootloader_message& boot, std::string* err); -/* Write bootloader message to the specified BCB device. */ +// 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. */ +// 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); -/* Write bootloader message (boots into recovery with the options) to the specific BCB device. Will - * set the command and recovery fields, and reset the rest. */ +// Write bootloader message (boots into recovery with the options) to the specific BCB device. Will +// set the command and recovery fields, and reset the rest. bool write_bootloader_message_to(const std::vector& options, const std::string& misc_blk_device, std::string* err); -/* Update bootloader message (boots into recovery with the options) to BCB. Will - * only update the command and recovery fields. */ +// 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. */ +// 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. */ +// Clear BCB. bool clear_bootloader_message(std::string* err); -/* Writes the reboot-bootloader reboot reason to the bootloader_message. */ +// 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). */ +// 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). */ +// 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. */ +// C Interface. bool write_bootloader_message(const char* options); bool write_reboot_bootloader(void); -#endif /* ifdef __cplusplus */ - +#endif // ifdef __cplusplus #endif /* __UBOOT__ */ #endif /* __ANDROID_BOOTLOADER_MESSAGE_H */ From patchwork Sun Jul 7 13:34:17 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eugeniu Rosca X-Patchwork-Id: 1128663 X-Patchwork-Delegate: trini@ti.com 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="bDtnpa8c"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45hV360hBXz9s7T for ; Sun, 7 Jul 2019 23:36:01 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 43413C21DE8; Sun, 7 Jul 2019 13:35:41 +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 ACE67C21DD4; Sun, 7 Jul 2019 13:35:17 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 542F8C21BE5; Sun, 7 Jul 2019 13:35:11 +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 DF0A3C21DB5 for ; Sun, 7 Jul 2019 13:35:10 +0000 (UTC) Received: by mail-wr1-f66.google.com with SMTP id p13so14229968wru.10 for ; Sun, 07 Jul 2019 06:35:10 -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=cCprPGIi7MCOaiSgsWKwMcNAuwewX173xu2+G5k9eIY=; b=bDtnpa8ckKgcMIytheOlwv1i+FxDJsxhiAdfvnujUE8nl/BztAfD97nBBRR1baD9nN IzLrgwBP2Zynyzdm7D87sTHiFBKQAMmxjpQp6J29+EVDF+N95ktT+SV5ay3iGCldlQRX LQ2ahyAwtClVX5enM75FATu2ej6gKUYlN1MzEAc1dLU4wXY9DBBDhw52S0Y+k88xx75z XqWvCLwO8ddVbI3oqjh6ZxHQqVLCRO1vu7C485ZU/Um78ZH3cXZISUfZLu/ZkjTpz7k8 XCKtCqHZrJBKV5cymYBhNmUj31SMPEUN97soPB0Vp3ZoU8RYeMHrMMLakI/hgAEYag1s S6hw== 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=cCprPGIi7MCOaiSgsWKwMcNAuwewX173xu2+G5k9eIY=; b=a8bm2GIeVpxbCLrE9ZZTbrkLGnZTb/gQrLu4V33eaHYZ2ZhF5zx0NsCklw1KZnHpcR rSPwwPaKBz0BgxpAkUH9uve9PT2JALxsRfXaOxGlGvjxp0XsRV9hN42qzWUM/OGj8EO7 zlAiQTijNJMk+1exrpn/xurjNsWZL6JvT4ptaJa7hrfmvaBYw8/oHvoof+d9EobnsCKk I0N6mKx9SctvGw0Nq86ot9Ak2m5lTtrsQnDddgjn4Cf/1lPNYJGk5x0+uktfZ6pIpnEX vpE3rfaD5zwPjuWK+BABmzS5GC7HfcrQj1pIS1yc9Rp+6NbJpet/WoFrdZFy2Ei+Ng4q Agbg== X-Gm-Message-State: APjAAAWgdJGYUrsnNNjIfVL5GuULlmGFoh4eetFQBh7dEPnALBGKGQih N6baZH9RCeFXPSQWDgScWRxohpu1GgB+Rw== X-Google-Smtp-Source: APXvYqyv6U7zQSxrmKnaKW63qgGDt8wBe6dH2Su9Q9y32gLrRO7/ykF4NUAj72sIW3pkUk/zQHecew== X-Received: by 2002:a5d:53c1:: with SMTP id a1mr14110101wrw.185.1562506510166; Sun, 07 Jul 2019 06:35:10 -0700 (PDT) Received: from localhost.localdomain (ipb218f489.dynamic.kabel-deutschland.de. [178.24.244.137]) by smtp.gmail.com with ESMTPSA id u186sm11196759wmu.26.2019.07.07.06.35.08 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Sun, 07 Jul 2019 06:35:09 -0700 (PDT) From: Eugeniu Rosca X-Google-Original-From: Eugeniu Rosca To: u-boot@lists.denx.de, Simon Glass , Sam Protsenko , Heinrich Schuchardt , AKASHI Takahiro , Igor Opaniuk , Marek Vasut , Alex Kiernan , Alex Deymo , Praneeth Bajjuri , Alistair Strachan , Joe Hershberger , Michal Simek , Chris Packham , Miquel Raynal , Mario Six , Adam Ford , Stefan Roese , Tom Rini Date: Sun, 7 Jul 2019 15:34:17 +0200 Message-Id: <20190707133419.8335-3-erosca@de.adit-jv.com> X-Mailer: git-send-email 2.22.0 In-Reply-To: <20190707133419.8335-1-erosca@de.adit-jv.com> References: <20190707133419.8335-1-erosca@de.adit-jv.com> MIME-Version: 1.0 Cc: Eugeniu Rosca , Eugeniu Rosca Subject: [U-Boot] [PATCH v4 2/4] cmd: Add 'bcb' command to read/modify/write BCB fields 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" 'Bootloader Control Block' (BCB) is a well established term/acronym in the Android namespace which refers to a location in a dedicated raw (i.e. FS-unaware) flash (e.g. eMMC) partition, usually called "misc", which is used as media for exchanging messages between Android userspace (particularly recovery [1]) and an Android-capable bootloader. On higher level, this allows implementing a subset of Android Bootloader Requirements [2], amongst which is the Android-specific bootloader flow [3]. Regardless how the latter is implemented in U-Boot ([3] being the most memorable example), reading/writing/dumping the BCB fields in the development process from inside the U-Boot is a convenient feature. Hence, make it available to the users. Some usage examples of the new command recorded on R-Car H3ULCB-KF ('>>>' is an overlay on top of the original console output): => bcb bcb - Load/set/clear/test/dump/store Android BCB fields Usage: bcb load - load BCB from mmc : bcb set - set BCB to bcb clear [] - clear BCB or all fields bcb test - test BCB against bcb dump - dump BCB bcb store - store BCB back to mmc Legend: - MMC device index containing the BCB partition - MMC partition index or name containing the BCB - one of {command,status,recovery,stage,reserved} - the binary operator used in 'bcb test': '=' returns true if matches the string stored in '~' returns true if matches a subset of 's string - string/text provided as input to bcb {set,test} NOTE: any ':' character in will be replaced by line feed during 'bcb set' and used as separator by upper layers => bcb dump command Error: Please, load BCB first! >>> Users must specify mmc device and partition before any other call => bcb load 1 misc => bcb load 1 1 >>> The two calls are equivalent (assuming "misc" has index 1) => bcb dump command 00000000: 62 6f 6f 74 6f 6e 63 65 2d 73 68 65 6c 6c 00 72 bootonce-shell.r 00000010: 79 00 72 00 00 00 00 00 00 00 00 00 00 00 00 00 y.r............. >>> The output is in binary/string format for convenience >>> The output size matches the size of inspected BCB field >>> (32 bytes in case of 'command') => bcb test command = bootonce-shell && echo true true => bcb test command = bootonce-shell- && echo true => bcb test command = bootonce-shel && echo true >>> The '=' operator returns 'true' on perfect match => bcb test command ~ bootonce-shel && echo true true => bcb test command ~ bootonce-shell && echo true true >>> The '~' operator returns 'true' on substring match => bcb set command recovery => bcb dump command 00000000: 72 65 63 6f 76 65 72 79 00 73 68 65 6c 6c 00 72 recovery.shell.r 00000010: 79 00 72 00 00 00 00 00 00 00 00 00 00 00 00 00 y.r............. >>> The new value is NULL-terminated and stored in the BCB field => bcb set recovery "msg1:msg2:msg3" => bcb dump recovery 00000040: 6d 73 67 31 0a 6d 73 67 32 0a 6d 73 67 33 00 00 msg1.msg2.msg3.. 00000050: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ 00000060: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ >>> --- snip --- >>> Every ':' is replaced by line-feed '\n' (0xA). The latter is used >>> as separator between individual commands by Android userspace => bcb store >>> Flush/store the BCB structure to MMC [1] https://android.googlesource.com/platform/bootable/recovery [2] https://source.android.com/devices/bootloader [3] https://patchwork.ozlabs.org/patch/746835/ ("[U-Boot,5/6] Initial support for the Android Bootloader flow") Signed-off-by: Eugeniu Rosca --- v4: - [Simon Glass] Use strcmp instead of strncmp whenever one of the arguments is a string literal - [Simon Glass] s/field/fieldp/, s/size/sizep/ in bcb_field_get() - [Simon Glass] Place 'static int do_bcb_load' on one line - [Simon Glass] Refine the goto labels in do_bcb_load() - [Simon Glass] Refine the comment in do_bcb() - Merge two identical case-branches in bcb_is_misused() - Rerun static analysis (cppcheck, sparse, smatch, make W=1) - Retest on Renesas R-Car H3-ES2.0-ULCB-KF-M06 - Compile/boot/smoke-test on sandbox v3: - [Simon Glass] Allow 'strsep' to modify the argv[n] string in-place rather than duplicating it with 'strdup'. Remove #include - [Simon Glass] Call bcb_is_misused() _once_ in do_bcb() - [Simon Glass] Report error codes if IO fails in do_bcb_{load,store} - [Simon Glass] Leave one empty line above top-level returns (note: checkpatch is indifferent about this) - [Simon Glass] Replace strncmp with '==' operator for single-character strings in do_bcb_test(), which reduces compiled object size - Reorder the functions to match the cmd_bcb_sub table - Improve error reporting: - s/Error: Unknown field/Error: Unknown bcb field/ - s/debug Error: Unexpected BCB command/ printf Error: 'bcb %s' not supported/ - s/Error: BCB not loaded/Error: Please, load BCB first/ - Make sure static analysis is clean: - cppcheck --force --enable=all --inconclusive - sparse/make C=2 - make W=1 - smatch - Re-test on R-Car H3ULCB-KF - Compile/boot/smoke-test on sandbox - https://patchwork.ozlabs.org/patch/1104244/ v2: - [Heinrich Schuchardt] Implement sub-commands via U_BOOT_CMD_MKENT. - Polished the code. Ensured no warnings returned by sparse, smatch, `cppcheck --force --enable=all --inconclusive`, make W=1. - Tested on R-Car-H3-ES20 ULCB-KF. - https://patchwork.ozlabs.org/patch/1101107/ v1: - https://patchwork.ozlabs.org/patch/1080395/ --- cmd/Kconfig | 17 +++ cmd/Makefile | 1 + cmd/bcb.c | 338 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 356 insertions(+) create mode 100644 cmd/bcb.c diff --git a/cmd/Kconfig b/cmd/Kconfig index cda7931fe360..3afb760a816f 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -631,6 +631,23 @@ config CMD_ADC Shows ADC device info and permit printing one-shot analog converted data from a named Analog to Digital Converter. +config CMD_BCB + bool "bcb" + depends on MMC + depends on PARTITIONS + help + Read/modify/write the fields of Bootloader Control Block, usually + stored on the flash "misc" partition with its structure defined in: + https://android.googlesource.com/platform/bootable/recovery/+/master/ + bootloader_message/include/bootloader_message/bootloader_message.h + + Some real-life use-cases include (but are not limited to): + - Determine the "boot reason" (and act accordingly): + https://source.android.com/devices/bootloader/boot-reason + - Get/pass a list of commands from/to recovery: + https://android.googlesource.com/platform/bootable/recovery + - Inspect/dump the contents of the BCB fields + config CMD_BIND bool "bind/unbind - Bind or unbind a device to/from a driver" depends on DM diff --git a/cmd/Makefile b/cmd/Makefile index f982564ab9f5..49e64cde1d07 100644 --- a/cmd/Makefile +++ b/cmd/Makefile @@ -16,6 +16,7 @@ obj-$(CONFIG_CMD_ADC) += adc.o obj-$(CONFIG_CMD_ARMFLASH) += armflash.o obj-y += blk_common.o obj-$(CONFIG_CMD_SOURCE) += source.o +obj-$(CONFIG_CMD_BCB) += bcb.o obj-$(CONFIG_CMD_BDI) += bdinfo.o obj-$(CONFIG_CMD_BEDBUG) += bedbug.o obj-$(CONFIG_CMD_BIND) += bind.o diff --git a/cmd/bcb.c b/cmd/bcb.c new file mode 100644 index 000000000000..9626f2c69e34 --- /dev/null +++ b/cmd/bcb.c @@ -0,0 +1,338 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright (C) 2019 Eugeniu Rosca + * + * Command to read/modify/write Android BCB fields + */ + +#include +#include +#include + +enum bcb_cmd { + BCB_CMD_LOAD, + BCB_CMD_FIELD_SET, + BCB_CMD_FIELD_CLEAR, + BCB_CMD_FIELD_TEST, + BCB_CMD_FIELD_DUMP, + BCB_CMD_STORE, +}; + +static int bcb_dev = -1; +static int bcb_part = -1; +static struct bootloader_message bcb = { { 0 } }; + +static int bcb_cmd_get(char *cmd) +{ + if (!strcmp(cmd, "load")) + return BCB_CMD_LOAD; + if (!strcmp(cmd, "set")) + return BCB_CMD_FIELD_SET; + if (!strcmp(cmd, "clear")) + return BCB_CMD_FIELD_CLEAR; + if (!strcmp(cmd, "test")) + return BCB_CMD_FIELD_TEST; + if (!strcmp(cmd, "store")) + return BCB_CMD_STORE; + if (!strcmp(cmd, "dump")) + return BCB_CMD_FIELD_DUMP; + else + return -1; +} + +static int bcb_is_misused(int argc, char *const argv[]) +{ + int cmd = bcb_cmd_get(argv[0]); + + switch (cmd) { + case BCB_CMD_LOAD: + case BCB_CMD_FIELD_SET: + if (argc != 3) + goto err; + break; + case BCB_CMD_FIELD_TEST: + if (argc != 4) + goto err; + break; + case BCB_CMD_FIELD_CLEAR: + if (argc != 1 && argc != 2) + goto err; + break; + case BCB_CMD_STORE: + if (argc != 1) + goto err; + break; + case BCB_CMD_FIELD_DUMP: + if (argc != 2) + goto err; + break; + default: + printf("Error: 'bcb %s' not supported\n", argv[0]); + return -1; + } + + if (cmd != BCB_CMD_LOAD && (bcb_dev < 0 || bcb_part < 0)) { + printf("Error: Please, load BCB first!\n"); + return -1; + } + + return 0; +err: + printf("Error: Bad usage of 'bcb %s'\n", argv[0]); + + return -1; +} + +static int bcb_field_get(char *name, char **fieldp, int *sizep) +{ + if (!strcmp(name, "command")) { + *fieldp = bcb.command; + *sizep = sizeof(bcb.command); + } else if (!strcmp(name, "status")) { + *fieldp = bcb.status; + *sizep = sizeof(bcb.status); + } else if (!strcmp(name, "recovery")) { + *fieldp = bcb.recovery; + *sizep = sizeof(bcb.recovery); + } else if (!strcmp(name, "stage")) { + *fieldp = bcb.stage; + *sizep = sizeof(bcb.stage); + } else if (!strcmp(name, "reserved")) { + *fieldp = bcb.reserved; + *sizep = sizeof(bcb.reserved); + } else { + printf("Error: Unknown bcb field '%s'\n", name); + return -1; + } + + return 0; +} + +static int do_bcb_load(cmd_tbl_t *cmdtp, int flag, int argc, + char * const argv[]) +{ + struct blk_desc *desc; + disk_partition_t info; + u64 cnt; + char *endp; + int part, ret; + + ret = blk_get_device_by_str("mmc", argv[1], &desc); + if (ret < 0) + goto err_read_fail; + + part = simple_strtoul(argv[2], &endp, 0); + if (*endp == '\0') { + ret = part_get_info(desc, part, &info); + if (ret) + goto err_read_fail; + } else { + part = part_get_info_by_name(desc, argv[2], &info); + if (part < 0) { + ret = part; + goto err_read_fail; + } + } + + cnt = DIV_ROUND_UP(sizeof(struct bootloader_message), info.blksz); + if (cnt > info.size) + goto err_too_small; + + if (blk_dread(desc, info.start, cnt, &bcb) != cnt) { + ret = -EIO; + goto err_read_fail; + } + + bcb_dev = desc->devnum; + bcb_part = part; + debug("%s: Loaded from mmc %d:%d\n", __func__, bcb_dev, bcb_part); + + return CMD_RET_SUCCESS; +err_read_fail: + printf("Error: mmc %s:%s read failed (%d)\n", argv[1], argv[2], ret); + goto err; +err_too_small: + printf("Error: mmc %s:%s too small!", argv[1], argv[2]); + goto err; +err: + bcb_dev = -1; + bcb_part = -1; + + return CMD_RET_FAILURE; +} + +static int do_bcb_set(cmd_tbl_t *cmdtp, int flag, int argc, + char * const argv[]) +{ + int size, len; + char *field, *str, *found; + + if (bcb_field_get(argv[1], &field, &size)) + return CMD_RET_FAILURE; + + len = strlen(argv[2]); + if (len >= size) { + printf("Error: sizeof('%s') = %d >= %d = sizeof(bcb.%s)\n", + argv[2], len, size, argv[1]); + return CMD_RET_FAILURE; + } + str = argv[2]; + + field[0] = '\0'; + while ((found = strsep(&str, ":"))) { + if (field[0] != '\0') + strcat(field, "\n"); + strcat(field, found); + } + + return CMD_RET_SUCCESS; +} + +static int do_bcb_clear(cmd_tbl_t *cmdtp, int flag, int argc, + char * const argv[]) +{ + int size; + char *field; + + if (argc == 1) { + memset(&bcb, 0, sizeof(bcb)); + return CMD_RET_SUCCESS; + } + + if (bcb_field_get(argv[1], &field, &size)) + return CMD_RET_FAILURE; + + memset(field, 0, size); + + return CMD_RET_SUCCESS; +} + +static int do_bcb_test(cmd_tbl_t *cmdtp, int flag, int argc, + char * const argv[]) +{ + int size; + char *field; + char *op = argv[2]; + + if (bcb_field_get(argv[1], &field, &size)) + return CMD_RET_FAILURE; + + if (*op == '=' && *(op + 1) == '\0') { + if (!strncmp(argv[3], field, size)) + return CMD_RET_SUCCESS; + else + return CMD_RET_FAILURE; + } else if (*op == '~' && *(op + 1) == '\0') { + if (!strstr(field, argv[3])) + return CMD_RET_FAILURE; + else + return CMD_RET_SUCCESS; + } else { + printf("Error: Unknown operator '%s'\n", op); + } + + return CMD_RET_FAILURE; +} + +static int do_bcb_dump(cmd_tbl_t *cmdtp, int flag, int argc, + char * const argv[]) +{ + int size; + char *field; + + if (bcb_field_get(argv[1], &field, &size)) + return CMD_RET_FAILURE; + + print_buffer((ulong)field - (ulong)&bcb, (void *)field, 1, size, 16); + + return CMD_RET_SUCCESS; +} + +static int do_bcb_store(cmd_tbl_t *cmdtp, int flag, int argc, + char * const argv[]) +{ + struct blk_desc *desc; + disk_partition_t info; + u64 cnt; + int ret; + + desc = blk_get_devnum_by_type(IF_TYPE_MMC, bcb_dev); + if (!desc) { + ret = -ENODEV; + goto err; + } + + ret = part_get_info(desc, bcb_part, &info); + if (ret) + goto err; + + cnt = DIV_ROUND_UP(sizeof(struct bootloader_message), info.blksz); + + if (blk_dwrite(desc, info.start, cnt, &bcb) != cnt) { + ret = -EIO; + goto err; + } + + return CMD_RET_SUCCESS; +err: + printf("Error: mmc %d:%d write failed (%d)\n", bcb_dev, bcb_part, ret); + + return CMD_RET_FAILURE; +} + +static cmd_tbl_t cmd_bcb_sub[] = { + U_BOOT_CMD_MKENT(load, CONFIG_SYS_MAXARGS, 1, do_bcb_load, "", ""), + U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 1, do_bcb_set, "", ""), + U_BOOT_CMD_MKENT(clear, CONFIG_SYS_MAXARGS, 1, do_bcb_clear, "", ""), + U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_bcb_test, "", ""), + U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_bcb_dump, "", ""), + U_BOOT_CMD_MKENT(store, CONFIG_SYS_MAXARGS, 1, do_bcb_store, "", ""), +}; + +static int do_bcb(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[]) +{ + cmd_tbl_t *c; + + if (argc < 2) + return CMD_RET_USAGE; + + argc--; + argv++; + + c = find_cmd_tbl(argv[0], cmd_bcb_sub, ARRAY_SIZE(cmd_bcb_sub)); + if (!c) + return CMD_RET_USAGE; + + if (bcb_is_misused(argc, argv)) { + /* + * We try to improve the user experience by reporting the + * root-cause of misusage, so don't return CMD_RET_USAGE, + * since the latter prints out the full-blown help text + */ + return CMD_RET_FAILURE; + } + + return c->cmd(cmdtp, flag, argc, argv); +} + +U_BOOT_CMD( + bcb, CONFIG_SYS_MAXARGS, 1, do_bcb, + "Load/set/clear/test/dump/store Android BCB fields", + "load - load BCB from mmc :\n" + "bcb set - set BCB to \n" + "bcb clear [] - clear BCB or all fields\n" + "bcb test - test BCB against \n" + "bcb dump - dump BCB \n" + "bcb store - store BCB back to mmc\n" + "\n" + "Legend:\n" + " - MMC device index containing the BCB partition\n" + " - MMC partition index or name containing the BCB\n" + " - one of {command,status,recovery,stage,reserved}\n" + " - the binary operator used in 'bcb test':\n" + " '=' returns true if matches the string stored in \n" + " '~' returns true if matches a subset of 's string\n" + " - string/text provided as input to bcb {set,test}\n" + " NOTE: any ':' character in will be replaced by line feed\n" + " during 'bcb set' and used as separator by upper layers\n" +); From patchwork Sun Jul 7 13:34:18 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eugeniu Rosca X-Patchwork-Id: 1128664 X-Patchwork-Delegate: trini@ti.com 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="b0oiTyyg"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45hV3l4NsPz9s7T for ; Sun, 7 Jul 2019 23:36:35 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 38324C21D83; Sun, 7 Jul 2019 13:36:09 +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 9DD32C21DAF; Sun, 7 Jul 2019 13:35:36 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 6D952C21DCA; Sun, 7 Jul 2019 13:35:24 +0000 (UTC) Received: from mail-wr1-f67.google.com (mail-wr1-f67.google.com [209.85.221.67]) by lists.denx.de (Postfix) with ESMTPS id B06C7C21D56 for ; Sun, 7 Jul 2019 13:35:18 +0000 (UTC) Received: by mail-wr1-f67.google.com with SMTP id p17so3093427wrf.11 for ; Sun, 07 Jul 2019 06:35:18 -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=NNX/fJcN2JmsO8zqJD9gP0ibyMHGy1qrLDpgQaKB2XI=; b=b0oiTyyg2h0goAf2auLvONpTg9iK/KS04kUAomLOeGXsAOhTEx8EpDntUtX/59NNft eKHu7PQCKB+iVnElrGY6tapeAdRFQdPhehBMCAsidRCO20eKbRP5o/E/8eI4HxornWYO NSeNKamHROs5OQdHqNAwKwEZHv+t8R8AVBhbSQghgNhf8q5D/ZMzP/KLbY1ycV6o0C6I wU7uNB0IorEoR3xPFbiUrauN+PFz7tmY5jXbDfNc0MfpSF7fo6lao6j4zCm7HKIyj/nR NQCvyFT0pyYae8o5f2syEuhqohFG5zoMdj4MReguCupLLhv3w7KcZHNe6yiCwwJSrSE2 /aUw== 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=NNX/fJcN2JmsO8zqJD9gP0ibyMHGy1qrLDpgQaKB2XI=; b=cfwqtKrhaknp2yjimAFP+CVhwQW0bfx2d3VyilEUaaRIRH0G2ooz4xd2YDSXzy4eXn fS6V6U5PsCO0+V/LQwTeNY4zRLzj7u7yGXIk2k1+dhxYixE3hPD9SWAfC7Lv63uhy2pL 3MNmrGbojPRj+ZIF0RXnpSZCtAwgSMT27bbfoOrXXoEK0ArTvNcdKin7UsfHP09Ht7Jo STiIVvfmTraM/09fU0nftiZ6AFFTA4Ztd6yfWfMMeyKRJZPRPM55tuZXgqKNgaVvHXWH OANQFommrOGqvVCkO74UjjHwdXOT50Gknalw8gTqh2LUgYRfWSr3OlT1FCYCg4Ad5MrD xa1g== X-Gm-Message-State: APjAAAVTnea6iWRFUG2k/6B0MfcbVuqvTL1nJGuhUA0W2mHkp+v0lJb7 T4aHNvUK3SOGj0rRS8v0SQcpL3bFQMCDug== X-Google-Smtp-Source: APXvYqxqrBCn7LkekvHjKzZEQqUNkxti9FFQjccNiZSHzR1aaYZhaD94SC2mpSPVjWALrnJiO9vKmA== X-Received: by 2002:adf:a70b:: with SMTP id c11mr14427156wrd.172.1562506518169; Sun, 07 Jul 2019 06:35:18 -0700 (PDT) Received: from localhost.localdomain (ipb218f489.dynamic.kabel-deutschland.de. [178.24.244.137]) by smtp.gmail.com with ESMTPSA id u186sm11196759wmu.26.2019.07.07.06.35.16 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Sun, 07 Jul 2019 06:35:17 -0700 (PDT) From: Eugeniu Rosca X-Google-Original-From: Eugeniu Rosca To: u-boot@lists.denx.de, Simon Glass , Sam Protsenko , Heinrich Schuchardt , AKASHI Takahiro , Igor Opaniuk , Marek Vasut , Alex Kiernan , Alex Deymo , Praneeth Bajjuri , Alistair Strachan , Joe Hershberger , Michal Simek , Chris Packham , Miquel Raynal , Mario Six , Adam Ford , Stefan Roese , Tom Rini Date: Sun, 7 Jul 2019 15:34:18 +0200 Message-Id: <20190707133419.8335-4-erosca@de.adit-jv.com> X-Mailer: git-send-email 2.22.0 In-Reply-To: <20190707133419.8335-1-erosca@de.adit-jv.com> References: <20190707133419.8335-1-erosca@de.adit-jv.com> MIME-Version: 1.0 Cc: Eugeniu Rosca , Eugeniu Rosca Subject: [U-Boot] [PATCH v4 3/4] doc: android: relocate/rename README files 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" Rename: - doc/{README.avb2 => android/avb2.txt} - doc/{README.android-fastboot => android/fastboot.txt} - doc/{README.android-fastboot-protocol => android/fastboot-protocol.txt} The new directory structure has been reviewed by Simon [0]. Thanks to Sam [1], update a number of stale references in: - cmd/Kconfig - test/py/tests/test_avb.py As per Simon [2], any additions to doc/android/ (e.g. bcb.txt) should come as standalone patches. [0] https://patchwork.ozlabs.org/patch/1101107/#2176031 [1] https://patchwork.ozlabs.org/patch/1104245/#2208134 [2] https://patchwork.ozlabs.org/patch/1104245/#2200256 Signed-off-by: Eugeniu Rosca Reviewed-by: Simon Glass Reviewed-by: Sam Protsenko --- v4: - [Simon Glass] Defer bcb.txt addition to a separate patch - [Sam Protsenko] Update stale doc references - Rename one more lost doc: doc/{README.android-fastboot-protocol => android/fastboot-protocol.txt} - Refine summary line - Pick up 'Reviewed-by: Simon Glass' from: https://patchwork.ozlabs.org/patch/1104245/#2200256 - Pick up 'Reviewed-by: Sam Protsenko' from: https://patchwork.ozlabs.org/cover/1104242/#2177898 v3: - Newly pushed. - https://patchwork.ozlabs.org/patch/1104245/ --- cmd/Kconfig | 2 +- doc/{README.avb2 => android/avb2.txt} | 0 .../fastboot-protocol.txt} | 0 doc/{README.android-fastboot => android/fastboot.txt} | 2 +- test/py/tests/test_avb.py | 2 +- 5 files changed, 3 insertions(+), 3 deletions(-) rename doc/{README.avb2 => android/avb2.txt} (100%) rename doc/{README.android-fastboot-protocol => android/fastboot-protocol.txt} (100%) rename doc/{README.android-fastboot => android/fastboot.txt} (98%) diff --git a/cmd/Kconfig b/cmd/Kconfig index 3afb760a816f..3cf8233df62e 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -707,7 +707,7 @@ config CMD_FASTBOOT Android devices. Fastboot requires either the network stack enabled or support for acting as a USB device. - See doc/README.android-fastboot for more information. + See doc/android/fastboot.txt for more information. config CMD_FDC bool "fdcboot - Boot from floppy device" diff --git a/doc/README.avb2 b/doc/android/avb2.txt similarity index 100% rename from doc/README.avb2 rename to doc/android/avb2.txt diff --git a/doc/README.android-fastboot-protocol b/doc/android/fastboot-protocol.txt similarity index 100% rename from doc/README.android-fastboot-protocol rename to doc/android/fastboot-protocol.txt diff --git a/doc/README.android-fastboot b/doc/android/fastboot.txt similarity index 98% rename from doc/README.android-fastboot rename to doc/android/fastboot.txt index 431191c473f2..dcf824713f94 100644 --- a/doc/README.android-fastboot +++ b/doc/android/fastboot.txt @@ -6,7 +6,7 @@ Overview ======== The protocol that is used over USB and UDP is described in the -``README.android-fastboot-protocol`` file in the same directory. +``fastboot-protocol.txt`` file in the same directory. The current implementation supports the following standard commands: diff --git a/test/py/tests/test_avb.py b/test/py/tests/test_avb.py index 2bb75ed6e2a2..813242343555 100644 --- a/test/py/tests/test_avb.py +++ b/test/py/tests/test_avb.py @@ -8,7 +8,7 @@ This tests Android Verified Boot 2.0 support in U-boot: For additional details about how to build proper vbmeta partition -check doc/README.avb2 +check doc/android/avb2.txt For configuration verification: - Corrupt boot partition and check for failure From patchwork Sun Jul 7 13:34:19 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eugeniu Rosca X-Patchwork-Id: 1128665 X-Patchwork-Delegate: trini@ti.com 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="U26gksP/"; dkim-atps=neutral Received: from lists.denx.de (dione.denx.de [81.169.180.215]) by ozlabs.org (Postfix) with ESMTP id 45hV3x5Y5mz9s7T for ; Sun, 7 Jul 2019 23:36:45 +1000 (AEST) Received: by lists.denx.de (Postfix, from userid 105) id 2721BC21DFA; Sun, 7 Jul 2019 13:36:24 +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, 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 581C8C21DD3; Sun, 7 Jul 2019 13:35:51 +0000 (UTC) Received: by lists.denx.de (Postfix, from userid 105) id 3EF20C21D8A; Sun, 7 Jul 2019 13:35:33 +0000 (UTC) Received: from mail-wr1-f49.google.com (mail-wr1-f49.google.com [209.85.221.49]) by lists.denx.de (Postfix) with ESMTPS id 3271AC21CB6 for ; Sun, 7 Jul 2019 13:35:27 +0000 (UTC) Received: by mail-wr1-f49.google.com with SMTP id n9so5097458wrr.4 for ; Sun, 07 Jul 2019 06:35:27 -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=553URjkpVk3u7nsu/l93DbpfmHZdYqZ7+fNfi2GhXXQ=; b=U26gksP/rNIMrRZCKWccmDDdSYa+3KzaLwrGm5e2YExjBnyXASAdmjhLGxi4vNl6++ WUcjw7deByCJgWkyilKLpV4oSNLm4kvKJro1kvYXz79PSv7DjLeQA1fcbNE4iXYGy5aa 9ga1dZAnuH2sszDASXnevOJipoui7vPtXqVJHM2ZmVsBwFqwnuM0h34nqN56qEpNADAJ 2Tcr2e28X37OjFRE9PJPJhgWJEvlrL8RxPX4hXL4JbdfArs1zCbvAUtA/KomoFgxQyw3 lZg+J0/m0fAEeavZ4ouwiifrRS2AI1loJR54/JFcYdjoNWe/kbLtVZL/hE2grTDOv2Bn WCNw== 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=553URjkpVk3u7nsu/l93DbpfmHZdYqZ7+fNfi2GhXXQ=; b=d+/t2XjfX1vodKFXmSoBQloCDjEIBQik7aZwf2NTmxg7JJeMnz1WU22jglCrKXp6Vs QHfzCGt1ssekNk1DwK8Kd2SfWGEF2mp177ZmWPdF8QI/HDH/OW7tJvEiKTP42VtgSodm RS8wYBnbCqN5cr8nVAT/ZOtbFyhb2C9tRbyTD88zHQXJFmMYtBAHGDm3h+Da+bZYYOO6 XhER9NAu3+Ayrr0BUOUOmo1ylqCN4l334zrtZ8m0Kceaq7NgY9N/YNBg8ZmcPVczJorB ckm/V9qASdDu+Swty7S95rQ+l7Ah/BqGm1Qjki2x6qNwjtB0Wxyd9RHMzNcK6TvuKKSu rz/A== X-Gm-Message-State: APjAAAXvdu2A1QvPEFjjN6LQgLgZIA0vIKCdrZ5axw/9FWJzIqLQDvTm H6CqznWpeu9pYiFteGTgjd+ozxEbQly2+A== X-Google-Smtp-Source: APXvYqzlGIYdOae8zaVJf4RAG5uEVCN2bSTlwK8e+IjZUqe6S8S2ONdWtxWbG8iufmyznYX3Xy6LxQ== X-Received: by 2002:a5d:6406:: with SMTP id z6mr13658148wru.280.1562506526690; Sun, 07 Jul 2019 06:35:26 -0700 (PDT) Received: from localhost.localdomain (ipb218f489.dynamic.kabel-deutschland.de. [178.24.244.137]) by smtp.gmail.com with ESMTPSA id u186sm11196759wmu.26.2019.07.07.06.35.25 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Sun, 07 Jul 2019 06:35:26 -0700 (PDT) From: Eugeniu Rosca X-Google-Original-From: Eugeniu Rosca To: u-boot@lists.denx.de, Simon Glass , Sam Protsenko , Heinrich Schuchardt , AKASHI Takahiro , Igor Opaniuk , Marek Vasut , Alex Kiernan , Alex Deymo , Praneeth Bajjuri , Alistair Strachan , Joe Hershberger , Michal Simek , Chris Packham , Miquel Raynal , Mario Six , Adam Ford , Stefan Roese , Tom Rini Date: Sun, 7 Jul 2019 15:34:19 +0200 Message-Id: <20190707133419.8335-5-erosca@de.adit-jv.com> X-Mailer: git-send-email 2.22.0 In-Reply-To: <20190707133419.8335-1-erosca@de.adit-jv.com> References: <20190707133419.8335-1-erosca@de.adit-jv.com> MIME-Version: 1.0 Cc: Eugeniu Rosca , Eugeniu Rosca Subject: [U-Boot] [PATCH v4 4/4] doc: android: add BCB overview and usage 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" Document the BCB concept and U-Boot command, touching below aspects: - give an overview of BCB w/o duplicating public documentation - describe the main BCB use-cases which concern U-Boot - reflect current support status in U-Boot - mention any relevant U-Boot build-time tunables - precisely exemplify one or more use-cases Signed-off-by: Eugeniu Rosca --- v4: - This is carved out from https://patchwork.ozlabs.org/patch/1104245/ ("[v3,3/3] doc: relocate/rename Android README and add BCB overview") with no modifications. --- doc/android/bcb.txt | 89 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 doc/android/bcb.txt diff --git a/doc/android/bcb.txt b/doc/android/bcb.txt new file mode 100644 index 000000000000..7b7177cacf21 --- /dev/null +++ b/doc/android/bcb.txt @@ -0,0 +1,89 @@ +Android Bootloader Control Block (BCB) + +The purpose behind this file is to: + - give an overview of BCB w/o duplicating public documentation + - describe the main BCB use-cases which concern U-Boot + - reflect current support status in U-Boot + - mention any relevant U-Boot build-time tunables + - precisely exemplify one or more use-cases + +Additions and fixes are welcome! + + +1. OVERVIEW +--------------------------------- +Bootloader Control Block (BCB) is a well established term/acronym in +the Android namespace which refers to a location in a dedicated raw +(i.e. FS-unaware) flash (e.g. eMMC) partition, usually called "misc", +which is used as media for exchanging messages between Android userspace +(particularly recovery [1]) and an Android-capable bootloader. + +On higher level, BCB provides a way to implement a subset of Android +Bootloader Requirements [2], amongst which are: + - Android-specific bootloader flow [3] + - Get the "reboot reason" (and act accordingly) [4] + - Get/pass a list of commands from/to recovery [1] + - TODO + + +2. 'BCB'. SHELL COMMAND OVERVIEW +----------------------------------- +The 'bcb' command provides a CLI to facilitate the development of the +requirements enumerated above. Below is the command's help message: + +=> bcb +bcb - Load/set/clear/test/dump/store Android BCB fields + +Usage: +bcb load - load BCB from mmc : +bcb set - set BCB to +bcb clear [] - clear BCB or all fields +bcb test - test BCB against +bcb dump - dump BCB +bcb store - store BCB back to mmc + +Legend: + - MMC device index containing the BCB partition + - MMC partition index or name containing the BCB + - one of {command,status,recovery,stage,reserved} + - the binary operator used in 'bcb test': + '=' returns true if matches the string stored in + '~' returns true if matches a subset of 's string + - string/text provided as input to bcb {set,test} + NOTE: any ':' character in will be replaced by line feed + during 'bcb set' and used as separator by upper layers + + +3. 'BCB'. EXAMPLE OF GETTING REBOOT REASON +----------------------------------- +if bcb load 1 misc; then + # valid BCB found + if bcb test command = bootonce-bootloader; then + bcb clear command; bcb store; + # do the equivalent of AOSP ${fastbootcmd} + # i.e. call fastboot + else if bcb test command = boot-recovery; then + bcb clear command; bcb store; + # do the equivalent of AOSP ${recoverycmd} + # i.e. do anything required for booting into recovery + else + # boot Android OS normally + fi +else + # corrupted/non-existent BCB + # report error or boot non-Android OS (platform-specific) +fi + + +4. ENABLE ON YOUR BOARD +----------------------------------- +The following Kconfig options must be enabled: +CONFIG_PARTITIONS=y +CONFIG_MMC=y +CONFIG_BCB=y + +[1] https://android.googlesource.com/platform/bootable/recovery +[2] https://source.android.com/devices/bootloader +[3] https://patchwork.ozlabs.org/patch/746835/ + ("[U-Boot,5/6] Initial support for the Android Bootloader flow") +[4] https://source.android.com/devices/bootloader/boot-reason