@ GNU AS assembler header file for Squash
@ Written by DefMod (Dec  9 2012) on Sun Dec  9 15:45:18 2012
@ Jonathan Coxhead, jonathan@doves.demon.co.uk, 29 Jun 1995

@ OSLib---efficient, type-safe, transparent, extensible,
@ register-safe API coverage of RISC OS
@ 
@ Copyright (c) 1994-2012 Jonathan Coxhead and OSLib maintainers
@ 
@ Licence:
@ 
@    OSLib is free software; you can redistribute it and/or modify
@ it under the terms of the GNU General Public License as published by
@ the Free Software Foundation; either version 1, or (at your option)
@ any later version - and this with the following clarification and
@ special exception:
@ 
@    Linking this library statically or dynamically with other modules
@ is making a combined work based on this library. Thus, the terms
@ and conditions of the GNU General Public License cover the whole
@ combination.
@ 
@    As a special exception, the copyright holders of this library
@ give you permission to link this library with independent modules
@ to produce an executable, regardless of the license terms of these
@ independent modules, and to copy and distribute the resulting
@ executable under terms of your choice, provided that you also meet,
@ for each linked independent module, the terms and conditions of the
@ license of that module. An independent module is a module which is
@ not derived from or based on this library. If you modify this
@ library, you may extend this exception to your version of the library,
@ but you are not obliged to do so. If you do not wish to do so, delete
@ this exception statement from your version.
@ 
@    OSLib is distributed in the hope that it will be useful,
@ but WITHOUT ANY WARRANTY; without even the implied warranty of
@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@ GNU General Public License for more details.
@ 
@    You should have received a copy of the GNU General Public License
@ along with this programme; if not, write to the Free Software
@ Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, USA.

#ifndef Squash_Hdr
#  define Squash_Hdr

#  ifndef Get_Types
#    define Get_Types
#    include "oslib/Types.Hdr"
#  endif

#  ifndef Get_OS
#    define Get_OS
#    include "oslib/OS.Hdr"
#  endif

@Symbols for constants
#  define Error_SquashBadAddress 0x921
#  define Error_SquashBadInput 0x922
#  define Error_SquashBadWorkspace 0x923
#  define Error_SquashBadParameters 0x924
#  define Squash_FileType 0xfca
#  define Squash_InputNotStart 0x1
#  define Squash_InputNotEnd 0x2
#  define Squash_InputAllPresent 0x4
#  define Squash_OutputEnd 0x1
#  define Squash_OutputMore 0x2
#  define Squash_OutputNoMem 0x4

@Symbols for structure offsets and sizes
        .struct 0
        .skip   Bits
Squash_InputStatus             : 

        .struct 0
        .skip   Bits
Squash_OutputStatus            : 

        .struct 0
Squash_File_id                 : .skip   Bits
Squash_File_size               : .skip   Int
Squash_File_load_addr          : .skip   Bits
Squash_File_exec_addr          : .skip   Bits
Squash_File_reserved           : .skip   Int
Squash_File_data               : .skip   Byte
Squash_File                    : 
        
        .altmacro
        .macro  Squash_File_MEMBERS label
\label&_id                     : .skip   Bits
\label&_size                   : .skip   Int
\label&_load_addr              : .skip   Bits
\label&_exec_addr              : .skip   Bits
\label&_reserved               : .skip   Int
        .endm
        
        .struct 0
        Squash_File_MEMBERS Squash_FileBase
Squash_FileBase                : 


@Symbols for SWI's and SWI reason codes
.set XSquash_CompressReturnSizes,0x62700
.set Squash_CompressReturnSizes,0x42700
   @Entry
   @  R0 = &8
   @  R1 = input_size (Int)
   @Exit
   @  R0 = workspace_size (Int)
   @  R1 = output_size (Int)

.set XSquash_Compress,0x62700
.set Squash_Compress,0x42700
   @Entry
   @  R0 = input_status (Squash_InputStatus)
   @  R1 = workspace (pointer to Void)
   @  R2 -> input (data)
   @  R3 = input_size (Int)
   @  R4 = output (pointer to data)
   @  R5 = output_size (Int)
   @Exit
   @  R0 = output_status (Squash_OutputStatus)
   @  R2 -> input_out (data)
   @  R3 = input_spare (Int)
   @  R4 -> output_out (data)
   @  R5 = output_spare (Int)

.set XSquash_DecompressReturnSizes,0x62701
.set Squash_DecompressReturnSizes,0x42701
   @Entry
   @  R0 = &8
   @  R1 = input_size (Int)
   @Exit
   @  R0 = workspace_size (Int)
   @  R1 = output_size (Int)

.set XSquash_Decompress,0x62701
.set Squash_Decompress,0x42701
   @Entry
   @  R0 = input_status (Squash_InputStatus)
   @  R1 = workspace (pointer to Void)
   @  R2 -> input (data)
   @  R3 = input_size (Int)
   @  R4 = output (pointer to data)
   @  R5 = output_size (Int)
   @Exit
   @  R0 = output_status (Squash_OutputStatus)
   @  R2 -> input_out (data)
   @  R3 = input_spare (Int)
   @  R4 -> output_out (data)
   @  R5 = output_spare (Int)

#endif
