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 <libpayload-config.h>
  47 #include <ctype.h>
  48 #include <stddef.h>
  49 #include <stdio.h>
  50 #include <stdarg.h>
  51 #include <stdlib.h>
  52 #include <string.h>
  53 #include <arch/types.h>
  54 #include <arch/io.h>
  55 #include <arch/virtual.h>
  56 #include <sysinfo.h>
  57 #include <pci.h>
  58 #ifdef CONFIG_LAR
  59 #include <lar.h>
  60 #endif
  61
  62 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  63 #define MAX(a,b) ((a) > (b) ? (a) : (b))
  64 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  65
  66 #define LITTLE_ENDIAN   1234
  67 #define BIG_ENDIAN      4321
  68
  69 #define EXIT_SUCCESS 0
  70 #define EXIT_FAILURE 1
  71
  72 #define RAND_MAX 0x7fffffff
  73
  74 #define MAX_ARGC_COUNT 10
  75
  76 /*
  77  * Payload information parameters - these are used to pass information
  78  * to the entity loading the payload.
  79  * Usage:   PAYLOAD_INFO(key, value)
  80  * Example: PAYLOAD_INFO(name, "CoreInfo!")
  81  */
  82 #define _pstruct(key) __pinfo_ ##key
  83 #define PAYLOAD_INFO(key, value)                                        \
  84 static const char _pstruct(key)[]                                        \
  85   __attribute__((__used__))                                              \
  86   __attribute__((section(".note.pinfo"),unused)) = #key "=" value
  87
  88 /**
  89  * @defgroup nvram NVRAM and RTC functions
  90  * @{
  91  */
  92
  93 #define NVRAM_RTC_SECONDS        0      /**< RTC Seconds offset in CMOS */
  94 #define NVRAM_RTC_MINUTES        2      /**< RTC Minutes offset in CMOS */
  95 #define NVRAM_RTC_HOURS          4      /**< RTC Hours offset in CMOS */
  96 #define NVRAM_RTC_DAY            7      /**< RTC Days offset in CMOS */
  97 #define NVRAM_RTC_MONTH          8      /**< RTC Month offset in CMOS */
  98 #define NVRAM_RTC_YEAR           9      /**< RTC Year offset in CMOS */
  99 #define NVRAM_RTC_FREQ_SELECT    10     /**< RTC Update Status Register */
 100 #define  NVRAM_RTC_UIP           0x80
 101
 102 /** Broken down time structure */
 103 struct tm {
 104         int tm_sec;   /**< Number of seconds after the minute */
 105         int tm_min;   /**< Number of minutes after the hour */
 106         int tm_hour;  /**< Number of hours past midnight */
 107         int tm_mday;  /**< The day of the month */
 108         int tm_mon;   /**< The month of the year */
 109         int tm_year;  /**< The number of years since 1900 */
 110         int tm_wday;  /**< The day of the week */
 111         int tm_yday;  /**< The number of days since January 1 */
 112         int tm_isdst; /**< A flag indicating daylight savings time */
 113 };
 114
 115 u8 nvram_read(u8 addr);
 116 void nvram_write(u8 val, u8 addr);
 117 int nvram_updating(void);
 118 void rtc_read_clock(struct tm *tm);
 119 /** @} */
 120
 121 /**
 122  * @defgroup usb USB functions
 123  * @{
 124  */
 125 int usb_initialize(void);
 126 int usbhid_havechar(void);
 127 int usbhid_getchar(void);
 128 /** @} */
 129
 130 /**
 131  * @defgroup input Device functions
 132  * @{ @}
 133  */
 134
 135 extern void (*reset_handler)(void);
 136 int add_reset_handler(void (*new_handler)(void));
 137
 138 /**
 139  * @defgroup keyboard Keyboard functions
 140  * @ingroup input
 141  * @{
 142  */
 143 void keyboard_init(void);
 144 int keyboard_havechar(void);
 145 unsigned char keyboard_get_scancode(void);
 146 int keyboard_getchar(void);
 147 int keyboard_set_layout(char *country);
 148 /** @} */
 149
 150 /**
 151  * @defgroup serial Serial functions
 152  * @ingroup input
 153  * @{
 154  */
 155 void serial_init(void);
 156 void serial_putchar(unsigned int c);
 157 int serial_havechar(void);
 158 int serial_getchar(void);
 159 void serial_clear(void);
 160 void serial_start_bold(void);
 161 void serial_end_bold(void);
 162 void serial_start_reverse(void);
 163 void serial_end_reverse(void);
 164 void serial_start_altcharset(void);
 165 void serial_end_altcharset(void);
 166 void serial_set_color(short fg, short bg);
 167 void serial_cursor_enable(int state);
 168 void serial_set_cursor(int y, int x);
 169 /** @} */
 170
 171 /**
 172  * @defgroup speaker Speaker functions
 173  * @ingroup input
 174  * @{
 175  */
 176 void speaker_enable(u16 freq);
 177 void speaker_disable(void);
 178 void speaker_tone(u16 freq, unsigned int duration);
 179 /** @} */
 180
 181 /**
 182  * @defgroup video Video functions
 183  * @ingroup input
 184  * @{
 185  */
 186 int video_console_init(void);
 187 void video_console_putchar(unsigned int ch);
 188 void video_console_putc(u8 row, u8 col, unsigned int ch);
 189 void video_console_clear(void);
 190 void video_console_cursor_enable(int state);
 191 void video_console_get_cursor(unsigned int *x, unsigned int *y, unsigned int *en);
 192 void video_console_set_cursor(unsigned int cursorx, unsigned int cursory);
 193 /** @} */
 194
 195 /* drivers/option.c */
 196 void fix_options_checksum(void);
 197 int get_option(void *dest, char *name);
 198
 199 /**
 200  * @defgroup console Console functions
 201  * @{
 202  */
 203 void console_init(void);
 204 int putchar(unsigned int c);
 205 int puts(const char *s);
 206 int havekey(void);
 207 int getchar(void);
 208 int getchar_timeout(int *ms);
 209
 210 extern int last_putchar;
 211
 212 struct console_input_driver;
 213 struct console_input_driver {
 214         struct console_input_driver *next;
 215         int (*havekey) (void);
 216         int (*getchar) (void);
 217 };
 218
 219 struct console_output_driver;
 220 struct console_output_driver {
 221         struct console_output_driver *next;
 222         void (*putchar) (unsigned int);
 223 };
 224
 225 void console_add_output_driver(struct console_output_driver *out);
 226 void console_add_input_driver(struct console_input_driver *in);
 227
 228 #define havechar havekey
 229 /** @} */
 230
 231 /**
 232  * @defgroup ipchecksum IP checksum functions
 233  * @{
 234  */
 235 unsigned short ipchksum(const void *ptr, unsigned long nbytes);
 236 /** @} */
 237
 238
 239 /**
 240  * @defgroup exec Execution functions
 241  * @{
 242  */
 243 int exec(long addr, int argc, char **argv);
 244 /** @} */
 245
 246 /**
 247  * @defgroup misc Misc functions
 248  * @{
 249  */
 250 int bcd2dec(int b);
 251 int dec2bcd(int d);
 252 int abs(int j);
 253 long int labs(long int j);
 254 long long int llabs(long long int j);
 255 u8 bin2hex(u8 b);
 256 u8 hex2bin(u8 h);
 257 void fatal(const char *msg) __attribute__ ((noreturn));
 258 /** @} */
 259
 260
 261 /**
 262  * @defgroup hash Hashing functions
 263  * @{
 264  */
 265 #define SHA1_BLOCK_LENGTH       64
 266 #define SHA1_DIGEST_LENGTH      20
 267 typedef struct {
 268         u32 state[5];
 269         u64 count;
 270         u8 buffer[SHA1_BLOCK_LENGTH];
 271 } SHA1_CTX;
 272 void SHA1Init(SHA1_CTX *context);
 273 void SHA1Transform(u32 state[5], const u8 buffer[SHA1_BLOCK_LENGTH]);
 274 void SHA1Update(SHA1_CTX *context, const u8 *data, size_t len);
 275 void SHA1Pad(SHA1_CTX *context);
 276 void SHA1Final(u8 digest[SHA1_DIGEST_LENGTH], SHA1_CTX *context);
 277 u8 *sha1(const u8 *data, size_t len, u8 *buf);
 278 /** @} */
 279
 280 /**
 281  * @defgroup time Time functions
 282  * @{
 283  */
 284
 285 /** System time structure */
 286 struct timeval {
 287         time_t tv_sec;       /**< Seconds */
 288         suseconds_t tv_usec; /**< Microseconds */
 289 };
 290
 291 int gettimeofday(struct timeval *tv, void *tz);
 292 /** @} */
 293
 294 #ifdef CONFIG_LAR
 295 /**
 296  * @defgroup lar LAR functions
 297  * @{
 298  */
 299
 300 /** LAR file header */
 301 struct LAR {
 302         void *start;    /**< Location of the LAR in memory */
 303         int cindex;     /**< Next file to return in readlar() */
 304         int count;      /**< Number of entries in the header cache */
 305         int alloc;      /**< Number of slots in the header cache */
 306         int eof;        /**< Last entry in the header cache */
 307         void **headers; /**< Pointer to the header cache */
 308 };
 309
 310 /** A structure representing the next LAR entry */
 311 struct larent {
 312         u8 name[LAR_MAX_PATHLEN]; /**< The name of the next LAR entry */
 313 };
 314
 315 /** A structure containing information about a LAR file */
 316 struct larstat {
 317         u32 len;           /**< Length of the file in the LAR */
 318         u32 reallen;       /**< Length of the uncompressed file */
 319         u32 checksum;      /**< Checksum of the uncompressed file */
 320         u32 compchecksum;  /**< Checksum of the compressed file in the LAR */
 321         u32 offset;        /**< Offset of the file in the LAR */
 322         u32 compression;   /**< Compression type of the file */
 323         u64 entry;         /**< Entry point of the file for executables */
 324         u64 loadaddress;   /**< Address in memory to put the uncompressed file */
 325 };
 326
 327 /** A structure representing a LAR file */
 328 struct LFILE {
 329         struct LAR *lar;           /**< Pointer to the LAR struct */
 330         struct lar_header *header; /**< Pointer to the header struct */
 331         u32 size;                  /**< Size of the file */
 332         void *start;               /**< Start of the file in memory */
 333         u32 offset;                /**< Offset of the file in the LAR */
 334 };
 335
 336 struct LAR *openlar(void *addr);
 337 int closelar(struct LAR *lar);
 338 struct larent *readlar(struct LAR *lar);
 339 void rewindlar(struct LAR *lar);
 340 int larstat(struct LAR *lar, const char *path, struct larstat *buf);
 341 void *larfptr(struct LAR *lar, const char *filename);
 342 int lfverify(struct LAR *lar, const char *filename);
 343 struct LFILE *lfopen(struct LAR *lar, const char *filename);
 344 int lfread(void *ptr, size_t size, size_t nmemb, struct LFILE *stream);
 345
 346 int lfseek(struct LFILE *stream, long offset, int whence);
 347 int lfclose(struct LFILE *file);
 348 /** @} */
 349 #endif
 350
 351 /**
 352  * @defgroup info System information functions
 353  * This module contains functions that return information about the system
 354  * @{
 355  */
 356
 357 int sysinfo_have_multiboot(unsigned long *addr);
 358 /** @} */
 359
 360 /**
 361  * @defgroup arch Architecture specific functions
 362  * This module contains global architecture specific functions.
 363  * All architectures are expected to define these functions.
 364  * @{
 365  */
 366 int get_coreboot_info(struct sysinfo_t *info);
 367 int get_multiboot_info(struct sysinfo_t *info);
 368
 369 void lib_get_sysinfo(void);
 370
 371 /* Timer functions - defined by each architecture. */
 372 unsigned int get_cpu_speed(void);
 373 void ndelay(unsigned int n);
 374 void udelay(unsigned int n);
 375 void mdelay(unsigned int n);
 376 void delay(unsigned int n);
 377
 378 /**
 379  * @defgroup readline Readline functions
 380  * This interface provides a simple implementation of the standard readline()
 381  * and getline() functions. They read a line of input from the console.
 382  * @{
 383  */
 384 char *readline(const char *prompt);
 385 int getline(char *buffer, int len);
 386 /** @} */
 387
 388 #endif