coreboot-kgpe-d16/payloads/libpayload
Jakub Czapiga 111de557ee tests: Move x86 I/O functions to include/mock/arch/io.h
Move th x86 I/O functions declarations from tests mocks to the mock
architecture io.h. This will make x86 I/O-dependent tests simpler,
because the x86_io.h from mocks will not have to be included manually.

Change-Id: Ie7f06c992be306d2523f2079bc90adf114b93946
Signed-off-by: Jakub Czapiga <jacz@semihalf.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/58881
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Yu-Ping Wu <yupingso@google.com>
2021-11-04 15:07:38 +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: 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: cbgfx: Clear screen by memcpy 2021-10-07 14:11:56 +00:00
gdb
include tests: Move x86 I/O functions to include/mock/arch/io.h 2021-11-04 15:07:38 +00:00
libc coreboot tables: Add type-c port info to coreboot table 2021-10-04 17:12:48 +00:00
libcbfs
liblz4
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 tests: Move x86 I/O functions to include/mock/arch/io.h 2021-11-04 15:07:38 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
Doxyfile
Kconfig libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSE_GPL
Makefile libpayload: Add unit-tests framework and first test case 2021-10-18 12:33:49 +00:00
Makefile.inc libpayload: Add unit-tests framework and first test case 2021-10-18 12:33:49 +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.