From patchwork Mon Jan 20 12:43:11 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: 'Darko Komljenovic' via swupdate X-Patchwork-Id: 1225928 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=googlegroups.com (client-ip=2a00:1450:4864:20::439; helo=mail-wr1-x439.google.com; envelope-from=swupdate+bncbc6ynavgsakrbegbs3yqkgqeohjr36a@googlegroups.com; receiver=) Authentication-Results: ozlabs.org; dmarc=pass (p=none dis=none) header.from=googlegroups.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.a=rsa-sha256 header.s=20161025 header.b=scPrDw7W; dkim-atps=neutral Received: from mail-wr1-x439.google.com (mail-wr1-x439.google.com [IPv6:2a00:1450:4864:20::439]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 481WZC5y30z9sRl for ; Mon, 20 Jan 2020 23:44:03 +1100 (AEDT) Received: by mail-wr1-x439.google.com with SMTP id c6sf14015047wrm.18 for ; Mon, 20 Jan 2020 04:44:03 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1579524240; cv=pass; d=google.com; s=arc-20160816; b=xTTBIFoBuIx8cknY6Vk5tBMAgbdfjbUxI/asWRBnwe5GcYRrQVfYL2zosNRECgZlJn rz2HyJsMzhGYc8nejzl3lqTaB9o3+spZFwy7MU93ORH3Oc0BSX217fFNCcg1+NWVfSlU p1pgzy/PvXH99UzZ8rFwfKP7MnOvn69c0ZcNA1euldqRe0suNfqJantepo1BEf/NDpAe 49eC643Ddf91nOl4WF9SGB7Plv1XJQ8dSrqUlbodMLZqaVZAnyrd+o5BBU7TurINW5j5 mPADJazO1go/b3zYxLH85iRGAakbGc2Zx5t/vbyo9KRS7lyisoHL/jIB4CUPOd9tsEAx 8RLw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:reply-to:mime-version:references :in-reply-to:message-id:date:subject:cc:to:from:dkim-signature; bh=nB/LiL/JwWnnczxieBJzBnU1ic3QgPci90ft46Tt5L8=; b=ygiwN7DIGwGSCk+HFNvyENNC9+ejltEwhRYlA/dKuvrKQbX/XfcBVsPHvaQ9uNvi2+ 6SGgs8T9FSeiG5f6rw+oYW/k2AvRNA13NBYaJDu8izG6GWjy9201dwfFml+dPTlf1Oju eqm4THEVtANXehZe4Hwz0iF/kV4I79ruUjL5zW0nLmgFQPhX7ZdZl5CoZfMvE0s9CM0a 2D8Iq+SMRtgAVvDjIZ2J/MHWxuQvuxqF97CrJZtSzSwyXFNbpesepb87IZUUOP7IczDJ gJ2VsrVHkQKnGC/nWPs07UepOlDPakUzT7+mw284VNVTncf69kb752HOkz8UWEmWSgb0 YMeQ== ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ZL2avRiX; spf=pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) smtp.mailfrom=Mark.Jonas@de.bosch.com; dmarc=pass (p=REJECT sp=NONE dis=NONE) header.from=de.bosch.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:x-original-sender:x-original-authentication-results :reply-to:precedence:mailing-list:list-id:list-post:list-help :list-archive:list-subscribe:list-unsubscribe; bh=nB/LiL/JwWnnczxieBJzBnU1ic3QgPci90ft46Tt5L8=; b=scPrDw7WZr1R/CnshvlDI9lr/84FVRk+gK/U0bnXJ+MXc2mLOtJIXZInXuxwC+p9B4 zAb2KwzmGCUnXIJbXVGUEIb3j/dqxT5RjM0pplGdl6OWQMCcqT7dDCNs33uBjv6knfnm JqccDKry4LYDu/o8/3tTbWoRkadF3tZJoTNpQN85LsDCe8P+OyrhydWLfh3FgfZMEfhz DsVFJpFUe0Fd9oAD0oX9McwuwuOG/CQf9y7lAjY6hskFPxXG3u/BYvG/oD+54ZzJmarW p/aqMoITYWxa527kUFiurjHfyDWmJwj4imT81Gnf6pV8MpiO7CktaFy9uZdlcz0Ht732 9lkA== 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:x-original-sender :x-original-authentication-results:reply-to:precedence:mailing-list :list-id:x-spam-checked-in-group:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=nB/LiL/JwWnnczxieBJzBnU1ic3QgPci90ft46Tt5L8=; b=LOL4wAVQmeUeYy3GkI1dHNf+aG4mY2XqambaFYKgAiSr4OYPgYJ4btvo8HXczvy+fE kpWpdm2DkpY5wK8F0+A060UDs9SvnvShLsg0pkuxMwV4nUAK9+YEFMs/+u686JqGibrr EhyuxmZ83gAqrZIKvwkAjZLBlRcU0Sj51hhjCpBMmx40u6Jrohyppt6aev1cSfPc+A6P JIC8tjyx1n84L5J3fD7+e0HuMQIswj4s5Np07UmCMgWrRFBfnu26iREO0UpMSkayL2i+ 87aqcJTe2ypMb5mmuEHQ4LLpnA/DDrldVuchganXKGOMmmUgG8hw3x4xhjHhJTdMZdpZ aM7g== X-Gm-Message-State: APjAAAXaFBGdtRVeRZrxPfFF3Bl38sb6r/Kx8dzFYq6rBqdfKb5qTUnW BnbX8iTeEdGGvuMjxBoU8Gw= X-Google-Smtp-Source: APXvYqzOI2GZmLu2KKcLYTiAU9l5EFlL4/jNiTdmFQ39Xrp9h+p7KBHwpOfX8pktTJDq8SNlcZKRbg== X-Received: by 2002:a05:6000:11c9:: with SMTP id i9mr18661763wrx.164.1579524240582; Mon, 20 Jan 2020 04:44:00 -0800 (PST) X-BeenThere: swupdate@googlegroups.com Received: by 2002:a1c:e913:: with SMTP id q19ls24020wmc.3.canary-gmail; Mon, 20 Jan 2020 04:43:59 -0800 (PST) X-Received: by 2002:a7b:cb0a:: with SMTP id u10mr19278021wmj.165.1579524239684; Mon, 20 Jan 2020 04:43:59 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1579524239; cv=none; d=google.com; s=arc-20160816; b=DoVauaZcCtsSn9W2sghpDE1Vsgoap5Ov+acuYvQS+9URlsB6m9620+HtaKkDYB57it pTYId4zTdKJ8MKQYlQrtc5YotuVTfpf8d66zJn+Q95opUMaikE/RjOPHbBubiLJNSxAV wfhuMoWtuCFj8li9hsV7h2WZ9g4gJMPqx38iGoO9rUN2PnAPFxIe59/zScELJdbJh1Bo gvaaW5041437Qzm2uN62UXcOQzBWFI0R3FVB9fHmN9ua1qYpjXmN7H2DRQloQe7/EtAb vVPZkzWR8DF9x1nVjeA7PvFJhkn8K5i35Gkz0FNuk1eGDFriOs5pf5jCqKsW1RiSPjb5 MVSg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=MydMJqOcwsMwXsYJylm1YL0OfpX4e8qdjMuTKVNwlo0=; b=k8ktDdIeR7LB7+Y1xmRCQJft8TbymE3abgyceNn1XZk84XBn0JYgwB94kmuJtNIsQG a0us4YtF+CmV8osQ0NkICY7epURMraVhORiIA5SWsoCTa56qx/v+k0/bM2maWMHbfnTS qbMlwcwv+t4QGIqO0wjyLuoYqr1mGy+jO3I01XGcCopqgxBCX+UPDZnAsTmjWSYepOWS C1y3n08qJVxdlIqNH/LRM6437UsSIVlVg9XKXg6KsjgdWkE/caUGBkmJFYm6XqHJMsxw zkoL+mEAYkMVJ2MxoyUwBCoHXK5lIH5ehGQJk9Gl0tG1NVAa23gW2kTyJKF6/mZXiUyE q3nw== ARC-Authentication-Results: i=1; gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ZL2avRiX; spf=pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) smtp.mailfrom=Mark.Jonas@de.bosch.com; dmarc=pass (p=REJECT sp=NONE dis=NONE) header.from=de.bosch.com Received: from de-out1.bosch-org.com (de-out1.bosch-org.com. [139.15.230.186]) by gmr-mx.google.com with ESMTPS id p23si700968wma.1.2020.01.20.04.43.59 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 20 Jan 2020 04:43:59 -0800 (PST) Received-SPF: pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) client-ip=139.15.230.186; Received: from si0vm1947.rbesz01.com (unknown [139.15.230.188]) by si0vms0217.rbdmz01.com (Postfix) with ESMTPS id 481WZ72LSZz4f3lwN; Mon, 20 Jan 2020 13:43:59 +0100 (CET) Received: from si0vm2082.rbesz01.com (unknown [10.58.172.176]) by si0vm1947.rbesz01.com (Postfix) with ESMTPS id 481WZ728Tbz6CjRqB; Mon, 20 Jan 2020 13:43:59 +0100 (CET) X-AuditID: 0a3aad16-083ff70000004782-16-5e25a08f078b Received: from si0vm1949.rbesz01.com ( [10.58.173.29]) (using TLS with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by si0vm2082.rbesz01.com (SMG Outbound) with SMTP id E0.3C.18306.F80A52E5; Mon, 20 Jan 2020 13:43:59 +0100 (CET) Received: from SI-HUB2000.de.bosch.com (si-hub2000.de.bosch.com [10.4.103.108]) by si0vm1949.rbesz01.com (Postfix) with ESMTPS id 481WZ70Hxfz6CjZNl; Mon, 20 Jan 2020 13:43:59 +0100 (CET) Received: from ninja.grb-fir.grb.de.bosch.com (10.19.187.97) by SI-HUB2000.de.bosch.com (10.4.103.108) with Microsoft SMTP Server id 15.1.1847.3; Mon, 20 Jan 2020 13:43:43 +0100 X-Patchwork-Original-From: "'Mark Jonas' via swupdate" From: 'Darko Komljenovic' via swupdate To: , CC: , , , Kevin Zhang , Mark Jonas Subject: [swupdate] [PATCH v2 2/3] doc: handlers: add readback handler documentation Date: Mon, 20 Jan 2020 13:43:11 +0100 Message-ID: <20200120124312.15129-3-mark.jonas@de.bosch.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200120124312.15129-1-mark.jonas@de.bosch.com> References: <20200120124312.15129-1-mark.jonas@de.bosch.com> MIME-Version: 1.0 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFmpjl+LIzCtJLcpLzFFi42Lhslorq9u/QDXOoPMxm0X7KR+L6Tt/sDow ecybdYLFY8/Ek2wBTFFcNimpOZllqUX6dglcGRf2r2csuCla8Xr6H5YGxlP8XYycHBICJhIr Fy9h6WLk4hASmM4k8f7Vd2aQhJDAPkaJv81hEImtjBLXly5hA0mwCWhJ3DyxA6xIRMBQ4vq7 n0wgRcwCyxkl1uz/ApYQFvCUONT0CKyBRUBVYufjfSwgNq+AjcTiNbtZIFbLS6zecACsnlPA VuJKeytrFyMH0DYbifmHHSDKBSVOznwCVs4sICFx8MUL5gmM/LOQpGYhSS1gZFrFKFqcaVCW a2RgYaRXlJRaXGVgqJecn7uJERJmYjsYl55KO8TIxMF4iNGUg0lJlJc9SylOiC8pP6UyI7E4 I76oNCe1WEmKt/5NZ6yQMFy4uDQpN7O4ODM/7xCjBAezkgjvgibVOCHelMTKqtSifIi2Q4zS HCxK4rzpHP4xQgLpiSWp2ampBalFMFlrDg4lCd62+UCNgkWp6akVaZk5JTBpJVleRgYGBiEx ZBlka5k4OA8xGnPwAO2ePQ9kd3FBYm5xZjpUuyREuxBMFKH1FKO5lDivhRVQjwBINqM0D26r lAyv1iRgAIgiSSB0vmK8wcjBqCTM+xHkZh5gAkTYJ8HbAAoiQaggQpPREqAegYXsEv9Xq0vM 2/GVUeLFj++MEp8vfmKSOLJ7GqvEltZ2NomOlp88ElfWv+GV+P35OJ9E35wf/BI9S48JSuxr 6xWVuNc2WUzi86z7EhITlm2Ukvg35aGcxNb9G+QlFq3qU5doXb9KU+Jyx00diRVzGnUlzp9d aSQxY8cVI4nPK/cYS0z6vsZW4s71k7YSP3pW2Uk8edjiILG5abuTxIzZR1wk3h1e4iFx5+42 31fAsGQChuVVcyVQWJYklmAJS6gownNSDYyceRwPSlpF9F1N9a13BizlXS+c9ICjfZHyJGuL uZru+1NLuXjmR3Ctnsni6PPaL6c68pbOYYcHAQ82fSs596fK7YUV55S7MUsmKC5UDLoempLE yBd30izMN2vits78F0WT0xL6cvTDAnQqevlVsqLfVcwK+XD7ZcCE89KL1i48vTbLc9GF50os xRmJhlrMRcWJAHEHz18ZBAAA X-Original-Sender: mark.jonas@de.bosch.com X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@de.bosch.com header.s=key2-intmail header.b=ZL2avRiX; spf=pass (google.com: domain of mark.jonas@de.bosch.com designates 139.15.230.186 as permitted sender) smtp.mailfrom=Mark.Jonas@de.bosch.com; dmarc=pass (p=REJECT sp=NONE dis=NONE) header.from=de.bosch.com X-Original-From: Mark Jonas Reply-To: Mark Jonas Precedence: list Mailing-list: list swupdate@googlegroups.com; contact swupdate+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: swupdate@googlegroups.com X-Google-Group-Id: 605343134186 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , From: Kevin Zhang Signed-off-by: Kevin Zhang Signed-off-by: Mark Jonas Reviewed-by: Stefano Babic --- doc/source/handlers.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst index 6b694af..a55292b 100644 --- a/doc/source/handlers.rst +++ b/doc/source/handlers.rst @@ -642,4 +642,45 @@ of the two SSBL administration. | | | when this SSBL is set. | +-------------+----------+----------------------------------------------------+ +Readback Handler +---------------- +To verify that an image was written properly, this readback handler calculates +the sha256 hash of a partition (or part of it) and compares it against a given +hash value. + +The following example explains how to use this handler: + +:: + scripts: ( + { + device = "/dev/mmcblk2p1"; + type = "readback"; + properties: { + sha256 = "e7afc9bd98afd4eb7d8325196d21f1ecc0c8864d6342bfc6b6b6c84eac86eb42"; + size = "184728576"; + offset = "0"; + }; + } + ); + +Properties ``size`` and ``offset`` are optional, all the other properties are mandatory. + +.. table:: Properties for readback handler + + +-------------+----------+----------------------------------------------------+ + | Name | Type | Description | + +=============+==========+====================================================+ + | device | string | The partition which shall be verified. | + +-------------+----------+----------------------------------------------------+ + | type | string | Identifier for the handler. | + +-------------+----------+----------------------------------------------------+ + | sha256 | string | Expected sha256 hash of the partition. | + +-------------+----------+----------------------------------------------------+ + | size | string | Data size (in bytes) to be verified. | + | | | If 0 or not set, the handler will get the | + | | | partition size from the device. | + +-------------+----------+----------------------------------------------------+ + | offset | string | Offset (in bytes) to the start of the partition. | + | | | If not set, default value 0 will be used. | + +-------------+----------+----------------------------------------------------+