coreboot-kgpe-d16/payloads/libpayload
Patrick Georgi 49f0f9a422 libpayload: Refer to vboot source consistently
Don't assume that libpayload is built from a fully checked
out coreboot tree.
There's already an override when building vboot, so reuse
that override when referring to its header files.

Signed-off-by: Patrick Georgi <pgeorgi@google.com>
Change-Id: I503c69a593dd68b3a974fbdbb64d7bb25d6c7f63
Reviewed-on: https://review.coreboot.org/c/coreboot/+/61427
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: HAOUAS Elyes <ehaouas@noos.fr>
Reviewed-by: Rob Barnes <robbarnes@google.com>
2022-01-28 14:47:38 +00:00
..
arch libpayload: Add -Wno-address-of-packed-member for ARCH_MOCK 2021-12-20 17:47:50 +00:00
bin libpayload: Install vboot headers and add include paths to lpgcc 2022-01-15 00:22:41 +00:00
configs libpayload: Add unit-tests framework and first test case 2021-10-18 12:33:49 +00:00
crypto payloads: Drop unneeded empty lines 2020-09-21 16:20:57 +00:00
curses libpayload: curses: Only call `serial_set_color()` with initialized values 2021-07-14 08:22:05 +00:00
drivers libpayload: cbgfx: Clear screen by memcpy 2021-10-07 14:11:56 +00:00
gdb libpayload: gdb: Condition video console init on LP_VIDEO_CONSOLE 2020-06-22 12:24:42 +00:00
include libpayload: Fix legacy CBFS code after recent refactoring 2022-01-14 00:41:13 +00:00
libc libpayload/libc/fmap: Implement new FlashMap API 2021-12-23 14:37:42 +00:00
libcbfs libpayload: Fix legacy CBFS code after recent refactoring 2022-01-14 00:41:13 +00:00
liblz4 lz4: Fix out-of-bounds reads 2020-03-02 15:03:03 +00:00
liblzma payloads: Drop unneeded empty lines 2020-09-21 16:20:57 +00:00
libpci libpayload/libpci: Introduce device class attribute in pci_dev 2020-10-17 16:33:55 +00:00
sample libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
tests libpayload: Refer to vboot source consistently 2022-01-28 14:47:38 +00:00
vboot libpayload: Install vboot headers and add include paths to lpgcc 2022-01-15 00:22:41 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
Doxyfile
Kconfig libpayload: Implement new CBFS access API 2022-01-10 14:30:04 +00:00
LICENSES
LICENSE_GPL
Makefile libpayload: Install vboot headers and add include paths to lpgcc 2022-01-15 00:22:41 +00:00
Makefile.inc libpayload: Refer to vboot source consistently 2022-01-28 14:47:38 +00:00
Makefile.payload util/kconfig: Uprev to Linux 5.13's kconfig 2021-07-13 20:28:14 +00:00
README payloads/libpayload: Update a Makefile for sample libpayload 2019-06-21 09:16:36 +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

 $ make install (optional, will install into ./install per default)

On x86 systems, libpayload will always be 32-bit even if your host OS runs
in 64-bit, so you might have to install the 32-bit libgcc version.
On Debian systems you'd do 'apt-get install gcc-multilib' for example.

Run 'make distclean' before switching boards. This command will remove
your current .config file, so you need 'make menuconfig' again or
'make defconfig' in order to set up configuration. Default configuration
is based on 'configs/defconfig'. See the configs/ directory for examples
of configuration.


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.