coreboot-kgpe-d16/payloads/libpayload
Martin Roth e81ce0483d payloads: change coreboot to lowercase
The word 'coreboot' should always be written in lowercase, even at the
start of a sentence.

Change-Id: I2ec18ca55e0ea672343a951ab81a24a5630f45fd
Signed-off-by: Martin Roth <martinroth@google.com>
Reviewed-on: https://review.coreboot.org/20028
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Philippe Mathieu-Daudé <philippe.mathieu.daude@gmail.com>
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
2017-06-07 12:08:55 +02:00
..
arch payloads: change coreboot to lowercase 2017-06-07 12:08:55 +02:00
bin libpayload: Move base address, stack and heap size to Kconfig 2016-03-15 20:53:38 +01:00
configs libpayload: Add gru config 2017-04-07 21:33:19 +02:00
crypto libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
curses libpayload/.../PDCurses: Improve compatibility with ncurses 2016-12-14 18:02:51 +01:00
drivers detachables: Add invert parameter 2017-05-25 18:23:56 +02:00
gdb libpayload/gdb: fix unused variable warning 2017-04-29 07:34:08 +02:00
include detachables: Add invert parameter 2017-05-25 18:23:56 +02:00
libc payloads: change coreboot to lowercase 2017-06-07 12:08:55 +02:00
libcbfs libpayload: cbfs: Fix minor memory leak in some edge cases 2016-08-12 22:52:22 +02:00
liblz4 cbfs: Add LZ4 in-place decompression support for pre-RAM stages 2016-02-22 21:38:37 +01:00
liblzma libpayload: lzma: Allocate scratchpad on the heap 2016-08-08 19:02:07 +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: Reintroduce CONFIG_LP_CHROMEOS to set suitable defaults 2016-10-17 22:46:11 +02:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSE_GPL
Makefile libpayload: fix build 2017-01-25 17:58:48 +01:00
Makefile.inc libpayload: update junit.xml target, clean up output 2016-03-25 18:18:27 +01:00
README Use www.coreboot.org over coreboot.org 2017-06-07 12:05:44 +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 https://www.coreboot.org for details on coreboot.


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

 $ git clone https://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 https://www.coreboot.org/Libpayload.

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


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

See LICENSES.