doc/mkfwumdata.1

   1 .\" SPDX-License-Identifier: GPL-2.0-or-later
   2 .\" Copyright (C) 2023 Jassi Brar <[email protected]>
   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 \-v version
  10 .OP \-a activeidx
  11 .OP \-p previousidx
  12 .OP \-g
  13 .OP \-V vendor-file
  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
  25 creates metadata info to be used with FWU.
  26 .
  27 .SH OPTIONS
  28 .TP
  29 .B \-h
  30 Print usage information and exit.
  31 .
  32 .TP
  33 .B \-v
  34 Set
  35 .IR version
  36 as the metadata version to generate. Valid values 1 or 2.
  37 .
  38 .TP
  39 .B \-a
  40 Set
  41 .IR activeidx
  42 as the currently active Bank. Default is 0.
  43 .
  44 .TP
  45 .B \-p
  46 Set
  47 .IR previousidx
  48 as the previous active Bank. Default is
  49 .IR activeidx "-1"
  50 or
  51 .IR bankcount "-1,"
  52 whichever is non-negative.
  53 .
  54 .TP
  55 .B \-g
  56 Convert the
  57 .IR UUIDs
  58 as GUIDs before use.
  59 .
  60 .TP
  61 .B \-V
  62 Pass
  63 .IR vendor-file
  64 for appending vendor data to the metadata. Supported only with version 2.
  65 .
  66 .TP
  67 .B \-i
  68 Specify there are
  69 .IR imagecount
  70 images in each bank.
  71 .
  72 .TP
  73 .B \-b
  74 Specify there are a total of
  75 .IR bankcount
  76 banks.
  77 .
  78 .TP
  79 .IR UUIDs
  80 Comma-separated list of UUIDs required to create the metadata :-
  81 location_uuid,image_type_uuid,<images per bank uuid list of all banks>
  82 .
  83 .TP
  84 .IR outputimage
  85 Specify the name of the metadata image file to be created.
  86 .
  87 .SH BUGS
  88 Please report bugs to the
  89 .UR https://\:source\:.denx\:.de/\:u-boot/\:u-boot/\:issues
  90 U-Boot bug tracker
  91 .UE .
  92 .SH EXAMPLES
  93 Create a metadata image with 2 banks and 1 image/bank, BankAct=0, BankPrev=1:
  94 .PP
  95 .EX
  96 .in +4
  97 $ \c
  98 .B mkfwumdata \-v 2 \-a 0 \-p 1 \-b 2 \-i 1 \\\\\&
  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