coreboot-kgpe-d16/payloads/libpayload
Jakub Czapiga 3d91b47b42 libpayload: Add mock architecture
Mock architecture can be used to build libpayload using host compiler.
It can be enabled by setting ARCH_MOCK=y in the dotconfig. It sets
LITTLE_ENDIAN=y, as most machines these days use little-endian CPUs.
Libpayload will use HOSTCC as CC, HOSTLD as LD, etc. instead of tools
provided by xcompile.
Mock architecture configuration can be used by payloads for testing
purposes. Thanks to it, tests can be architecture-independent,
and can be executed without requiring compatible Kconfig options,
e.g. ARCH_ARM64=y for ARM64 machine. However, one has to provide
implementation for most architecture-specific functions present
in arch/* directories.

Signed-off-by: Jakub Czapiga <jacz@semihalf.com>
Change-Id: Ie3a6e6f6cad2f8a2e48a8e546d3b79c577653080
Reviewed-on: https://review.coreboot.org/c/coreboot/+/57708
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Julius Werner <jwerner@chromium.org>
2021-10-11 12:59:57 +00:00
..
arch libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
bin libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
configs libpayload: Enable UART driver for sc7280 2021-10-06 23:57:20 +00:00
crypto
curses libpayload: curses: Only call `serial_set_color()` with initialized values 2021-07-14 08:22:05 +00:00
drivers libpayload: cbgfx: Clear screen by memcpy 2021-10-07 14:11:56 +00:00
gdb
include libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
libc coreboot tables: Add type-c port info to coreboot table 2021-10-04 17:12:48 +00:00
libcbfs
liblz4
liblzma
libpci
sample libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
tests
.gitignore
Doxyfile
Kconfig libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
LICENSES
LICENSE_GPL
Makefile libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
Makefile.inc libpayload: Add mock architecture 2021-10-11 12:59:57 +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.