coreboot-kgpe-d16/payloads/libpayload
Martin Roth 354389365b payloads: Rename Makefiles from .inc to .mk
The .inc suffix is confusing to various tools as it's not specific to
Makefiles. This means that editors don't recognize the files, and don't
open them with highlighting and any other specific editor functionality.

This issue is also seen in the release notes generation script where
Makefiles get renamed before running cloc.

Signed-off-by: Martin Roth <gaumless@gmail.com>
Change-Id: Ie7038712de8cc646632d5e7d29550e3260bf2c62
Reviewed-on: https://review.coreboot.org/c/coreboot/+/80103
Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Reviewed-by: Maximilian Brune <maximilian.brune@9elements.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2024-01-24 10:15:10 +00:00
..
arch payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
bin libpayload: bin/lpgcc allow to call without files 2023-03-07 17:10:36 +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 payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
gdb payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
include libpayload: Add dma_allocator_range() 2023-11-21 13:50:53 +00:00
libc payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
libcbfs payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +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: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
vboot payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
Doxyfile
Kconfig libpayload;arch,cpu/x86: drop USE_MARCH_586 Kconfig option 2023-05-27 00:29:02 +00:00
LICENSES
LICENSE_GPL
Makefile payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
Makefile.mk payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +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.