coreboot-kgpe-d16/payloads/libpayload
Stefan Reinauer 5d866213f4 libpayload: Have make install save .xcompile file
Useful information, record it in the destination directory,
together with .config.

Change-Id: Icf3282f61f502b37f9f06d7d5a0a630f49c96ed2
Signed-off-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Reviewed-on: http://review.coreboot.org/10864
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2015-07-09 08:47:41 +02:00
..
arch cbfs: define libpayload_init_default_cbfs_media weakly 2015-07-06 09:42:12 +02:00
bin libpayload: arch/mips: Add basic MIPS architecture support 2015-03-21 11:07:50 +01:00
configs libpayload: update defconfigs 2015-07-08 10:25:11 +02:00
crypto libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
curses libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
drivers libpayload: usb: dwc2: support interrupt transfer 2015-07-06 09:40:02 +02:00
gdb Remove address from GPLv2 headers 2015-05-21 20:50:25 +02:00
include libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
libc libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
libcbfs libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
liblz4 libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
liblzma lzma: Return correct amount of decompressed bytes 2015-07-06 09:40:37 +02:00
libpci Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
sample Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
tests Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
Doxyfile Run doxygen -u on doxygen configuration files 2010-06-28 10:40:38 +00:00
Kconfig libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSE_GPL libpayload: Introduce new Kconfig to explicitly allow GPL code 2015-01-09 07:06:27 +01:00
Makefile libpayload: Use top level xcompile 2015-07-09 08:47:16 +02:00
Makefile.inc libpayload: Have make install save .xcompile file 2015-07-09 08:47:41 +02:00
README Remove empty lines at end of file 2015-06-08 00:55:07 +02:00

README

-------------------------------------------------------------------------------
libpayload README
-------------------------------------------------------------------------------

libpayload is a minimal library to support standalone payloads
that can be booted with firmware like coreboot. It handles the setup
code, and provides common C library symbols such as malloc() and printf().

Note: This is _not_ a standard library for use with an operating system,
rather it's only useful for coreboot payload development!
See http://coreboot.org for details on coreboot.


Installation
------------

 $ git clone http://review.coreboot.org/p/coreboot.git

 $ cd coreboot/payloads/libpayload

 $ make menuconfig

 $ make

 $ sudo make install (optional, will install into /opt per default)

As libpayload is for 32bit x86 systems only, you might have to install the
32bit libgcc version, otherwise your payloads will fail to compile.
On Debian systems you'd do 'apt-get install gcc-multilib' for example.


Usage
-----

Here's an example of a very simple payload (hello.c) and how to build it:

 #include <libpayload.h>

 int main(void)
 {
     printf("Hello, world!\n");
     return 0;
 }

Building the payload using the 'lpgcc' compiler wrapper:

 $ lpgcc -o hello.elf hello.c

Please see the sample/ directory for details.


Website and Mailing List
------------------------

The main website is http://www.coreboot.org/Libpayload.

For additional information, patches, and discussions, please join the
coreboot mailing list at http://coreboot.org/Mailinglist, where most
libpayload developers are subscribed.


Copyright and License
---------------------

See LICENSES.