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

BUG=none
BRANCH=none
TEST=none

Change-Id: I9aeccd7b0dcf3ea7b8801c76251b7409a79b99d4
Signed-off-by: Patrick Georgi <pgeorgi@google.com>
Original-Commit-Id: e81ce0483d
Original-Change-Id: I2ec18ca55e0ea672343a951ab81a24a5630f45fd
Original-Signed-off-by: Martin Roth <martinroth@google.com>
Original-Reviewed-on: https://review.coreboot.org/20028
Original-Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Original-Reviewed-by: Philippe Mathieu-Daud <philippe.mathieu.daude@gmail.com>
Original-Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
Reviewed-on: https://chromium-review.googlesource.com/528258
Commit-Ready: Patrick Georgi <pgeorgi@chromium.org>
Tested-by: Patrick Georgi <pgeorgi@chromium.org>
Reviewed-by: Patrick Georgi <pgeorgi@chromium.org>
2017-06-12 08:47:50 -07:00
..
arch UPSTREAM: payloads: change coreboot to lowercase 2017-06-12 08:47:50 -07:00
bin libpayload: Move base address, stack and heap size to Kconfig 2016-03-15 20:53:38 +01:00
configs UPSTREAM: libpayload: Add gru config 2017-04-10 14:28:35 -07:00
crypto libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
curses UPSTREAM: libpayload/.../PDCurses: Improve compatibility with ncurses 2016-12-16 04:50:58 -08:00
drivers UPSTREAM: detachables: Add invert parameter 2017-05-26 09:47:45 -07:00
gdb UPSTREAM: libpayload/gdb: fix unused variable warning 2017-05-02 20:24:02 -07:00
include UPSTREAM: detachables: Add invert parameter 2017-05-26 09:47:45 -07:00
libc UPSTREAM: payloads: change coreboot to lowercase 2017-06-12 08:47:50 -07:00
libcbfs UPSTREAM: libpayload: cbfs: Fix minor memory leak in some edge cases 2016-08-15 07:36:11 -07:00
liblz4 cbfs: Add LZ4 in-place decompression support for pre-RAM stages 2016-02-22 21:38:37 +01:00
liblzma UPSTREAM: libpayload: lzma: Allocate scratchpad on the heap 2016-08-13 20:28:18 -07: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 UPSTREAM: libpayload: split "Drivers" config section in Kconfig 2016-08-10 00:27:33 -07:00
LICENSE_GPL libpayload: Introduce new Kconfig to explicitly allow GPL code 2015-01-09 07:06:27 +01:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
Makefile UPSTREAM: libpayload: fix build 2017-01-26 18:43:51 -08:00
Makefile.inc libpayload: update junit.xml target, clean up output 2016-03-25 18:18:27 +01:00
README UPSTREAM: Use www.coreboot.org over coreboot.org 2017-06-12 08:47:49 -07:00

-------------------------------------------------------------------------------
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.