atari.inc

6502 c compiler free open source

;-------------------------------------------------------------------------
; Atari System Equates
; by Freddy Offenga & Christian Groessler
;
; References:
; - Atari 400/800 OS rev.B source code, Atari 1979
; - Atari OS manual - XL addendum
; - Atari XL/XE rev.2 source code, Atari 1984
; - Mapping the Atari - revised edition, Ian Chadwick 1985
;
; ##old##	old OS rev.B label - moved or deleted
; ##1200xl##	new label introduced in 1200XL OS (rev.10/11)
; ##rev2##	new label introduced in XL/XE OS rev.2
;-------------------------------------------------------------------------

;-------------------------------------------------------------------------
; Configuration Equates
;-------------------------------------------------------------------------

MAXDEV	= 33		;offset to last possible entry of HATABS
IOCBSZ	= 16		;length of IOCB

SEIOCB	= 0*IOCBSZ	;##rev2## screen editor IOCB index
MAXIOC	= 8*IOCBSZ	;first invalid IOCB index

DSCTSZ	= 128		;##rev2## disk sector size

LEDGE	= 2		;left edge
REDGE	= 39		;right edge

INIML	= $0700		;##rev2## initial MEMLO

ICSORG	= $CC00		;##rev2## international character set origin
DCSORG	= $E000		;##rev2## domestic character set origin

; IOCB Command Code Equates

OPEN	= $03		;open
GETREC	= $05		;get record
GETCHR	= $07		;get character(s)
PUTREC	= $09		;put record
PUTCHR	= $0B		;put character(s)
CLOSE	= $0C		;close
STATIS	= $0D		;status
SPECIL	= $0E		;special

; Special Entry Command Equates

; Screen Commands

DRAWLN	= $11		;draw line
FILLIN	= $12		;draw line with right fill

; ICAX1 Auxiliary Byte 1 Equates

APPEND	= $01		;open write append (D:)
DIRECT	= $02		;open for directory access (D:)
OPNIN	= $04		;open for input (all devices)
OPNOT	= $08		;open for output (all devices)
MXDMOD	= $10		;open for mixed mode (E:, S:)
INSCLR	= $20		;open for input without clearing screen

; Device Code Equates

CASSET	= 'C'		;cassette
DISK	= 'D'		;disk
SCREDT	= 'E'		;screen editor
KBD	= 'K'		;keyboard
PRINTR	= 'P'		;printer
DISPLY	= 'S'		;screen display

; SIO Command Code Equates

SIO_FORMAT   = $21	;format disk (default density)
SIO_FORMATS  = $22	;1050: format medium density
SIO_CONFIG   = $44	;configure drive
SIO_CONFIGSF = $4B	;slow/fast configure drive??
SIO_WRITE    = $50	;write sector
SIO_READ     = $52	;read sector
SIO_STAT     = $53	;get status information
SIO_VERIFY   = $56	;verify sector 
SIO_WRITEV   = $57	;write sector with verify

; Character and Key Code Equates

CLS	= $7D		;##rev2## clear screen
EOL	= $9B		;end of line (RETURN)

HELP	= $11		;##1200xl## key code for HELP
CNTLF1	= $83		;##1200xl## key code for CTRL-F1
CNTLF2	= $84		;##1200xl## key code for CTRL-F2
CNTLF3	= $93		;##1200xl## key code for CTRL-F3
CNTLF4	= $94		;##1200xl## key code for CTRL-F4
CNTL1	= $9F		;##1200xl## key code for CTRL-1

; Status Code Equates

SUCCES	= 1		;($01) succesful operation

BRKABT	= 128		;($80) BREAK key abort
PRVOPN	= 129		;($81) IOCB already open error
NONDEV	= 130		;($82) nonexistent device error
WRONLY	= 131		;($83) IOCB opened for write only error
NVALID	= 132		;($84) invalid command error
NOTOPN	= 133		;($85) device/file not open error
BADIOC	= 134		;($86) invalid IOCB index error
RDONLY	= 135		;($87) IOCB opened for read only error
EOFERR	= 136		;($88) end of file error
TRNRCD	= 137		;($89) truncated record error
TIMOUT	= 138		;($8A) peripheral device timeout error
DNACK	= 139		;($8B) device does not acknowledge command
FRMERR	= 140		;($8C) serial bus framing error
CRSROR	= 141		;($8D) cursor overrange error
OVRRUN	= 142		;($8E) serial bus data overrun error
CHKERR	= 143		;($8F) serial bus checksum error
DERROR	= 144		;($90) device done (operation incomplete)
BADMOD	= 145		;($91) bad screen mode number error
FNCNOT	= 146		;($92) function not implemented in handler
SCRMEM	= 147		;($93) insufficient memory for screen mode

