coreboot-kgpe-d16/payloads/libpayload
Julius Werner 69cc557cfb commonlib/bsd: Remove cb_err_t
cb_err_t was meant to be used in place of `enum cb_err` in all
situations, but the choice to use a typedef here seems to be
controversial. We should not be arbitrarily using two different
identifiers for the same thing across the codebase, so since there are
no use cases for serializing enum cb_err at the moment (which would be
the primary reason to typedef a fixed-width integer instead), remove
cb_err_t again for now.

Signed-off-by: Julius Werner <jwerner@chromium.org>
Change-Id: Iaec36210d129db26d51f0a105d3de070c03b686b
Reviewed-on: https://review.coreboot.org/c/coreboot/+/62600
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Yu-Ping Wu <yupingso@google.com>
Reviewed-by: Tim Wawrzynczak <twawrzynczak@chromium.org>
2022-03-09 02:18:21 +00:00
..
arch libpayload/x86: Fix boot_device_read() and hook it up 2022-02-23 22:47:09 +00:00
bin libpayload/bin/lpgcc: Make lpgcc provide TPM configuration for vboot 2022-03-03 22:38:59 +00:00
configs libpayload: Add unit-tests framework and first test case 2021-10-18 12:33:49 +00:00
crypto
curses libpayload: curses: Only call `serial_set_color()` with initialized values 2021-07-14 08:22:05 +00:00
drivers libpayload: cbmem_console: Drop loglevel markers from snapshot 2022-03-04 16:04:10 +00:00
gdb
include commonlib/bsd: Remove cb_err_t 2022-03-09 02:18:21 +00:00
libc commonlib/bsd: Remove cb_err_t 2022-03-09 02:18:21 +00:00
libcbfs commonlib/bsd: Remove cb_err_t 2022-03-09 02:18:21 +00:00
liblz4
liblzma
libpci
sample libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
tests commonlib/bsd: Remove cb_err_t 2022-03-09 02:18:21 +00:00
vboot libpayload/vboot: Enable vboot and x86 SHA extension for ChromeOS 2022-02-21 15:18:55 +00:00
.gitignore
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

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.