Difference between revisions of "Libpayload"

From coreboot
Jump to: navigation, search
m (add download instructions)
m (Fixed downloading from Subversion to Git)
 
(33 intermediate revisions by 7 users not shown)
Line 1: Line 1:
'''libpayload''' is a small BSD-licensed "library" (a lightweight implementation of common and useful functions) intended to be used as a basis for coreboot payloads.
+
'''libpayload''' is a small BSD-licensed static library (a lightweight implementation of common and useful functions) intended to be used as a basis for coreboot [[payloads]].
 
+
== Overview ==
+
  
 
The benefits of linking a coreboot payload against libpayload are:
 
The benefits of linking a coreboot payload against libpayload are:
Line 9: Line 7:
 
* The libpayload functions can be tested and scrutinized outside payload development.
 
* The libpayload functions can be tested and scrutinized outside payload development.
 
* Payloads themselves may be partly host-tested, e.g. against an emulation libpayload.
 
* Payloads themselves may be partly host-tested, e.g. against an emulation libpayload.
* Leads to the possibility of payloads using dynamic linking, reducing total payload footprint.
 
  
 
''Just give us a main() and a pocket full of dreams and we'll do the rest.''
 
''Just give us a main() and a pocket full of dreams and we'll do the rest.''
  
== Download ==
+
== Features ==
  
  $ svn co svn://coreboot.org/repos/trunk/payloads/libpayload
