diff options
| author | Alyssa Rosenzweig <alyssa@rosenzweig.io> | 2017-03-17 22:24:25 -0700 |
|---|---|---|
| committer | Alyssa Rosenzweig <alyssa@rosenzweig.io> | 2017-03-17 22:24:25 -0700 |
| commit | dbc480fb28a694ad5a587be025eabfded7c7784b (patch) | |
| tree | 16b4251dcbdede274781f7bb8b1f23570853f3bb /docs/git/index.html | |
| parent | 85ec6862e8af0747420ca15fef7100edb5885302 (diff) | |
| download | librebootfr-dbc480fb28a694ad5a587be025eabfded7c7784b.tar.gz librebootfr-dbc480fb28a694ad5a587be025eabfded7c7784b.zip | |
Convert documentation to markdown
Diffstat (limited to 'docs/git/index.html')
| -rw-r--r-- | docs/git/index.html | 490 |
1 files changed, 0 insertions, 490 deletions
diff --git a/docs/git/index.html b/docs/git/index.html deleted file mode 100644 index dc4b584a..00000000 --- a/docs/git/index.html +++ /dev/null @@ -1,490 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - - <style type="text/css"> - @import url('../css/main.css'); - </style> - - <title>Building libreboot from source</title> -</head> - -<body> - -<div class="section"> -<p> -Depthcharge is currently not documented, since it is in the new build system. -Instructions for how to build boards that have depthcharge are included in -the BUILD_HOWTO file in libreboot.git or _src. -</p> -</div> - - <div class="section"> - <h1 id="pagetop">Building libreboot from source</h1> - <p> - This section relates to building libreboot from source, and - working with the git repository. - </p> - <p> - Or <a href="../">Back to main index</a>. - </p> - <ul> - <li><a href="#build_dependencies">Install build dependencies</a></li> - <li><a href="#build_meta">Get the full source code from metadata (git clone)</a></li> - <li><a href="#build_bucts">How to build "bucts" (for LenovoBIOS X60/X60S/X60T/T60)</a></li> - <li><a href="#build_flashrom">How to build "flashrom"</a></li> - <li><a href="#build">How to build the ROM images</a></li> - </ul> - </div> - - <div class="section"> - - <h1 id="build_dependencies">Install build dependencies</h1> - - <p> - Before doing anything, you need the dependencies first. This is true if - you want to build libreboot from source, with either libreboot_src.tar.xz or git. - <b>If you are using libreboot_util.tar.xz (binary archive) then you can ignore this, because - ROM images and statically compiled executables for the utilities are included.</b> - </p> - - <div class="important"> - <p> - For Debian Stretch (may also work on Debian Jessie), you can run the following command:<br/> - $ <b>sudo ./oldbuild dependencies debian</b> - <br/>(this will also work in Devuan) - </p> - <p> - For Parabola, you can run the following command:<br/> - $ <b>sudo ./oldbuild dependencies parabola</b><br/> - or:<br/> - # <b>./oldbuild dependencies parabola</b> - </p> - </div> - - <p> - For other GNU+Linux distributions, you can adapt the existing scripts. - </p> - - <p><a href="#pagetop">Back to top of page</a></p> - - </div> - - <div class="section"> - - <h1 id="build_meta">Get the full source code from metadata (git clone)</h1> - - <p> - If you downloaded libreboot from git, then there are some steps to download and patch - the source code for all relevant dependencies. The archive in the git repository used to be - available as a tarball called 'libreboot_meta.tar.gz'. It contains 'metadata' (scripts) - which define how the source was created (where it came from). - </p> - - <p> - You can use the scripts included to download everything. - </p> - - <p> - First, <a href="#build_dependencies">install the build dependencies</a>. - </p> - - <p> - Since libreboot makes extensive use of git, you need to configure git properly. If you have not yet configured - git, then the minimum requirement is:<br/> - $ <b>git config --global user.name "Your Name"</b><br/> - $ <b>git config --global user.email your@emailaddress.com</b><br/> - This is what will also appear in git logs if you ever commit your own changes to a given repository. For - more information, see <a href="http://git-scm.com/doc">http://git-scm.com/doc</a>. - </p> - - <p> - Another nice config for you (optional, but recommended):<br/> - $ <b>git config --global core.editor nano</b><br/> - $ <b>git config --global color.status auto</b><br/> - $ <b>git config --global color.branch auto</b><br/> - $ <b>git config --global color.interactive auto</b><br/> - $ <b>git config --global color.diff auto</b> - </p> - - <p> - After that, run the script:<br/> - $ <b>./download all</b> - </p> - - <p> - What this did was download everything (grub, coreboot, memtest86+, bucts, flashrom) - at the versions last tested for this release, and patch them. Read the script - in a text editor to learn more. - </p> - - <p> - To build the ROM images, see <a href="#build">#build</a>. - </p> - - <p><a href="#pagetop">Back to top of page.</a></p> - - </div> - - <div class="section"> - - <h1 id="build_bucts">How to build "bucts" (for LenovoBIOS X60/X60S/X60T/T60)</h1> - - <p> - <b>This is for Lenovo BIOS users on the ThinkPad X60/X60S, X60 Tablet and T60. If you have coreboot or libreboot running already, ignore this.</b> - </p> - - <p> - BUC.TS isn't really specific to these laptops, but is a bit inside the a register in the chipset on some Intel systems. - </p> - - <p> - Bucts is needed when flashing in software the X60/X60S/X60T/T60 ROM while Lenovo BIOS is running; - external flashing will be safe regardless. - Each ROM contains identical data inside the two final 64K region in the file*. - This corresponds to the final two 64K regions in the flash chip. Lenovo BIOS will prevent you from writing the - final one, so running "<b>bucts 1</b>" will set the system to boot from the other block instead (which - is writeable along with everything beneath it when using a patched flashrom. see <a href="#build_flashrom">#build_flashrom</a>). - After shutting down and booting up after the first flash of libreboot, - the final 64K block is writeable so you flash the ROM again with an unpatched flashrom and run "<b>bucts 0</b>" to - make the system boot from the normal (highest) block again. - </p> - - <p> - *Libreboot ROM images have identical data in those two 64KiB regions because dd is used to do that, by the build system. - If you're building from upstream (coreboot), you have to do it manually. - </p> - - <p> - BUC.TS is backed up (powered) by the NVRAM battery (or CMOS battery, as some people call it). On thinkpads, - this is typically in a yellow plastic package with the battery inside, connected via power lines to the - mainboard. Removing that battery removes power to BUC.TS, resetting the bit back to 0 (if you previously set - it to 1). - </p> - - <p> - BUC.TS utility is included in libreboot_src.tar.xz and libreboot_util.tar.xz.<br/> - <b>If you downloaded from git, follow <a href="#build_meta">#build_meta</a> before you proceed.</b> - </p> - - <p> - "BUC" means "<b>B</b>ack<b>u</b>p <b>C</b>ontrol" (it's a register) and "TS" means "<b>T</b>op <b>S</b>wap" - (it's a status bit). Hence "bucts" (BUC.TS). TS 1 and TS 0 corresponds to bucts 1 and bucts 0. - </p> - - <p> - If you have the binary release archive, you'll find executables under ./bucts/. Otherwise if you need to build from source, continue reading. - </p> - - <p> - First, <a href="#build_dependencies">install the build dependencies</a>. - </p> - - <p> - To build bucts, do this in the main directory:<br/> - $ <b>./oldbuild module bucts</b> - </p> - - <p> - To statically compile it, do this:<br/> - $ <b>./oldbuild module bucts static</b> - </p> - - <p> - The "builddeps" script in libreboot_src also makes use of builddeps-bucts. - </p> - - <p><a href="#pagetop">Back to top of page.</a></p> - - </div> - - <div class="section"> - - <h1 id="build_flashrom">How to build "flashrom"</h1> - - <p> - Flashrom is the utility for flashing/dumping ROM images. This is what you will use to install libreboot. - </p> - - <p> - Flashrom source code is included in libreboot_src.tar.xz and libreboot_util.tar.xz.<br/> - <b>If you downloaded from git, follow <a href="#build_meta">#build_meta</a> before you proceed.</b> - </p> - - <p> - If you are using the binary release archive, then there are already binaries included - under ./flashrom/. The flashing scripts will try to choose the correct one for you. Otherwise - if you wish to re-build flashrom from source, continue reading. - </p> - - <p> - First, <a href="#build_dependencies">install the build dependencies</a>. - </p> - - <p> - To build it, do the following in the main directory:<br/> - $ <b>./oldbuild module flashrom</b> - </p> - - <p> - To statically compile it, do the following in the main directory:<br/> - $ <b>./oldbuild module flashrom static</b> - </p> - - <p> - After you've done that, under ./flashrom/ you will find the following executables: - </p> - <ul> - <li> - <b>flashrom</b> - <ul> - <li>For flashing while coreboot or libreboot is running.</li> - </ul> - </li> - <li> - <b>flashrom_lenovobios_sst</b> - <ul> - <li>This is patched for flashing while Lenovo BIOS is running on an X60 or T60 with the SST25VF016B (SST) flash chip.</li> - </ul> - </li> - <li> - <b>flashrom_lenovobios_macronix</b> - <ul> - <li>This is patched for flashing while Lenovo BIOS is running on an X60 or T60 with the MX25L1605D (Macronix) flash chip.</li> - </ul> - </li> - </ul> - - <p> - The "builddeps" script in libreboot_src also makes use of builddeps-flashrom. - </p> - - <p><a href="#pagetop">Back to top of page.</a></p> - - </div> - - <div class="section"> - - <h1 id="build">How to build the ROM images</h1> - - <p>You don't need to do much, as there are scripts already written for you that can build everything automatically.</p> - - <p> - You can build libreboot from source on a 32-bit (i686) or 64-bit (x86_64) system. Recommended (if possible): x86_64. - ASUS KFSN4-DRE has 64-bit CPUs. - On a ThinkPad T60, you can replace the CPU (Core 2 Duo T5600, T7200 or T7600. T5600 recommended) for 64-bit support. - On an X60s, you can replace the board with one that has a Core 2 Duo L7400 (you could also use an X60 Tablet board with the same CPU). - On an X60, you can replace the board with one that has a Core 2 Duo T5600 or T7200 (T5600 is recommended). All MacBook2,1 laptops - are 64-bit, as are all ThinkPad X200, X200S, X200 Tablet, R400, T400 and T500 laptops. Warning: MacBook1,1 laptops are all 32-bit only. - </p> - - <p> - First, <a href="#build_dependencies">install the build dependencies</a>. - </p> - <p> - If you downloaded libreboot from git, refer to <a href="#build_meta">#build_meta</a>. - </p> - - <p> - Build all of the components used in libreboot:<br/> - $ <b>./oldbuild module all</b> - </p> - - <p> - You can also build each modules separately, using <i>./oldbuild module modulename</i>. - To see the possible values for <i>modulename</i>, use:<br/> - $ <b>./oldbuild module list</b> - </p> - - <p> - After that, build the ROM images (for all boards):<br/> - $ <b>./oldbuild roms withgrub</b><br/> - Alternatively, you can build for a specific board or set of boards. - For example:<br/> - $ <b>./oldbuild roms withgrub x60</b><br/> - $ <b>./oldbuild roms withgrub x200_8mb</b><br/> - $ <b>./oldbuild roms withgrub x60 x200_8mb</b><br/> - The list of board options can be found by looking at the directory - names in <b>resources/libreboot/config/grub/</b>. - </p> - - <p> - To clean (reverse) everything, do the following:<br/> - $ <b>./oldbuild clean all</b> - </p> - - <p> - The ROM images will be stored under <b>bin/<i>payload</i>/</b>, - where <i>payload</i> could be <i>grub</i>, <i>seabios</i>, or - whatever other payload those images were built for. - </p> - - <div class="subsection"> - - <h2>Preparing release archives (optional)</h2> - - <p> - <b>This is only confirmed to work (tested) in Debian Stretch. Parabola *fails* at this stage - (for now). For all other distros, YMMV. This will also work in Devuan.</b> - </p> - - <p> - This is mainly intended for use with the git repository. - These commands will work in the release archive (_src), unless otherwise noted below. - </p> - - <p> - The archives will appear under <i>release/oldbuildsystem/${version}/</i>; - ${version} will either be set using <i>git describe</i> or, - if a <i>version</i> file already exists (_src release archive), - then it will simply re-use that. - </p> - - <p> - Tag the current commit, and that version will appear in both the ${version} - string on the directory under <i>release/oldbuildsystem/</i>, and in the file names of the - archives. Otherwise, whatever git uses for <i>git describe --tags HEAD</i> - will be used. - </p> - - <p> - Utilities (static executables):<br/> - $ <b>./oldbuild release util</b> - </p> - <p> - Archive containing flashrom and bucts source code:<br/> - $ <b>./oldbuild release tobuild</b> - </p> - <p> - Documentation archive (<b>does not work on _src release archive, only git</b>):<br/> - $ <b>./oldbuild release docs</b> - </p> - <p> - ROM image archives:<br/> - $ <b>./oldbuild release roms</b> - </p> - <p> - Source code archive:<br/> - $ <b>./oldbuild release src</b> - </p> - <p> - SHA512 sums of all other release archives that have been generated:<br/> - $ <b>./oldbuild release sha512sums</b> - </p> - - <p> - If you are building on an i686 host, this will build statically linked 32-bit binaries in - the binary release archive that you created, - for: <b>nvramtool, cbfstool, ich9deblob, cbmem</b>. - </p> - - <p> - If you are building on an x86_64 host, this will build statically linked 32- *and* 64-bit binaries for - <b>cbmem</b>, <b>ich9deblob</b>, <b>cbfstool</b> and <b>nvramtool</b>. - </p> - <p> - <b>To include statically linked i686 and x86_64 binaries for bucts and flashrom, - you will need to build them on a chroot, a virtual system or a real - system where the host uses each given architecture. These packages are difficult - to cross-compile, and the libreboot project is still figuring out how to deal - with them.</b> - </p> - <p> - The same applies if you want to include statically linked flashrom binaries for ARM. - </p> - - <p> - armv7l binaries (tested on a BeagleBone Black) are also included in libreboot_util, for: - </p> - <ul> - <li>cbfstool</li> - <li>ich9gen</li> - <li>ich9deblob</li> - <li>flashrom</li> - </ul> - - <p> - If you are building binaries on a live system or chroot (for flashrom/bucts), you can use the following to statically link them:<br/> - $ <b>./oldbuild module flashrom static</b><br/> - $ <b>./oldbuild module bucts static</b> - </p> - - <p> - The same conditions as above apply for ARM (except, building bucts on ARM is pointless, and for flashrom - you only need the normal executable since the lenovobios_sst and _macronix executables are meant - to run on an X60/T60 while lenovo bios is present, working around the security restrictions). - </p> - - <p> - The command that you used for generating the release archives will also run the following command:<br/> - $ <b>./oldbuild release tobuild</b><br/> - The archive <b>tobuild.tar.xz</b> will have been created under <b>release/oldbuildsystem/</b>, containing bucts, flashrom and all other required - resources for building them. - </p> - - <p> - You'll find that the files libreboot_util.tar.xz and libreboot_src.tar.xz have been created, under <b>release/oldbuildsystem/</b>. - </p> - - <p> - The ROM images will be stored in separate archives for each system, under <b>release/oldbuildsystem/rom/</b>. - </p> - - </div> - - <p><a href="#pagetop">Back to top of page</a></p> - - </div> - - <div class="section"> - - <p> - Copyright © 2014, 2015, 2016 Leah Rowe <info@minifree.org><br/> - Permission is granted to copy, distribute and/or modify this document - under the terms of the Creative Commons Attribution-ShareAlike 4.0 International license - or any later version published by Creative Commons; - - A copy of the license can be found at <a href="../cc-by-sa-4.0.txt">../cc-by-sa-4.0.txt</a> - </p> - - <p> - Updated versions of the license (when available) can be found at - <a href="https://creativecommons.org/licenses/by-sa/4.0/legalcode">https://creativecommons.org/licenses/by-sa/4.0/legalcode</a> - </p> - - <p> - UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE - EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS - AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF - ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, - IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, - WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, - ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT - KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT - ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. - </p> - <p> - TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE - TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, - NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, - INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, - COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR - USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN - ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR - DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR - IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. - </p> - <p> - The disclaimer of warranties and limitation of liability provided - above shall be interpreted in a manner that, to the extent - possible, most closely approximates an absolute disclaimer and - waiver of all liability. - </p> - - </div> - -</body> -</html> |