coreboot-kgpe-d16/payloads/libpayload
Daisuke Nojiri 6d2c7226cb libpayload: add archive.h
archive.h is a header file for the programs which need to parse an archive
created by 'archive' tool. See archive.h for the format description.

BUG=chromium:502066
BRANCH=tot
TEST=Tested on Glados

Change-Id: I2bee9d7c12b0e1bce1529dfef360c5fa4ce0872d
Signed-off-by: Daisuke Nojiri <dnojiri@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/311201
Reviewed-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://review.coreboot.org/12734
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
2015-12-16 19:00:53 +01:00
..
arch tree: drop last paragraph of GPL copyright header 2015-10-31 21:37:39 +01:00
bin libpayload: Rename PDCurses-3.4 to PDCurses 2015-11-11 21:38:48 +01:00
configs libpayload/configs/config.veyron: Use CONFIG_LP_8250_SERIAL_CONSOLE 2015-12-06 22:24:30 +01:00
crypto libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
curses libpayload: PDCurses: Remove trailing whitespace 2015-11-20 16:27:36 +01:00
drivers libpayload: Remove redundant 8250 MMIO32 UART driver 2015-11-28 19:19:31 +01:00
gdb tree: drop last paragraph of GPL copyright header 2015-10-31 21:37:39 +01:00
include libpayload: add archive.h 2015-12-16 19:00:53 +01:00
libc libpayload: Fix default_memmove() implementation 2015-08-19 16:35:08 +00:00
libcbfs libpayload: get cbfs offset & size for default media from lib_sysinfo 2015-12-03 14:16:34 +01:00
liblz4 libpayload: lz4: Add output overrun check to incompressible case 2015-07-21 21:27:42 +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: Remove redundant 8250 MMIO32 UART driver 2015-11-28 19:19:31 +01: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: Add missing autoconf dependency 2015-09-10 09:18:12 +00:00
Makefile.inc libpayload: Use CONFIG_LP_CCACHE instead of CONFIG_CCACHE 2015-08-09 21:02:37 +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.