2 * This file is part of the libpayload project.
4 * Copyright (C) 2008 Advanced Micro Devices, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * @section intro Introduction
34 * libpayload is a small BSD-licensed static library (a lightweight
35 * implementation of common and useful functions) intended to be used
36 * as a basis for coreboot payloads.
38 * @section example Example
39 * Here is an example of a very simple payload:
40 * @include sample/hello.c
47 #include <arch/types.h>
49 #include <arch/virtual.h>
55 #define MIN(a,b) ((a) < (b) ? (a) : (b))
56 #define MAX(a,b) ((a) > (b) ? (a) : (b))
57 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
59 #define LITTLE_ENDIAN 1234
60 #define BIG_ENDIAN 4321
62 #define EXIT_SUCCESS 0
63 #define EXIT_FAILURE 1
65 #define RAND_MAX 0x7fffffff
67 #define MAX_ARGC_COUNT 10
70 * Payload information parameters - these are used to pass information
71 * to the entity loading the payload.
72 * Usage: PAYLOAD_INFO(key, value)
73 * Example: PAYLOAD_INFO(name, "CoreInfo!")
75 #define _pstruct(key) __pinfo_ ##key
76 #define PAYLOAD_INFO(key, value) \
77 static const char _pstruct(key)[] \
78 __attribute__((__used__)) \
79 __attribute__((section(".note.pinfo"),unused)) = #key "=" value
82 * @defgroup nvram NVRAM and RTC functions
86 #define NVRAM_RTC_SECONDS 0 /**< RTC Seconds offset in CMOS */
87 #define NVRAM_RTC_MINUTES 2 /**< RTC Minutes offset in CMOS */
88 #define NVRAM_RTC_HOURS 4 /**< RTC Hours offset in CMOS */
89 #define NVRAM_RTC_DAY 7 /**< RTC Days offset in CMOS */
90 #define NVRAM_RTC_MONTH 8 /**< RTC Month offset in CMOS */
91 #define NVRAM_RTC_YEAR 9 /**< RTC Year offset in CMOS */
92 #define NVRAM_RTC_FREQ_SELECT 10 /**< RTC Update Status Register */
93 #define NVRAM_RTC_UIP 0x80
95 /** Broken down time structure */
97 int tm_sec; /**< Number of seconds after the minute */
98 int tm_min; /**< Number of minutes after the hour */
99 int tm_hour; /**< Number of hours past midnight */
100 int tm_mday; /**< The day of the month */
101 int tm_mon; /**< The month of the year */
102 int tm_year; /**< The number of years since 1900 */
103 int tm_wday; /**< The day of the week */
104 int tm_yday; /**< The number of days since January 1 */
105 int tm_isdst; /**< A flag indicating daylight savings time */
108 u8 nvram_read(u8 addr);
109 void nvram_write(u8 val, u8 addr);
110 int nvram_updating(void);
111 void rtc_read_clock(struct tm *tm);
115 * @defgroup usb USB functions
118 int usb_initialize(void);
119 int usbhid_havechar(void);
120 int usbhid_getchar(void);
124 * @defgroup input Device functions
129 * @defgroup keyboard Keyboard functions
133 void keyboard_init(void);
134 int keyboard_havechar(void);
135 unsigned char keyboard_get_scancode(void);
136 int keyboard_getchar(void);
137 int keyboard_set_layout(char *country);
138 int keyboard_add_reset_handler(void (*new_handler)(void));
142 * @defgroup serial Serial functions
146 void serial_init(void);
147 void serial_hardware_init(int port, int speed, int word_bits, int parity, int stop_bits);
148 void serial_putchar(unsigned char c);
149 int serial_havechar(void);
150 int serial_getchar(void);
151 void serial_clear(void);
152 void serial_start_bold(void);
153 void serial_end_bold(void);
154 void serial_start_reverse(void);
155 void serial_end_reverse(void);
156 void serial_start_altcharset(void);
157 void serial_end_altcharset(void);
158 void serial_set_color(short fg, short bg);
159 void serial_cursor_enable(int state);
160 void serial_set_cursor(int y, int x);
164 * @defgroup speaker Speaker functions
168 void speaker_enable(u16 freq);
169 void speaker_disable(void);
170 void speaker_tone(u16 freq, unsigned int duration);
174 * @defgroup video Video functions
178 int video_console_init(void);
179 void video_console_putchar(unsigned int ch);
180 void video_console_putc(u8 row, u8 col, unsigned int ch);
181 void video_console_clear(void);
182 void video_console_cursor_enable(int state);
183 void video_console_get_cursor(unsigned int *x, unsigned int *y, unsigned int *en);
184 void video_console_set_cursor(unsigned int cursorx, unsigned int cursory);
187 /* drivers/option.c */
188 int get_option(void *dest, char *name);
191 * @defgroup console Console functions
194 void console_init(void);
196 int puts(const char *s);
199 int getchar_timeout(int *ms);
201 extern int last_putchar;
203 #define havechar havekey
207 * @defgroup ctype Character type functions
228 * @defgroup ipchecksum IP checksum functions
231 unsigned short ipchksum(const void *ptr, unsigned long nbytes);
235 * @defgroup malloc Memory allocation functions
238 void free(void *ptr);
239 void *malloc(size_t size);
240 void *calloc(size_t nmemb, size_t size);
241 void *realloc(void *ptr, size_t size);
242 void *memalign(size_t align, size_t size);
246 * @defgroup exec Execution functions
249 int exec(long addr, int argc, char **argv);
253 * @defgroup misc Misc functions
259 long int labs(long int j);
260 long long int llabs(long long int j);
263 void fatal(const char *msg) __attribute__ ((noreturn));
267 * @defgroup memory Memory manipulation functions
270 void *memset(void *s, int c, size_t n);
271 void *memcpy(void *dst, const void *src, size_t n);
272 void *memmove(void *dst, const void *src, size_t n);
273 int memcmp(const void *s1, const void *s2, size_t len);
277 * @defgroup printf Print functions
280 int snprintf(char *str, size_t size, const char *fmt, ...);
281 int sprintf(char *str, const char *fmt, ...);
282 int vsnprintf(char *str, size_t size, const char *fmt, va_list ap);
283 int vsprintf(char *str, const char *fmt, va_list ap);
284 int printf(const char *fmt, ...);
285 int vprintf(const char *fmt, va_list ap);
289 * @defgroup rand Random number generator functions
292 int rand_r(unsigned int *seed);
294 void srand(unsigned int seed);
298 * @defgroup hash Hashing functions
301 #define SHA1_BLOCK_LENGTH 64
302 #define SHA1_DIGEST_LENGTH 20
306 u8 buffer[SHA1_BLOCK_LENGTH];
308 void SHA1Init(SHA1_CTX *context);
309 void SHA1Transform(u32 state[5], const u8 buffer[SHA1_BLOCK_LENGTH]);
310 void SHA1Update(SHA1_CTX *context, const u8 *data, size_t len);
311 void SHA1Final(u8 digest[SHA1_DIGEST_LENGTH], SHA1_CTX *context);
312 u8 *sha1(const u8 *data, size_t len, u8 *buf);
316 * @defgroup string String functions
319 size_t strnlen(const char *str, size_t maxlen);
320 size_t strlen(const char *str);
321 int strcmp(const char *s1, const char *s2);
322 int strncmp(const char *s1, const char *s2, size_t maxlen);
323 char *strncpy(char *d, const char *s, size_t n);
324 char *strcpy(char *d, const char *s);
325 char *strncat(char *d, const char *s, size_t n);
326 char *strchr(const char *s, int c);
327 char *strdup(const char *s);
328 char *strstr(const char *h, const char *n);
329 char *strsep(char **stringp, const char *delim);
333 * @defgroup time Time functions
337 /** System time structure */
339 time_t tv_sec; /**< Seconds */
340 suseconds_t tv_usec; /**< Microseconds */
343 int gettimeofday(struct timeval *tv, void *tz);
347 * @defgroup lar LAR functions
351 /** LAR file header */
353 void *start; /**< Location of the LAR in memory */
354 int cindex; /**< Next file to return in readlar() */
355 int count; /**< Number of entries in the header cache */
356 int alloc; /**< Number of slots in the header cache */
357 int eof; /**< Last entry in the header cache */
358 void **headers; /**< Pointer to the header cache */
361 /** A structure representing the next LAR entry */
363 u8 name[LAR_MAX_PATHLEN]; /**< The name of the next LAR entry */
366 /** A structure containing information about a LAR file */
368 u32 len; /**< Length of the file in the LAR */
369 u32 reallen; /**< Length of the uncompressed file */
370 u32 checksum; /**< Checksum of the uncompressed file */
371 u32 compchecksum; /**< Checksum of the compressed file in the LAR */
372 u32 offset; /**< Offset of the file in the LAR */
373 u32 compression; /**< Compression type of the file */
374 u64 entry; /**< Entry point of the file for executables */
375 u64 loadaddress; /**< Address in memory to put the uncompressed file */
378 /** A structure representing a LAR file */
380 struct LAR *lar; /**< Pointer to the LAR struct */
381 struct lar_header *header; /**< Pointer to the header struct */
382 u32 size; /**< Size of the file */
383 void *start; /**< Start of the file in memory */
384 u32 offset; /**< Offset of the file in the LAR */
387 struct LAR *openlar(void *addr);
388 int closelar(struct LAR *lar);
389 struct larent *readlar(struct LAR *lar);
390 void rewindlar(struct LAR *lar);
391 int larstat(struct LAR *lar, const char *path, struct larstat *buf);
392 void *larfptr(struct LAR *lar, const char *filename);
393 int lfverify(struct LAR *lar, const char *filename);
394 struct LFILE *lfopen(struct LAR *lar, const char *filename);
395 int lfread(void *ptr, size_t size, size_t nmemb, struct LFILE *stream);
397 #define SEEK_SET 0 /**< The seek offset is absolute. */
398 #define SEEK_CUR 1 /**< The seek offset is against the current position. */
399 #define SEEK_END 2 /**< The seek offset is against the end of the file. */
401 int lfseek(struct LFILE *stream, long offset, int whence);
402 int lfclose(struct LFILE *file);
406 * @defgroup arch Architecture specific functions
407 * This module contains global architecture specific functions.
408 * All architectures are expected to define these functions.
411 int get_coreboot_info(struct sysinfo_t *info);
412 int get_multiboot_info(struct sysinfo_t *info);
414 void lib_get_sysinfo(void);
416 /* Timer functions - defined by each architecture. */
417 unsigned int get_cpu_speed(void);
418 void ndelay(unsigned int n);
419 void udelay(unsigned int n);
420 void mdelay(unsigned int n);
421 void delay(unsigned int n);
423 #define abort() halt() /**< Alias for the halt() function */
426 * Stop execution and halt the processor (this function does not return).
428 void halt(void) __attribute__ ((noreturn));
432 * @defgroup readline Readline functions
433 * This interface provides a simple implementation of the standard readline()
434 * and getline() functions. They read a line of input from the console.
437 char *readline(const char *prompt);
438 int getline(char *buffer, int len);