coreboot-kgpe-d16/payloads/libpayload
Thomas Heijligen 303a895d77 libpayload: Outsource delay function into own header
For libflashrom we need the delay functions but when including the whole
libpayload.h it has conflicting symbols.

Change-Id: I6e4a669b8ba25836fb870d74c200985c1bfdb387
Signed-off-by: Thomas Heijligen <src@posteo.de>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/70139
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Nico Huber <nico.h@gmx.de>
Reviewed-by: Julius Werner <jwerner@chromium.org>
2023-08-24 13:35:02 +00:00
..
arch payloads/libpayload: Remove ARCH_SPECIFIC_OPTIONS 2023-08-20 18:41:23 +00:00
bin libpayload: bin/lpgcc allow to call without files 2023-03-07 17:10:36 +00:00
configs payloads/libpayload/configs: drop config.galileo 2023-05-27 00:26:59 +00:00
crypto
curses tree: Replace `egrep` with `grep -E` 2023-04-06 19:54:44 +00:00
drivers libpayload/drivers/cbmem_console: Use C99 flexible arrays 2023-08-01 12:40:07 +00:00
gdb
include libpayload: Outsource delay function into own header 2023-08-24 13:35:02 +00:00
libc libpayload: Add parsing of SMBIOS address 2023-08-17 15:48:56 +00:00
libcbfs libpayload/cbfs: Fill size_out even if cbfs_map() fails 2023-08-18 14:15:19 +00:00
liblz4
liblzma
libpci
sample libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
tests tests: Add support for tests build failures detection 2022-09-21 14:06:42 +00:00
vboot libpayload: Add VBOOT_SHA_ARMV8_CE config 2023-02-16 15:04:24 +00:00
.gitignore
Doxyfile
Kconfig libpayload;arch,cpu/x86: drop USE_MARCH_586 Kconfig option 2023-05-27 00:29:02 +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/Makefile.inc: Initialize vboot submodule 2022-06-20 13:54:31 +00:00
Makefile.payload libpayload/Makefile.payload: Fix CFLAGS 2022-06-15 18:06:39 +00:00
README

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.