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