ea29b6237852e0efd1c60123faace470a0af8016
[linux-2.6.git] / arch / xtensa / boot / include / zlib.h
1 /*
2  * BK Id: SCCS/s.zlib.h 1.8 05/18/01 15:17:23 cort
3  */
4 /*
5  * This file is derived from zlib.h and zconf.h from the zlib-0.95
6  * distribution by Jean-loup Gailly and Mark Adler, with some additions
7  * by Paul Mackerras to aid in implementing Deflate compression and
8  * decompression for PPP packets.
9  */
10
11 /*
12  *  ==FILEVERSION 960122==
13  *
14  * This marker is used by the Linux installation script to determine
15  * whether an up-to-date version of this file is already installed.
16  */
17
18 /* zlib.h -- interface of the 'zlib' general purpose compression library
19   version 0.95, Aug 16th, 1995.
20
21   Copyright (C) 1995 Jean-loup Gailly and Mark Adler
22
23   This software is provided 'as-is', without any express or implied
24   warranty.  In no event will the authors be held liable for any damages
25   arising from the use of this software.
26
27   Permission is granted to anyone to use this software for any purpose,
28   including commercial applications, and to alter it and redistribute it
29   freely, subject to the following restrictions:
30
31   1. The origin of this software must not be misrepresented; you must not
32      claim that you wrote the original software. If you use this software
33      in a product, an acknowledgment in the product documentation would be
34      appreciated but is not required.
35   2. Altered source versions must be plainly marked as such, and must not be
36      misrepresented as being the original software.
37   3. This notice may not be removed or altered from any source distribution.
38
39   Jean-loup Gailly        Mark Adler
40   gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
41  */
42
43 #ifndef _ZLIB_H
44 #define _ZLIB_H
45
46 /* #include "zconf.h" */        /* included directly here */
47
48 /* zconf.h -- configuration of the zlib compression library
49  * Copyright (C) 1995 Jean-loup Gailly.
50  * For conditions of distribution and use, see copyright notice in zlib.h
51  */
52
53 /* From: zconf.h,v 1.12 1995/05/03 17:27:12 jloup Exp */
54
55 /*
56      The library does not install any signal handler. It is recommended to
57   add at least a handler for SIGSEGV when decompressing; the library checks
58   the consistency of the input data whenever possible but may go nuts
59   for some forms of corrupted input.
60  */
61
62 /*
63  * Compile with -DMAXSEG_64K if the alloc function cannot allocate more
64  * than 64k bytes at a time (needed on systems with 16-bit int).
65  * Compile with -DUNALIGNED_OK if it is OK to access shorts or ints
66  * at addresses which are not a multiple of their size.
67  * Under DOS, -DFAR=far or -DFAR=__far may be needed.
68  */
69
70 #ifndef STDC
71 #  if defined(MSDOS) || defined(__STDC__) || defined(__cplusplus)
72 #    define STDC
73 #  endif
74 #endif
75
76 #ifdef  __MWERKS__ /* Metrowerks CodeWarrior declares fileno() in unix.h */
77 #  include <unix.h>
78 #endif
79
80 /* Maximum value for memLevel in deflateInit2 */
81 #ifndef MAX_MEM_LEVEL
82 #  ifdef MAXSEG_64K
83 #    define MAX_MEM_LEVEL 8
84 #  else
85 #    define MAX_MEM_LEVEL 9
86 #  endif
87 #endif
88
89 #ifndef FAR
90 #  define FAR
91 #endif
92
93 /* Maximum value for windowBits in deflateInit2 and inflateInit2 */
94 #ifndef MAX_WBITS
95 #  define MAX_WBITS   15 /* 32K LZ77 window */
96 #endif
97
98 /* The memory requirements for deflate are (in bytes):
99             1 << (windowBits+2)   +  1 << (memLevel+9)
100  that is: 128K for windowBits=15  +  128K for memLevel = 8  (default values)
101  plus a few kilobytes for small objects. For example, if you want to reduce
102  the default memory requirements from 256K to 128K, compile with
103      make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"
104  Of course this will generally degrade compression (there's no free lunch).
105
106    The memory requirements for inflate are (in bytes) 1 << windowBits
107  that is, 32K for windowBits=15 (default value) plus a few kilobytes
108  for small objects.
109 */
110
111                         /* Type declarations */
112
113 #ifndef OF /* function prototypes */
114 #  ifdef STDC
115 #    define OF(args)  args
116 #  else
117 #    define OF(args)  ()
118 #  endif
119 #endif
120
121 typedef unsigned char  Byte;  /* 8 bits */
122 typedef unsigned int   uInt;  /* 16 bits or more */
123 typedef unsigned long  uLong; /* 32 bits or more */
124
125 typedef Byte FAR Bytef;
126 typedef char FAR charf;
127 typedef int FAR intf;
128 typedef uInt FAR uIntf;
129 typedef uLong FAR uLongf;
130
131 #ifdef STDC
132    typedef void FAR *voidpf;
133    typedef void     *voidp;
134 #else
135    typedef Byte FAR *voidpf;
136    typedef Byte     *voidp;
137 #endif
138
139 /* end of original zconf.h */
140
141 #define ZLIB_VERSION "0.95P"
142
143 /*
144      The 'zlib' compression library provides in-memory compression and
145   decompression functions, including integrity checks of the uncompressed
146   data.  This version of the library supports only one compression method
147   (deflation) but other algorithms may be added later and will have the same
148   stream interface.
149
150      For compression the application must provide the output buffer and
151   may optionally provide the input buffer for optimization. For decompression,
152   the application must provide the input buffer and may optionally provide
153   the output buffer for optimization.
154
155      Compression can be done in a single step if the buffers are large
156   enough (for example if an input file is mmap'ed), or can be done by
157   repeated calls of the compression function.  In the latter case, the
158   application must provide more input and/or consume the output
159   (providing more output space) before each call.
160 */
161
162 typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
163 typedef void   (*free_func)  OF((voidpf opaque, voidpf address, uInt nbytes));
164
165 struct internal_state;
166
167 typedef struct z_stream_s {
168     Bytef    *next_in;  /* next input byte */
169     uInt     avail_in;  /* number of bytes available at next_in */
170     uLong    total_in;  /* total nb of input bytes read so far */
171
172     Bytef    *next_out; /* next output byte should be put there */
173     uInt     avail_out; /* remaining free space at next_out */
174     uLong    total_out; /* total nb of bytes output so far */
175
176     char     *msg;      /* last error message, NULL if no error */
177     struct internal_state FAR *state; /* not visible by applications */
178
179     alloc_func zalloc;  /* used to allocate the internal state */
180     free_func  zfree;   /* used to free the internal state */
181     voidp      opaque;  /* private data object passed to zalloc and zfree */
182
183     Byte     data_type; /* best guess about the data type: ascii or binary */
184
185 } z_stream;
186
187 /*
188    The application must update next_in and avail_in when avail_in has
189    dropped to zero. It must update next_out and avail_out when avail_out
190    has dropped to zero. The application must initialize zalloc, zfree and
191    opaque before calling the init function. All other fields are set by the
192    compression library and must not be updated by the application.
193
194    The opaque value provided by the application will be passed as the first
195    parameter for calls of zalloc and zfree. This can be useful for custom
196    memory management. The compression library attaches no meaning to the
197    opaque value.
198
199    zalloc must return Z_NULL if there is not enough memory for the object.
200    On 16-bit systems, the functions zalloc and zfree must be able to allocate
201    exactly 65536 bytes, but will not be required to allocate more than this
202    if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
203    pointers returned by zalloc for objects of exactly 65536 bytes *must*
204    have their offset normalized to zero. The default allocation function
205    provided by this library ensures this (see zutil.c). To reduce memory
206    requirements and avoid any allocation of 64K objects, at the expense of
207    compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
208
209    The fields total_in and total_out can be used for statistics or
210    progress reports. After compression, total_in holds the total size of
211    the uncompressed data and may be saved for use in the decompressor
212    (particularly if the decompressor wants to decompress everything in
213    a single step).
214 */
215
216                         /* constants */
217
218 #define Z_NO_FLUSH      0
219 #define Z_PARTIAL_FLUSH 1
220 #define Z_FULL_FLUSH    2
221 #define Z_SYNC_FLUSH    3 /* experimental: partial_flush + byte align */
222 #define Z_FINISH        4
223 #define Z_PACKET_FLUSH  5
224 /* See deflate() below for the usage of these constants */
225
226 #define Z_OK            0
227 #define Z_STREAM_END    1
228 #define Z_ERRNO        (-1)
229 #define Z_STREAM_ERROR (-2)
230 #define Z_DATA_ERROR   (-3)
231 #define Z_MEM_ERROR    (-4)
232 #define Z_BUF_ERROR    (-5)
233 /* error codes for the compression/decompression functions */
234
235 #define Z_BEST_SPEED             1
236 #define Z_BEST_COMPRESSION       9
237 #define Z_DEFAULT_COMPRESSION  (-1)
238 /* compression levels */
239
240 #define Z_FILTERED            1
241 #define Z_HUFFMAN_ONLY        2
242 #define Z_DEFAULT_STRATEGY    0
243
244 #define Z_BINARY   0
245 #define Z_ASCII    1
246 #define Z_UNKNOWN  2
247 /* Used to set the data_type field */
248
249 #define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
250
251 extern char *zlib_version;
252 /* The application can compare zlib_version and ZLIB_VERSION for consistency.
253    If the first character differs, the library code actually used is
254    not compatible with the zlib.h header file used by the application.
255  */
256
257                         /* basic functions */
258
259 extern int inflateInit OF((z_stream *strm));
260 /*
261      Initializes the internal stream state for decompression. The fields
262    zalloc and zfree must be initialized before by the caller.  If zalloc and
263    zfree are set to Z_NULL, inflateInit updates them to use default allocation
264    functions.
265
266      inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
267    enough memory.  msg is set to null if there is no error message.
268    inflateInit does not perform any decompression: this will be done by
269    inflate().
270 */
271
272
273 extern int inflate OF((z_stream *strm, int flush));
274 /*
275   Performs one or both of the following actions:
276
277   - Decompress more input starting at next_in and update next_in and avail_in
278     accordingly. If not all input can be processed (because there is not
279     enough room in the output buffer), next_in is updated and processing
280     will resume at this point for the next call of inflate().
281
282   - Provide more output starting at next_out and update next_out and avail_out
283     accordingly.  inflate() always provides as much output as possible
284     (until there is no more input data or no more space in the output buffer).
285
286   Before the call of inflate(), the application should ensure that at least
287   one of the actions is possible, by providing more input and/or consuming
288   more output, and updating the next_* and avail_* values accordingly.
289   The application can consume the uncompressed output when it wants, for
290   example when the output buffer is full (avail_out == 0), or after each
291   call of inflate().
292
293     If the parameter flush is set to Z_PARTIAL_FLUSH or Z_PACKET_FLUSH,
294   inflate flushes as much output as possible to the output buffer. The
295   flushing behavior of inflate is not specified for values of the flush
296   parameter other than Z_PARTIAL_FLUSH, Z_PACKET_FLUSH or Z_FINISH, but the
297   current implementation actually flushes as much output as possible
298   anyway.  For Z_PACKET_FLUSH, inflate checks that once all the input data
299   has been consumed, it is expecting to see the length field of a stored
300   block; if not, it returns Z_DATA_ERROR.
301
302     inflate() should normally be called until it returns Z_STREAM_END or an
303   error. However if all decompression is to be performed in a single step
304   (a single call of inflate), the parameter flush should be set to
305   Z_FINISH. In this case all pending input is processed and all pending
306   output is flushed; avail_out must be large enough to hold all the
307   uncompressed data. (The size of the uncompressed data may have been saved
308   by the compressor for this purpose.) The next operation on this stream must
309   be inflateEnd to deallocate the decompression state. The use of Z_FINISH
310   is never required, but can be used to inform inflate that a faster routine
311   may be used for the single inflate() call.
312
313     inflate() returns Z_OK if some progress has been made (more input
314   processed or more output produced), Z_STREAM_END if the end of the
315   compressed data has been reached and all uncompressed output has been
316   produced, Z_DATA_ERROR if the input data was corrupted, Z_STREAM_ERROR if
317   the stream structure was inconsistent (for example if next_in or next_out
318   was NULL), Z_MEM_ERROR if there was not enough memory, Z_BUF_ERROR if no
319   progress is possible or if there was not enough room in the output buffer
320   when Z_FINISH is used. In the Z_DATA_ERROR case, the application may then
321   call inflateSync to look for a good compression block.  */
322
323
324 extern int inflateEnd OF((z_stream *strm));
325 /*
326      All dynamically allocated data structures for this stream are freed.
327    This function discards any unprocessed input and does not flush any
328    pending output.
329
330      inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
331    was inconsistent. In the error case, msg may be set but then points to a
332    static string (which must not be deallocated).
333 */
334
335                         /* advanced functions */
336
337 extern int inflateInit2 OF((z_stream *strm,
338                             int  windowBits));
339 /*
340      This is another version of inflateInit with more compression options. The
341    fields next_out, zalloc and zfree must be initialized before by the caller.
342
343      The windowBits parameter is the base two logarithm of the maximum window
344    size (the size of the history buffer).  It should be in the range 8..15 for
345    this version of the library (the value 16 will be allowed soon). The
346    default value is 15 if inflateInit is used instead. If a compressed stream
347    with a larger window size is given as input, inflate() will return with
348    the error code Z_DATA_ERROR instead of trying to allocate a larger window.
349
350      If next_out is not null, the library will use this buffer for the history
351    buffer; the buffer must either be large enough to hold the entire output
352    data, or have at least 1<<windowBits bytes.  If next_out is null, the
353    library will allocate its own buffer (and leave next_out null). next_in
354    need not be provided here but must be provided by the application for the
355    next call of inflate().
356
357      If the history buffer is provided by the application, next_out must
358    never be changed by the application since the decompressor maintains
359    history information inside this buffer from call to call; the application
360    can only reset next_out to the beginning of the history buffer when
361    avail_out is zero and all output has been consumed.
362
363       inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was
364    not enough memory, Z_STREAM_ERROR if a parameter is invalid (such as
365    windowBits < 8). msg is set to null if there is no error message.
366    inflateInit2 does not perform any decompression: this will be done by
367    inflate().
368 */
369
370 extern int inflateSync OF((z_stream *strm));
371 /*
372     Skips invalid compressed data until the special marker (see deflate()
373   above) can be found, or until all available input is skipped. No output
374   is provided.
375
376     inflateSync returns Z_OK if the special marker has been found, Z_BUF_ERROR
377   if no more input was provided, Z_DATA_ERROR if no marker has been found,
378   or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
379   case, the application may save the current current value of total_in which
380   indicates where valid compressed data was found. In the error case, the
381   application may repeatedly call inflateSync, providing more input each time,
382   until success or end of the input data.
383 */
384
385 extern int inflateReset OF((z_stream *strm));
386 /*
387      This function is equivalent to inflateEnd followed by inflateInit,
388    but does not free and reallocate all the internal decompression state.
389    The stream will keep attributes that may have been set by inflateInit2.
390
391       inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
392    stream state was inconsistent (such as zalloc or state being NULL).
393 */
394
395 extern int inflateIncomp OF((z_stream *strm));
396 /*
397      This function adds the data at next_in (avail_in bytes) to the output
398    history without performing any output.  There must be no pending output,
399    and the decompressor must be expecting to see the start of a block.
400    Calling this function is equivalent to decompressing a stored block
401    containing the data at next_in (except that the data is not output).
402 */
403
404                         /* checksum functions */
405
406 /*
407      This function is not related to compression but is exported
408    anyway because it might be useful in applications using the
409    compression library.
410 */
411
412 extern uLong adler32 OF((uLong adler, Bytef *buf, uInt len));
413
414 /*
415      Update a running Adler-32 checksum with the bytes buf[0..len-1] and
416    return the updated checksum. If buf is NULL, this function returns
417    the required initial value for the checksum.
418    An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
419    much faster. Usage example:
420
421      uLong adler = adler32(0L, Z_NULL, 0);
422
423      while (read_buffer(buffer, length) != EOF) {
424        adler = adler32(adler, buffer, length);
425      }
426      if (adler != original_adler) error();
427 */
428
429 #ifndef _Z_UTIL_H
430     struct internal_state {int dummy;}; /* hack for buggy compilers */
431 #endif
432
433 #endif /* _ZLIB_H */