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