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