payloads/libpayload/include/libpayload.h

   1 /*
   2  * This file is part of the libpayload project.
   3  *
   4  * Copyright (C) 2008 Advanced Micro Devices, Inc.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   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.
  16  *
  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
  27  * SUCH DAMAGE.
  28  */
  29
  30 /**
  31  * @mainpage
  32  *
  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.
  37  *
  38  * @section example Example
  39  * Here is an example of a very simple payload:
  40  * @include sample/hello.c
  41  */
  42
  43 #ifndef _LIBPAYLOAD_H
  44 #define _LIBPAYLOAD_H
  45
  46 #include <stddef.h>
  47 #include <arch/types.h>
  48 #include <arch/io.h>
  49 #include <arch/virtual.h>
  50 #include <sysinfo.h>
  51 #include <stdarg.h>
  52 #include <lar.h>
  53 #include <pci.h>
  54
  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]))
  58
  59 #define LITTLE_ENDIAN   1234
  60 #define BIG_ENDIAN      4321
  61
  62 #define EXIT_SUCCESS 0
  63 #define EXIT_FAILURE 1
  64
  65 #define RAND_MAX 0x7fffffff
  66
  67 /*
  68  * Payload information parameters - these are used to pass information
  69  * to the entity loading the payload.
  70  * Usage:   PAYLOAD_INFO(key, value)
  71  * Example: PAYLOAD_INFO(name, "CoreInfo!")
  72  */
  73 #define _pstruct(key) __pinfo_ ##key
  74 #define PAYLOAD_INFO(key, value)                                        \
  75 static const char _pstruct(key)[]                                        \
  76   __attribute__((__used__))                                              \
  77   __attribute__((section(".note.pinfo"),unused)) = #key "=" value
  78
  79 /**
  80  * @defgroup nvram NVRAM and RTC functions
  81  * @{
  82  */
  83
  84 #define NVRAM_RTC_SECONDS        0      /**< RTC Seconds offset in CMOS */
  85 #define NVRAM_RTC_MINUTES        2      /**< RTC Minutes offset in CMOS */
  86 #define NVRAM_RTC_HOURS          4      /**< RTC Hours offset in CMOS */
  87 #define NVRAM_RTC_DAY            7      /**< RTC Days offset in CMOS */
  88 #define NVRAM_RTC_MONTH          8      /**< RTC Month offset in CMOS */
  89 #define NVRAM_RTC_YEAR           9      /**< RTC Year offset in CMOS */
  90 #define NVRAM_RTC_FREQ_SELECT    10     /**< RTC Update Status Register */
  91 #define  NVRAM_RTC_UIP           0x80
  92
  93 /** Broken down time structure */
  94 struct tm {
  95         int tm_sec;   /**< Number of seconds after the minute */
  96         int tm_min;   /**< Number of minutes after the hour */
  97         int tm_hour;  /**< Number of hours past midnight */
  98         int tm_mday;  /**< The day of the month */
  99         int tm_mon;   /**< The month of the year */
 100         int tm_year;  /**< The number of years since 1900 */
 101         int tm_wday;  /**< The day of the week */
 102         int tm_yday;  /**< The number of days since January 1 */
 103         int tm_isdst; /**< A flag indicating daylight savings time */
 104 };
 105
 106 u8 nvram_read(u8 addr);
 107 void nvram_write(u8 val, u8 addr);
 108 int nvram_updating(void);
 109 void rtc_read_clock(struct tm *tm);
 110 /** @} */
 111
 112 /**
 113  * @defgroup input Device functions
 114  * @{ @}
 115  */
 116
 117 /**
 118  * @defgroup keyboard Keyboard functions
 119  * @ingroup input
 120  * @{
 121  */
 122 void keyboard_init(void);
 123 int keyboard_havechar(void);
 124 unsigned char keyboard_get_scancode(void);
 125 int keyboard_getchar(void);
 126 /** @} */
 127
 128 /**
 129  * @defgroup serial Serial functions
 130  * @ingroup input
 131  * @{
 132  */
 133 void serial_init(void);
 134 void serial_putchar(unsigned char c);
 135 int serial_havechar(void);
 136 int serial_getchar(void);
 137 void serial_clear(void);
 138 void serial_start_bold(void);
 139 void serial_end_bold(void);
 140 void serial_start_altcharset(void);
 141 void serial_end_altcharset(void);
 142 void serial_set_cursor(int y, int x);
 143 /** @} */
 144
 145 /**
 146  * @defgroup speaker Speaker functions
 147  * @ingroup input
 148  * @{
 149  */
 150 void speaker_enable(u16 freq);
 151 void speaker_disable(void);
 152 void speaker_tone(u16 freq, unsigned int duration);
 153 /** @} */
 154
 155 /**
 156  * @defgroup video Video functions
 157  * @ingroup input
 158  * @{
 159  */
 160 int video_console_init(void);
 161 void video_console_putchar(unsigned int ch);
 162 void video_console_putc(u8 row, u8 col, unsigned int ch);
 163 void video_console_clear(void);
 164 void video_console_cursor_enable(int state);
 165 void video_console_get_cursor(unsigned int *x, unsigned int *y, unsigned int *en);
 166 void video_console_set_cursor(unsigned int cursorx, unsigned int cursory);
 167 /** @} */
 168
 169 /* drivers/option.c */
 170 int get_option(void *dest, char *name);
 171
 172 /**
 173  * @defgroup console Console functions
 174  * @{
 175  */
 176 void console_init(void);
 177 int putchar(int c);
 178 int puts(const char *s);
 179 int havekey(void);
 180 int getchar(void);
 181 int getchar_timeout(int *ms);
 182
 183 extern int last_putchar;
 184
 185 #define havechar havekey
 186 /** @} */
 187
 188 /**
 189  * @defgroup ctype Character type functions
 190  * @{
 191  */
 192 int isalnum(int c);
 193 int isalpha(int c);
 194 int isascii(int c);
 195 int isblank(int c);
 196 int iscntrl(int c);
 197 int isdigit(int c);
 198 int isgraph(int c);
 199 int islower(int c);
 200 int isprint(int c);
 201 int ispunct(int c);
 202 int isspace(int c);
 203 int isupper(int c);
 204 int isxdigit(int c);
 205 int tolower(int c);
 206 int toupper(int c);
 207 /** @} */
 208
 209 /**
 210  * @defgroup ipchecksum IP checksum functions
 211  * @{
 212  */
 213 unsigned short ipchksum(const void *ptr, unsigned long nbytes);
 214 /** @} */
 215
 216 /**
 217  * @defgroup malloc Memory allocation functions
 218  * @{
 219  */
 220 void free(void *ptr);
 221 void *malloc(size_t size);
 222 void *calloc(size_t nmemb, size_t size);
 223 void *realloc(void *ptr, size_t size);
 224 /** @} */
 225
 226 /**
 227  * @defgroup exec Execution functions
 228  * @{
 229  */
 230 int exec(long addr, int argc, char **argv);
 231 /** @} */
 232
 233 /**
 234  * @defgroup misc Misc functions
 235  * @{
 236  */
 237 int bcd2dec(int b);
 238 int dec2bcd(int d);
 239 int abs(int j);
 240 long int labs(long int j);
 241 long long int llabs(long long int j);
 242 u8 bin2hex(u8 b);
 243 u8 hex2bin(u8 h);
 244 void fatal(const char *msg) __attribute__ ((noreturn));
 245 /** @} */
 246
 247 /**
 248  * @defgroup memory Memory manipulation functions
 249  * @{
 250  */
 251 void *memset(void *s, int c, size_t n);
 252 void *memcpy(void *dst, const void *src, size_t n);
 253 void *memmove(void *dst, const void *src, size_t n);
 254 int memcmp(const void *s1, const void *s2, size_t len);
 255 /** @} */
 256
 257 /**
 258  * @defgroup printf Print functions
 259  * @{
 260  */
 261 int snprintf(char *str, size_t size, const char *fmt, ...);
 262 int sprintf(char *str, const char *fmt, ...);
 263 int vsnprintf(char *str, size_t size, const char *fmt, va_list ap);
 264 int vsprintf(char *str, const char *fmt, va_list ap);
 265 int printf(const char *fmt, ...);
 266 int vprintf(const char *fmt, va_list ap);
 267 /** @} */
 268
 269 /**
 270  * @defgroup rand Random number generator functions
 271  * @{
 272  */
 273 int rand_r(unsigned int *seed);
 274 int rand(void);
 275 void srand(unsigned int seed);
 276 /** @} */
 277
 278 /**
 279  * @defgroup hash Hashing functions
 280  * @{
 281  */
 282 #define SHA1_BLOCK_LENGTH       64
 283 #define SHA1_DIGEST_LENGTH      20
 284 typedef struct {
 285         u32 state[5];
 286         u64 count;
 287         u8 buffer[SHA1_BLOCK_LENGTH];
 288 } SHA1_CTX;
 289 void SHA1Init(SHA1_CTX *context);
 290 void SHA1Transform(u32 state[5], const u8 buffer[SHA1_BLOCK_LENGTH]);
 291 void SHA1Update(SHA1_CTX *context, const u8 *data, size_t len);
 292 void SHA1Final(u8 digest[SHA1_DIGEST_LENGTH], SHA1_CTX *context);
 293 u8 *sha1(const u8 *data, size_t len, u8 *buf);
 294 /** @} */
 295
 296 /**
 297  * @defgroup string String functions
 298  * @{
 299  */
 300 size_t strnlen(const char *str, size_t maxlen);
 301 size_t strlen(const char *str);
 302 int strcmp(const char *s1, const char *s2);
 303 int strncmp(const char *s1, const char *s2, size_t maxlen);
 304 char *strncpy(char *d, const char *s, size_t n);
 305 char *strcpy(char *d, const char *s);
 306 char *strncat(char *d, const char *s, size_t n);
 307 char *strchr(const char *s, int c);
 308 char *strdup(const char *s);
 309 char *strstr(const char *h, const char *n);
 310 /** @} */
 311
 312 /**
 313  * @defgroup time Time functions
 314  * @{
 315  */
 316
 317 /** System time structure */
 318 struct timeval {
 319         time_t tv_sec;       /**< Seconds */
 320         suseconds_t tv_usec; /**< Microseconds */
 321 };
 322
 323 int gettimeofday(struct timeval *tv, void *tz);
 324 /** @} */
 325
 326 /**
 327  * @defgroup lar LAR functions
 328  * @{
 329  */
 330
 331 /** LAR file header */
 332 struct LAR {
 333         void *start;    /**< Location of the LAR in memory */
 334         int cindex;     /**< Next file to return in readlar() */
 335         int count;      /**< Number of entries in the header cache */
 336         int alloc;      /**< Number of slots in the header cache */
 337         int eof;        /**< Last entry in the header cache */
 338         void **headers; /**< Pointer to the header cache */
 339 };
 340
 341 /** A structure representing the next LAR entry */
 342 struct larent {
 343         u8 name[LAR_MAX_PATHLEN]; /**< The name of the next LAR entry */
 344 };
 345
 346 /** A structure containing information about a LAR file */
 347 struct larstat {
 348         u32 len;           /**< Length of the file in the LAR */
 349         u32 reallen;       /**< Length of the uncompressed file */
 350         u32 checksum;      /**< Checksum of the uncompressed file */
 351         u32 compchecksum;  /**< Checksum of the compressed file in the LAR */
 352         u32 offset;        /**< Offset of the file in the LAR */
 353         u32 compression;   /**< Compression type of the file */
 354         u64 entry;         /**< Entry point of the file for executables */
 355         u64 loadaddress;   /**< Address in memory to put the uncompressed file */
 356 };
 357
 358 /** A structure representing a LAR file */
 359 struct LFILE {
 360         struct LAR *lar;           /**< Pointer to the LAR struct */
 361         struct lar_header *header; /**< Pointer to the header struct */
 362         u32 size;                  /**< Size of the file */
 363         void *start;               /**< Start of the file in memory */
 364         u32 offset;                /**< Offset of the file in the LAR */
 365 };
 366
 367 struct LAR *openlar(void *addr);
 368 int closelar(struct LAR *lar);
 369 struct larent *readlar(struct LAR *lar);
 370 void rewindlar(struct LAR *lar);
 371 int larstat(struct LAR *lar, const char *path, struct larstat *buf);
 372 void *larfptr(struct LAR *lar, const char *filename);
 373 int lfverify(struct LAR *lar, const char *filename);
 374 struct LFILE *lfopen(struct LAR *lar, const char *filename);
 375 int lfread(void *ptr, size_t size, size_t nmemb, struct LFILE *stream);
 376
 377 #define SEEK_SET 0 /**< The seek offset is absolute. */
 378 #define SEEK_CUR 1 /**< The seek offset is against the current position. */
 379 #define SEEK_END 2 /**< The seek offset is against the end of the file. */
 380
 381 int lfseek(struct LFILE *stream, long offset, int whence);
 382 int lfclose(struct LFILE *file);
 383 /** @} */
 384
 385 /**
 386  * @defgroup arch Architecture specific functions
 387  * This module contains global architecture specific functions.
 388  * All architectures are expected to define these functions.
 389  * @{
 390  */
 391 int get_coreboot_info(struct sysinfo_t *info);
 392
 393 void lib_get_sysinfo(void);
 394
 395 /* Timer functions - defined by each architecture. */
 396 unsigned int get_cpu_speed(void);
 397 void ndelay(unsigned int n);
 398 void udelay(unsigned int n);
 399 void mdelay(unsigned int n);
 400 void delay(unsigned int n);
 401
 402 #define abort() halt()    /**< Alias for the halt() function */
 403
 404 /**
 405  * Stop execution and halt the processor (this function does not return).
 406  */
 407 void halt(void) __attribute__ ((noreturn));
 408 /** @} */
 409
 410 /**
 411  * @defgroup readline Readline functions
 412  * This interface provides a simple implementation of the standard readline()
 413  * and getline() functions. They read a line of input from the console.
 414  * @{
 415  */
 416 char *readline(const char *prompt);
 417 int getline(char *buffer, int len);
 418 /** @} */
 419
 420 #endif