coreboot-kgpe-d16/payloads/libpayload
Uwe Hermann 3153863567 Various Doxygen-related fixes in libpayload (trivial).
- Drop all '@brief's, they're not needed as we use JAVADOC_AUTOBRIEF.
   The first sentence of every description will be treated as the '@brief'
   automatically.
 
 - Also, put all documentation/descriptions on top of the Doxygen-comments,
   and put the '@foo' keywords at the bottom of the comments for consistency.
 
 - Change comments for SEEK_SET/SEEK_CUR/SEEK_END from '/**@def' to '/**<'
   in order to make them appear in the output.
 
 - Drop all explicit '@struct' lines (which are optional; Doxygen will figure
   out that it's a struct if the comment is right before the struct).
 
 - Fix various typos, whitespace issues, etc.
 
 - Fix incorrect @param variable names, e.g. change '@param n foobar' to
   '@param s foobar' if the variable is named 's'.

Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de>
Acked-by: Uwe Hermann <uwe@hermann-uwe.de>



git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3555 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2008-08-31 22:10:35 +00:00
..
bin fix cross compilationor libpayload / coreinfo by honoring 2008-08-07 15:22:01 +00:00
crypto No really, _these_ should be the last occurences of CONFIG_ without 2008-08-11 17:10:58 +00:00
curses Add a kconfig option to choose between outputing ACS characters or 2008-08-18 19:29:41 +00:00
drivers misc fixes: 2008-08-19 17:51:30 +00:00
i386 Various Doxygen-related fixes in libpayload (trivial). 2008-08-31 22:10:35 +00:00
include Various Doxygen-related fixes in libpayload (trivial). 2008-08-31 22:10:35 +00:00
lib libpayload: Add PAYLOAD_INFO macro 2008-05-27 20:06:54 +00:00
libc Various Doxygen-related fixes in libpayload (trivial). 2008-08-31 22:10:35 +00:00
sample libpayload: Fix the putc function 2008-05-14 20:07:31 +00:00
util/kconfig compile fix (trivial) 2008-08-08 14:17:46 +00:00
Config.in Add a kconfig option to choose between outputing ACS characters or 2008-08-18 19:29:41 +00:00
Doxyfile [PATCH]: Libpayload: Remove static variables from the doxygen output 2008-08-28 23:10:25 +00:00
LICENSES Document all of the external code we use in libpayload (trivial). 2008-08-11 20:34:50 +00:00
Makefile libpayload: Expand doxygen definitions 2008-08-28 16:53:24 +00:00
README Add more information to the libpayload README (trivial). 2008-08-18 18:55:33 +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/repos/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.