source: rtems/c/src/lib/libbsp/powerpc/shared/bootloader/zlib.h @ eba2e4f
Last change on this file since eba2e4f was acc25ee, checked in by Joel Sherrill <joel.sherrill@…>, on Dec 2, 1999 at 2:31:19 PM

Merged of mcp750 and mvme2307 BSP by Eric Valette <valette@…>.
As part of this effort, the mpc750 libcpu code is now shared with the

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