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_color(short fg, short bg);
 143 void serial_set_cursor(int y, int x);
 144 /** @} */
 145
 146 /**
 147  * @defgroup speaker Speaker functions
 148  * @ingroup input
 149  * @{
 150  */
 151 void speaker_enable(u16 freq);
 152 void speaker_disable(void);
 153 void speaker_tone(u16 freq, unsigned int duration);
 154 /** @} */
 155
 156 /**
 157  * @defgroup video Video functions
 158  * @ingroup input
 159  * @{
 160  */
 161 int video_console_init(void);
 162 void video_console_putchar(unsigned int ch);
 163 void video_console_putc(u8 row, u8 col, unsigned int ch);
 164 void video_console_clear(void);
 165 void video_console_cursor_enable(int state);
 166 void video_console_get_cursor(unsigned int *x, unsigned int *y, unsigned int *en);
 167 void video_console_set_cursor(unsigned int cursorx, unsigned int cursory);
 168 /** @} */
 169
 170 /* drivers/option.c */
 171 int get_option(void *dest, char *name);
 172
 173 /**
 174  * @defgroup console Console functions
 175  * @{
 176  */
 177 void console_init(void);
 178 int putchar(int c);
 179 int puts(const char *s);
 180 int havekey(void);
 181 int getchar(void);
 182 int getchar_timeout(int *ms);
 183
 184 extern int last_putchar;
 185
 186 #define havechar havekey
 187 /** @} */
 188
 189 /**
 190  * @defgroup ctype Character type functions
 191  * @{
 192  */
 193 int isalnum(int c);
 194 int isalpha(int c);
 195 int isascii(int c);
 196 int isblank(int c);
 197 int iscntrl(int c);
 198 int isdigit(int c);
 199 int isgraph(int c);
 200 int islower(int c);
 201 int isprint(int c);
 202 int ispunct(int c);
 203 int isspace(int c);
 204 int isupper(int c);
 205 int isxdigit(int c);
 206 int tolower(int c);
 207 int toupper(int c);
 208 /** @} */
 209
 210 /**
 211  * @defgroup ipchecksum IP checksum functions
 212  * @{
 213  */
 214 unsigned short ipchksum(const void *ptr, unsigned long nbytes);
 215 /** @} */
 216
 217 /**
 218  * @defgroup malloc Memory allocation functions
 219  * @{
 220  */
 221 void free(void *ptr);
 222 void *malloc(size_t size);
 223 void *calloc(size_t nmemb, size_t size);
 224 void *realloc(void *ptr, size_t size);
 225 void *memalign(size_t align, size_t size);
 226 /** @} */
 227
 228 /**
 229  * @defgroup exec Execution functions
 230  * @{
 231  */
 232 int exec(long addr, int argc, char **argv);
 233 /** @} */
 234
 235 /**
 236  * @defgroup misc Misc functions
 237  * @{
 238  */
 239 int bcd2dec(int b);
 240 int dec2bcd(int d);
 241 int abs(int j);
 242 long int labs(long int j);
 243 long long int llabs(long long int j);
 244 u8 bin2hex(u8 b);
 245 u8 hex2bin(u8 h);
 246 void fatal(const char *msg) __attribute__ ((noreturn));
 247 /** @} */
 248
 249 /**
 250  * @defgroup memory Memory manipulation functions
 251  * @{
 252  */
 253 void *memset(void *s, int c, size_t n);
 254 void *memcpy(void *dst, const void *src, size_t n);
 255 void *memmove(void *dst, const void *src, size_t n);
 256 int memcmp(const void *s1, const void *s2, size_t len);
 257 /** @} */
 258
 259 /**
 260  * @defgroup printf Print functions
 261  * @{
 262  */
 263 int snprintf(char *str, size_t size, const char *fmt, ...);
 264 int sprintf(char *str, const char *fmt, ...);
 265 int vsnprintf(char *str, size_t size, const char *fmt, va_list ap);
 266 int vsprintf(char *str, const char *fmt, va_list ap);
 267 int printf(const char *fmt, ...);
 268 int vprintf(const char *fmt, va_list ap);
 269 /** @} */
 270
 271 /**
 272  * @defgroup rand Random number generator functions
 273  * @{
 274  */
 275 int rand_r(unsigned int *seed);
 276 int rand(void);
 277 void srand(unsigned int seed);
 278 /** @} */
 279
 280 /**
 281  * @defgroup hash Hashing functions
 282  * @{
 283  */
 284 #define SHA1_BLOCK_LENGTH       64
 285 #define SHA1_DIGEST_LENGTH      20
 286 typedef struct {
 287         u32 state[5];
 288         u64 count;
 289         u8 buffer[SHA1_BLOCK_LENGTH];
 290 } SHA1_CTX;
 291 void SHA1Init(SHA1_CTX *context);
 292 void SHA1Transform(u32 state[5], const u8 buffer[SHA1_BLOCK_LENGTH]);
 293 void SHA1Update(SHA1_CTX *context, const u8 *data, size_t len);
 294 void SHA1Final(u8 digest[SHA1_DIGEST_LENGTH], SHA1_CTX *context);
 295 u8 *sha1(const u8 *data, size_t len, u8 *buf);
 296 /** @} */
 297
 298 /**
 299  * @defgroup string String functions
 300  * @{
 301  */
 302 size_t strnlen(const char *str, size_t maxlen);
 303 size_t strlen(const char *str);
 304 int strcmp(const char *s1, const char *s2);
 305 int strncmp(const char *s1, const char *s2, size_t maxlen);
 306 char *strncpy(char *d, const char *s, size_t n);
 307 char *strcpy(char *d, const char *s);
 308 char *strncat(char *d, const char *s, size_t n);
 309 char *strchr(const char *s, int c);
 310 char *strdup(const char *s);
 311 char *strstr(const char *h, const char *n);
 312 /** @} */
 313
 314 /**
 315  * @defgroup time Time functions
 316  * @{
 317  */
 318
 319 /** System time structure */
 320 struct timeval {
 321         time_t tv_sec;       /**< Seconds */
 322         suseconds_t tv_usec; /**< Microseconds */
 323 };
 324
 325 int gettimeofday(struct timeval *tv, void *tz);
 326 /** @} */
 327
 328 /**
 329  * @defgroup lar LAR functions
 330  * @{
 331  */
 332
 333 /** LAR file header */
 334 struct LAR {
 335         void *start;    /**< Location of the LAR in memory */
 336         int cindex;     /**< Next file to return in readlar() */
 337         int count;      /**< Number of entries in the header cache */
 338         int alloc;      /**< Number of slots in the header cache */
 339         int eof;        /**< Last entry in the header cache */
 340         void **headers; /**< Pointer to the header cache */
 341 };
 342
 343 /** A structure representing the next LAR entry */
 344 struct larent {
 345         u8 name[LAR_MAX_PATHLEN]; /**< The name of the next LAR entry */
 346 };
 347
 348 /** A structure containing information about a LAR file */
 349 struct larstat {
 350         u32 len;           /**< Length of the file in the LAR */
 351         u32 reallen;       /**< Length of the uncompressed file */
 352         u32 checksum;      /**< Checksum of the uncompressed file */
 353         u32 compchecksum;  /**< Checksum of the compressed file in the LAR */
 354         u32 offset;        /**< Offset of the file in the LAR */
 355         u32 compression;   /**< Compression type of the file */
 356         u64 entry;         /**< Entry point of the file for executables */
 357         u64 loadaddress;   /**< Address in memory to put the uncompressed file */
 358 };
 359
 360 /** A structure representing a LAR file */
 361 struct LFILE {
 362         struct LAR *lar;           /**< Pointer to the LAR struct */
 363         struct lar_header *header; /**< Pointer to the header struct */
 364         u32 size;                  /**< Size of the file */
 365         void *start;               /**< Start of the file in memory */
 366         u32 offset;                /**< Offset of the file in the LAR */
 367 };
 368
 369 struct LAR *openlar(void *addr);
 370 int closelar(struct LAR *lar);
 371 struct larent *readlar(struct LAR *lar);
 372 void rewindlar(struct LAR *lar);
 373 int larstat(struct LAR *lar, const char *path, struct larstat *buf);
 374 void *larfptr(struct LAR *lar, const char *filename);
 375 int lfverify(struct LAR *lar, const char *filename);
 376 struct LFILE *lfopen(struct LAR *lar, const char *filename);
 377 int lfread(void *ptr, size_t size, size_t nmemb, struct LFILE *stream);
 378
 379 #define SEEK_SET 0 /**< The seek offset is absolute. */
 380 #define SEEK_CUR 1 /**< The seek offset is against the current position. */
 381 #define SEEK_END 2 /**< The seek offset is against the end of the file. */
 382
 383 int lfseek(struct LFILE *stream, long offset, int whence);
 384 int lfclose(struct LFILE *file);
 385 /** @} */
 386
 387 /**
 388  * @defgroup arch Architecture specific functions
 389  * This module contains global architecture specific functions.
 390  * All architectures are expected to define these functions.
 391  * @{
 392  */
 393 int get_coreboot_info(struct sysinfo_t *info);
 394
 395 void lib_get_sysinfo(void);
 396
 397 /* Timer functions - defined by each architecture. */
 398 unsigned int get_cpu_speed(void);
 399 void ndelay(unsigned int n);
 400 void udelay(unsigned int n);
 401 void mdelay(unsigned int n);
 402 void delay(unsigned int n);
 403
 404 #define abort() halt()    /**< Alias for the halt() function */
 405
 406 /**
 407  * Stop execution and halt the processor (this function does not return).
 408  */
 409 void halt(void) __attribute__ ((noreturn));
 410 /** @} */
 411
 412 /**
 413  * @defgroup readline Readline functions
 414  * This interface provides a simple implementation of the standard readline()
 415  * and getline() functions. They read a line of input from the console.
 416  * @{
 417  */
 418 char *readline(const char *prompt);
 419 int getline(char *buffer, int len);
 420 /** @} */
 421
 422 #endif