coreboot-kgpe-d16/payloads/libpayload
Julius Werner 39c4bb0211 libpayload: Move GDB functions to stdlib.h
When GDB support is compiled in, halt() in libpayload will call
gdb_enter(). halt() is defined in <stdlib.h> and gdb_enter() in
<libpayload.h>. Usually files just include <libpayload.h> so this is not
a problem, but in some situatons a payload may just include <stdlib.h>
(or a file including it like <assert.h>), leading to an undeclared
identifier here. Move the GDB functions to <stdlib.h> to solve this.

Change-Id: I7b23b8ac9cd302aa6ef96f24565130490ac40071
Signed-off-by: Julius Werner <jwerner@chromium.org>
Reviewed-on: https://review.coreboot.org/25730
Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2018-04-19 20:39:29 +00:00
..
arch arch/arm64/armv8/mmu: Add support for 48bit VA 2018-03-23 04:09:50 +00:00
bin libpayload: Move base address, stack and heap size to Kconfig 2016-03-15 20:53:38 +01:00
configs libpayload: Double HEAP_SIZE in default config 2017-07-28 16:17:04 +00:00
crypto libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
curses libpayload/.../PDCurses: Improve compatibility with ncurses 2016-12-14 18:02:51 +01:00
drivers libpayload: usbhid: Zero-initialize all parts of usbhid instance struct 2018-02-16 00:08:26 +00:00
gdb libpayload/gdb: fix unused variable warning 2017-04-29 07:34:08 +02:00
include libpayload: Move GDB functions to stdlib.h 2018-04-19 20:39:29 +00:00
libc libpayload: Add SKU ID coreboot table support 2017-12-07 01:19:38 +00:00
libcbfs libpayload: cbfs: Fix minor memory leak in some edge cases 2016-08-12 22:52:22 +02:00
liblz4 Rename __attribute__((packed)) --> __packed 2017-07-13 19:45:59 +00:00
liblzma libpayload: lzma: Allocate scratchpad on the heap 2016-08-08 19:02:07 +02:00
libpci libpayload: Add pci_free_dev() and some boilerplate 2017-12-07 21:51:24 +00:00
sample Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
tests Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
Doxyfile
Kconfig libpayload: video: Add support for font scaling with a factor 2017-08-03 20:37:07 +00:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSE_GPL libpayload: Introduce new Kconfig to explicitly allow GPL code 2015-01-09 07:06:27 +01:00
Makefile libpayload: fix build 2017-01-25 17:58:48 +01:00
Makefile.inc copy & update test routines from what-jenkins-does 2017-08-11 15:24:56 +00:00
README Use git HTTP URLs without `/p` in it 2018-04-17 10:38:06 +00:00

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

 $ sudo make install (optional, will install into /opt per default)

As libpayload is for 32bit x86 systems only, you might have to install the
32bit libgcc version, otherwise your payloads will fail to compile.
On Debian systems you'd do 'apt-get install gcc-multilib' for example.


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.