aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJeremy Kerr <jk@ozlabs.org>2015-02-06 17:53:09 +0800
committerStewart Smith <stewart@linux.vnet.ibm.com>2015-02-09 11:46:27 +1100
commit4e60baa269007715c1ff81acf0fc1a94ee19a3f1 (patch)
tree88fd083745bbc52b29371842b59287557afd561d /README
parent5c70f1c764abeec7c29171285ec90af3318b113d (diff)
downloadskiboot-4e60baa269007715c1ff81acf0fc1a94ee19a3f1.zip
skiboot-4e60baa269007715c1ff81acf0fc1a94ee19a3f1.tar.gz
skiboot-4e60baa269007715c1ff81acf0fc1a94ee19a3f1.tar.bz2
Fix commit 16c80346
Commit 16c80346 change included some reverts of previous commits, which we need. This change reverts those reverts, leaving the original intent of that change. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'README')
-rw-r--r--README46
1 files changed, 38 insertions, 8 deletions
diff --git a/README b/README
index 5e479c7..5ba0e23 100644
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
skiboot
-------
-Firmware for OpenPower systems
+Firmware for OpenPower systems.
Source:
https://github.com/open-power/skiboot
@@ -43,22 +43,52 @@ make OPAL calls. A TODO item is to extensively document this API.
See doc/overview.txt for a more in depth overview of skiboot.
+Building
+--------
+You can build on a linux host. Modern Debian and Ubuntu are well known
+to be suitable. Build and testing on x86 is fine. You do not need a POWER
+host to build and test skiboot.
-Hacking
--------
-You will need a C compiler (gcc 4.8) for ppc64 (big endian).
-You will need a POWER8 system that you can deploy new firmware to.
+You will need a C compiler for big endian ppc64. If your distro does
+not provide one, crosstool built compilers work well:
+https://www.kernel.org/pub/tools/crosstool/
+
+You should then be able to just (where 4=nr cpu cores of your machine)
+$ make -j4
+$ make -j4 check
+
+If using crosstool compilers, add /opt/cross/gcc-4.8.0-nolibc/powerpc64-linux/bin/
+to your PATH.
+
+If using packaged cross compilers on Ubuntu, you may need to set the
+following environment variable:
+CROSS=powerpc-linux-gnu-
-You may also use the IBM POWER8 Functional Simulator to test on.
+Testing
+-------
+To test in a simulator, install the IBM POWER8 Functional Simulator from:
http://www-304.ibm.com/support/customercare/sas/f/pwrfs/home.html
Qemu (as of 2.2.0) is not suitable as it does not (yet) implement
the HyperVisor mode of the POWER8 processor.
+To run a boot-to-bootloader test, you'll need a zImage.papr built using
+the mambo_defconfig config for op-build. See
+https://github.com/open-power/op-build/ on howto build. Drop zImage.epapr
+in the skiboot directory and the skiboot test suite will automatically pick
+it up.
+
+To test on real hardware, you will need to understand how to flash new
+skiboot onto your system. This will vary from platform to platform.
+
+Hacking
+-------
All patches should be sent to the mailing list with linux-kernel style
-'Signed-Off-By'.
+'Signed-Off-By'. The following git commands are your friends:
+- git commit -s
+- git format-patch
-You probably want to read the linux documentation/SubmittingPatches as
+You probably want to read the linux Documentation/SubmittingPatches as
much of it applies to skiboot.
License