[coreboot-gerrit] Change in coreboot[master]: Documentation: Added binary extraction documentation

[Logan Carlson (Code Review)]

Logan Carlson has uploaded this change for review. ( https://review.coreboot.org/20753


Change subject: Documentation: Added binary extraction documentation
......................................................................

Documentation: Added binary extraction documentation

Added documentation on how to extract binaries from a ROM image,
including:

- Using ifdtool to extract binaries.
- Using cbfstool to extract binaries.
- Changing menuconfig to use the extracted binaries.

Change-Id: Ia31b01afc66789f95c7d21a0d41b532bc19a6430
Signed-off-by: Logan Carlson <logancarlson at google.com>
---
A Documentation/Binary Extraction.md
1 file changed, 51 insertions(+), 0 deletions(-)



  git pull ssh://review.coreboot.org:29418/coreboot refs/changes/53/20753/1

diff --git a/Documentation/Binary Extraction.md b/Documentation/Binary Extraction.md
new file mode 100644
index 0000000..5407f6b
--- /dev/null
+++ b/Documentation/Binary Extraction.md
@@ -0,0 +1,51 @@
+# Binary Extraction Tutorial
+
+### Part 1: Extracting Binaries
+
+To begin extracting the binaries, first create a directory labeled "binaries"
+in the coreboot directory (i.e. /coreboot/binaries/).
+
+Now, execute the following commands to extract the binaries from a ROM image.
+**Note:** Make sure you are in the root coreboot directory.
+
+    cd util/ifdtool
+    ./ifdtool <ROM IMAGE>
+    ./ifdtool -d <ROM IMAGE>
+    ./ifdtool -x <ROM IMAGE>
+
+In the above steps, <ROM IMAGE> is the name of the ROM image to extract the
+binaries from, including the file path (ex. /build/coreboot.rom).
+
+Copy the extracted .bin files to the binaries directory you created previously.
+**Note:** You may want to rename your various .bin files to more clearly
+indicate what they are and their purpose.
+
+To extract the mrc.bin, move to the /coreboot/build directory and run the
+following command:
+
+    ./cbfstool <ROM IMAGE> extract -n mrc.bin -f <DEST>/<filename>
+
+where <ROM IMAGE> is the filepath to the ROM image (same image as above),
+<DEST> is the filepath to the destination directory and <filename> is the
+output filename. An example command is given below:
+
+    ./cbfstool coreboot.rom extract -n mrc.bin -f ../binaries/mrc.bin
+
+### Part 2: Changing the coreboot configuration settings
+
+From the main coreboot directory, run "make menuconfig". Select "General Setup",
+then select "Allow use of binary-only repository", then exit to the main menu.
+
+To configure the ROM image for the specific board you want to use and select
+"Mainboard". Select "Mainboard vendor" and scroll to the correct vendor. Then
+select "Mainboard model" and select the name of the board model. Exit back to
+the main menu.
+
+To add the binaries you extracted, select "Chipset". Scroll and select "Add a
+System Agent Binary" and set the filepath to your mrc.bin file's filepath.
+Scroll and select "Add Intel descriptor.bin file" and type the filepath for
+your descriptor.bin file. Scroll down and select "Add Intel ME/TXE firmware
+file" and type the filepath for your ME file. Exit to the main menu.
+
+Select "Exit", and select "Yes" if prompted to save your configuration
+settings.

-- 
To view, visit https://review.coreboot.org/20753
To unsubscribe, visit https://review.coreboot.org/settings

Gerrit-Project: coreboot
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia31b01afc66789f95c7d21a0d41b532bc19a6430
Gerrit-Change-Number: 20753
Gerrit-PatchSet: 1
Gerrit-Owner: Logan Carlson <logancarlson at google.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.coreboot.org/pipermail/coreboot-gerrit/attachments/20170724/5bebec06/attachment-0001.html>