DSKFMT	= 148		;($94) SpartaDOS: urecognized disk format
INCVER	= 149		;($95) SpartaDOS: disk was made with incompat. version
DIRNFD	= 150		;($96) SpartaDOS: directory not found
FEXIST	= 151		;($97) SpartaDOS: file exists
NOTBIN	= 152		;($98) SpartaDOS: file not binary
LSYMND	= 154		;($9A) SDX: loader symbol not defined
BADPRM	= 156		;($9C) SDX: bad parameter
OUTOFM	= 158		;($9E) SDX: out of memory
INVDEV	= 160		;($A0) invalid device number
TMOF	= 161		;($A1) too many open files
DSKFLL	= 162		;($A2) disk full
FATLIO	= 163		;($A3) fatal I/O error
FNMSMT	= 164		;($A4) internal file number mismatch
INVFNM	= 165		;($A5) invalid file name
PDLERR	= 166		;($A6) point data length error
EPERM	= 167		;($A7) permission denied
DINVCM	= 168		;($A8) command invalid for disk
DIRFLL	= 169		;($A9) directory full
FNTFND	= 170		;($AA) file not found
PNTINV	= 171		;($AB) point invalid
BADDSK	= 173		;($AD) bad disk
INCFMT	= 176		;($B0) DOS 3: incompatible file system

; DCB Device Bus Equates

DISKID	= $31		;##rev2## disk bus ID
PDEVN	= $40		;##rev2## printer bus ID
CASET	= $60		;##rev2## cassette bus ID

; Bus Command Equates

FOMAT	= '!'		;##rev2## format command
PUTSEC	= 'P'		;##rev2## put sector command
READ	= 'R'		;##rev2## read command
STATC	= 'S'		;##rev2## status command
WRITE	= 'W'		;##rev2## write command

; Command Auxiliary Byte Equates

DOUBLE	= 'D'		;##rev2## print 20 characters double width
NORMAL	= 'N'		;##rev2## print 40 characters normally
PLOT	= 'P'		;##rev2## plot
SIDWAY	= 'S'		;##rev2## print 16 characters sideways

; Bus Response Equates

ACK	= 'A'		;##rev2## device acknowledged
COMPLT	= 'C'		;##rev2## device succesfully completed operation
ERROR	= 'E'		;##rev2## device incurred error
NACK	= 'N'		;##rev2## device did not understand

; Floating Point Miscellaneous Equates

FPREC	= 6		;precision

FMPREC	= FPREC-1	;##rev2## length of mantissa

; Cassette Record Type Equates

HDR	= $FB		;##rev2## header
DTA	= $FC		;##rev2## data record
DT1	= $FA		;##rev2## last data record
EOT	= $FE		;##rev2## end of tape (file)

TONE1	= 2		;##rev2## record
TONE2	= 1		;##rev2## playback

; Cassette Timing Equates

WLEADN	= 1152		;##rev2## NTSC 19.2 second WRITE file leader
RLEADN	= 576		;##rev2## NTSC 9.6 second READ file leader
WIRGLN	= 180		;##rev2## NTSC 3.0 second WRITE IRG
RIRGLN	= 120		;##rev2## NTSC 2.0 second READ IRG
WSIRGN	= 15		;##rev2## NTSC 0.25 second WRITE short IRG
RSIRGN	= 10		;##rev2## NTSC 0.16 second READ short IRG
BEEPNN	= 30		;##rev2## NTSC 0.5 second beep duration
BEEPFN	= 10		;##rev2## NTSC 0.16 seconrd beep duration

WLEADP	= 960		;##rev2## PAL 19.2 second WRITE file leader
RLEADP	= 480		;##rev2## PAL 9.6 second READ file leader
WIRGLP	= 150		;##rev2## PAL 3.0 second WRITE IRG
RIRGLP	= 100		;##rev2## PAL 2.0 second READ IRG
WSIRGP	= 13		;##rev2## PAL 0.25 second WRITE short IRG
RSIRGP	= 8		;##rev2## PAL 0.16 second READ short IRG
BEEPNP	= 25		;##rev2## PAL 0.5 second beep duration
BEEPFP	= 8		;##rev2## PAL 0.16 seconrd beep duration

