[PATCH] xtensa: Architecture support for Tensilica Xtensa Part 2
authorChris Zankel <czankel@tensilica.com>
Fri, 24 Jun 2005 05:01:12 +0000 (22:01 -0700)
committerLinus Torvalds <torvalds@ppc970.osdl.org>
Fri, 24 Jun 2005 07:05:21 +0000 (00:05 -0700)
The attached patches provides part 2 of an architecture implementation for the
Tensilica Xtensa CPU series.

Signed-off-by: Chris Zankel <chris@zankel.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
13 files changed:
arch/xtensa/boot/Makefile [new file with mode: 0644]
arch/xtensa/boot/boot-elf/Makefile [new file with mode: 0644]
arch/xtensa/boot/boot-elf/boot.ld [new file with mode: 0644]
arch/xtensa/boot/boot-elf/bootstrap.S [new file with mode: 0644]
arch/xtensa/boot/boot-redboot/Makefile [new file with mode: 0644]
arch/xtensa/boot/boot-redboot/boot.ld [new file with mode: 0644]
arch/xtensa/boot/boot-redboot/bootstrap.S [new file with mode: 0644]
arch/xtensa/boot/include/zlib.h [new file with mode: 0644]
arch/xtensa/boot/lib/Makefile [new file with mode: 0644]
arch/xtensa/boot/lib/memcpy.S [new file with mode: 0644]
arch/xtensa/boot/lib/zlib.c [new file with mode: 0644]
arch/xtensa/boot/lib/zmem.c [new file with mode: 0644]
arch/xtensa/boot/ramdisk/Makefile [new file with mode: 0644]

