From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 399E0C433F5 for ; Mon, 31 Jan 2022 02:53:06 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 56F9F83678; Mon, 31 Jan 2022 03:52:55 +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="ypFwy92X"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 5C711836A8; Mon, 31 Jan 2022 03:52:54 +0100 (CET) Received: from mail-pj1-x1036.google.com (mail-pj1-x1036.google.com [IPv6:2607:f8b0:4864:20::1036]) (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 8B38F836A3 for ; Mon, 31 Jan 2022 03:52:50 +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-pj1-x1036.google.com with SMTP id o16-20020a17090aac1000b001b62f629953so9497635pjq.3 for ; Sun, 30 Jan 2022 18:52:50 -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=ypFwy92X/RqkeHZeB+m4qFtZGxB3yeHCq3PnnNHKh0Nh3OhFzVAZNM+wfE7XmAp4Y1 +9YH2vSA8xsYUq2Sw+EnWx3aNNnTWf8yyIWnGiPTC6YEW4YOi6ELsGgy5XY5rjn15kiC PbeaHPKNScDCodIhSkeNG0bjL8LhwtKFunr4iZbr0WFvuu4vr51MaJ1Pn2S9Blj7n+rO 2//rY72cRjoulf04jpWhaNdNc+5GQUtC1oUBGxlv1x49/BdO4MNtp08UE3FK9Hz73X44 e1q1jjnApXVJZlpWwuM88zNq+khC2jS8YIYzLwYv4eDGF46/wAsWgqTV7nZJKJTDrsb2 CdGA== 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=OPno6cF8MkpuCU/VCRVh41oxqDRZwug2mWY1fOwdj2F207m4X4x4wS2u8zGw8SAPN0 qaZsWhBxlZ9ks5WZemQCzjM2ZLLLTf75qWxrEjRUTnUCM4pG3AqVrMHoH+UWyDVROoGa KVzqav9w0LWzORVpwHsBvUJh9u8KNB7nSeBveDNCbRimafjg9s+QYjXZ73v+FXE+5J0i JHnNBgVbt3At69EdTbWSMjac7tSHqGkrkPTwN9X1nweFJn/Z/TuL3ZfftY+hUuqoB5Pf X/Owf3JDMLxqE7VY4Wa5X4WDl5Nt5jqoW7GzKRqzxmi2BOi1vz45oQyYk18yUi3cC+W3 tNHw== X-Gm-Message-State: AOAM5312SMDJ7KW8j36weC8dNwvGxqtvpdLHas62TnJx4DlGK3qT5UUg iwUL3A9axc0XNKLq5xzfHvWnvQ== X-Google-Smtp-Source: ABdhPJyipUWVcbwtKk7enqwNkB9Ky40+7uYp0i05li5m7gUZZmPG5S7FEpQpoO7PEnka8p7TshvRzw== X-Received: by 2002:a17:90b:4d84:: with SMTP id oj4mr22027072pjb.192.1643597569010; Sun, 30 Jan 2022 18:52:49 -0800 (PST) Received: from localhost.localdomain (113x37x226x201.ap113.ftth.ucom.ne.jp. [113.37.226.201]) by smtp.gmail.com with ESMTPSA id f16sm17384059pfa.147.2022.01.30.18.52.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 30 Jan 2022 18:52:48 -0800 (PST) From: Masami Hiramatsu To: Tom Rini , Lukasz Majewski Cc: u-boot@lists.denx.de, ilias.apalodimas@linaro.org, sughosh.ganu@linaro.org, jaswinder.singh@linaro.org Subject: [PATCH v2 4/5] doc: usage: DFU: Fix dfu_alt_info document Date: Mon, 31 Jan 2022 11:52:46 +0900 Message-Id: <164359756596.280839.6668664818943333738.stgit@localhost> X-Mailer: git-send-email 2.25.1 In-Reply-To: <164359753172.280839.8310577813724924540.stgit@localhost> References: <164359753172.280839.8310577813724924540.stgit@localhost> User-Agent: StGit/0.19 MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 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.5 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