coreboot-kgpe-d16/payloads/libpayload
Stefan Reinauer 347a7529aa libpayload: Make comment into help text
Change-Id: I8c8669e73e335e12cb3785cf84b878c305dd5929
Signed-off-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Reviewed-on: https://review.coreboot.org/14068
Tested-by: build bot (Jenkins)
Reviewed-by: Martin Roth <martinroth@google.com>
2016-03-15 20:53:27 +01:00
..
arch libpayload: Add comment about ARM64 exception stack 2016-03-15 18:24:30 +01:00
bin libpayload: Fix ARM workaround code 2016-03-15 18:24:41 +01:00
configs libpayload: Drop CONFIG_LP_CHROMEOS 2016-03-15 18:22:58 +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: use 32bit access when accessing 4byte wide uart registers 2016-02-09 21:53:42 +01:00
gdb tree: drop last paragraph of GPL copyright header 2015-10-31 21:37:39 +01:00
include libpayload: Drop CONFIG_LP_CHROMEOS 2016-03-15 18:22:58 +01:00
libc libpayload: Drop CONFIG_LP_CHROMEOS 2016-03-15 18:22:58 +01:00
libcbfs cbfs: Add LZ4 in-place decompression support for pre-RAM stages 2016-02-22 21:38:37 +01:00
liblz4 cbfs: Add LZ4 in-place decompression support for pre-RAM stages 2016-02-22 21:38:37 +01: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
Kconfig libpayload: Make comment into help text 2016-03-15 20:53:27 +01:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSE_GPL
Makefile libpayload: Add missing autoconf dependency 2015-09-10 09:18:12 +00:00
Makefile.inc codebase: Change makefile $(shell pwd) commands to $(CURDIR) 2016-03-11 18:48:06 +01: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.