Difference between revisions of "Buildrom"

From coreboot
Jump to: navigation, search
m (Prerequisites)
m
Line 246: Line 246:
  
 
In the buildrom-devel directory, type:
 
In the buildrom-devel directory, type:
  $ make menuconfig
+
 
 +
  $ make menuconfig
  
 
You can now navigate the configuration system (this is the same configuration engine that the Linux kernel uses, so it should be familiar to some readers).
 
You can now navigate the configuration system (this is the same configuration engine that the Linux kernel uses, so it should be familiar to some readers).
Line 252: Line 253:
 
== Building the ROM ==
 
== Building the ROM ==
  
Make sure you have access to the internet (to download new packages), and type the following to create your ROM:
+
Make sure you have access to the Internet (to download new packages), and type the following to create your ROM:
 +
 
 
  $ make
 
  $ make
  
Buildrom will download and build all the components of the ROM selected in the configuration stage.  if the build is successful, then the final ROM will be located in ''buildrom-devel/deploy''. If it is not successful, then you will see an error message.  You can see the build output for each package in by reading build.log in the work/<package>logs/ directory (i.e work/filo/logs/build.log).  
+
Buildrom will download and build all the components of the ROM selected in the configuration stage.  If the build is successful, then the final ROM will be located in the '''deploy''' subdirectory. If it is not successful, then you will see an error message.  You can see the build output for each package by reading '''build.log''' in the '''work/<package>/logs''' directory (e.g. '''work/filo/logs/build.log''').  
 
   
 
   
 
== Developing within Buildrom ==
 
== Developing within Buildrom ==
  
This section is for the developers who wish to change and rebuild the code. BuildROM builds the code for coreboot and the payloads in the work/ directory. Here is a typical view of the buildROM work/ directory:
+
This section is for the developers who wish to change and rebuild the code.
 +
Buildrom builds the code for coreboot and the payloads in the '''work/''' directory.
 +
 
 +
Here is a typical view of the buildrom '''work/''' directory:
 +
 
 
  $ ls work/
 
  $ ls work/
   linuxbios filo
+
   coreboot filo nrvb2
 +
 
 +