+
* Provides a [[Libpayload#Libc_coverage|subset of libc functions]] (e.g. malloc, printf, strcmp, etc).
 +
* Provides an optional tiny (n)curses implementation.
 +
* Provides various small drivers for
 +
** keyboard
 +
** PC speaker
 +
** NVRAM/CMOS access
 +
** serial console
 +
** VGA
 +
** Geode framebuffer
 +
** USB stack
 +
* Reads and parses the coreboot table.
  
== Feature Wish List ==
+
== Design ==
  
* Basics
+
* [[Payload API|Discussion of the API for passing parameters to the payload]]
** coreboot services and structures (e.g. read CMOS, device tree)
+
** subset of C-library functions (e.g. printf, puts, getch)
+
** light ncurses from the Google Summer Of Code project
+
* Fancies
+
** directFB
+
** TWIN
+
  
== Libc Coverage ==
+
== Payloads using libpayload ==
  
{| border="0"  
+
* [[FILO]] is a bootloader which loads boot images from a local filesystem, without help from legacy BIOS services.
|- bgcolor="#6699ff"
+
* [[coreinfo]] is a small payload which can display system information such as PCI info, or an NVRAM dump.
! align="left" | Function/Macro/Variable
+
* [[GRUB invaders]] has been ported successfully to libpayload (patch pending).
! align="left" | Status
+
* [[tint]] (a "falling blocks" game) has been successfully ported to libpayload.
 +
* [http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=tree;f=scripts/kconfig/lxdialog;hb=HEAD lxdialog] from the Linux '''kconfig''' utility has been ported to be usable when linked with libpayload (patch pending).
  
|- bgcolor="red"
+
== Downloading and building libpayload ==
| colspan=2 align="center" | assert.h
+
  
|-
+
It is now in main coreboot git tree (see [[Download_coreboot]] for additional reference)
| <code>assert( )</code> (macro)
+
| style="background:red" | no
+
  
|- bgcolor="red"
+
$ '''git clone http://review.coreboot.org/p/coreboot'''
| colspan=2 align="center" | ctype.h
+
$ '''cd payloads/libpayload'''
 +
$ '''make menuconfig'''
 +
$ '''make install'''
  
|-
+
Here [http://review.coreboot.org/#/q/status:open+project:coreboot+message:libpayload,n,z gerrit] you can find pending patches for libpayload
| <code>int isalnum(int character)</code>
+
| style="background:red" | no
+
  
|-
+
== Documentation ==
| <code>int isalpha(int character)</code>
+
| style="background:red" | no
+
  
|-
+
See the autogenerated documentation for libpayload [http://qa.coreboot.org/docs/libpayload/ here].
| <code>int iscntrl(int character)</code>
+
| style="background:red" | no
+
  
|-
+
== Libc coverage ==
| <code>int isdigit(int character)</code>
+
| style="background:red" | no
+
  
|-
+
{| border="0" valign="top"
| <code>int isgraph(int character)</code>
+
| valign="top"|
| style="background:red" | no
+
  
|-  
+
{| border="0" style="font-size: smaller"
| <code>int islower(int character)</code>
+
|- bgcolor="#6699ff"
| style="background:red" | no
+
! align="left" | Status
 +
! align="left" | Function/Macro/Variable
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''assert.h'''
 
|-  
 
|-  
| <code>int isprint(int character)</code>
+
|- bgcolor="#eeeeee" valign="top"
| style="background:red" | no
+
| style="background:lime" | no
 +
| assert()
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''ctype.h'''
 
|-  
 
|-  
| <code>int ispunct(int character)</code>
+
|- bgcolor="#eeeeee" valign="top"
| style="background:red" | no
+
| style="background:lime" | yes
 
+
| int isalnum(int character)
 
|-  
 
|-  
| <code>int isspace(int character)</code>
+
|- bgcolor="#dddddd" valign="top"
| style="background:red" | no
+
| style="background:lime" | yes
 
+
| int isalpha(int character)
 
|-  
 
|-  
| i<code>nt isupper(int character)</code>
+
|- bgcolor="#dddddd" valign="top"
| style="background:red" | no
+
| style="background:lime" | yes
 
+
| int isascii(int character)
 
|-  
 
|-  
| <code>int isxdigit(int character)</code>
+
|- bgcolor="#dddddd" valign="top"
| style="background:red" | no
+
| style="background:lime" | yes
 
+
| int isblanc(int character)
|- bgcolor="red"
+
|-
| colspan=2 align="center" | errno.h
+
|- bgcolor="#eeeeee" valign="top"
 +
| style="background:lime" | yes
 +
| int iscntrl(int character)
 +
|-
 +
|- bgcolor="#dddddd" valign="top"
 +
| style="background:lime" | yes
 +
| int isdigit(int character)
 +
|-
 +
|- bgcolor="#eeeeee" valign="top"
 +
| style="background:lime" | yes
 +
| int isgraph(int character)
 +
|-
 +
|- bgcolor="#dddddd" valign="top"
 +
| style="background:lime" | yes
 +
| int islower(int character)
 +
|-
 +
|- bgcolor="#eeeeee" valign="top"
 +
| style="background:lime" | yes
 +
| int isprint(int character)
 +
|-
 +
|- bgcolor="#dddddd" valign="top"
 +
| style="background:lime" | yes
 +
| int ispunct(int character)
 +
|-
 +
|- bgcolor="#eeeeee" valign="top"
 +
| style="background:lime" | yes
 +
| int isspace(int character)
 +
|-
 +
|- bgcolor="#dddddd" valign="top"
 +
| style="background:lime" | yes
 +
| int isupper(int character)
 +
|-
 +
|- bgcolor="#eeeeee" valign="top"
 +
| style="background:lime" | yes
 +
| int isxdigit(int character)
 +
|-
 +
|- bgcolor="#eeeeee" valign="top"
 +
| style="background:lime" | yes
 +
| int tolower(int character)
 +
|-
 +
|- bgcolor="#eeeeee" valign="top"
 +
| style="background:lime" | yes
 +
| int toupper(int character)
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''errno.h'''
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>errno</code> (global)
 
| <code>errno</code> (global)
| style="background:red" | no
 
  
|- bgcolor="red"
+
|- bgcolor="#6699ff"
| colspan=2 align="center" | float.h
+
| colspan=2 | '''float.h'''
  
|- bgcolor="red"
+
|- bgcolor="#6699ff"
| colspan=2 align="center" | limits.h
+
| colspan=2 | '''limits.h'''
 
+
|- bgcolor="red"
+
| colspan=2 align="center" | locale.h
+
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''locale.h'''
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>char *setlocale(int category, const char *locale)</code>
 
| <code>char *setlocale(int category, const char *locale)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 +
| <code>struct lconv *localeconv(void)</code>
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''math.h'''
 
|-  
 
|-  
| <code>struct lconv *localeconv(void)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double exp(double x)</code>
|- bgcolor="red"
+
| colspan=2 align="center" | math.h
+
 
+
 
|-  
 
|-  
| <code>double exp(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double log(double x)</code>
 
|-  
 
|-  
| <code>double log(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double log10(double x)</code>
 
|-  
 
|-  
| <code>double log10(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double pow(double x, double y)</code>
 
|-  
 
|-  
| <code>double pow(double x, double y)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double sqrt(double x)</code>
 
|-  
 
|-  
| <code>double sqrt(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double ceil(double x)</code>
 
|-  
 
|-  
| <code>double ceil(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double floor(double x)</code>
 
|-  
 
|-  
| <code>double floor(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double fabs(double x)</code>
 
|-  
 
|-  
| <code>double fabs(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double ldexp(double x, int n)</code>
 
|-  
 
|-  
| <code>double ldexp(double x, int n)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double frexp(double x, int* exp)</code>
 
|-  
 
|-  
| <code>double frexp(double x, int* exp)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double modf(double x, double* ip)</code>
 
|-  
 
|-  
| <code>double modf(double x, double* ip)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double fmod(double x, double y)</code>
 
|-  
 
|-  
| <code>double fmod(double x, double y)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double sin(double x)</code>
 
|-  
 
|-  
| <code>double sin(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double cos(double x)</code>
 
|-  
 
|-  
| <code>double cos(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double tan(double x)</code>
 
|-  
 
|-  
| <code>double tan(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double asin(double x)</code>
 
|-  
 
|-  
| <code>double asin(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double acos(double x)</code>
 
|-  
 
|-  
| <code>double acos(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double atan(double x)</code>
 
|-  
 
|-  
| <code>double atan(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double atan2(double y, double x)</code>
 
|-  
 
|-  
| <code>double atan2(double y, double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double sinh(double x)</code>
 
|-  
 
|-  
| <code>double sinh(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double cosh(double x)</code>
 
|-  
 
|-  
| <code>double cosh(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 +
| <code>double tanh(double x)</code>
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''setjmp.h'''
 
|-  
 
|-  
| <code>double tanh(double x)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int setjmp(jmp_buf env)</code>
|- bgcolor="red"
+
| colspan=2 align="center" | setjmp.h
+
 
+
 
|-  
 
|-  
| <code>int setjmp(jmp_buf env)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 +
| <code>void longjmp(jmp_buf env, int val)</code>
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''signal.h'''
 
|-  
 
|-  
| <code>void longjmp(jmp_buf env, int val)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>void (*signal(int sig, void (*handler)(int)))(int)</code>
|- bgcolor="red"
+
| colspan=2 align="center" | signal.h
+
 
+
 
|-  
 
|-  
| <code>void (*signal(int sig, void (*handler)(int)))(int)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 +
| <code>int raise(int sig)</code>
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''stdarg.h'''
 
|-  
 
|-  
| <code>int raise(int sig)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>void va_start(va_list ap, lastarg)</code>
|- bgcolor="red"
+
| colspan=2 align="center" | stdarg.h
+
 
+
 
|-  
 
|-  
| <code>void va_start(va_list ap, lastarg)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>type va_arg(va_list ap, type)</code>
 
|-  
 
|-  
| <code>type va_arg(va_list ap, type)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>void va_end(va_list ap)</code>
 
| <code>void va_end(va_list ap)</code>
| style="background:red" | no
 
  
|- bgcolor="red"
+
|- bgcolor="#6699ff"
| colspan=2 align="center" | stddef.h
+
| colspan=2 | '''stddef.h'''
  
 
|- colspan=2  
 
|- colspan=2  
 
| TODO
 
| TODO
  
|- bgcolor="yellow"
+
|- bgcolor="#6699ff"
| colspan=2 align="center" | stdio.h
+
| colspan=2 | '''stdio.h'''
 
+
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>FILE* fopen(const char* filename, const char* mode)</code>
 
| <code>FILE* fopen(const char* filename, const char* mode)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>FILE* freopen(const char* filename, const char* mode, FILE* stream)</code>
 
| <code>FILE* freopen(const char* filename, const char* mode, FILE* stream)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int fflush(FILE* stream)</code>
 
|-  
 
|-  
| <code>int fflush(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int fclose(FILE* stream)</code>
 
|-  
 
|-  
| <code>int fclose(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int remove(const char* filename)</code>
 
|-  
 
|-  
| <code>int remove(const char* filename)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int rename(const char* oldname, const char* newname)</code>
 
|-  
 
|-  
| <code>int rename(const char* oldname, const char* newname)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>FILE* tmpfile()</code>
 
|-  
 
|-  
| <code>FILE* tmpfile()</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>char* tmpnam(char s[L_tmpnam])</code>
 
|-  
 
|-  
| <code>char* tmpnam(char s[L_tmpnam])</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int setvbuf(FILE* stream, char* buf, int mode, size_t size)</code>
 
|-  
 
|-  
| <code>int setvbuf(FILE* stream, char* buf, int mode, size_t size)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>void setbuf(FILE* stream, char* buf)</code>
 
|-  
 
|-  
| <code>void setbuf(FILE* stream, char* buf)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>int fprintf(FILE* stream, const char* format, ...)</code>
 
| <code>int fprintf(FILE* stream, const char* format, ...)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int printf(const char* format, ...)</code>
 
| <code>int printf(const char* format, ...)</code>
| style="background:yellow" | partial
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int sprintf(char* s, const char* format, ...)</code>
 
| <code>int sprintf(char* s, const char* format, ...)</code>
| style="background:yellow" | partial
+
|-
 
+
| style="background:lime" | yes
 +
| <code>int snprintf(char* s, size_t size, const char* format, ...)</code>
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>int vfprintf(FILE* stream, const char* format, va_list arg)</code>
 
| <code>int vfprintf(FILE* stream, const char* format, va_list arg)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int vprintf(const char* format, va_list arg)</code>
 
| <code>int vprintf(const char* format, va_list arg)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int vsprintf(char* s, const char* format, va_list arg)</code>
 
| <code>int vsprintf(char* s, const char* format, va_list arg)</code>
| style="background:yellow" | partial
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 +
| <code>int vsnprintf(char* s, size_t size, const char* format, va_list arg)</code>
 +
|-
 +
| style="background:red" | no
 
| <code>int fscanf(FILE* stream, const char* format, ...)</code>
 
| <code>int fscanf(FILE* stream, const char* format, ...)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int scanf(const char* format, ...)</code>
 
|-  
 
|-  
| <code>int scanf(const char* format, ...)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int sscanf(char* s, const char* format, ...)</code>
 
|-  
 
|-  
| <code>int sscanf(char* s, const char* format, ...)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int fgetc(FILE* stream)</code>
 
|-  
 
|-  
| <code>int fgetc(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>char* fgets(char* s, int n, FILE* stream)</code>
 
|-  
 
|-  
| <code>char* fgets(char* s, int n, FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int fputc(int c, FILE* stream)</code>
 
|-  
 
|-  
| <code>int fputc(int c, FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>char* fputs(const char* s, FILE* stream)</code>
 
|-  
 
|-  
| <code>char* fputs(const char* s, FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>int getc(FILE* stream)</code>
 
| <code>int getc(FILE* stream)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int getchar(void)</code>
 
| <code>int getchar(void)</code>
| style="background:lime" | yes
 
 
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>char* gets(char* s)</code>
 
| <code>char* gets(char* s)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>int putc(int c, FILE* stream)</code>
 
| <code>int putc(int c, FILE* stream)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int putchar(int c)</code>
 
| <code>int putchar(int c)</code>
 +
|-
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
|-
 
 
| <code>int puts(const char* s)</code>
 
| <code>int puts(const char* s)</code>
| style="background:lime" | yes
 
 
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>int ungetc(int c, FILE* stream)</code>
 
| <code>int ungetc(int c, FILE* stream)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>size_t fread(void* ptr, size_t size, size_t nobj, FILE* stream)</code>
 
| <code>size_t fread(void* ptr, size_t size, size_t nobj, FILE* stream)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>size_t fwrite(const void* ptr, size_t size, size_t nobj, FILE* stream)</code>
 
|-  
 
|-  
| <code>size_t fwrite(const void* ptr, size_t size, size_t nobj, FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int fseek(FILE* stream, long offset, int origin)</code>
 
|-  
 
|-  
| <code>int fseek(FILE* stream, long offset, int origin)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>long ftell(FILE* stream)</code>
 
|-  
 
|-  
| <code>long ftell(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>void rewind(FILE* stream)</code>
 
|-  
 
|-  
| <code>void rewind(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int fgetpos(FILE* stream, fpos_t* ptr)</code>
 
|-  
 
|-  
| <code>int fgetpos(FILE* stream, fpos_t* ptr)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int fsetpos(FILE* stream, const fpos_t* ptr)</code>
 
|-  
 
|-  
| <code>int fsetpos(FILE* stream, const fpos_t* ptr)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>void clearerr(FILE* stream)</code>
 
|-  
 
|-  
| <code>void clearerr(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int feof(FILE* stream)</code>
 
|-  
 
|-  
| <code>int feof(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int ferror(FILE* stream)</code>
 
|-  
 
|-  
| <code>int ferror(FILE* stream)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>void perror(const char* s)</code>
 
| <code>void perror(const char* s)</code>
| style="background:red" | no
 
  
|- bgcolor="yellow"
+
|}
| colspan=2 align="center" | stdlib.h
+
  
 +
| valign="top"|
 +
 +
{| border="0" style="font-size: smaller"
 +
|- bgcolor="#6699ff"
 +
! align="left" | Status
 +
! align="left" | Function/Macro/Variable
 +
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''stdlib.h'''
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int abs(int n)</code>
 
| <code>int abs(int n)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>long labs(long n)</code>
 
| <code>long labs(long n)</code>
 +
|-
 +
| style="background:lime" | yes
 +
| <code>long long llabs(long long n)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>div_t div(int num, int denom)</code>
 
|-  
 
|-  
| <code>div_t div(int num, int denom)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>ldiv_t ldiv(long num, long denom)</code>
 
|-  
 
|-  
| <code>ldiv_t ldiv(long num, long denom)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double atof(const char* s)</code>
 
|-  
 
|-  
| <code>double atof(const char* s)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int atoi(const char* s)</code>
 
|-  
 
|-  
| <code>int atoi(const char* s)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>long atol(const char* s)</code>
 
|-  
 
|-  
| <code>long atol(const char* s)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>double strtod(const char* s, char** endp)</code>
 
| <code>double strtod(const char* s, char** endp)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>long strtol(const char* s, char** endp, int base)</code>
 
| <code>long strtol(const char* s, char** endp, int base)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>unsigned long strtoul(const char* s, char** endp, int base)</code>
 
| <code>unsigned long strtoul(const char* s, char** endp, int base)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
| <code>void* calloc(size_t nobj, size_t size)</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>void* calloc(size_t nobj, size_t size)</code>
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>void* malloc(size_t size)</code>
 
| <code>void* malloc(size_t size)</code>
 +
|-
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>void* realloc(void* p, size_t size)</code>
 
|-  
 
|-  
| <code>void* realloc(void* p, size_t size)</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>void free(void* p)</code>
 
|-  
 
|-  
| <code>void free(void* p)</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>void * memalign (size_t align, size_t size)</code>
 
|-  
 
|-  
| <code>void abort()</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>void abort()</code>
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>void exit(int status)</code>
 
| <code>void exit(int status)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int atexit(void (*fcm)(void))</code>
 
|-  
 
|-  
| <code>int atexit(void (*fcm)(void))</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>int system(const char* s)</code>
 
|-  
 
|-  
| <code>int system(const char* s)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>char* getenv(const char* name)</code>
 
| <code>char* getenv(const char* name)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
| <code>void* bsearch(const void* key, const void* base, size_t n, size_t size, int (*cmp)(const void* keyval, const void* datum))</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>void* bsearch(const void* key, const void* base, size_t n,<br />size_t size, int (*cmp)(const void* keyval, const void* datum))</code>
 
|-  
 
|-  
| <code>void qsort(void* base, size_t n, size_t size, int (*cmp)(const void*, const void*))</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>void qsort(void* base, size_t n, size_t size, <br />int (*cmp)(const void*, const void*))</code>
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>int rand(void)</code>
 
| <code>int rand(void)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>void srand(unsigned int seed)</code>
 
| <code>void srand(unsigned int seed)</code>
| style="background:red" | no
 
 
|- bgcolor="yellow"
 
| colspan=2 align="center" | string.h
 
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''string.h'''
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>char* strcpy(char* s, const char* ct)</code>
 
| <code>char* strcpy(char* s, const char* ct)</code>
| style="background:red" | proto only
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>char* strncpy(char* s, const char* ct, size_t n)</code>
 
| <code>char* strncpy(char* s, const char* ct, size_t n)</code>
| style="background:lime" | yes
 
 
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>char* strcat(char* s, const char* ct)</code>
 
| <code>char* strcat(char* s, const char* ct)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>char* strncat(char* s, const char* ct, size_t n)</code>
 
| <code>char* strncat(char* s, const char* ct, size_t n)</code>
 +
|-
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>int strcmp(const char* cs, const char* ct)</code>
 
|-  
 
|-  
| <code>int strcmp(const char* cs, const char* ct)</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
|-
 
 
| <code>int strncmp(const char* cs, const char* ct, size_t n)</code>
 
| <code>int strncmp(const char* cs, const char* ct, size_t n)</code>
| style="background:lime" | yes
 
 
 
|-  
 
|-  
 +
| style="background:red" | no
 
| <code>int strcoll(const char* cs, const char* ct)</code>
 
| <code>int strcoll(const char* cs, const char* ct)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>char* strchr(const char* cs, int c)</code>
 
| <code>char* strchr(const char* cs, int c)</code>
| style="background:lime" | yes
 
 
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>char* strrchr(const char* cs, int c)</code>
 
| <code>char* strrchr(const char* cs, int c)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>size_t strspn(const char* cs, const char* ct)</code>
 
| <code>size_t strspn(const char* cs, const char* ct)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>size_t strcspn(const char* cs, const char* ct)</code>
 
| <code>size_t strcspn(const char* cs, const char* ct)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>char* strpbrk(const char* cs, const char* ct)</code>
 
| <code>char* strpbrk(const char* cs, const char* ct)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>char* strstr(const char* cs, const char* ct)</code>
 
| <code>char* strstr(const char* cs, const char* ct)</code>
| style="background:lime" | yes
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>size_t strlen(const char* cs)</code>
 
| <code>size_t strlen(const char* cs)</code>
 +
|-
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>size_t strnlen(const char* cs, size_t maxlen)</code>
 +
|-
 +
| style="background:lime" | yes
 +
| <code>char * strdup (const char *s)</code>
 
|-  
 
|-  
| <code>char* strerror(int n)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>char* strerror(int n)</code>
 
|-  
 
|-  
 +
| style="background:lime" | no
 
| <code>char* strtok(char* s, const char* t)</code>
 
| <code>char* strtok(char* s, const char* t)</code>
 +
|-
 +
| style="background:lime" | no
 +
| <code>char* strtok_r(char* s, const char* t, char **p)</code>
 +
|-
 
| style="background:red" | no
 
| style="background:red" | no
 
|-
 
 
| <code>size_t strxfrm(char* s, const char* ct, size_t n)</code>
 
| <code>size_t strxfrm(char* s, const char* ct, size_t n)</code>
| style="background:red" | no
 
 
 
|-  
 
|-  
 +
| style="background:lime" | yes
 
| <code>void* memcpy(void* s, const void* ct, size_t n)</code>
 
| <code>void* memcpy(void* s, const void* ct, size_t n)</code>
 +
|-
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>void* memmove(void* s, const void* ct, size_t n)</code>
 
|-  
 
|-  
| <code>void* memmove(void* s, const void* ct, size_t n)</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>int memcmp(const void* cs, const void* ct, size_t n)</code>
 +
|-
 +
| style="background:red" | no
 +
| <code>void* memchr(const void* cs, int c, size_t n)</code>
 
|-  
 
|-  
| <code>int memcmp(const void* cs, const void* ct, size_t n)</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 +
| <code>void* memset(void* s, int c, size_t n)</code>
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''time.h'''
 
|-  
 
|-  
| <code>void* memchr(const void* cs, int c, size_t n)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>clock_t clock(void)</code>
 
|-  
 
|-  
| <code>void* memset(void* s, int c, size_t n)</code>
 
 
| style="background:lime" | yes
 
| style="background:lime" | yes
 
+
| <code>int gettimeofday (struct timeval *tv, void *tz)</code>
|- bgcolor="red"
+
| colspan=2 align="center" | time.h
+
 
+
 
|-  
 
|-  
| <code>clock_t clock(void)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>time_t time(time_t* tp)</code>
 
|-  
 
|-  
| <code>time_t time(time_t* tp)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>double difftime(time_t time2, time_t time1)</code>
 
|-  
 
|-  
| <code>double difftime(time_t time2, time_t time1)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>time_t mktime(struct tm* tp)</code>
 
|-  
 
|-  
| <code>time_t mktime(struct tm* tp)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>char* asctime(const struct tm* tp)</code>
 
|-  
 
|-  
| <code>char* asctime(const struct tm* tp)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>char* ctime(const time_t* tp)</code>
 
|-  
 
|-  
| <code>char* ctime(const time_t* tp)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>struct tm* gmtime(const time_t* tp)</code>
 
|-  
 
|-  
| <code>struct tm* gmtime(const time_t* tp)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 
+
| <code>struct tm* localtime(const time_t* tp)</code>
 
|-  
 
|-  
| <code>struct tm* localtime(const time_t* tp)</code>
 
 
| style="background:red" | no
 
| style="background:red" | no
 +
| <code>size_t strftime(char* s, size_t smax, const char* fmt,<br />const struct tm* tp)</code>
  
 +
|- bgcolor="#6699ff"
 +
| colspan=2 | '''unistd.h'''
 
|-  
 
|-  
| <code>size_t strftime(char* s, size_t smax, const char* fmt, const struct tm* tp)</code>
+
| style="background:lime" | yes
| style="background:red" | no
+
| <code>int exec (long addr, int argc, char **argv)</code>
  
 
|}
 
|}
 
 
{| border="1"
 
|- bgcolor="red"
 
| No Support
 
|- bgcolor="yellow"
 
| Partial Support
 
|- bgcolor="lime"
 
| Full Support
 
 
|}
 
|}
  
== Usage Example ==
+
== Usage example ==
  
hello_payload.c:
+
Here's an example of a very simple payload (hello.c) and how to build it:
  
<pre>
+
<source lang="C">
 
#include <libpayload.h>
 
#include <libpayload.h>
  
Line 663: Line 609:
 
     return 0;
 
     return 0;
 
}
 
}
</pre>
+
</source>
  
Build example (basic idea):
+
Building the payload:
  
  gcc -o hello_payload hello_payload.c
+
  $ '''lpgcc -o hello.elf hello.c'''
  
  
 
{{PD-self}}
 
{{PD-self}}

Latest revision as of 10:23, 1 June 2012

libpayload is a small BSD-licensed static library (a lightweight implementation of common and useful functions) intended to be used as a basis for coreboot payloads.

The benefits of linking a coreboot payload against libpayload are:

  • Payloads do not have to implement and maintain low-level code for I/O, common functions, etc.
  • Payloads can be recompiled and deployed for CPU architectures supported by coreboot in the future.
  • The libpayload functions can be tested and scrutinized outside payload development.
  • Payloads themselves may be partly host-tested, e.g. against an emulation libpayload.

Just give us a main() and a pocket full of dreams and we'll do the rest.

Features

  • Provides a subset of libc functions (e.g. malloc, printf, strcmp, etc).
  • Provides an optional tiny (n)curses implementation.
  • Provides various small drivers for
    • keyboard
    • PC speaker
    • NVRAM/CMOS access
    • serial console
    • VGA
    • Geode framebuffer
    • USB stack
  • Reads and parses the coreboot table.

Design

Payloads using libpayload

  • FILO is a bootloader which loads boot images from a local filesystem, without help from legacy BIOS services.
  • coreinfo is a small payload which can display system information such as PCI info, or an NVRAM dump.
  • GRUB invaders has been ported successfully to libpayload (patch pending).
  • tint (a "falling blocks" game) has been successfully ported to libpayload.
  • lxdialog from the Linux kconfig utility has been ported to be usable when linked with libpayload (patch pending).

Downloading and building libpayload

It is now in main coreboot git tree (see Download_coreboot for additional reference)

$ git clone http://review.coreboot.org/p/coreboot
$ cd payloads/libpayload
$ make menuconfig
$ make install

Here gerrit you can find pending patches for libpayload

Documentation

See the autogenerated documentation for libpayload here.

Libc coverage

Status Function/Macro/Variable
assert.h
no assert()
ctype.h
yes int isalnum(int character)
yes int isalpha(int character)
yes int isascii(int character)
yes int isblanc(int character)
yes int iscntrl(int character)
yes int isdigit(int character)
yes int isgraph(int character)
yes int islower(int character)
yes int isprint(int character)
yes int ispunct(int character)
yes int isspace(int character)
yes int isupper(int character)
yes int isxdigit(int character)
yes int tolower(int character)
yes int toupper(int character)
errno.h
no errno (global)
float.h
limits.h
locale.h
no char *setlocale(int category, const char *locale)
no struct lconv *localeconv(void)
math.h
no double exp(double x)
no double log(double x)
no double log10(double x)
no double pow(double x, double y)
no double sqrt(double x)
no double ceil(double x)
no double floor(double x)
no double fabs(double x)
no double ldexp(double x, int n)
no double frexp(double x, int* exp)
no double modf(double x, double* ip)
no double fmod(double x, double y)
no double sin(double x)
no double cos(double x)
no double tan(double x)
no double asin(double x)
no double acos(double x)
no double atan(double x)
no double atan2(double y, double x)
no double sinh(double x)
no double cosh(double x)
no double tanh(double x)
setjmp.h
no int setjmp(jmp_buf env)
no void longjmp(jmp_buf env, int val)
signal.h
no void (*signal(int sig, void (*handler)(int)))(int)
no int raise(int sig)
stdarg.h
no void va_start(va_list ap, lastarg)
no type va_arg(va_list ap, type)
no void va_end(va_list ap)
stddef.h
TODO
stdio.h
no FILE* fopen(const char* filename, const char* mode)
no FILE* freopen(const char* filename, const char* mode, FILE* stream)
no int fflush(FILE* stream)
no int fclose(FILE* stream)
no int remove(const char* filename)
no int rename(const char* oldname, const char* newname)
no FILE* tmpfile()
no char* tmpnam(char s[L_tmpnam])
no int setvbuf(FILE* stream, char* buf, int mode, size_t size)
no void setbuf(FILE* stream, char* buf)
no int fprintf(FILE* stream, const char* format, ...)
yes int printf(const char* format, ...)
yes int sprintf(char* s, const char* format, ...)
yes int snprintf(char* s, size_t size, const char* format, ...)
no int vfprintf(FILE* stream, const char* format, va_list arg)
yes int vprintf(const char* format, va_list arg)
yes int vsprintf(char* s, const char* format, va_list arg)
yes int vsnprintf(char* s, size_t size, const char* format, va_list arg)
no int fscanf(FILE* stream, const char* format, ...)
no int scanf(const char* format, ...)
no int sscanf(char* s, const char* format, ...)
no int fgetc(FILE* stream)
no char* fgets(char* s, int n, FILE* stream)
no int fputc(int c, FILE* stream)
no char* fputs(const char* s, FILE* stream)
no int getc(FILE* stream)
yes int getchar(void)
no char* gets(char* s)
no int putc(int c, FILE* stream)
yes int putchar(int c)
yes int puts(const char* s)
no int ungetc(int c, FILE* stream)
no size_t fread(void* ptr, size_t size, size_t nobj, FILE* stream)
no size_t fwrite(const void* ptr, size_t size, size_t nobj, FILE* stream)
no int fseek(FILE* stream, long offset, int origin)
no long ftell(FILE* stream)
no void rewind(FILE* stream)
no int fgetpos(FILE* stream, fpos_t* ptr)
no int fsetpos(FILE* stream, const fpos_t* ptr)
no void clearerr(FILE* stream)
no int feof(FILE* stream)
no int ferror(FILE* stream)
no void perror(const char* s)
Status Function/Macro/Variable
stdlib.h
yes int abs(int n)
yes long labs(long n)
yes long long llabs(long long n)
no div_t div(int num, int denom)
no ldiv_t ldiv(long num, long denom)
no double atof(const char* s)
no int atoi(const char* s)
no long atol(const char* s)
no double strtod(const char* s, char** endp)
no long strtol(const char* s, char** endp, int base)
yes unsigned long strtoul(const char* s, char** endp, int base)
yes void* calloc(size_t nobj, size_t size)
yes void* malloc(size_t size)
yes void* realloc(void* p, size_t size)
yes void free(void* p)
yes void * memalign (size_t align, size_t size)
yes void abort()
no void exit(int status)
no int atexit(void (*fcm)(void))
no int system(const char* s)
no char* getenv(const char* name)
no void* bsearch(const void* key, const void* base, size_t n,
size_t size, int (*cmp)(const void* keyval, const void* datum))
no void qsort(void* base, size_t n, size_t size,
int (*cmp)(const void*, const void*))
yes int rand(void)
yes void srand(unsigned int seed)
string.h
yes char* strcpy(char* s, const char* ct)
yes char* strncpy(char* s, const char* ct, size_t n)
no char* strcat(char* s, const char* ct)
yes char* strncat(char* s, const char* ct, size_t n)
yes int strcmp(const char* cs, const char* ct)
yes int strncmp(const char* cs, const char* ct, size_t n)
no int strcoll(const char* cs, const char* ct)
yes char* strchr(const char* cs, int c)
no char* strrchr(const char* cs, int c)
no size_t strspn(const char* cs, const char* ct)
no size_t strcspn(const char* cs, const char* ct)
no char* strpbrk(const char* cs, const char* ct)
yes char* strstr(const char* cs, const char* ct)
yes size_t strlen(const char* cs)
yes size_t strnlen(const char* cs, size_t maxlen)
yes char * strdup (const char *s)
no char* strerror(int n)
no char* strtok(char* s, const char* t)
no char* strtok_r(char* s, const char* t, char **p)
no size_t strxfrm(char* s, const char* ct, size_t n)
yes void* memcpy(void* s, const void* ct, size_t n)
yes void* memmove(void* s, const void* ct, size_t n)
yes int memcmp(const void* cs, const void* ct, size_t n)
no void* memchr(const void* cs, int c, size_t n)
yes void* memset(void* s, int c, size_t n)
time.h
no clock_t clock(void)
yes int gettimeofday (struct timeval *tv, void *tz)
no time_t time(time_t* tp)
no double difftime(time_t time2, time_t time1)
no time_t mktime(struct tm* tp)
no char* asctime(const struct tm* tp)
no char* ctime(const time_t* tp)
no struct tm* gmtime(const time_t* tp)
no struct tm* localtime(const time_t* tp)
no size_t strftime(char* s, size_t smax, const char* fmt,
const struct tm* tp)
unistd.h
yes int exec (long addr, int argc, char **argv)

Usage example

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");
    halt();
    return 0;
}

Building the payload:

$ lpgcc -o hello.elf hello.c


Public domain I, the copyright holder of this work, hereby release it into the public domain. This applies worldwide.

In case this is not legally possible:
I grant anyone the right to use this work for any purpose, without any conditions, unless such conditions are required by law.