x86: unify headers in arch/x86/boot/compressed/misc_??.c
[sfrench/cifs-2.6.git] / arch / x86 / boot / compressed / misc_64.c
1 /*
2  * misc.c
3  *
4  * This is a collection of several routines from gzip-1.0.3
5  * adapted for Linux.
6  *
7  * malloc by Hannu Savolainen 1993 and Matthias Urlichs 1994
8  * puts by Nick Holloway 1993, better puts by Martin Mares 1995
9  * High loaded stuff by Hans Lermen & Werner Almesberger, Feb. 1996
10  */
11
12 /*
13  * we have to be careful, because no indirections are allowed here, and
14  * paravirt_ops is a kind of one. As it will only run in baremetal anyway,
15  * we just keep it from happening
16  */
17 #undef CONFIG_PARAVIRT
18 #define _LINUX_STRING_H_ 1
19 #define __LINUX_BITMAP_H 1
20
21 #include <linux/linkage.h>
22 #include <linux/screen_info.h>
23 #include <asm/io.h>
24 #include <asm/page.h>
25 #include <asm/boot.h>
26
27 /* WARNING!!
28  * This code is compiled with -fPIC and it is relocated dynamically
29  * at run time, but no relocation processing is performed.
30  * This means that it is not safe to place pointers in static structures.
31  */
32
33 /*
34  * Getting to provable safe in place decompression is hard.
35  * Worst case behaviours need to be analyzed.
36  * Background information:
37  *
38  * The file layout is:
39  *    magic[2]
40  *    method[1]
41  *    flags[1]
42  *    timestamp[4]
43  *    extraflags[1]
44  *    os[1]
45  *    compressed data blocks[N]
46  *    crc[4] orig_len[4]
47  *
48  * resulting in 18 bytes of non compressed data overhead.
49  *
50  * Files divided into blocks
51  * 1 bit (last block flag)
52  * 2 bits (block type)
53  *
54  * 1 block occurs every 32K -1 bytes or when there 50% compression has been achieved.
55  * The smallest block type encoding is always used.
56  *
57  * stored:
58  *    32 bits length in bytes.
59  *
60  * fixed:
61  *    magic fixed tree.
62  *    symbols.
63  *
64  * dynamic:
65  *    dynamic tree encoding.
66  *    symbols.
67  *
68  *
69  * The buffer for decompression in place is the length of the
70  * uncompressed data, plus a small amount extra to keep the algorithm safe.
71  * The compressed data is placed at the end of the buffer.  The output
72  * pointer is placed at the start of the buffer and the input pointer
73  * is placed where the compressed data starts.  Problems will occur
74  * when the output pointer overruns the input pointer.
75  *
76  * The output pointer can only overrun the input pointer if the input
77  * pointer is moving faster than the output pointer.  A condition only
78  * triggered by data whose compressed form is larger than the uncompressed
79  * form.
80  *
81  * The worst case at the block level is a growth of the compressed data
82  * of 5 bytes per 32767 bytes.
83  *
84  * The worst case internal to a compressed block is very hard to figure.
85  * The worst case can at least be boundined by having one bit that represents
86  * 32764 bytes and then all of the rest of the bytes representing the very
87  * very last byte.
88  *
89  * All of which is enough to compute an amount of extra data that is required
90  * to be safe.  To avoid problems at the block level allocating 5 extra bytes
91  * per 32767 bytes of data is sufficient.  To avoind problems internal to a block
92  * adding an extra 32767 bytes (the worst case uncompressed block size) is
93  * sufficient, to ensure that in the worst case the decompressed data for
94  * block will stop the byte before the compressed data for a block begins.
95  * To avoid problems with the compressed data's meta information an extra 18
96  * bytes are needed.  Leading to the formula:
97  *
98  * extra_bytes = (uncompressed_size >> 12) + 32768 + 18 + decompressor_size.
99  *
100  * Adding 8 bytes per 32K is a bit excessive but much easier to calculate.
101  * Adding 32768 instead of 32767 just makes for round numbers.
102  * Adding the decompressor_size is necessary as it musht live after all
103  * of the data as well.  Last I measured the decompressor is about 14K.
104  * 10K of actual data and 4K of bss.
105  *
106  */
107
108 /*
109  * gzip declarations
110  */
111
112 #define OF(args)  args
113 #define STATIC static
114
115 #undef memset
116 #undef memcpy
117 #define memzero(s, n)     memset ((s), 0, (n))
118
119 typedef unsigned char  uch;
120 typedef unsigned short ush;
121 typedef unsigned long  ulg;
122
123 #define WSIZE 0x80000000        /* Window size must be at least 32k,
124                                  * and a power of two
125                                  * We don't actually have a window just
126                                  * a huge output buffer so I report
127                                  * a 2G windows size, as that should
128                                  * always be larger than our output buffer.
129                                  */
130
131 static uch *inbuf;      /* input buffer */
132 static uch *window;     /* Sliding window buffer, (and final output buffer) */
133
134 static unsigned insize;  /* valid bytes in inbuf */
135 static unsigned inptr;   /* index of next byte to be processed in inbuf */
136 static unsigned outcnt;  /* bytes in output buffer */
137
138 /* gzip flag byte */
139 #define ASCII_FLAG   0x01 /* bit 0 set: file probably ASCII text */
140 #define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
141 #define EXTRA_FIELD  0x04 /* bit 2 set: extra field present */
142 #define ORIG_NAME    0x08 /* bit 3 set: original file name present */
143 #define COMMENT      0x10 /* bit 4 set: file comment present */
144 #define ENCRYPTED    0x20 /* bit 5 set: file is encrypted */
145 #define RESERVED     0xC0 /* bit 6,7:   reserved */
146
147 #define get_byte()  (inptr < insize ? inbuf[inptr++] : fill_inbuf())
148                 
149 /* Diagnostic functions */
150 #ifdef DEBUG
151 #  define Assert(cond,msg) {if(!(cond)) error(msg);}
152 #  define Trace(x) fprintf x
153 #  define Tracev(x) {if (verbose) fprintf x ;}
154 #  define Tracevv(x) {if (verbose>1) fprintf x ;}
155 #  define Tracec(c,x) {if (verbose && (c)) fprintf x ;}
156 #  define Tracecv(c,x) {if (verbose>1 && (c)) fprintf x ;}
157 #else
158 #  define Assert(cond,msg)
159 #  define Trace(x)
160 #  define Tracev(x)
161 #  define Tracevv(x)
162 #  define Tracec(c,x)
163 #  define Tracecv(c,x)
164 #endif
165
166 static int  fill_inbuf(void);
167 static void flush_window(void);
168 static void error(char *m);
169 static void gzip_mark(void **);
170 static void gzip_release(void **);
171   
172 /*
173  * This is set up by the setup-routine at boot-time
174  */
175 static unsigned char *real_mode; /* Pointer to real-mode data */
176
177 #define RM_EXT_MEM_K   (*(unsigned short *)(real_mode + 0x2))
178 #ifndef STANDARD_MEMORY_BIOS_CALL
179 #define RM_ALT_MEM_K   (*(unsigned long *)(real_mode + 0x1e0))
180 #endif
181 #define RM_SCREEN_INFO (*(struct screen_info *)(real_mode+0))
182
183 extern unsigned char input_data[];
184 extern int input_len;
185
186 static long bytes_out = 0;
187
188 static void *malloc(int size);
189 static void free(void *where);
190
191 static void *memset(void *s, int c, unsigned n);
192 static void *memcpy(void *dest, const void *src, unsigned n);
193
194 static void putstr(const char *);
195
196 static long free_mem_ptr;
197 static long free_mem_end_ptr;
198
199 #define HEAP_SIZE             0x7000
200
201 static char *vidmem = (char *)0xb8000;
202 static int vidport;
203 static int lines, cols;
204
205 #include "../../../../lib/inflate.c"
206
207 static void *malloc(int size)
208 {
209         void *p;
210
211         if (size <0) error("Malloc error");
212         if (free_mem_ptr <= 0) error("Memory error");
213
214         free_mem_ptr = (free_mem_ptr + 3) & ~3; /* Align */
215
216         p = (void *)free_mem_ptr;
217         free_mem_ptr += size;
218
219         if (free_mem_ptr >= free_mem_end_ptr)
220                 error("Out of memory");
221
222         return p;
223 }
224
225 static void free(void *where)
226 {       /* Don't care */
227 }
228
229 static void gzip_mark(void **ptr)
230 {
231         *ptr = (void *) free_mem_ptr;
232 }
233
234 static void gzip_release(void **ptr)
235 {
236         free_mem_ptr = (long) *ptr;
237 }
238  
239 static void scroll(void)
240 {
241         int i;
242
243         memcpy ( vidmem, vidmem + cols * 2, ( lines - 1 ) * cols * 2 );
244         for ( i = ( lines - 1 ) * cols * 2; i < lines * cols * 2; i += 2 )
245                 vidmem[i] = ' ';
246 }
247
248 static void putstr(const char *s)
249 {
250         int x,y,pos;
251         char c;
252
253         x = RM_SCREEN_INFO.orig_x;
254         y = RM_SCREEN_INFO.orig_y;
255
256         while ( ( c = *s++ ) != '\0' ) {
257                 if ( c == '\n' ) {
258                         x = 0;
259                         if ( ++y >= lines ) {
260                                 scroll();
261                                 y--;
262                         }
263                 } else {
264                         vidmem [(x + cols * y) * 2] = c;
265                         if ( ++x >= cols ) {
266                                 x = 0;
267                                 if ( ++y >= lines ) {
268                                         scroll();
269                                         y--;
270                                 }
271                         }
272                 }
273         }
274
275         RM_SCREEN_INFO.orig_x = x;
276         RM_SCREEN_INFO.orig_y = y;
277
278         pos = (x + cols * y) * 2;       /* Update cursor position */
279         outb(14, vidport);
280         outb(0xff & (pos >> 9), vidport+1);
281         outb(15, vidport);
282         outb(0xff & (pos >> 1), vidport+1);
283 }
284
285 static void* memset(void* s, int c, unsigned n)
286 {
287         int i;
288         char *ss = s;
289
290         for (i=0;i<n;i++) ss[i] = c;
291         return s;
292 }
293
294 static void* memcpy(void* dest, const void* src, unsigned n)
295 {
296         int i;
297         const char *s = src;
298         char *d = dest;
299
300         for (i=0;i<n;i++) d[i] = s[i];
301         return dest;
302 }
303
304 /* ===========================================================================
305  * Fill the input buffer. This is called only when the buffer is empty
306  * and at least one byte is really needed.
307  */
308 static int fill_inbuf(void)
309 {
310         error("ran out of input data");
311         return 0;
312 }
313
314 /* ===========================================================================
315  * Write the output window window[0..outcnt-1] and update crc and bytes_out.
316  * (Used for the decompressed data only.)
317  */
318 static void flush_window(void)
319 {
320         /* With my window equal to my output buffer
321          * I only need to compute the crc here.
322          */
323         ulg c = crc;         /* temporary variable */
324         unsigned n;
325         uch *in, ch;
326
327         in = window;
328         for (n = 0; n < outcnt; n++) {
329                 ch = *in++;
330                 c = crc_32_tab[((int)c ^ ch) & 0xff] ^ (c >> 8);
331         }
332         crc = c;
333         bytes_out += (ulg)outcnt;
334         outcnt = 0;
335 }
336
337 static void error(char *x)
338 {
339         putstr("\n\n");
340         putstr(x);
341         putstr("\n\n -- System halted");
342
343         while (1)
344                 asm("hlt");
345 }
346
347 asmlinkage void decompress_kernel(void *rmode, unsigned long heap,
348                                   uch *input_data, unsigned long input_len,
349                                   uch *output)
350 {
351         real_mode = rmode;
352
353         if (RM_SCREEN_INFO.orig_video_mode == 7) {
354                 vidmem = (char *) 0xb0000;
355                 vidport = 0x3b4;
356         } else {
357                 vidmem = (char *) 0xb8000;
358                 vidport = 0x3d4;
359         }
360
361         lines = RM_SCREEN_INFO.orig_video_lines;
362         cols = RM_SCREEN_INFO.orig_video_cols;
363
364         window = output;                /* Output buffer (Normally at 1M) */
365         free_mem_ptr     = heap;        /* Heap */
366         free_mem_end_ptr = heap + HEAP_SIZE;
367         inbuf  = input_data;            /* Input buffer */
368         insize = input_len;
369         inptr  = 0;
370
371         if ((ulg)output & (__KERNEL_ALIGN - 1))
372                 error("Destination address not 2M aligned");
373         if ((ulg)output >= 0xffffffffffUL)
374                 error("Destination address too large");
375
376         makecrc();
377         putstr("\nDecompressing Linux... ");
378         gunzip();
379         putstr("done.\nBooting the kernel.\n");
380         return;
381 }