WIRGHI	= 0		;##rev2## high WRITE IRG
RIRGHI	= 0		;##rev2## high READ IRG

; Power-up Validation Byte Value Equates

PUPVL1	= $5C		;##rev2## power-up validation value 1
PUPVL2	= $93		;##rev2## power-up validation value 2
PUPVL3	= $25		;##rev2## power-up validation value 3

; Relocating Loader Miscellaneous Equates

DATAER	= 156		;##rev2## end of record appears before END
MEMERR	= 157		;##rev2## memory insufficient for load error

; Miscellaneous Equates

IOCFRE	= $FF		;IOCB free indication

B19200	= $0028		;##rev2## 19200 baud POKEY counter value
B00600	= $05CC		;##rev2## 600 baud POKEY counter value

HITONE	= $05		;##rev2## FSK high freq. POKEY counter value
LOTONE	= $07		;##rev2## FSK low freq. POKEY counter value

NCOMLO	= $34		;##rev2## PIA lower NOT COMMAND line command
NCOMHI	= $3C		;##rev2## PIA raise NOT COMMAND line command

MOTRGO	= $34		;##rev2## PIA cassette motor ON command
MOTRST	= $3C		;##rev2## PIA cassette motor OFF command

NODAT	= $00		;##rev2## SIO immediate operation
GETDAT	= $40		;##rev2## SIO read data frame
PUTDAT	= $80		;##rev2## SIO write data frame

CRETRI	= 13		;##rev2## number of command frame retries
DRETRI	= 1		;##rev2## number of device retries
CTIM	= 2		;##rev2## command frame ACK timeout

NBUFSZ	= 40		;##rev2## print normal buffer size
DBUFSZ	= 20		;##rev2## print double buffer size
SBUFSZ	= 29		;##rev2## print sideways buffer size

;-------------------------------------------------------------------------
; Page Zero Address Equates
;-------------------------------------------------------------------------

LINZBS	= $00		;LINBUG RAM (WILL BE REPLACED BY MONITOR RAM)
LNFLG	= $00		;##1200xl## 1-byte LNBUG flag (0 = not LNBUG)
NGFLAG	= $01		;##1200xl## 1-byte memory status (0 = failure)

; Not Cleared

CASINI	= $02		;CASSETTE INIT LOCATION
RAMLO	= $04		;RAM POINTER FOR MEMORY TEST
TRAMSZ	= $06		;TEMPORARY REGISTER FOR RAM SIZE
;TSTDAT	= $07		;##old## RAM TEST DATA REGISTER
CMCMD	= $07		;##rev2## 1-byte command communications

; Cleared upon Coldstart only

WARMST	= $08		;WARM START FLAG
BOOTQ	= $09		;SUCCESSFUL BOOT FLAG
DOSVEC	= $0A		;DISK SOFTWARE START VECTOR
DOSINI	= $0C		;DISK SOFTWARE INIT ADDRESS
APPMHI	= $0E		;APPLICATIONS MEMORY HI LIMIT

; Cleared upon Coldstart or Warmstart

INTZBS	= $10		;INTERRUPT HANDLER

