coreboot/payloads/libpayload
Yu-Ping Wu a03e5456e6 libpayload/endian: Add read32p/write32p macros and friends
Add {read,write}{8,16,32,64}p macros and similar macros for clrsetbits,
setbits and clrbits.

Change-Id: If01e38663ffc1c08c553850d3210604c9b240655
Signed-off-by: Yu-Ping Wu <yupingso@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/84592
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Yidi Lin <yidilin@google.com>
2024-10-15 10:16:40 +00:00
..
arch libpayload: Use unsigned integer for PDG_MASK 2024-08-27 00:29:12 +00:00
bin libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
configs libpayload/unit-tests: Rename ARCH_BIG_ENDIAN to ARCH_MOCK_BIG_ENDIAN 2023-11-25 16:00:19 +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 commonlib/bsd: Add strcat() and strncat() functions 2024-08-14 03:09:20 +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 payloads/libpayload: Remove Wno-trigraphs 2024-10-15 02:19:58 +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
LICENSES
Makefile libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
Makefile.mk payloads/libpayload: Remove Wno-trigraphs 2024-10-15 02:19:58 +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.