In each directory, you will find three directories.  Logs from the build will be found in '''logs/''' and timestamps that the build system uses are in '''stamps/'''.  You normally won't have to touch these directories.  The source code is located in the third directory, '''svn/'''.
 +
 
 +
Buildrom provides several commands to make it easy to rebuild individual packages and ROMs.
 +
* To clean a directory (but not remove the source code) use '''make <package>-clean'''.
 +
* You can build individual packages with '''make <package>'''.
 +
* If you wish to completely erase the source code and start again with a pristine version, use '''make <package>-distclean'''.
 +
* Typing '''make''' at any time will rebuild the ROM using the most current versions of the individual packages.
  
In each directory, you will find three directories.  Logs from the build will be found in logs/ and timestamps that the build system uses are in stamps/.  You normally won't have to touch these directories.  The source code is located in the third directory.    BuildROM provides several commands to make it easy to rebuild individual packages and ROMs.    To clean a directory (but not remove the source code) use 'make <package>-clean'.  You can build an individual packages with 'make <package>'.  f you wish to completely erase the source code and start again with a pristine version, use 'make <package>-distclean'. Typing 'make' at any time will rebuild the ROM using the most current versions of the individual packages.
 
 
Here is a typical work flow for modifying coreboot code:
 
Here is a typical work flow for modifying coreboot code:
  
#Build the initial ROM from scratch with 'make'
+
# Build the initial ROM from scratch with 'make'
#Edit the coreboot source code in work/linuxbios/svn/
+
# Edit the coreboot source code in work/coreboot/svn/
#Clean the coreboot package with 'make linuxbios-clean'
+
# Clean the coreboot package with '''make coreboot-clean'''
#Rebuild the ROM with 'make'
+
# Rebuild the ROM with '''make''''

Revision as of 00:40, 22 April 2008

Buildrom is a tool that can construct a coreboot image (comprising the coreboot loader and payload) from scratch.

Starting from a configuration file, it will download and build all the code necessary to construct the final binary.

A tool with similar functionality is Etherboot's ROM-o-matic which builds etherboot as a coreboot ELF payload.

Supported Platforms/Boards

Buildrom currently supports the following platforms / mainboards:

Vendor Mainboard Northbridge Southbridge Super I/O CPU Socket v2 v3 Tutorial
AMD DB800 (Salsa) AMD LX AMD CS5536 Winbond™ W83627HF AMD Geode™ LX  ?  ?
AMD Norwich AMD LX AMD CS5536 AMD Geode™ LX  ?  ?
AMD Serengeti Cheetah AMD K8 AMD-8111™, 8151™, 8132™ Winbond™ W83627HF AMD Opteron™ Socket F  ?  ?
Artec Group DBE61 AMD LX AMD CS5536 AMD Geode™ LX  ?  ?
ASUS A8V-E SE AMD K8 VIA K8T890 / VT8237R Winbond™ W83627EHG AMD Athlon™ 64 / FX / X2 Socket 939  ?  ? Tutorial
ASUS A8V-E Deluxe AMD K8 VIA K8T890 / VT8237R Winbond™ W83627EHG AMD Athlon™ 64 / FX / X2 Socket 939  ?  ? Tutorial
DIGITAL-LOGIC MSM800SEV AMD Geode™ LX AMD Geode™ CS5536 AMD Geode™ LX  ?  ?
Emulation QEMU x86 Intel® 440BX Intel® 82371EB (PIIX4E) Intel® Pentium® II/III (?)  ?  ? Tutorial
GIGABYTE GA-M57SLI-S4 AMD K8 NVIDIA MCP55 ITE IT8716F AMD Sempron™ / Athlon™ 64 / FX / X2 Socket AM2  ?  ? Tutorial
GIGABYTE GA-2761GXDK (Churchill) AMD K8 SiS761GX/SiS966 ITE IT8716F AMD Sempron™ / Athlon™ 64 / FX / X2 (?) Socket AM2  ?  ? Tutorial
PC Engines ALIX1.C AMD Geode™ LX AMD Geode™ CS5536 Winbond® W83627HF AMD Geode™ LX  ?  ? Tutorial
Supermicro H8DMR-i2 AMD K8 NVIDIA MCP55 Winbond™ W83627EHG AMD Opteron™ Socket F  ?  ?
Tyan Thunder K8SR (S2881) AMD K8 AMD-8111™, 8131™ Winbond™ W83627HF AMD Opteron™ Socket 940  ?  ? Tutorial
Tyan Thunder K8S Pro (S2882) AMD K8 AMD-8111™, 8131™ Winbond™ W83627HF AMD Opteron™ Socket 940  ?  ? Tutorial
Tyan Thunder K8SRE (S2891) AMD K8 AMD-8131™, NVIDIA CK8041 Winbond™ W83627HF AMD Opteron™ Socket 940  ?  ? Tutorial

Supported Payloads

Buildrom currently supports the following payloads:

Experimental or untested payloads:

Planned payloads:

Download

$ svn co svn://coreboot.org/buildrom

You can also visit the web-based trac instance to browse the code and outstanding issues.

Prerequisites

You will need the following packages on your system to use buildrom. Please consult your distribution documentation on how to install new packages:

  • wget
  • subversion
  • git
  • make
  • quilt
  • GNU compiler tools (gcc, as, ld)
  • Standard utilities (rm, cp, gzip, bzip2, tar, dd, md5sum, awk, etc.)
  • iasl (for AMD K8 platforms)
  • python
  • ruby (for the GRUB2 payload)

Configuration

In the buildrom-devel directory, type:

$ make menuconfig

You can now navigate the configuration system (this is the same configuration engine that the Linux kernel uses, so it should be familiar to some readers).

Building the ROM

Make sure you have access to the Internet (to download new packages), and type the following to create your ROM:

$ make

Buildrom will download and build all the components of the ROM selected in the configuration stage. If the build is successful, then the final ROM will be located in the deploy subdirectory. If it is not successful, then you will see an error message. You can see the build output for each package by reading build.log in the work/<package>/logs directory (e.g. work/filo/logs/build.log).

Developing within Buildrom

This section is for the developers who wish to change and rebuild the code. Buildrom builds the code for coreboot and the payloads in the work/ directory.

Here is a typical view of the buildrom work/ directory:

$ ls work/
  coreboot  filo  nrvb2

In each directory, you will find three directories. Logs from the build will be found in logs/ and timestamps that the build system uses are in stamps/. You normally won't have to touch these directories. The source code is located in the third directory, svn/.

Buildrom provides several commands to make it easy to rebuild individual packages and ROMs.

  • To clean a directory (but not remove the source code) use make <package>-clean.
  • You can build individual packages with make <package>.
  • If you wish to completely erase the source code and start again with a pristine version, use make <package>-distclean.
  • Typing make at any time will rebuild the ROM using the most current versions of the individual packages.

Here is a typical work flow for modifying coreboot code:

  1. Build the initial ROM from scratch with 'make'
  2. Edit the coreboot source code in work/coreboot/svn/
  3. Clean the coreboot package with make coreboot-clean
  4. Rebuild the ROM with make'