POKMSK	= $10		;SYSTEM MASK FOR POKEY IRG ENABLE
BRKKEY	= $11		;BREAK KEY FLAG
RTCLOK	= $12		;REAL TIME CLOCK (IN 16 MSEC UNITS>
BUFADR	= $15		;INDIRECT BUFFER ADDRESS REGISTER
ICCOMT	= $17		;COMMAND FOR VECTOR
DSKFMS	= $18		;DISK FILE MANAGER POINTER
DSKUTL	= $1A		;DISK UTILITIES POINTER
ABUFPT	= $1C		;##1200xl## 4-byte ACMI buffer pointer area

;PTIMOT	= $1C		;##old## PRINTER TIME OUT REGISTER
;PBPNT	= $1D		;##old## PRINT BUFFER POINTER
;PBUFSZ	= $1E		;##old## PRINT BUFFER SIZE
;PTEMP	= $1F		;##old## TEMPORARY REGISTER

ZIOCB	= $20		;ZERO PAGE I/O CONTROL BLOCK
IOCBAS	= $20		;16-byte page zero IOCB
ICHIDZ	= $20		;HANDLER INDEX NUMBER (FF = IOCB FREE)
ICDNOZ	= $21		;DEVICE NUMBER (DRIVE NUMBER)
ICCOMZ	= $22		;COMMAND CODE
ICSTAZ	= $23		;STATUS OF LAST IOCB ACTION
ICBALZ	= $24		;BUFFER ADDRESS LOW BYTE
ICBAHZ	= $25		;1-byte high buffer address
ICPTLZ	= $26		;PUT BYTE ROUTINE ADDRESS -1
ICPTHZ	= $27		;1-byte high PUT-BYTE routine address
ICBLLZ	= $28		;BUFFER LENGTH LOW BYTE
ICBLHZ	= $29		;1-byte high buffer length
ICAX1Z	= $2A		;AUXILIARY INFORMATION FIRST BYTE
ICAX2Z	= $2B		;1-byte second auxiliary information
ICSPRZ	= $2C		;4-byte spares

ENTVEC	= $2C		;##rev2## 2-byte (not used)
ICIDNO	= $2E		;IOCB NUMBER X 16
CIOCHR	= $2F		;CHARACTER BYTE FOR CURRENT OPERATION

STATUS	= $30		;INTERNAL STATUS STORAGE
CHKSUM	= $31		;CHECKSUM (SINGLE BYTE SUM WITH CARRY)
BUFRLO	= $32		;POINTER TO DATA BUFFER (LO BYTE)
BUFRHI	= $33		;POINTER TO DATA BUFFER (HI BYTE)
BFENLO	= $34		;NEXT BYTE PAST END OF THE DATA BUFFER LO
BFENHI	= $35		;NEXT BYTE PAST END OF THE DATA BUFFER HI
;CRETRY	= $36		;##old## NUMBER OF COMMAND FRAME RETRIES
;DRETRY	= $37		;##old## NUMBER OF DEVICE RETRIES
LTEMP	= $36		;##1200xl## 2-byte loader temporary
BUFRFL	= $38		;DATA BUFFER FULL FLAG
RECVDN	= $39		;RECEIVE DONE FLAG
XMTDON	= $3A		;TRANSMISSION DONE FLAG
CHKSNT	= $3B		;CHECKSUM SENT FLAG
NOCKSM	= $3C		;NO CHECKSUM FOLLOWS DATA FLAG
BPTR	= $3D		;1-byte cassette buffer pointer
FTYPE	= $3E		;1-byte cassette IRG type
FEOF	= $3F		;1-byte cassette EOF flag (0 = quiet)
FREQ	= $40		;1-byte cassette beep counter
SOUNDR	= $41		;NOISY I/0 FLAG. (ZERO IS QUIET)

CRITIC	= $42		;DEFINES CRITICAL SECTION (CRITICAL IF NON-Z)

FMSZPG	= $43		;DISK FILE MANAGER SYSTEM ZERO PAGE

;CKEY	= $4A		;##old## FLAG SET WHEN GAME START PRESSED
ZCHAIN	= $4A		;##1200xl## 2-byte handler linkage chain pointer
;CASSBT	= $4B		;##old## CASSETTE BOOT FLAG
DSTAT	= $4C		;DISPLAY STATUS
ATRACT	= $4D		;ATRACT FLAG
DRKMSK	= $4E		;DARK ATRACT MASK
COLRSH	= $4F		;ATRACT COLOR SHIFTER (EOR'ED WITH PLAYFIELD


TMPCHR	= $50		;1-byte temporary character
HOLD1	= $51		;1-byte temporary
LMARGN	= $52		;LEFT MARGIN (SET TO 1 AT POWER ON>
RMARGN	= $53		;RIGHT MARGIN (SET TO 38 AT POWER ON)
ROWCRS	= $54		;1-byte cursor row
COLCRS	= $55		;2-byte cursor column
DINDEX	= $57		;1-byte display mode
SAVMSC	= $58		;2-byte saved memory scan counter
OLDROW	= $5A		;1-byte prior row
OLDCOL	= $5B		;2-byte prior column
OLDCHR	= $5D		;DATA UNDER CURSOR
OLDADR	= $5E		;2-byte saved cursor memory address
FKDEF	= $60		;##1200xl## 2-byte function key definition table
;NEWROW	= $60		;##old## POINT DRAW GOES TO
;NEWCOL	= $61		;##old##
PALNTS	= $62		;##1200xl## 1-byte PAL/NTSC indicator (0 = NTSC)
LOGCOL	= $63		;POINTS AT COLUMN IN LOGICAL LINE
ADRESS	= $64		;2-byte temporary address

MLTTMP	= $66		;1-byte temporary
OPNTMP	= $66		;FIRST BYTE IS USED IN OPEN AS TEMP
TOADR	= $66		;##rev2## 2-byte destination address

SAVADR	= $68		;2-byte saved address