coreboot-kgpe-d16/payloads/libpayload
Jon Murphy c4e90454f4 treewide: Unify Google branding
Branding changes to unify and update Chrome OS to ChromeOS (removing the
space).

This CL also includes changing Chromium OS to ChromiumOS as well.

BUG=None
TEST=N/A

Change-Id: I39af9f1069b62747dbfeebdd62d85fabfa655dcd
Signed-off-by: Jon Murphy <jpmurphy@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/65479
Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Felix Singer <felixsinger@posteo.net>
2022-07-04 14:02:26 +00:00
..
arch treewide: Unify Google branding 2022-07-04 14:02:26 +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
curses
drivers treewide: Unify Google branding 2022-07-04 14:02:26 +00:00
gdb
include treewide: Unify Google branding 2022-07-04 14:02:26 +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
liblzma
libpci
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
Doxyfile
Kconfig treewide: Unify Google branding 2022-07-04 14:02:26 +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.