| Masami Hiramatsu | fdd56bf | 2023-05-31 00:29:24 -0500 | [diff] [blame] | 1 | .\" SPDX-License-Identifier: GPL-2.0-or-later |
| 2 | .\" Copyright (C) 2023 Jassi Brar <jaswinder.singh@linaro.org> |
| 3 | .TH MKFWUMDATA 1 2023-04-10 U-Boot |
| 4 | .SH NAME |
| 5 | mkfwumdata \- create FWU metadata image |
| 6 | . |
| 7 | .SH SYNOPSIS |
| 8 | .SY mkfwumdata |
| Sughosh Ganu | df42d68 | 2024-03-22 16:27:28 +0530 | [diff] [blame^] | 9 | .OP \-v version |
| Masami Hiramatsu | fdd56bf | 2023-05-31 00:29:24 -0500 | [diff] [blame] | 10 | .OP \-a activeidx |
| 11 | .OP \-p previousidx |
| 12 | .OP \-g |
| 13 | .BI \-i\~ imagecount |
| 14 | .BI \-b\~ bankcount |
| 15 | .I UUIDs |
| 16 | .I outputimage |
| 17 | .YS |
| 18 | .SY mkfwumdata |
| 19 | .B \-h |
| 20 | .YS |
| 21 | . |
| 22 | .SH DESCRIPTION |
| 23 | .B mkfwumdata |
| 24 | creates metadata info to be used with FWU. |
| 25 | . |
| 26 | .SH OPTIONS |
| 27 | .TP |
| 28 | .B \-h |
| 29 | Print usage information and exit. |
| 30 | . |
| 31 | .TP |
| Sughosh Ganu | df42d68 | 2024-03-22 16:27:28 +0530 | [diff] [blame^] | 32 | .B \-v |
| 33 | Set |
| 34 | .IR version |
| 35 | as the metadata version to generate. Valid values 1 or 2. |
| 36 | . |
| 37 | .TP |
| Masami Hiramatsu | fdd56bf | 2023-05-31 00:29:24 -0500 | [diff] [blame] | 38 | .B \-a |
| 39 | Set |
| 40 | .IR activeidx |
| 41 | as the currently active Bank. Default is 0. |
| 42 | . |
| 43 | .TP |
| 44 | .B \-p |
| 45 | Set |
| 46 | .IR previousidx |
| 47 | as the previous active Bank. Default is |
| 48 | .IR activeidx "-1" |
| 49 | or |
| 50 | .IR bankcount "-1," |
| 51 | whichever is non-negative. |
| 52 | . |
| 53 | .TP |
| 54 | .B \-g |
| 55 | Convert the |
| 56 | .IR UUIDs |
| 57 | as GUIDs before use. |
| 58 | . |
| 59 | .TP |
| 60 | .B \-i |
| 61 | Specify there are |
| 62 | .IR imagecount |
| 63 | images in each bank. |
| 64 | . |
| 65 | .TP |
| 66 | .B \-b |
| 67 | Specify there are a total of |
| 68 | .IR bankcount |
| 69 | banks. |
| 70 | . |
| 71 | .TP |
| 72 | .IR UUIDs |
| 73 | Comma-separated list of UUIDs required to create the metadata :- |
| 74 | location_uuid,image_type_uuid,<images per bank uuid list of all banks> |
| 75 | . |
| 76 | .TP |
| 77 | .IR outputimage |
| 78 | Specify the name of the metadata image file to be created. |
| 79 | . |
| 80 | .SH BUGS |
| 81 | Please report bugs to the |
| 82 | .UR https://\:source\:.denx\:.de/\:u-boot/\:u-boot/\:issues |
| 83 | U-Boot bug tracker |
| 84 | .UE . |
| 85 | .SH EXAMPLES |
| 86 | Create a metadata image with 2 banks and 1 image/bank, BankAct=0, BankPrev=1: |
| 87 | .PP |
| 88 | .EX |
| 89 | .in +4 |
| 90 | $ \c |
| Sughosh Ganu | df42d68 | 2024-03-22 16:27:28 +0530 | [diff] [blame^] | 91 | .B mkfwumdata \-v 2 \-a 0 \-p 1 \-b 2 \-i 1 \\\\\& |
| Masami Hiramatsu | fdd56bf | 2023-05-31 00:29:24 -0500 | [diff] [blame] | 92 | .in +6 |
| 93 | .B 17e86d77-41f9-4fd7-87ec-a55df9842de5,\\\\\& |
| 94 | .B 10c36d7d-ca52-b843-b7b9-f9d6c501d108,\\\\\& |
| 95 | .B 5a66a702-99fd-4fef-a392-c26e261a2828,a8f868a1-6e5c-4757-878d-ce63375ef2c0 \\\\\& |
| 96 | .B fwu-mdata.img |