coreboot-kgpe-d16/payloads/libpayload
Nicholas Chin cc8be37a59 libpayload/Makefile.inc: Initialize vboot submodule
After commit 63e54275f6 (libpayload: Implement new CBFS access API),
libpayload includes headers from commonlib/bsd, which in turn include
vb2_sha.h from vboot after commit 0655f78041 (commonlib/bsd: Add new
CBFS core implementation). Usually submodules are initialized by the top
level Makefile.inc, but since this file is never read when building
libpayload based payloads outside the main coreboot build, the header
cannot be found unless the vboot submodule had previously been
initialized. This is especially evident when following Tutorial 1 in the
documentation, where the coreboot repo is cloned without recursing into
submodules and coreinfo is built separately from the coreboot build
using `make -C payloads/coreinfo`.

TEST=Deinitialize submodules and run `make -C payloads/coreinfo`.
Coreinfo should build without error.

Change-Id: I29b16525999921fbce51c2459d3d534b64e00b3c
Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/65222
Reviewed-by: Nico Huber <nico.h@gmx.de>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2022-06-20 13:54:31 +00:00
..
arch libpayload/x86: Fix boot_device_read() and hook it up 2022-02-23 22:47:09 +00:00
bin commonlib: Clean up compiler.h 2022-06-07 12:34:35 +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/pci: Add pci_map_bus function for MediaTek platform 2022-05-20 02:53:35 +00:00
gdb libpayload: gdb: Condition video console init on LP_VIDEO_CONSOLE 2020-06-22 12:24:42 +00:00
include libpayload: Add commonlib/bsd/elog and its dependency 2022-06-09 13:33:35 +00:00
libc libpayload: Add commonlib/bsd/elog and its dependency 2022-06-09 13:33:35 +00:00
libcbfs libpayload/libcbfs: Fix file hash check 2022-06-16 18:02:34 +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/libcbfs: Fix file hash check 2022-06-16 18:02:34 +00:00
vboot libpayload/vboot: Fix include paths fixup macro 2022-03-25 19:25:36 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
Doxyfile
Kconfig libpayload/pci: Add pci_map_bus function for MediaTek platform 2022-05-20 02:53:35 +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.