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 LITTLE_ENDIAN   1234
  45 #define BIG_ENDIAN      4321
  46 #ifdef CONFIG_TARGET_I386
  47 #define BYTE_ORDER      LITTLE_ENDIAN
  48 #else
  49 #define BYTE_ORDER      BIG_ENDIAN
  50 #endif
  51
  52 /* Some NVRAM byte definitions */
  53 #define NVRAM_RTC_SECONDS        0
  54 #define NVRAM_RTC_MINUTES        2
  55 #define NVRAM_RTC_HOURS          4
  56 #define NVRAM_RTC_DAY            7
  57 #define NVRAM_RTC_MONTH          8
  58 #define NVRAM_RTC_YEAR           9
  59
  60 /* drivers/nvram.c */
  61 u8 nvram_read(u8 addr);
  62 void nvram_write(u8 val, u8 addr);
  63
  64 /* drivers/keyboard.c */
  65 int keyboard_havechar(void);
  66 unsigned char keyboard_get_scancode(void);
  67 int keyboard_getchar(void);
  68
  69 /* drivers/serial.c */
  70 void serial_init(void);
  71 void serial_putchar(unsigned char c);
  72 int serial_havechar(void);
  73 int serial_getchar(void);
  74
  75 /* drivers/serial.c */
  76 void vga_cursor_enable(int state);
  77 void vga_clear_line(uint8_t row, uint8_t ch, uint8_t attr);
  78 void vga_fill(uint8_t ch, uint8_t attr);
  79 void vga_clear(void);
  80 void vga_putc(uint8_t row, uint8_t col, unsigned int c);
  81 void vga_putchar(unsigned int ch);
  82 void vga_move_cursor(int x, int y);
  83 void vga_init(void);
  84
  85 /* libc/console.c */
  86 void console_init(void);
  87 int putchar(int c);
  88 int puts(const char *s);
  89 int havekey(void);
  90 int getchar(void);
  91
  92 extern int last_putchar;
  93
  94 #define havechar havekey
  95
  96 /* libc/ctype.c */
  97 int isspace(int c);
  98 int isdigit(int c);
  99 int tolower(int c);
 100
 101 /* libc/ipchecksum.c */
 102 unsigned short ipchksum(const unsigned short *ptr, unsigned long nbytes);
 103
 104 /* libc/malloc.c */
 105 void free(void *ptr);
 106 void *malloc(size_t size);
 107 void *calloc(size_t nmemb, size_t size);
 108 void *realloc(void *ptr, size_t size);
 109
 110 /* libc/lib.c */
 111 int bcd2dec(int b);
 112 int dec2bcd(int d);
 113
 114 /* libc/memory.c */
 115 void *memset(void *s, int c, size_t n);
 116 void *memcpy(void *dst, const void *src, size_t n);
 117 void *memmove(void *dst, const void *src, size_t n);
 118 int memcmp(const char *s1, const char *s2, size_t len);
 119
 120 /* libc/printf.c */
 121 int snprintf(char *str, size_t size, const char *fmt, ...);
 122 int sprintf(char *str, const char *fmt, ...);
 123 int vsnprintf(char *str, size_t size, const char *fmt, va_list ap);
 124 int vsprintf(char *str, const char *fmt, va_list ap);
 125 int printf(const char *fmt, ...);
 126 int vprintf(const char *fmt, va_list ap);
 127
 128 /* libc/sha1.c */
 129 #define SHA1_BLOCK_LENGTH       64
 130 #define SHA1_DIGEST_LENGTH      20
 131 typedef struct {
 132         u32 state[5];
 133         u64 count;
 134         u8 buffer[SHA1_BLOCK_LENGTH];
 135 } SHA1_CTX;
 136 void SHA1Init(SHA1_CTX *context);
 137 void SHA1Transform(u32 state[5], const u8 buffer[SHA1_BLOCK_LENGTH]);
 138 void SHA1Update(SHA1_CTX *context, const u8 *data, size_t len);
 139 void SHA1Final(u8 digest[SHA1_DIGEST_LENGTH], SHA1_CTX *context);
 140 u8 *sha1(const u8 *data, size_t len, u8 *buf);
 141
 142 /* libc/string.c */
 143 size_t strnlen(const char *str, size_t maxlen);
 144 size_t strlen(const char *str);
 145 int strcmp(const char *s1, const char *s2);
 146 int strncmp(const char *s1, const char *s2, int maxlen);
 147 char *strncpy(char *d, const char *s, int n);
 148 char *strcpy(char *d, const char *s);
 149 char *strncat(char *d, const char *s, int n);
 150 char *strchr(const char *s, int c);
 151 char *strdup(const char *s);
 152 char *strstr(const char *h, const char *n);
 153
 154 /* i386/coreboot.c */
 155 int get_coreboot_info(struct sysinfo_t *info);
 156
 157 /* i386/sysinfo.c */
 158 void lib_get_sysinfo(void);
 159
 160 /* i386/timer.c */
 161 /* Timer functions - defined by each architecture. */
 162 unsigned int get_cpu_speed(void);
 163 void ndelay(unsigned int n);
 164 void mdelay(unsigned int n);
 165 void delay(unsigned int n);
 166
 167 /* i386/util.S */
 168 #define abort() halt()
 169 void halt(void) __attribute__ ((noreturn));
 170
 171 #endif