doc/mkfwumdata.1

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