coreboot/payloads/libpayload
Maximilian Brune a99b580c75 treewide: Move list.h to commonlib
It is needed in order to move device_tree.c into commonlib in a
subsequent commit.

Signed-off-by: Maximilian Brune <maximilian.brune@9elements.com>
Change-Id: I16eb7b743fb1d36301f0eda563a62364e7a9cfec
Reviewed-on: https://review.coreboot.org/c/coreboot/+/77968
Reviewed-by: Julius Werner <jwerner@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2024-02-24 11:49:46 +00:00
..
arch libpayload: Remove legacy CBFS API 2024-02-22 21:18:39 +00:00
bin libpayload: bin/lpgcc allow to call without files 2023-03-07 17:10:36 +00:00
configs libpayload/unit-tests: Rename ARCH_BIG_ENDIAN to ARCH_MOCK_BIG_ENDIAN 2023-11-25 16:00:19 +00:00
crypto payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
curses payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
drivers libpayload: timer: Revert timer_hz() return type to 64-bits 2024-02-08 21:07:13 +00:00
gdb payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
include libpayload: Remove legacy CBFS API 2024-02-22 21:18:39 +00:00
libc treewide: Move list.h to commonlib 2024-02-24 11:49:46 +00:00
libcbfs libpayload: Remove legacy CBFS API 2024-02-22 21:18:39 +00:00
liblz4 payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
liblzma payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
libpci payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
sample libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
tests Treewide: Fix incorrect SPDX license strings 2024-02-18 01:55:57 +00:00
vboot vboot: Enable new arm64 SIMD crypto acceleration 2024-02-24 02:02:34 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
Doxyfile payloads: Remove/fix trailing whitespace 2018-09-04 12:38:40 +00:00
Kconfig payloads: Add SPDX headers to Kconfig 2024-02-18 01:57:39 +00: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 payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
Makefile.mk treewide: Move list.h to commonlib 2024-02-24 11:49:46 +00:00
Makefile.payload libpayload/Makefile.payload: Fix CFLAGS 2022-06-15 18:06:39 +00:00
README payloads/libpayload: Update a Makefile for sample libpayload 2019-06-21 09:16:36 +00: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/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.