coreboot/payloads/libpayload
Maximilian Brune a8139c0b87 treewide: Rename PM4LE -> PML4E
The x86 (AMD and Intel) spec defines it as Page-Map Level-4 Entry.
It is annoying when searching for the wrong abbreviation in the spec so
fix it everywhere it occurs.

source: Intel 64 spec April 2022 and AMD64 spec April 2024.

Signed-off-by: Maximilian Brune <maximilian.brune@9elements.com>
Change-Id: I730235beea69b3720f080bbade083c2eeed26587
Reviewed-on: https://review.coreboot.org/c/coreboot/+/86587
Reviewed-by: Jérémy Compostella <jeremy.compostella@intel.com>
Reviewed-by: Patrick Rudolph <patrick.rudolph@9elements.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-by: Benjamin Doron <benjamin.doron00@gmail.com>
Reviewed-by: Andy Ebrahiem <ahmet.ebrahiem@9elements.com>
2025-02-25 17:33:36 +00:00
..
arch treewide: Rename PM4LE -> PML4E 2025-02-25 17:33:36 +00:00
bin libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
configs libpayload: configs: Add new config.featuretest to broaden CI 2024-12-04 22:25:34 +00:00
crypto payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
curses payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
drivers libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
gdb libpayload: gdb: Make die_if() format string a literal 2024-03-19 22:50:03 +00:00
include libpayload/endian: Add read32p/write32p macros and friends 2024-10-15 10:16:40 +00:00
libc libpayload: Unify selfboot() implementations 2025-02-11 20:59:57 +00:00
libcbfs libpayload: Remove legacy CBFS API 2024-02-22 21:18:39 +00:00
liblz4 payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
liblzma payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
libpci payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
sample libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
tests libpayload/tests: Remove unused test files 2025-02-25 03:56:49 +00:00
vboot libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
Doxyfile payloads: Remove/fix trailing whitespace 2018-09-04 12:38:40 +00:00
Kconfig libpayload: Allow LTO with clang 2024-08-27 00:27:27 +00:00
LICENSE_GPL libpayload: Introduce new Kconfig to explicitly allow GPL code 2015-01-09 07:06:27 +01:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
Makefile libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
Makefile.mk payloads/libpayload: Add Wno-address-of-packed-member flag 2024-10-15 18:55:32 +00:00
Makefile.payload libpayload/Makefile.payload: Add lto flags 2024-08-27 09:08:07 +00:00
README payloads/libpayload: Update a Makefile for sample libpayload 2019-06-21 09:16:36 +00:00

-------------------------------------------------------------------------------
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.