coreboot-kgpe-d16/payloads/libpayload
Nico Huber a482701451 libpayload: Document USB host controller setup functions
The semantics of the controller functions, start(), stop(), reset() and
shutdown(), are not self-explanatory which let to some confusion. At
least the reset() functions of the different host controller drivers
were implemented following different interpretations. Let's make the
intended behaviour of these functions clear.

The stated inconsistencies will be addressed in following commits.

Change-Id: Id2e300f65c21039218b6ba3f87c0fcd4f0dda0a8
Signed-off-by: Nico Huber <nico.huber@secunet.com>
Reviewed-on: http://review.coreboot.org/1848
Tested-by: build bot (Jenkins)
Reviewed-by: Ronald G. Minnich <rminnich@gmail.com>
2012-11-14 17:43:36 +01:00
..
arch libpayload: Add an option to skip console initialization on startup. 2012-11-09 22:55:38 +01:00
bin libpayload: Don't leave temporary files behind 2012-09-28 13:43:31 +02:00
configs libpayload: Add support for the CBMEM in memory console. 2012-11-09 19:01:15 +01:00
crypto Use coreboot build system for libpayload, too. 2011-06-30 20:40:10 +02:00
curses libpayload: Enable colors in PDcurses 2011-11-11 18:24:48 +01:00
drivers libpayload: Export device count in storage interface 2012-11-14 17:39:03 +01:00
include libpayload: Document USB host controller setup functions 2012-11-14 17:43:36 +01:00
lib Discard .note sections when linking. 2012-11-07 18:30:11 +01:00
libc libpayload: Add support for the CBMEM in memory console. 2012-11-09 19:01:15 +01:00
libcbfs Refactor the endianness conversion functions and header files. 2012-11-08 19:49:51 +01:00
liblzma libpayload: Add liblzma, libcbfs 2011-08-04 08:11:21 +02:00
libpci libpayload: minor cleanups 2012-04-04 00:40:31 +02:00
sample fix compilation of hello.elf example payload. 2010-08-28 23:23:47 +00:00
util Respect linker order 2011-12-21 16:27:01 +01:00
Config.in libpayload: Add an option to skip console initialization on startup. 2012-11-09 22:55:38 +01:00
Doxyfile Run doxygen -u on doxygen configuration files 2010-06-28 10:40:38 +00:00
LICENSES Since some people disapprove of white space cleanups mixed in regular commits 2010-04-27 06:56:47 +00:00
Makefile Fixes to the libpayload build system 2011-07-03 14:47:48 +02:00
Makefile.inc libpayload: Use EXTRA_CFLAGS for additional GCC options 2012-11-12 19:14:58 +01:00
README Update repo path in libpayload readme. 2011-03-29 19:29:01 +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 http://coreboot.org for details on coreboot.


Installation
------------

 $ svn co svn://coreboot.org/coreboot/trunk/payloads/libpayload

 $ cd 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 http://www.coreboot.org/Libpayload.

For additional information, patches, and discussions, please join the
coreboot mailing list at http://coreboot.org/Mailinglist, where most
libpayload developers are subscribed.


Copyright and License
---------------------

See LICENSES.