xref: /aosp_15_r20/external/vboot_reference/firmware/README (revision 8617a60d3594060b7ecbd21bc622a7c14f3cf2bc)
1*8617a60dSAndroid Build Coastguard Worker
2*8617a60dSAndroid Build Coastguard WorkerHere's what's what in the firmware/ directory.
3*8617a60dSAndroid Build Coastguard Worker
4*8617a60dSAndroid Build Coastguard Workerinclude/
5*8617a60dSAndroid Build Coastguard Workerlib/
6*8617a60dSAndroid Build Coastguard Worker
7*8617a60dSAndroid Build Coastguard Worker  These are the original structures and APIs used in the earliest
8*8617a60dSAndroid Build Coastguard Worker  Chromebooks and continuing through 2014. It never had a version as such to
9*8617a60dSAndroid Build Coastguard Worker  begin with, but we now refer to this implementation as "vboot1" or
10*8617a60dSAndroid Build Coastguard Worker  "vboot version 1.0".
11*8617a60dSAndroid Build Coastguard Worker
12*8617a60dSAndroid Build Coastguard Workerlinktest/
13*8617a60dSAndroid Build Coastguard Workerstub/
14*8617a60dSAndroid Build Coastguard Worker
15*8617a60dSAndroid Build Coastguard Worker  These are stubs used to link the vboot1 libraries into host-side test
16*8617a60dSAndroid Build Coastguard Worker  executables so we can run some tests on the build machine instead of a
17*8617a60dSAndroid Build Coastguard Worker  Chromebook.
18*8617a60dSAndroid Build Coastguard Worker
19*8617a60dSAndroid Build Coastguard Worker2lib/
20*8617a60dSAndroid Build Coastguard Worker
21*8617a60dSAndroid Build Coastguard Worker  In 2014 we began work on a new vboot API. The first step was just a
22*8617a60dSAndroid Build Coastguard Worker  refactoring and renaming of the verification API. The public functions and
23*8617a60dSAndroid Build Coastguard Worker  external headers that are exported for use by the Chrome OS firmware (or
24*8617a60dSAndroid Build Coastguard Worker  anything else that wants to use vboot) live in here. The internal
25*8617a60dSAndroid Build Coastguard Worker  structures and implementations go elsewhere.
26*8617a60dSAndroid Build Coastguard Worker
27*8617a60dSAndroid Build Coastguard Workerlib20/
28*8617a60dSAndroid Build Coastguard Worker
29*8617a60dSAndroid Build Coastguard Worker  This is an early implementation of the public (2lib/) API. It is
30*8617a60dSAndroid Build Coastguard Worker  binary-compatible with vboot1, so although the interface details are
31*8617a60dSAndroid Build Coastguard Worker  different, any existing on-device structures or signatures created by the
32*8617a60dSAndroid Build Coastguard Worker  vboot1 tools can be validated using this implementation.
33*8617a60dSAndroid Build Coastguard Worker
34*8617a60dSAndroid Build Coastguard Worker  This was deployed slightly before it was ready. That's not a problem,
35*8617a60dSAndroid Build Coastguard Worker  thanks to the binary compatibility, but this directory will be abandoned
36*8617a60dSAndroid Build Coastguard Worker  Real Soon Now, except for the product support branches.
37