Gitiles
Code Review Sign In
git01.mediatek.com / filogic / uboot / 32ef937d806dfa48a03e47f4169ed14ad4e56539 / . / doc / mkfwumdata.1
blob: 2ed0fb100b83844c9e8cd6cbc73ae7b6373379f8 [file] [log] [blame]
Masami Hiramatsuca09ad72023-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
5mkfwumdata \- create FWU metadata image
6.
7.SH SYNOPSIS
8.SY mkfwumdata
Sughosh Ganu081c0892024-03-22 16:27:28 +0530[diff] [blame]9.OP \-v version
Masami Hiramatsuca09ad72023-05-31 00:29:24 -0500[diff] [blame]10.OP \-a activeidx
11.OP \-p previousidx
12.OP \-g
Sughosh Ganu910bdb22024-03-22 16:27:29 +0530[diff] [blame]13.OP \-V vendor-file
Masami Hiramatsuca09ad72023-05-31 00:29:24 -0500[diff] [blame]14.BI \-i\~ imagecount
15.BI \-b\~ bankcount
16.I UUIDs
17.I outputimage
18.YS
19.SY mkfwumdata
20.B \-h
21.YS
22.
23.SH DESCRIPTION
24.B mkfwumdata
25creates metadata info to be used with FWU.
26.
27.SH OPTIONS
28.TP
29.B \-h
30Print usage information and exit.
31.
32.TP
Sughosh Ganu081c0892024-03-22 16:27:28 +0530[diff] [blame]33.B \-v
34Set
35.IR version
36as the metadata version to generate. Valid values 1 or 2.
37.
38.TP
Masami Hiramatsuca09ad72023-05-31 00:29:24 -0500[diff] [blame]39.B \-a
40Set
41.IR activeidx
42as the currently active Bank. Default is 0.
43.
44.TP
45.B \-p
46Set
47.IR previousidx
48as the previous active Bank. Default is
49.IR activeidx "-1"
50or
51.IR bankcount "-1,"
52whichever is non-negative.
53.
54.TP
55.B \-g
56Convert the
57.IR UUIDs
58as GUIDs before use.
59.
60.TP
Sughosh Ganu910bdb22024-03-22 16:27:29 +0530[diff] [blame]61.B \-V
62Pass
63.IR vendor-file
64for appending vendor data to the metadata. Supported only with version 2.
65.
66.TP
Masami Hiramatsuca09ad72023-05-31 00:29:24 -0500[diff] [blame]67.B \-i
68Specify there are
69.IR imagecount
70images in each bank.
71.
72.TP
73.B \-b
74Specify there are a total of
75.IR bankcount
76banks.
77.
78.TP
79.IR UUIDs
80Comma-separated list of UUIDs required to create the metadata :-
81location_uuid,image_type_uuid,<images per bank uuid list of all banks>
82.
83.TP
84.IR outputimage
85Specify the name of the metadata image file to be created.
86.
87.SH BUGS
88Please report bugs to the
89.UR https://\:source\:.denx\:.de/\:u-boot/\:u-boot/\:issues
90U-Boot bug tracker
91.UE .
92.SH EXAMPLES
93Create a metadata image with 2 banks and 1 image/bank, BankAct=0, BankPrev=1:
94.PP
95.EX
96.in +4
97$ \c
Sughosh Ganu081c0892024-03-22 16:27:28 +0530[diff] [blame]98.B mkfwumdata \-v 2 \-a 0 \-p 1 \-b 2 \-i 1 \\\\\&
Masami Hiramatsuca09ad72023-05-31 00:29:24 -0500[diff] [blame]99.in +6
100.B 17e86d77-41f9-4fd7-87ec-a55df9842de5,\\\\\&
101.B 10c36d7d-ca52-b843-b7b9-f9d6c501d108,\\\\\&
102.B 5a66a702-99fd-4fef-a392-c26e261a2828,a8f868a1-6e5c-4757-878d-ce63375ef2c0 \\\\\&
103.B fwu-mdata.img