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 #ifndef _LIBPAYLOAD_H
  31 #define _LIBPAYLOAD_H
  32
  33 #include <stddef.h>
  34 #include <arch/types.h>
  35 #include <arch/io.h>
  36 #include <sysinfo.h>
  37 #include <stdarg.h>
  38 #include <lar.h>
  39 #include <pci.h>
  40
  41 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  42 #define MAX(a,b) ((a) > (b) ? (a) : (b))
  43 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  44
  45 #define LITTLE_ENDIAN   1234
  46 #define BIG_ENDIAN      4321
  47 #ifdef CONFIG_TARGET_I386
  48 #define BYTE_ORDER      LITTLE_ENDIAN
  49 #else
  50 #define BYTE_ORDER      BIG_ENDIAN
  51 #endif
  52
  53 #define EXIT_SUCCESS 0
  54 #define EXIT_FAILURE 1
  55
  56 #define RAND_MAX 0x7fffffff
  57
  58 /* Payload information parameters - these are used to pass information
  59  * to the entity loading the payload
  60  * Usage:  PAYLOAD_INFO(key, value)
  61  * Example:  PAYLOAD_INFO(name, "CoreInfo!")
  62  */
  63
  64 #define _pstruct(key) __pinfo_ ##key
  65 #define PAYLOAD_INFO(key, value)                                        \
  66 static const char _pstruct(key)[]                                        \
  67   __attribute__((__used__))                                              \
  68   __attribute__((section(".note.pinfo"),unused)) = #key "=" value
  69
  70 /* Some NVRAM byte definitions */
  71 #define NVRAM_RTC_SECONDS        0
  72 #define NVRAM_RTC_MINUTES        2
  73 #define NVRAM_RTC_HOURS          4
  74 #define NVRAM_RTC_DAY            7
  75 #define NVRAM_RTC_MONTH          8
  76 #define NVRAM_RTC_YEAR           9
  77 #define NVRAM_RTC_FREQ_SELECT    10
  78 #define  NVRAM_RTC_UIP           0x80
  79
  80 struct tm {
  81         int tm_sec;
  82         int tm_min;
  83         int tm_hour;
  84         int tm_mday;
  85         int tm_mon;
  86         int tm_year;
  87         int tm_wday;
  88         int tm_yday;
  89         int tm_isdst;
  90 };
  91
  92 /* drivers/nvram.c */
  93 u8 nvram_read(u8 addr);
  94 void nvram_write(u8 val, u8 addr);
  95 int nvram_updating(void);
  96 void rtc_read_clock(struct tm *tm);
  97
  98 /* drivers/keyboard.c */
  99 void keyboard_init(void);
 100 int keyboard_havechar(void);
 101 unsigned char keyboard_get_scancode(void);
 102 int keyboard_getchar(void);
 103
 104 /* drivers/serial.c */
 105 void serial_init(void);
 106 void serial_putchar(unsigned char c);
 107 int serial_havechar(void);
 108 int serial_getchar(void);
 109
 110 void serial_clear(void);
 111 void serial_start_bold(void);
 112 void serial_end_bold(void);
 113 void serial_set_cursor(int y, int x);
 114
 115 /* drivers/speaker.c */
 116 void speaker_enable(u16 freq);
 117 void speaker_disable(void);
 118 void speaker_tone(u16 freq, unsigned int duration);
 119
 120 /* video/video.c */
 121 int video_console_init(void);
 122 void video_console_putchar(unsigned int ch);
 123 void video_console_putc(u8 row, u8 col, unsigned int ch);
 124 void video_console_clear(void);
 125 void video_console_cursor_enable(int state);
 126
 127 /* libc/console.c */
 128 void console_init(void);
 129 int putchar(int c);
 130 int puts(const char *s);
 131 int havekey(void);
 132 int getchar(void);
 133 int getchar_timeout(int *ms);
 134
 135 extern int last_putchar;
 136
 137 #define havechar havekey
 138
 139 /* libc/ctype.c */
 140 int isalnum(int c);
 141 int isalpha(int c);
 142 int isascii(int c);
 143 int isblank(int c);
 144 int iscntrl(int c);
 145 int isdigit(int c);
 146 int isgraph(int c);
 147 int islower(int c);
 148 int isprint(int c);
 149 int ispunct(int c);
 150 int isspace(int c);
 151 int isupper(int c);
 152 int isxdigit(int c);
 153 int tolower(int c);
 154 int toupper(int c);
 155
 156 /* libc/ipchecksum.c */
 157 unsigned short ipchksum(const unsigned short *ptr, unsigned long nbytes);
 158
 159 /* libc/malloc.c */
 160 void free(void *ptr);
 161 void *malloc(size_t size);
 162 void *calloc(size_t nmemb, size_t size);
 163 void *realloc(void *ptr, size_t size);
 164
 165 /* libc/exec.c */
 166 int exec(long addr, int argc, char **argv);
 167
 168 /* libc/lib.c */
 169 int bcd2dec(int b);
 170 int dec2bcd(int d);
 171 int abs(int j);
 172 long int labs(long int j);
 173 long long int llabs(long long int j);
 174 u8 bin2hex(u8 b);
 175 u8 hex2bin(u8 h);
 176
 177 /* libc/memory.c */
 178 void *memset(void *s, int c, size_t n);
 179 void *memcpy(void *dst, const void *src, size_t n);
 180 void *memmove(void *dst, const void *src, size_t n);
 181 int memcmp(const void *s1, const void *s2, size_t len);
 182
 183 /* libc/printf.c */
 184 int snprintf(char *str, size_t size, const char *fmt, ...);
 185 int sprintf(char *str, const char *fmt, ...);
 186 int vsnprintf(char *str, size_t size, const char *fmt, va_list ap);
 187 int vsprintf(char *str, const char *fmt, va_list ap);
 188 int printf(const char *fmt, ...);
 189 int vprintf(const char *fmt, va_list ap);
 190
 191 /* libc/rand.c */
 192 int rand_r(unsigned int *seed);
 193 int rand(void);
 194 void srand(unsigned int seed);
 195
 196 /* libc/sha1.c */
 197 #define SHA1_BLOCK_LENGTH       64
 198 #define SHA1_DIGEST_LENGTH      20
 199 typedef struct {
 200         u32 state[5];
 201         u64 count;
 202         u8 buffer[SHA1_BLOCK_LENGTH];
 203 } SHA1_CTX;
 204 void SHA1Init(SHA1_CTX *context);
 205 void SHA1Transform(u32 state[5], const u8 buffer[SHA1_BLOCK_LENGTH]);
 206 void SHA1Update(SHA1_CTX *context, const u8 *data, size_t len);
 207 void SHA1Final(u8 digest[SHA1_DIGEST_LENGTH], SHA1_CTX *context);
 208 u8 *sha1(const u8 *data, size_t len, u8 *buf);
 209
 210 /* libc/string.c */
 211 size_t strnlen(const char *str, size_t maxlen);
 212 size_t strlen(const char *str);
 213 int strcmp(const char *s1, const char *s2);
 214 int strncmp(const char *s1, const char *s2, int maxlen);
 215 char *strncpy(char *d, const char *s, int n);
 216 char *strcpy(char *d, const char *s);
 217 char *strncat(char *d, const char *s, int n);
 218 char *strchr(const char *s, int c);
 219 char *strdup(const char *s);
 220 char *strstr(const char *h, const char *n);
 221
 222 /* libc/time.c */
 223
 224 struct timeval {
 225         time_t tv_sec;
 226         suseconds_t tv_usec;
 227 };
 228
 229 int gettimeofday(struct timeval *tv, void *tz);
 230
 231 /* libc/lar.c */
 232
 233 struct LAR {
 234         void * start;
 235         int cindex;
 236         int count;
 237         int alloc;
 238         int eof;
 239         void **headers;
 240 };
 241
 242 struct larent {
 243         u8 name[LAR_MAX_PATHLEN];
 244 };
 245
 246 struct larstat {
 247         u32 len;
 248         u32 reallen;
 249         u32 checksum;
 250         u32 compchecksum;
 251         u32 offset;
 252         u32 compression;
 253         u64 entry;
 254         u64 loadaddress;
 255 };
 256
 257 struct LFILE {
 258         struct LAR *lar;
 259         struct lar_header *header;
 260         u32 size;
 261         void *start;
 262         u32 offset;
 263 };
 264
 265 struct LAR *openlar(void *addr);
 266 int closelar(struct LAR *lar);
 267 struct larent *readlar(struct LAR *lar);
 268 void rewindlar(struct LAR *lar);
 269 int larstat(struct LAR *lar, const char *path, struct larstat *buf);
 270 void *larfptr(struct LAR *lar, const char *filename);
 271 int lfverify(struct LAR *lar, const char *filename);
 272 struct LFILE * lfopen(struct LAR *lar, const char *filename);
 273 int lfread(void *ptr, size_t size, size_t nmemb, struct LFILE *stream);
 274
 275 #define SEEK_SET 0
 276 #define SEEK_CUR 1
 277 #define SEEK_END 2
 278
 279 int lfseek(struct LFILE *stream, long offset, int whence);
 280 int lfclose(struct LFILE *file);
 281
 282 /* i386/coreboot.c */
 283 int get_coreboot_info(struct sysinfo_t *info);
 284
 285 /* i386/sysinfo.c */
 286 void lib_get_sysinfo(void);
 287
 288 /* i386/timer.c */
 289 /* Timer functions - defined by each architecture. */
 290 unsigned int get_cpu_speed(void);
 291 void ndelay(unsigned int n);
 292 void udelay(unsigned int n);
 293 void mdelay(unsigned int n);
 294 void delay(unsigned int n);
 295
 296 /* i386/util.S */
 297 #define abort() halt()
 298 void halt(void) __attribute__ ((noreturn));
 299
 300 #endif