util/chromeos: revise description for more utility scripts in future
The description.md and README.md was explicitly made for downloading or extracting some resources, but we need to add more Chrome OS related scripts soon; so the description should be revised. Also changed README.md for better markdown style, for example - Use #, ## to replace the old '-' headers - Use code format for file names - Use code block for example of shell execution Change-Id: Icc3677fa318b03f4aee1b0f5fb13b2095f2afe64 Signed-off-by: Hung-Te Lin <hungte@chromium.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/35664 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
This commit is contained in:
parent
e088721f71
commit
544bc2693a
|
@ -1,27 +1,28 @@
|
||||||
Chrome OS binary extraction
|
# Chrome OS Scripts
|
||||||
===========================
|
|
||||||
|
|
||||||
These scripts can be used to extract System Agent reference code
|
These scripts can be used to access or generate Chrome OS resources, for example
|
||||||
and other blobs (e.g. mrc.bin, refcode, VGA option roms) from a
|
to extract System Agent reference code and other blobs (e.g. `mrc.bin`, refcode,
|
||||||
Chrome OS recovery image.
|
VGA option roms) from a Chrome OS recovery image.
|
||||||
|
|
||||||
crosfirmware.sh
|
## crosfirmware.sh
|
||||||
---------------
|
|
||||||
|
|
||||||
crosfirmware.sh downloads a Chrome OS recovery image from the recovery
|
`crosfirmware.sh` downloads a Chrome OS recovery image from the recovery
|
||||||
image server, unpacks it, extracts the firmware update shell archive,
|
image server, unpacks it, extracts the firmware update shell archive,
|
||||||
extracts the firmware images from the shell archive.
|
extracts the firmware images from the shell archive.
|
||||||
|
|
||||||
To download all Chrome OS firmware images, run
|
To download all Chrome OS firmware images, run
|
||||||
|
```
|
||||||
$ ./crosfirmware.sh
|
$ ./crosfirmware.sh
|
||||||
|
```
|
||||||
|
|
||||||
To download, e.g. the Panther firmware image, run
|
To download, e.g. the Panther firmware image, run
|
||||||
|
```
|
||||||
$ ./crosfirmware.sh panther
|
$ ./crosfirmware.sh panther
|
||||||
|
```
|
||||||
|
|
||||||
extract_blobs.sh
|
## extract_blobs.sh
|
||||||
----------------
|
|
||||||
|
|
||||||
extract_blobs.sh extracts the blobs from a Chrome OS firmware image.
|
`extract_blobs.sh` extracts the blobs from a Chrome OS firmware image.
|
||||||
|
|
||||||
Right now it will produce the ME firmware blob, IFD, VGA option rom,
|
Right now it will produce the ME firmware blob, IFD, VGA option rom,
|
||||||
and mrc.bin
|
and `mrc.bin`.
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
These scripts can be used to extract System Agent reference code and
|
These scripts can be used to access Chrome OS resources, for example to extract
|
||||||
other blobs (e.g. mrc.bin, refcode, VGA option roms) from a Chrome OS
|
System Agent reference code and other blobs (e.g. mrc.bin, refcode, VGA option
|
||||||
recovery image. `C`
|
roms) from a Chrome OS recovery image. `C`
|
||||||
|
|
Loading…
Reference in New Issue