README.md
1% FUTILITY(1) Version 1.0 | Unified Firmware Utility Program
2
3[TOC]
4
5NAME
6============
7
8**futility** - Futility is a unified firmware tool that provides a variety of
9firmware peripheral functions and subcommands.
10
11SYNOPSIS
12========
13
14- **futility** \[options] COMMAND \[args...]
15- **futility** **help** COMMAND
16
17DESCRIPTION
18===========
19
20This is the unified firmware utility, which contains various of distinct verified
21boot tools as subcommands.
22
23Options
24-------
25
26### Global Options:
27
28\--vb1
29
30: Use only vboot v1.0 binary formats.
31
32\--vb21
33
34: Use only vboot v2.1 binary formats.
35
36\--debug
37
38: Be noisy about what's going on.
39
40
41### Commands
42
43create
44
45: Create a keypair from an RSA .pem file.
46
47dump_fmap
48
49: Display FMAP contents from a firmware image.
50
51dump_kernel_config
52
53: Prints the kernel command line.
54
55flash
56
57: Manage AP SPI flash properties and writeprotect configuration.
58
59gbb, gbb_utility
60
61: Manipulate the Google Binary Block (GBB).
62 See [cmd_gbb_utility](./docs/cmd_gbb_utility.md) for detailed information.
63
64 Examples:
65
66 futility gbb --get $FILE
67 (dut) futility gbb --get --flash
68 (host) futility gbb --get --servo
69 (host) futility gbb --set --flags=$FLAGS --servo
70
71gscvd
72
73: Create RO verification structure.
74
75help
76
77: Show a bit of help.
78
79load_fmap
80
81: Replace the contents of specified FMAP areas.
82
83pcr
84
85: Simulate a TPM PCR extension operation.
86
87read
88
89: Read AP firmware.
90
91 Examples:
92
93 (dut) futility read $IMG_OUT
94 (host) futility read --servo $IMG_OUT
95 (host) futility read --ccd_without_servod -r RO_VPD $IMG_OUT
96
97show
98
99: Display the content of various binary components.
100
101sign
102
103: Sign / resign various binary components.
104
105update
106
107: Update system firmware.
108
109 Examples:
110
111 (dut) futility update -i $IMG
112 (host) futility update --wp 0 -i $IMG --servo
113 (host) futility update --force -i $IMG --servo
114
115vbutil_firmware
116
117: Verified boot firmware utility.
118
119vbutil_kernel
120
121: Creates, signs, and verifies the kernel partition.
122
123vbutil_key
124
125: Wraps RSA keys with vboot headers.
126
127vbutil_keyblock
128
129: Creates, signs, and verifies a keyblock.
130
131verify
132
133: Verify the signatures of various binary components. This does not verify GSCVD contents.
134
135version
136
137: Show the futility source revision and build date.
138