From patchwork Mon Dec 6 05:45:03 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masami Hiramatsu X-Patchwork-Id: 520960 Delivered-To: patch@linaro.org Received: by 2002:a05:6e04:2287:0:0:0:0 with SMTP id bl7csp4224387imb; Sun, 5 Dec 2021 21:45:26 -0800 (PST) X-Google-Smtp-Source: ABdhPJxv18OM8L0CCcnobqhOSySEDzdtdh1dQEQdSXgWH7QbTOnWzoDMCm1XUsOLERID5ZAjGaem X-Received: by 2002:a17:907:728c:: with SMTP id dt12mr41471878ejc.375.1638769526363; Sun, 05 Dec 2021 21:45:26 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1638769526; cv=none; d=google.com; s=arc-20160816; b=sN/1Y6BPQggbqeCHyolWaXUpuul3qW7xtw7AYqzVVgRI3z+6TzJRm5XXClihTSpDYx 2GeEXdCdsYNOf4HoNKSmHx5jBfWh0GiErPKGyU5IoReM/s84YU3cmTEY5vQ4eJsQPrVT xRML4K+5yBD8eWMrlFTlePmJc0+McEJ45gUr2P5kB+qabGwrcx7VF/+FP/ZXEmJEkhHF 9FFzqlckqbPKdpZ6hTLu31hdttDjTbpkchxvyiQ7F1u1HdcpIKhKiKA+3NFQq1wXDPHf XgMRa/BLLpYI1E5Pm4BlnEvCIzQDsNpzk4L+wBcCJz3DAI3qUANjn8Qh3J4PQRZeQlii /VTA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:user-agent:references:in-reply-to:message-id:date :subject:cc:to:from:dkim-signature; bh=CLqRMktc+XAN1vyHP67n8zLu6z9KiN8YVEfbtM81pvs=; b=bG3FMogQ/BCU7Gre3Oj2BfMLlZ+P0r2xRHPm9og47EwVWr2/a1mregGosa4AwnUuvk CsRHlCRcTEwngnnwHsArN9/WRzvdKTBNxPgJmVpLt78san6KsbXYMprauFv4w5BM+wUG FBlhST/GPyG0S0lTU1NQNBeAxSAmQFEDOAHJCL0MRpyLuoz9oZ1Vcbl+zIKlfwpec1wn BEn+bep5wME1v2JC53FrSMpC2ioQOrQvBUb0i7qQM/K1XaFYhUUCe+1gVAjgM++vfdFI yawIwHGCAETMJfMJy1WV3G1VnfI1DlbVBwLIJy9ycJzBQjjwMZhVnWmRvBQ6EX9bEAAY TpVg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=TzSj1euT; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from phobos.denx.de (phobos.denx.de. [2a01:238:438b:c500:173d:9f52:ddab:ee01]) by mx.google.com with ESMTPS id f12si17946014edx.390.2021.12.05.21.45.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 05 Dec 2021 21:45:26 -0800 (PST) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=TzSj1euT; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 2a01:238:438b:c500:173d:9f52:ddab:ee01 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id CF6408307B; Mon, 6 Dec 2021 06:45:21 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="TzSj1euT"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id E85F68307D; Mon, 6 Dec 2021 06:45:18 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.2 Received: from mail-pl1-x62c.google.com (mail-pl1-x62c.google.com [IPv6:2607:f8b0:4864:20::62c]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 5D217830B3 for ; Mon, 6 Dec 2021 06:45:07 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=masami.hiramatsu@linaro.org Received: by mail-pl1-x62c.google.com with SMTP id b13so6366828plg.2 for ; Sun, 05 Dec 2021 21:45:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :user-agent:mime-version:content-transfer-encoding; bh=CLqRMktc+XAN1vyHP67n8zLu6z9KiN8YVEfbtM81pvs=; b=TzSj1euTz0NZ39xNPkTd7RPWTXWc/4ZRE1J3Bi/YY4F+OJHN7gkxDAicf9CecgBFj+ Ujf1mbQwloBIjfa1zTaaU+e5A6wnTwn+dNCpPrFg5tZ+9ZevcWFJO/9/ZV+7+inj9LFG /dbTyguKyqsJUrA0smPTZSLX1+bHT7hibYqOOkR4LS8p6RMq9n9i8TYSqY6XliwLOqSU H6rKRLQ9p8k9AhTozt2hm6jKlxTMrLElTojEl3dDKEePU9T0e+QS6W1lD3sesLVYwEHt kPa3pWWpjf/T57H0SOn++xLqHROjETuEnmLncfA0OhUN1MmeQ8ts0BFF8+5T1qLVlbzj KcmA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:user-agent:mime-version:content-transfer-encoding; bh=CLqRMktc+XAN1vyHP67n8zLu6z9KiN8YVEfbtM81pvs=; b=p9nnL0M8xCu6Wj/GFmiilj86Glq+Yuw3Ax3koHCxzkgrOaKnG+VbcEEb6nuzs8sqJa UuNzZbx1RyKfo42xWFeaEqxSKWD+YiaK1tUCT0XJE6hh0JVNsjLqhnL61/Aw6IQRIeaC Y0JEbXmJtyZeah47hTpXHrCQLpRJQh4p/WK8IFn/4n+mYiNhcrx3tVHouNteE7TbV1vq jd5HuE0j3AfEJecgSJclaw9DhwNQAh+3DWmy4R1jwCEMPyZBzr9nWDoXwQ/ddCYBxmXL quOKGyQ1y7VK4Yx9+Z1MzQAmPoYvG06JcYm7+42OpIM/hJgcs+d2Fse7saQ2WO71wSW4 mgpw== X-Gm-Message-State: AOAM533S2w3dtI6q69nyoFEi6B3XiwTO6yl+hoxSzq+Kng6I+PySIKM1 UTmZdwtUm4jA8yDYI1O5JzGp4j5JUrIlHg== X-Received: by 2002:a17:90a:e2c3:: with SMTP id fr3mr34202393pjb.187.1638769505730; Sun, 05 Dec 2021 21:45:05 -0800 (PST) Received: from localhost.localdomain (122x208x150x49.ap122.ftth.ucom.ne.jp. [122.208.150.49]) by smtp.gmail.com with ESMTPSA id v19sm11507855pju.32.2021.12.05.21.45.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 05 Dec 2021 21:45:05 -0800 (PST) From: Masami Hiramatsu To: Lukasz Majewski Cc: u-boot@lists.denx.de, ilias.apalodimas@linaro.org, sughosh.ganu@linaro.org, jaswinder.singh@linaro.org Subject: [PATCH 4/5] doc: usage: DFU: Fix dfu_alt_info document Date: Mon, 6 Dec 2021 14:45:03 +0900 Message-Id: <163876950284.38238.13634509540751439795.stgit@localhost> X-Mailer: git-send-email 2.25.1 In-Reply-To: <163876946986.38238.10896882043017582609.stgit@localhost> References: <163876946986.38238.10896882043017582609.stgit@localhost> User-Agent: StGit/0.19 MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.38 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" X-Virus-Scanned: clamav-milter 0.103.2 at phobos.denx.de X-Virus-Status: Clean Fix some typo and wrong information about dfu_alt_info. - Add the parameter format, decimal only or hexadecimal. - Use same parameter name for the same kind of parameters. (e.g. dev -> dev_id) Signed-off-by: Masami Hiramatsu --- doc/usage/dfu.rst | 57 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 40 insertions(+), 17 deletions(-) diff --git a/doc/usage/dfu.rst b/doc/usage/dfu.rst index 11c88072b8..ed47ff561e 100644 --- a/doc/usage/dfu.rst +++ b/doc/usage/dfu.rst @@ -113,9 +113,9 @@ mmc each element in *dfu_alt_info* being * raw [mmcpart ] raw access to mmc device - * part [mmcpart ] raw access to partition - * fat [mmcpart ] file in FAT partition - * ext4 [mmcpart ] file in EXT4 partition + * part [offset ] raw access to partition + * fat file in FAT partition + * ext4 file in EXT4 partition * skip 0 0 ignore flashed data * script 0 0 execute commands in shell @@ -169,14 +169,20 @@ nand each element in *dfu_alt_info* being either of - * raw raw access to mmc device - * part raw acces to partition - * partubi raw acces to ubi partition + * raw raw access to nand device + * part raw access to partition + * partubi raw access to ubi partition with - partid - is the MTD partition index + offset + is the offset in the nand device (hexadecimal without "0x") + size + is the size of the access area (hexadecimal without "0x") + dev_id + is the NAND device index (decimal only) + part_id + is the NAND partition index (decimal only) ram raw access to ram:: @@ -190,6 +196,13 @@ ram ram raw access to ram + with + + offset + is the offset in the ram device (hexadecimal without "0x") + size + is the size of the access area (hexadecimal without "0x") + sf serial flash : NOR:: @@ -198,13 +211,19 @@ sf each element in *dfu_alt_info* being either of: * raw raw access to sf device - * part raw acces to partition - * partubi raw acces to ubi partition + * part raw acces to partition + * partubi raw acces to ubi partition with - partid - is the MTD partition index + offset + is the offset in the sf device (hexadecimal without "0x") + size + is the size of the access area (hexadecimal without "0x") + dev_id + is the sf device index (the device is "nor") (deximal only) + part_id + is the MTD partition index (decimal only) mtd all MTD device: NAND, SPI-NOR, SPI-NAND,...:: @@ -219,14 +238,18 @@ mtd each element in *dfu_alt_info* being either of: - * raw forraw access to mtd device - * part for raw acces to partition - * partubi for raw acces to ubi partition + * raw for raw access to mtd device + * part for raw access to partition + * partubi for raw access to ubi partition with - partid - is the MTD partition index + offset + is the offset in the mtd device (hexadecimal without "0x") + size + is the size of the access area (hexadecimal without "0x") + part_id + is the MTD partition index (decimal only) virt virtual flash back end for DFU