coreboot-kgpe-d16/payloads/libpayload
Patrick Rudolph 4f5bed5210 cbfs: Rename CBFS_TYPE_PAYLOAD to CBFS_TYPE_SELF
In preparation of having FIT payloads, which aren't converted to simple ELF,
rename the CBFS type payload to actually show the format the payload is
encoded in.

Another type CBFS_TYPE_FIT will be added to have two different payload
formats. For now this is only a cosmetic change.

Change-Id: I39ee590d063b3e90f6153fe655aa50e58d45e8b0
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com>
Reviewed-on: https://review.coreboot.org/25986
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-by: Julius Werner <jwerner@chromium.org>
2018-05-04 10:30:24 +00:00
..
arch libpayload: Add raw_read_ functions 2018-05-01 23:34:03 +00:00
bin libpayload: Move base address, stack and heap size to Kconfig 2016-03-15 20:53:38 +01:00
configs libpayload: Add Timer for sdm845 2018-05-01 23:35:25 +00:00
crypto libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
curses payloads/libpayload: Add spaces around '==' 2018-05-02 07:59:14 +00:00
drivers payloads/libpayload: Add spaces around '==' 2018-05-02 07:59:14 +00:00
gdb libpayload/gdb: fix unused variable warning 2017-04-29 07:34:08 +02:00
include cbfs: Rename CBFS_TYPE_PAYLOAD to CBFS_TYPE_SELF 2018-05-04 10:30:24 +00:00
libc libpayload: Add SKU ID coreboot table support 2017-12-07 01:19:38 +00:00
libcbfs cbfs: Rename CBFS_TYPE_PAYLOAD to CBFS_TYPE_SELF 2018-05-04 10:30:24 +00:00
liblz4 Rename __attribute__((packed)) --> __packed 2017-07-13 19:45:59 +00:00
liblzma libpayload: lzma: Allocate scratchpad on the heap 2016-08-08 19:02:07 +02:00
libpci libpayload: Add pci_free_dev() and some boilerplate 2017-12-07 21:51:24 +00: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: video: Add support for font scaling with a factor 2017-08-03 20:37:07 +00: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: fix build 2017-01-25 17:58:48 +01:00
Makefile.inc copy & update test routines from what-jenkins-does 2017-08-11 15:24:56 +00:00
README Use git HTTP URLs without `/p` in it 2018-04-17 10:38:06 +00: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/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.