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 <autoconf.h>
  34 #include <stddef.h>
  35 #include <arch/types.h>
  36 #include <arch/io.h>
  37 #include <sysinfo.h>
  38 #include <stdarg.h>
  39
  40 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  41 #define MAX(a,b) ((a) > (b) ? (a) : (b))
  42 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  43
  44 #define BIN2HEX(b) ("0123456789abcdef"[b & 15])
  45 #define HEX2BIN(h) (('0' <= h && h <= '9') ? (h - '0') : \
  46                     ('a' <= h && h <= 'f') ? (h - 'a' + 10) : 0)
  47
  48 #define LITTLE_ENDIAN   1234
  49 #define BIG_ENDIAN      4321
  50 #ifdef CONFIG_TARGET_I386
  51 #define BYTE_ORDER      LITTLE_ENDIAN
  52 #else
  53 #define BYTE_ORDER      BIG_ENDIAN
  54 #endif
  55
  56 #define RAND_MAX 0x7fffffff
  57
  58 /* Some NVRAM byte definitions */
  59 #define NVRAM_RTC_SECONDS        0
  60 #define NVRAM_RTC_MINUTES        2
  61 #define NVRAM_RTC_HOURS          4
  62 #define NVRAM_RTC_DAY            7
  63 #define NVRAM_RTC_MONTH          8
  64 #define NVRAM_RTC_YEAR           9
  65
  66 /* drivers/nvram.c */
  67 u8 nvram_read(u8 addr);
  68 void nvram_write(u8 val, u8 addr);
  69
  70 /* drivers/keyboard.c */
  71 int keyboard_havechar(void);
  72 unsigned char keyboard_get_scancode(void);
  73 int keyboard_getchar(void);
  74
  75 /* drivers/serial.c */
  76 void serial_init(void);
  77 void serial_putchar(unsigned char c);
  78 int serial_havechar(void);
  79 int serial_getchar(void);
  80
  81 /* drivers/speaker.c */
  82 void speaker_enable(u16 freq);
  83 void speaker_disable(void);
  84 void speaker_tone(u16 freq, unsigned int duration);
  85
  86 /* video/video.c */
  87 int video_console_init(void);
  88 void video_console_putchar(unsigned int ch);
  89 void video_console_putc(u8 row, u8 col, unsigned int ch);
  90 void video_console_clear(void);
  91 void video_console_cursor_enable(int state);
  92
  93 /* libc/console.c */
  94 void console_init(void);
  95 int putchar(int c);
  96 int puts(const char *s);
  97 int havekey(void);
  98 int getchar(void);
  99 int getchar_timeout(int *ms);
 100
 101 extern int last_putchar;
 102
 103 #define havechar havekey
 104
 105 /* libc/ctype.c */
 106 int isspace(int c);
 107 int isdigit(int c);
 108 int tolower(int c);
 109
 110 /* libc/ipchecksum.c */
 111 unsigned short ipchksum(const unsigned short *ptr, unsigned long nbytes);
 112
 113 /* libc/malloc.c */
 114 void free(void *ptr);
 115 void *malloc(size_t size);
 116 void *calloc(size_t nmemb, size_t size);
 117 void *realloc(void *ptr, size_t size);
 118
 119 /* libc/lib.c */
 120 int bcd2dec(int b);
 121 int dec2bcd(int d);
 122
 123 /* libc/memory.c */
 124 void *memset(void *s, int c, size_t n);
 125 void *memcpy(void *dst, const void *src, size_t n);
 126 void *memmove(void *dst, const void *src, size_t n);
 127 int memcmp(const char *s1, const char *s2, size_t len);
 128
 129 /* libc/printf.c */
 130 int snprintf(char *str, size_t size, const char *fmt, ...);
 131 int sprintf(char *str, const char *fmt, ...);
 132 int vsnprintf(char *str, size_t size, const char *fmt, va_list ap);
 133 int vsprintf(char *str, const char *fmt, va_list ap);
 134 int printf(const char *fmt, ...);
 135 int vprintf(const char *fmt, va_list ap);
 136
 137 /* libc/rand.c */
 138 int rand_r(unsigned int *seed);
 139 int rand(void);
 140 void srand(unsigned int seed);
 141
 142 /* libc/sha1.c */
 143 #define SHA1_BLOCK_LENGTH       64
 144 #define SHA1_DIGEST_LENGTH      20
 145 typedef struct {
 146         u32 state[5];
 147         u64 count;
 148         u8 buffer[SHA1_BLOCK_LENGTH];
 149 } SHA1_CTX;
 150 void SHA1Init(SHA1_CTX *context);
 151 void SHA1Transform(u32 state[5], const u8 buffer[SHA1_BLOCK_LENGTH]);
 152 void SHA1Update(SHA1_CTX *context, const u8 *data, size_t len);
 153 void SHA1Final(u8 digest[SHA1_DIGEST_LENGTH], SHA1_CTX *context);
 154 u8 *sha1(const u8 *data, size_t len, u8 *buf);
 155
 156 /* libc/string.c */
 157 size_t strnlen(const char *str, size_t maxlen);
 158 size_t strlen(const char *str);
 159 int strcmp(const char *s1, const char *s2);
 160 int strncmp(const char *s1, const char *s2, int maxlen);
 161 char *strncpy(char *d, const char *s, int n);
 162 char *strcpy(char *d, const char *s);
 163 char *strncat(char *d, const char *s, int n);
 164 char *strchr(const char *s, int c);
 165 char *strdup(const char *s);
 166 char *strstr(const char *h, const char *n);
 167
 168 /* i386/coreboot.c */
 169 int get_coreboot_info(struct sysinfo_t *info);
 170
 171 /* i386/sysinfo.c */
 172 void lib_get_sysinfo(void);
 173
 174 /* i386/timer.c */
 175 /* Timer functions - defined by each architecture. */
 176 unsigned int get_cpu_speed(void);
 177 void ndelay(unsigned int n);
 178 void udelay(unsigned int n);
 179 void mdelay(unsigned int n);
 180 void delay(unsigned int n);
 181
 182 /* i386/util.S */
 183 #define abort() halt()
 184 void halt(void) __attribute__ ((noreturn));
 185
 186 #endif