diff --git a/arch/xtensa/boot/Makefile b/arch/xtensa/boot/Makefile
new file mode 100644 (file)
index 0000000..260f456
--- /dev/null
@@ -0,0 +1,37 @@
+#
+# arch/xtensa/boot/Makefile
+#
+# This file is subject to the terms and conditions of the GNU General Public
+# License.  See the file "COPYING" in the main directory of this archive
+# for more details.
+#
+#
+
+
+CFLAGS                 += -fno-builtin -Iarch/$(ARCH)/boot/include
+HOSTFLAGS      += -Iarch/$(ARCH)/boot/include
+
+BIG_ENDIAN     := $(shell echo -e "\#ifdef __XTENSA_EL__\nint little;\n\#else\nint big;\n\#endif" | $(CC) -E -|grep -c big)
+
+
+export CFLAGS
+export AFLAGS
+export BIG_ENDIAN
+
+# Subdirs for the boot loader(s)
+
+bootdir-$(CONFIG_XTENSA_PLATFORM_ISS)   += boot-elf
+bootdir-$(CONFIG_XTENSA_PLATFORM_XT2000) += boot-redboot boot-elf
+
+subdir-y       := lib/
+
+subdir-y       += boot-elf/ boot-redboot/
+
+zImage zImage.initrd Image Image.initrd: $(bootdir-y)
+
+$(bootdir-y): $(addprefix $(obj)/,$(subdir-y)) \
+             $(addprefix $(obj)/,$(host-progs))
+       $(Q)$(MAKE) $(build)=$(obj)/$@ $(MAKECMDGOALS)
+
+
+
diff --git a/arch/xtensa/boot/boot-elf/Makefile b/arch/xtensa/boot/boot-elf/Makefile
new file mode 100644 (file)
index 0000000..f6ef6a3
--- /dev/null
@@ -0,0 +1,52 @@
+#
+# This file is subject to the terms and conditions of the GNU General Public
+# License.  See the file "COPYING" in the main directory of this archive
+# for more details.
+#
+
+GZIP = gzip
+GZIP_FLAGS = -v9fc
+
+ifeq ($(BIG_ENDIAN),1)
+OBJCOPY_ARGS    := -O elf32-xtensa-be
+else
+OBJCOPY_ARGS    := -O elf32-xtensa-le
+endif
+
+export OBJCOPY_ARGS
+
+boot-y         := bootstrap.o
+
+OBJS           := $(addprefix $(obj)/,$(boot-y))
+
+Image: vmlinux $(OBJS)
+       $(OBJCOPY) --strip-all -R .comment -R .xt.insn -O binary \
+               vmlinux vmlinux.tmp
+       $(OBJCOPY) $(OBJCOPY_ARGS) -R .comment \
+               --add-section image=vmlinux.tmp \
+               --set-section-flags image=contents,alloc,load,load,data \
+               $(OBJS) $@.tmp
+       $(LD) $(LDFLAGS) $(LDFLAGS_vmlinux) \
+               -T arch/$(ARCH)/boot/boot-elf/boot.ld \
+               -o arch/$(ARCH)/boot/$@.elf $@.tmp
+       rm -f $@.tmp vmlinux.tmp
+
+Image.initrd:  vmlinux $(OBJS)
+       $(OBJCOPY) --strip-all -R .comment -R .xt.insn -O binary \
+               --add-section .initrd=arch/$(ARCH)/boot/ramdisk \
+               --set-section-flags .initrd=contents,alloc,load,load,data \
+               vmlinux vmlinux.tmp
+       $(OBJCOPY) $(OBJCOPY_ARGS) -R .comment \
+               --add-section image=vmlinux.tmp \
+               --set-section-flags image=contents,alloc,load,load,data \
+               $(OBJS) $@.tmp
+       $(LD) $(LDFLAGS) $(LDFLAGS_vmlinux) \
+               -T arch/$(ARCH)/boot/boot-elf/boot.ld \
+               -o arch/$(ARCH)/boot/$@.elf $@.tmp
+       rm -f $@.tmp vmlinux.tmp
+
+
+zImage:        Image
+
+zImage.initrd: Image.initrd
+
diff --git a/arch/xtensa/boot/boot-elf/boot.ld b/arch/xtensa/boot/boot-elf/boot.ld
new file mode 100644 (file)
index 0000000..4ab06a0
--- /dev/null
@@ -0,0 +1,71 @@
+OUTPUT_ARCH(xtensa)
+
+SECTIONS
+{
+       .start 0xD0000000 : { *(.start) }
+
+       .text 0xD0000000:
+       {
+               __reloc_start = . ;
+               _text_start = . ;
+               *(.literal .text.literal .text)
+               _text_end = . ;
+       }
+
+       .rodata ALIGN(0x04):
+       {
+               *(.rodata)
+               *(.rodata1)
+       }
+
+       .data ALIGN(0x04):
+       {
+               *(.data)
+               *(.data1)
+               *(.sdata)
+               *(.sdata2)
+               *(.got.plt)
+               *(.got)
+               *(.dynamic)
+       }
+
+       __reloc_end = . ;
+
+       .initrd ALIGN(0x10) :
+       {
+               boot_initrd_start = . ;
+               *(.initrd)
+               boot_initrd_end = .;
+       }
+
+       . = ALIGN(0x10);
+       __image_load = . ;
+       .image 0xd0001000:
+       {
+               _image_start = .;
+               *(image)
+               . = (. + 3) & ~ 3;
+               _image_end = .  ;
+       }
+
+
+       .bss ((LOADADDR(.image) + SIZEOF(.image) + 3) & ~ 3):
+       {
+               __bss_start = .;
+               *(.sbss)
+               *(.scommon)
+               *(.dynbss)
+               *(.bss)
+               __bss_end = .;
+       }
+       _end = .;
+       _param_start = .;
+
+       .ResetVector.text 0xfe000020 :
+       {
+               *(.ResetVector.text)
+       }
+
+
+       PROVIDE (end = .);
+}
diff --git a/arch/xtensa/boot/boot-elf/bootstrap.S b/arch/xtensa/boot/boot-elf/bootstrap.S
new file mode 100644 (file)
index 0000000..7cba94a
--- /dev/null
@@ -0,0 +1,37 @@
+
+#include <xtensa/config/specreg.h>
+#include <xtensa/config/core.h>
+
+#include <linux/config.h>
+#include <asm/bootparam.h>
+
+
+/* ResetVector
+ */
+       .section        .ResetVector.text, "ax"
+       .global         _ResetVector
+_ResetVector:
+       _j reset
+       .align 4
+RomInitAddr:
+       .word 0xd0001000
+RomBootParam:
+       .word _bootparam
+reset:
+       l32r    a0, RomInitAddr
+       l32r    a2, RomBootParam
+       movi    a3, 0
+       movi    a4, 0
+       jx      a0
+
+       .align 4
+       .section .bootstrap.data, "aw"
+
+       .globl _bootparam
+_bootparam:
+       .short  BP_TAG_FIRST
+       .short  4
+       .long   BP_VERSION
+       .short  BP_TAG_LAST
+       .short  0
+       .long   0
diff --git a/arch/xtensa/boot/boot-redboot/Makefile b/arch/xtensa/boot/boot-redboot/Makefile
new file mode 100644 (file)
index 0000000..ca8a68b
--- /dev/null
@@ -0,0 +1,35 @@
+#
+# This file is subject to the terms and conditions of the GNU General Public
+# License.  See the file "COPYING" in the main directory of this archive
+# for more details.
+#
+
+GZIP = gzip
+GZIP_FLAGS = -v9fc
+ifeq ($(BIG_ENDIAN),1)
+OBJCOPY_ARGS   := -O elf32-xtensa-be
+else
+OBJCOPY_ARGS   := -O elf32-xtensa-le
+endif
+
+LD_ARGS        = -T $(obj)/boot.ld
+
+boot-y := bootstrap.o
+
+OBJS   := $(addprefix $(obj)/,$(boot-y))
+LIBS   := arch/$(ARCH)/boot/lib/lib.a arch/$(ARCH)/lib/lib.a
+
+LIBGCC := $(shell $(CC) $(CFLAGS) -print-libgcc-file-name)
+
+zImage: vmlinux $(OBJS) $(LIBS)
+       $(OBJCOPY) --strip-all -R .comment -R .xt.insn -O binary \
+               $(TOPDIR)/vmlinux vmlinux.tmp
+       gzip -vf9 vmlinux.tmp
+       $(OBJCOPY) $(OBJCOPY_ARGS) -R .comment \
+               --add-section image=vmlinux.tmp.gz \
+               --set-section-flags image=contents,alloc,load,load,data \
+               $(OBJS) $@.tmp
+       $(LD) $(LD_ARGS) -o $@.elf $@.tmp $(LIBS) -L/xtensa-elf/lib $(LIBGCC)
+       $(OBJCOPY) -S -O binary $@.elf arch/$(ARCH)/boot/images/$@.redboot
+#      rm -f $@.tmp $@.elf vmlinux.tmp.gz
+
diff --git a/arch/xtensa/boot/boot-redboot/boot.ld b/arch/xtensa/boot/boot-redboot/boot.ld
new file mode 100644 (file)
index 0000000..65b7264
--- /dev/null
@@ -0,0 +1,66 @@
+OUTPUT_ARCH(xtensa)
+
+SECTIONS
+{
+       .start 0xD0200000 : { *(.start) }
+
+       .text :
+       {
+               __reloc_start = . ;
+               _text_start = . ;
+               *(.literal .text.literal .text)
+               _text_end = . ;
+       }
+
+       .rodata ALIGN(0x04):
+       {
+               *(.rodata)
+               *(.rodata1)
+       }
+
+       .data ALIGN(0x04):
+       {
+               *(.data)
+               *(.data1)
+               *(.sdata)
+               *(.sdata2)
+               *(.got.plt)
+               *(.got)
+               *(.dynamic)
+       }
+
+       __reloc_end = . ;
+
+       .initrd ALIGN(0x10) :
+       {
+               boot_initrd_start = . ;
+               *(.initrd)
+               boot_initrd_end = .;
+       }
+
+       . = ALIGN(0x10);
+       __image_load = . ;
+       .image 0xd0001000: AT(__image_load)
+       {
+               _image_start = .;
+               *(image)
+               . = (. + 3) & ~ 3;
+               _image_end = .  ;
+       }
+
+
+       .bss ((LOADADDR(.image) + SIZEOF(.image) + 3) & ~ 3):
+       {
+               __bss_start = .;
+               *(.sbss)
+               *(.scommon)
+               *(.dynbss)
+               *(.bss)
+               __bss_end = .;
+       }
+       _end = .;
+       _param_start = .;
+
+
+       PROVIDE (end = .);
+}
diff --git a/arch/xtensa/boot/boot-redboot/bootstrap.S b/arch/xtensa/boot/boot-redboot/bootstrap.S
new file mode 100644 (file)
index 0000000..ee636b0
--- /dev/null
@@ -0,0 +1,246 @@
+
+#define _ASMLANGUAGE
+#include <xtensa/config/specreg.h>
+#include <xtensa/config/core.h>
+#include <xtensa/cacheasm.h>
+
+       /*
+        * RB-Data: RedBoot data/bss
+        * P:       Boot-Parameters
+        * L:       Kernel-Loader
+        *
+        * The Linux-Kernel image including the loader must be loaded
+        * to a position so that the kernel and the boot parameters
+        * can fit in the space before the load address.
+        *  ______________________________________________________
+        * |_RB-Data_|_P_|__________|_L_|___Linux-Kernel___|______|
+        *                          ^
+        *                          ^ Load address
+        *  ______________________________________________________
+        * |___Linux-Kernel___|_P_|_L_|___________________________|
+        *
+        * The loader copies the parameter to the position that will
+        * be the end of the kernel and itself to the end of the
+        * parameter list.
+        */
+
+/* Make sure we have enough space for the 'uncompressor' */
+
+#define STACK_SIZE 32768
+#define HEAP_SIZE (131072*4)
+
+       # a2: Parameter list
+       # a3: Size of parameter list
+
+       .section .start, "ax"
+
+       .globl __start
+       /* this must be the first byte of the loader! */
+__start:
+       entry   sp, 32          # we do not intend to return
+       _call0  _start
+__start_a0:
+       .align 4
+
+       .section .text, "ax"
+       .begin literal_prefix .text
+
+       /* put literals in here! */
+
+       .globl _start
+_start:
+
+       /* 'reset' window registers */
+
+       movi    a4, 1
+       wsr     a4, PS
+       rsync
+
+       rsr     a5, WINDOWBASE
+       ssl     a5
+       sll     a4, a4
+       wsr     a4, WINDOWSTART
+       rsync
+
+       movi    a4, 0x00040000
+       wsr     a4, PS
+       rsync
+
+       /* copy the loader to its address
+        * Note: The loader itself is a very small piece, so we assume we
+        *       don't partially overlap. We also assume (even more important)
+        *       that the kernel image is out of the way. Usually, when the
+        *       load address of this image is not at an arbitrary address,
+        *       but aligned to some 10K's we shouldn't overlap.
+        */
+
+       /* Note: The assembler cannot relax "addi a0, a0, ..." to an
+          l32r, so we load to a4 first. */
+
+       addi    a4, a0, __start - __start_a0
+       mov     a0, a4
+       movi    a4, __start
+       movi    a5, __reloc_end
+
+       # a0: address where this code has been loaded
+       # a4: compiled address of __start
+       # a5: compiled end address
+
+       mov.n   a7, a0
+       mov.n   a8, a4
+
+1:
+       l32i    a10, a7, 0
+       l32i    a11, a7, 4
+       s32i    a10, a8, 0
+       s32i    a11, a8, 4
+       l32i    a10, a7, 8
+       l32i    a11, a7, 12
+       s32i    a10, a8, 8
+       s32i    a11, a8, 12
+       addi    a8, a8, 16
+       addi    a7, a7, 16
+       blt     a8, a5, 1b
+
+
+       /* We have to flush and invalidate the caches here before we jump. */
+
+#if XCHAL_DCACHE_IS_WRITEBACK
+       dcache_writeback_all  a5, a6
+#endif
+       icache_invalidate_all a5, a6
+
+       movi    a11, _reloc
+       jx      a11
+
+       .globl _reloc
+_reloc:
+
+       /* RedBoot is now at the end of the memory, so we don't have
+        * to copy the parameter list. Keep the code around; in case
+        * we need it again. */
+#if 0
+       # a0: load address
+       # a2: start address of parameter list
+       # a3: length of parameter list
+       # a4: __start
+
+       /* copy the parameter list out of the way */
+
+       movi    a6, _param_start
+       add     a3, a2, a3
+2:
+       l32i    a8, a2, 0
+       s32i    a8, a6, 0
+       addi    a2, a2, 4
+       addi    a6, a6, 4
+       blt     a2, a3, 2b
+#endif
+
+       /* clear BSS section */
+       movi    a6, __bss_start
+       movi    a7, __bss_end
+       movi.n  a5, 0
+3:
+       s32i    a5, a6, 0
+       addi    a6, a6, 4
+       blt     a6, a7, 3b
+
+       movi    a5, -16
+       movi    a1, _stack + STACK_SIZE
+       and     a1, a1, a5
+
+       /* Uncompress the kernel */
+
+       # a0: load address
+       # a2: boot parameter
+       # a4: __start
+
+       movi    a3, __image_load
+       sub     a4, a3, a4
+       add     a8, a0, a4
+
+       # a1  Stack
+       # a8(a4)  Load address of the image
+
+       movi    a6, _image_start
+       movi    a10, _image_end
+       movi    a7, 0x1000000
+       sub     a11, a10, a6
+       movi    a9, complen
+       s32i    a11, a9, 0
+
+       movi    a0, 0
+
+       # a6 destination
+       # a7 maximum size of destination
+       # a8 source
+       # a9 ptr to length
+
+       .extern gunzip
+       movi    a4, gunzip
+       beqz    a4, 1f
+
+       callx4  a4
+
+       j       2f
+
+
+       # a6 destination start
+       # a7 maximum size of destination
+       # a8 source start
+       # a9 ptr to length
+       # a10 destination end
+
+1:
+        l32i    a9, a8, 0
+        l32i    a11, a8, 4
+        s32i    a9, a6, 0
+        s32i    a11, a6, 4
+        l32i    a9, a8, 8
+        l32i    a11, a8, 12
+        s32i    a9, a6, 8
+        s32i    a11, a6, 12
+        addi    a6, a6, 16
+        addi    a8, a8, 16
+        blt     a6, a10, 1b
+
+
+       /* jump to the kernel */
+2:
+#if XCHAL_DCACHE_IS_WRITEBACK
+       dcache_writeback_all a5, a6
+#endif
+       icache_invalidate_all a5, a6
+
+       movi    a5, __start
+       movi    a3, boot_initrd_start
+       movi    a4, boot_initrd_end
+       sub     a3, a3, a5
+       sub     a4, a4, a5
+       add     a3, a0, a3
+       add     a4, a0, a4
+
+       # a2  Boot parameter list
+       # a3  initrd_start (virtual load address)
+       # a4  initrd_end   (virtual load address)
+
+       movi    a0, _image_start
+       jx      a0
+
+       .align 16
+       .data
+       .globl avail_ram
+avail_ram:
+       .long   _heap
+       .globl end_avail
+end_avail:
+       .long   _heap + HEAP_SIZE
+
+       .comm _stack, STACK_SIZE
+       .comm _heap, HEAP_SIZE
+
+       .globl end_avail
+       .comm complen, 4
+
+       .end    literal_prefix
diff --git a/arch/xtensa/boot/include/zlib.h b/arch/xtensa/boot/include/zlib.h
new file mode 100644 (file)
index 0000000..ea29b62
--- /dev/null
@@ -0,0 +1,433 @@
+/*
+ * BK Id: SCCS/s.zlib.h 1.8 05/18/01 15:17:23 cort
+ */
+/*
+ * This file is derived from zlib.h and zconf.h from the zlib-0.95
+ * distribution by Jean-loup Gailly and Mark Adler, with some additions
+ * by Paul Mackerras to aid in implementing Deflate compression and
+ * decompression for PPP packets.
+ */
+
+/*
+ *  ==FILEVERSION 960122==
+ *
+ * This marker is used by the Linux installation script to determine
+ * whether an up-to-date version of this file is already installed.
+ */
+
+/* zlib.h -- interface of the 'zlib' general purpose compression library
+  version 0.95, Aug 16th, 1995.
+
+  Copyright (C) 1995 Jean-loup Gailly and Mark Adler
+
+  This software is provided 'as-is', without any express or implied
+  warranty.  In no event will the authors be held liable for any damages
+  arising from the use of this software.
+
+  Permission is granted to anyone to use this software for any purpose,
+  including commercial applications, and to alter it and redistribute it
+  freely, subject to the following restrictions:
+
+  1. The origin of this software must not be misrepresented; you must not
+     claim that you wrote the original software. If you use this software
+     in a product, an acknowledgment in the product documentation would be
+     appreciated but is not required.
+  2. Altered source versions must be plainly marked as such, and must not be
+     misrepresented as being the original software.
+  3. This notice may not be removed or altered from any source distribution.
+
+  Jean-loup Gailly        Mark Adler
+  gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
+ */
+
+#ifndef _ZLIB_H
+#define _ZLIB_H
+
+/* #include "zconf.h" */       /* included directly here */
+
+/* zconf.h -- configuration of the zlib compression library
+ * Copyright (C) 1995 Jean-loup Gailly.
+ * For conditions of distribution and use, see copyright notice in zlib.h
+ */
+
+/* From: zconf.h,v 1.12 1995/05/03 17:27:12 jloup Exp */
+
+/*
+     The library does not install any signal handler. It is recommended to
+  add at least a handler for SIGSEGV when decompressing; the library checks
+  the consistency of the input data whenever possible but may go nuts
+  for some forms of corrupted input.
+ */
+
+/*
+ * Compile with -DMAXSEG_64K if the alloc function cannot allocate more
+ * than 64k bytes at a time (needed on systems with 16-bit int).
+ * Compile with -DUNALIGNED_OK if it is OK to access shorts or ints
+ * at addresses which are not a multiple of their size.
+ * Under DOS, -DFAR=far or -DFAR=__far may be needed.
+ */
+
+#ifndef STDC
+#  if defined(MSDOS) || defined(__STDC__) || defined(__cplusplus)
+#    define STDC
+#  endif
+#endif
+
+#ifdef __MWERKS__ /* Metrowerks CodeWarrior declares fileno() in unix.h */
+#  include <unix.h>
+#endif
+
+/* Maximum value for memLevel in deflateInit2 */
+#ifndef MAX_MEM_LEVEL
+#  ifdef MAXSEG_64K
+#    define MAX_MEM_LEVEL 8
+#  else
+#    define MAX_MEM_LEVEL 9
+#  endif
+#endif
+
+#ifndef FAR
+#  define FAR
+#endif
+
+/* Maximum value for windowBits in deflateInit2 and inflateInit2 */
+#ifndef MAX_WBITS
+#  define MAX_WBITS   15 /* 32K LZ77 window */
+#endif
+
+/* The memory requirements for deflate are (in bytes):
+            1 << (windowBits+2)   +  1 << (memLevel+9)
+ that is: 128K for windowBits=15  +  128K for memLevel = 8  (default values)
+ plus a few kilobytes for small objects. For example, if you want to reduce
+ the default memory requirements from 256K to 128K, compile with
+     make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"
+ Of course this will generally degrade compression (there's no free lunch).
+
+   The memory requirements for inflate are (in bytes) 1 << windowBits
+ that is, 32K for windowBits=15 (default value) plus a few kilobytes
+ for small objects.
+*/
+
+                        /* Type declarations */
+
+#ifndef OF /* function prototypes */
+#  ifdef STDC
+#    define OF(args)  args
+#  else
+#    define OF(args)  ()
+#  endif
+#endif
+
+typedef unsigned char  Byte;  /* 8 bits */
+typedef unsigned int   uInt;  /* 16 bits or more */
+typedef unsigned long  uLong; /* 32 bits or more */
+
+typedef Byte FAR Bytef;
+typedef char FAR charf;
+typedef int FAR intf;
+typedef uInt FAR uIntf;
+typedef uLong FAR uLongf;
+
+#ifdef STDC
+   typedef void FAR *voidpf;
+   typedef void     *voidp;
+#else
+   typedef Byte FAR *voidpf;
+   typedef Byte     *voidp;
+#endif
+
+/* end of original zconf.h */
+
+#define ZLIB_VERSION "0.95P"
+
+/*
+     The 'zlib' compression library provides in-memory compression and
+  decompression functions, including integrity checks of the uncompressed
+  data.  This version of the library supports only one compression method
+  (deflation) but other algorithms may be added later and will have the same
+  stream interface.
+
+     For compression the application must provide the output buffer and
+  may optionally provide the input buffer for optimization. For decompression,
+  the application must provide the input buffer and may optionally provide
+  the output buffer for optimization.
+
+     Compression can be done in a single step if the buffers are large
+  enough (for example if an input file is mmap'ed), or can be done by
+  repeated calls of the compression function.  In the latter case, the
+  application must provide more input and/or consume the output
+  (providing more output space) before each call.
+*/
+
+typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
+typedef void   (*free_func)  OF((voidpf opaque, voidpf address, uInt nbytes));
+
+struct internal_state;
+
+typedef struct z_stream_s {
+    Bytef    *next_in;  /* next input byte */
+    uInt     avail_in;  /* number of bytes available at next_in */
+    uLong    total_in;  /* total nb of input bytes read so far */
+
+    Bytef    *next_out; /* next output byte should be put there */
+    uInt     avail_out; /* remaining free space at next_out */
+    uLong    total_out; /* total nb of bytes output so far */
+
+    char     *msg;      /* last error message, NULL if no error */
+    struct internal_state FAR *state; /* not visible by applications */
+
+    alloc_func zalloc;  /* used to allocate the internal state */
+    free_func  zfree;   /* used to free the internal state */
+    voidp      opaque;  /* private data object passed to zalloc and zfree */
+
+    Byte     data_type; /* best guess about the data type: ascii or binary */
+
+} z_stream;
+
+/*
+   The application must update next_in and avail_in when avail_in has
+   dropped to zero. It must update next_out and avail_out when avail_out
+   has dropped to zero. The application must initialize zalloc, zfree and
+   opaque before calling the init function. All other fields are set by the
+   compression library and must not be updated by the application.
+
+   The opaque value provided by the application will be passed as the first
+   parameter for calls of zalloc and zfree. This can be useful for custom
+   memory management. The compression library attaches no meaning to the
+   opaque value.
+
+   zalloc must return Z_NULL if there is not enough memory for the object.
+   On 16-bit systems, the functions zalloc and zfree must be able to allocate
+   exactly 65536 bytes, but will not be required to allocate more than this
+   if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
+   pointers returned by zalloc for objects of exactly 65536 bytes *must*
+   have their offset normalized to zero. The default allocation function
+   provided by this library ensures this (see zutil.c). To reduce memory
+   requirements and avoid any allocation of 64K objects, at the expense of
+   compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
+
+   The fields total_in and total_out can be used for statistics or
+   progress reports. After compression, total_in holds the total size of
+   the uncompressed data and may be saved for use in the decompressor
+   (particularly if the decompressor wants to decompress everything in
+   a single step).
+*/
+
+                        /* constants */
+
+#define Z_NO_FLUSH      0
+#define Z_PARTIAL_FLUSH 1
+#define Z_FULL_FLUSH    2
+#define Z_SYNC_FLUSH    3 /* experimental: partial_flush + byte align */
+#define Z_FINISH        4
+#define Z_PACKET_FLUSH 5
+/* See deflate() below for the usage of these constants */
+
+#define Z_OK            0
+#define Z_STREAM_END    1
+#define Z_ERRNO        (-1)
+#define Z_STREAM_ERROR (-2)
+#define Z_DATA_ERROR   (-3)
+#define Z_MEM_ERROR    (-4)
+#define Z_BUF_ERROR    (-5)
+/* error codes for the compression/decompression functions */
+
+#define Z_BEST_SPEED             1
+#define Z_BEST_COMPRESSION       9
+#define Z_DEFAULT_COMPRESSION  (-1)
+/* compression levels */
+
+#define Z_FILTERED            1
+#define Z_HUFFMAN_ONLY        2
+#define Z_DEFAULT_STRATEGY    0
+
+#define Z_BINARY   0
+#define Z_ASCII    1
+#define Z_UNKNOWN  2
+/* Used to set the data_type field */
+
+#define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
+
+extern char *zlib_version;
+/* The application can compare zlib_version and ZLIB_VERSION for consistency.
+   If the first character differs, the library code actually used is
+   not compatible with the zlib.h header file used by the application.
+ */
+
+                        /* basic functions */
+
+extern int inflateInit OF((z_stream *strm));
+/*
+     Initializes the internal stream state for decompression. The fields
+   zalloc and zfree must be initialized before by the caller.  If zalloc and
+   zfree are set to Z_NULL, inflateInit updates them to use default allocation
+   functions.
+
+     inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
+   enough memory.  msg is set to null if there is no error message.
+   inflateInit does not perform any decompression: this will be done by
+   inflate().
+*/
+
+
+extern int inflate OF((z_stream *strm, int flush));
+/*
+  Performs one or both of the following actions:
+
+  - Decompress more input starting at next_in and update next_in and avail_in
+    accordingly. If not all input can be processed (because there is not
+    enough room in the output buffer), next_in is updated and processing
+    will resume at this point for the next call of inflate().
+
+  - Provide more output starting at next_out and update next_out and avail_out
+    accordingly.  inflate() always provides as much output as possible
+    (until there is no more input data or no more space in the output buffer).
+
+  Before the call of inflate(), the application should ensure that at least
+  one of the actions is possible, by providing more input and/or consuming
+  more output, and updating the next_* and avail_* values accordingly.
+  The application can consume the uncompressed output when it wants, for
+  example when the output buffer is full (avail_out == 0), or after each
+  call of inflate().
+
+    If the parameter flush is set to Z_PARTIAL_FLUSH or Z_PACKET_FLUSH,
+  inflate flushes as much output as possible to the output buffer. The
+  flushing behavior of inflate is not specified for values of the flush
+  parameter other than Z_PARTIAL_FLUSH, Z_PACKET_FLUSH or Z_FINISH, but the
+  current implementation actually flushes as much output as possible
+  anyway.  For Z_PACKET_FLUSH, inflate checks that once all the input data
+  has been consumed, it is expecting to see the length field of a stored
+  block; if not, it returns Z_DATA_ERROR.
+
+    inflate() should normally be called until it returns Z_STREAM_END or an
+  error. However if all decompression is to be performed in a single step
+  (a single call of inflate), the parameter flush should be set to
+  Z_FINISH. In this case all pending input is processed and all pending
+  output is flushed; avail_out must be large enough to hold all the
+  uncompressed data. (The size of the uncompressed data may have been saved
+  by the compressor for this purpose.) The next operation on this stream must
+  be inflateEnd to deallocate the decompression state. The use of Z_FINISH
+  is never required, but can be used to inform inflate that a faster routine
+  may be used for the single inflate() call.
+
+    inflate() returns Z_OK if some progress has been made (more input
+  processed or more output produced), Z_STREAM_END if the end of the
+  compressed data has been reached and all uncompressed output has been
+  produced, Z_DATA_ERROR if the input data was corrupted, Z_STREAM_ERROR if
+  the stream structure was inconsistent (for example if next_in or next_out
+  was NULL), Z_MEM_ERROR if there was not enough memory, Z_BUF_ERROR if no
+  progress is possible or if there was not enough room in the output buffer
+  when Z_FINISH is used. In the Z_DATA_ERROR case, the application may then
+  call inflateSync to look for a good compression block.  */
+
+
+extern int inflateEnd OF((z_stream *strm));
+/*
+     All dynamically allocated data structures for this stream are freed.
+   This function discards any unprocessed input and does not flush any
+   pending output.
+
+     inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
+   was inconsistent. In the error case, msg may be set but then points to a
+   static string (which must not be deallocated).
+*/
+
+                        /* advanced functions */
+
+extern int inflateInit2 OF((z_stream *strm,
+                            int  windowBits));
+/*
+     This is another version of inflateInit with more compression options. The
+   fields next_out, zalloc and zfree must be initialized before by the caller.
+
+     The windowBits parameter is the base two logarithm of the maximum window
+   size (the size of the history buffer).  It should be in the range 8..15 for
+   this version of the library (the value 16 will be allowed soon). The
+   default value is 15 if inflateInit is used instead. If a compressed stream
+   with a larger window size is given as input, inflate() will return with
+   the error code Z_DATA_ERROR instead of trying to allocate a larger window.
+
+     If next_out is not null, the library will use this buffer for the history
+   buffer; the buffer must either be large enough to hold the entire output
+   data, or have at least 1<<windowBits bytes.  If next_out is null, the
+   library will allocate its own buffer (and leave next_out null). next_in
+   need not be provided here but must be provided by the application for the
+   next call of inflate().
+
+     If the history buffer is provided by the application, next_out must
+   never be changed by the application since the decompressor maintains
+   history information inside this buffer from call to call; the application
+   can only reset next_out to the beginning of the history buffer when
+   avail_out is zero and all output has been consumed.
+
+      inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was
+   not enough memory, Z_STREAM_ERROR if a parameter is invalid (such as
+   windowBits < 8). msg is set to null if there is no error message.
+   inflateInit2 does not perform any decompression: this will be done by
+   inflate().
+*/
+
+extern int inflateSync OF((z_stream *strm));
+/*
+    Skips invalid compressed data until the special marker (see deflate()
+  above) can be found, or until all available input is skipped. No output
+  is provided.
+
+    inflateSync returns Z_OK if the special marker has been found, Z_BUF_ERROR
+  if no more input was provided, Z_DATA_ERROR if no marker has been found,
+  or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
+  case, the application may save the current current value of total_in which
+  indicates where valid compressed data was found. In the error case, the
+  application may repeatedly call inflateSync, providing more input each time,
+  until success or end of the input data.
+*/
+
+extern int inflateReset OF((z_stream *strm));
+/*
+     This function is equivalent to inflateEnd followed by inflateInit,
+   but does not free and reallocate all the internal decompression state.
+   The stream will keep attributes that may have been set by inflateInit2.
+
+      inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
+   stream state was inconsistent (such as zalloc or state being NULL).
+*/
+
+extern int inflateIncomp OF((z_stream *strm));
+/*
+     This function adds the data at next_in (avail_in bytes) to the output
+   history without performing any output.  There must be no pending output,
+   and the decompressor must be expecting to see the start of a block.
+   Calling this function is equivalent to decompressing a stored block
+   containing the data at next_in (except that the data is not output).
+*/
+
+                        /* checksum functions */
+
+/*
+     This function is not related to compression but is exported
+   anyway because it might be useful in applications using the
+   compression library.
+*/
+
+extern uLong adler32 OF((uLong adler, Bytef *buf, uInt len));
+
+/*
+     Update a running Adler-32 checksum with the bytes buf[0..len-1] and
+   return the updated checksum. If buf is NULL, this function returns
+   the required initial value for the checksum.
+   An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
+   much faster. Usage example:
+
+     uLong adler = adler32(0L, Z_NULL, 0);
+
+     while (read_buffer(buffer, length) != EOF) {
+       adler = adler32(adler, buffer, length);
+     }
+     if (adler != original_adler) error();
+*/
+
+#ifndef _Z_UTIL_H
+    struct internal_state {int dummy;}; /* hack for buggy compilers */
+#endif
+
+#endif /* _ZLIB_H */
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge