RTEMS: bsps/powerpc/motorola_powerpc/bootloader/zlib.h Source File

| RTEMS 5.4-rc2

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