@ GNU AS assembler header file for Freeway
@ Written by DefMod (Dec  9 2012) on Sun Dec  9 15:47:15 2012
@ Jonathan Coxhead, jonathan@doves.demon.co.uk, 5 June 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 Freeway_Hdr
#  define Freeway_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 Freeway_TypeDisc 0x1
#  define Freeway_TypePrinter 0x2
#  define Freeway_TypeHost 0x5
#  define Freeway_InterestRegister 0x0
#  define Freeway_InterestDeregister 0x1
#  define Freeway_InterestUnauthenticated 0x0
#  define Freeway_InterestAuthenticated 0x2
#  define Freeway_ObjectAdd 0x0
#  define Freeway_ObjectRemove 0x1
#  define Freeway_ObjectUnauthenticated 0x0
#  define Freeway_ObjectAuthenticated 0x2
#  define Freeway_ReadGivenAuthentication 0x1
#  define Freeway_NoMore 0xffffffff
#  define Freeway_EnumerateAuthenticated 0x1
#  define Freeway_ObjectAdded 0x0
#  define Freeway_ObjectRemoved 0x1
#  define Freeway_ObjectChanged 0x2
#  define Freeway_ObjectDeleted 0x3

@Symbols for structure offsets and sizes
        .struct 0
        .skip   Int
Freeway_ObjectType             : 

        .struct 0
        .skip   Bits
Freeway_InterestFlags          : 

        .struct 0
        .skip   Bits
Freeway_ObjectFlags            : 

        .struct 0
        .skip   Bits
Freeway_ReadFlags              : 

        .struct 0
        .skip   Bits
Freeway_EnumerateFlags         : 

        .struct 0
        .skip   Bits
Freeway_StartingFlags          : 

        .struct 0
        .skip   Bits
Freeway_TerminatingFlags       : 

        .struct 0
        .skip   Int
Freeway_UpcallReason           : 


@Symbols for SWI's and SWI reason codes
.set XFreeway_Register,0x67a80
.set Freeway_Register,0x47a80
   @Entry
   @  R0 = flags (Freeway_InterestFlags)
   @  R1 = type (Freeway_ObjectType)
   @  R2 = authentication (Int)

.set XFreeway_Write,0x67a81
.set Freeway_Write,0x47a81
   @Entry
   @  R0 = flags (Freeway_ObjectFlags)
   @  R1 = type (Freeway_ObjectType)
   @  R2 -> obj_name (String)
   @  R3 = size (Int)
   @  R4 -> desc (String)
   @  R5 = authentication (Int)

.set XFreeway_Read,0x67a82
.set Freeway_Read,0x47a82
   @Entry
   @  R0 = flags (Freeway_ReadFlags)
   @  R1 = type (Freeway_ObjectType)
   @  R2 -> obj_name (String)
   @  R3 = size (Int)
   @  R4 = desc (pointer to String)
   @  R5 = authentication (Int)
   @Exit
   @  R3 = size_out (Int)
   @  R5 = ip_addr (Bits)

.set XFreeway_Enumerate,0x67a83
.set Freeway_Enumerate,0x47a83
   @Entry
   @  R0 = flags (Freeway_EnumerateFlags)
   @  R1 = type (Freeway_ObjectType)
   @  R2 = obj_name_size (Int)
   @  R3 = obj_name (pointer to String)
   @  R4 = desc_size (Int)
   @  R5 = desc (pointer to String)
   @  R6 = &0
   @  R7 = context (Int)
   @  R8 = authentication (Int)
   @Exit
   @  R2 = obj_name_size_out (Int)
   @  R4 = desc_size_out (Int)
   @  R6 = ip_addr (Bits)
   @  R7 = context_out (Int)

#  define Service_FreewayStarting 0x95
   @Entry
   @  R1 = &95
   @  R2 = flags (Freeway_StartingFlags)

#  define Service_FreewayTerminating 0x96
   @Entry
   @  R1 = &96
   @  R2 = flags (Freeway_TerminatingFlags)

#  define UpCall_Freeway 0xc
   @Entry
   @  R0 = &C
   @  R1 = reason (Freeway_UpcallReason)
   @  R2 = type (Freeway_ObjectType)
   @  R3 -> obj_name (String)
   @  R4 = desc_size (Int)
   @  R5 -> desc (String)
   @  R6 = ip_addr (Bits)

#endif
