;license:MIT
;(c) 2018-9 by 4am
;

;------------------------------------------------------------------------------
; YE OLDE GRAND UNIFIED MEMORY MAP
;
; LC RAM BANK 1
; D000..E5F4 - persistent data structures (per-game cheat categories,
;              gGlobalPrefsStore, gGamesListStore)
; ...unused...
; EB4C..FFF9 - main program code
; FFFA..FFFF - NMI, reset, IRQ vectors
;
; LC RAM BANK 2
; D000..D3FF - ProRWTS data
; D400..D5FF - ProRWTS code
; D600..D9FF - HGR font data
; DA00..DF2F - HGR font code & ProRWTS glue code
; ...unused...
; DFF0..DFFF - backup of stack (during gameplay and self-running demos)
;------------------------------------------------------------------------------

; soft switches
KBD =          $C000      ; last key pressed (if any)
CLEARKBD =     $C010      ; clear last key pressed
STOREOFF =     $C000      ; STA then use the following 4 flags:
READMAINMEM =  $C002      ; STA to read from main mem
READAUXMEM =   $C003      ; STA to read from aux mem
WRITEMAINMEM = $C004      ; STA to write to main mem
WRITEAUXMEM =  $C005      ; STA to write to aux mem
CLRC3ROM =     $C00A      ; STA to use internal Slot 3 ROM (required to use 128K and DHGR)
SETC3ROM =     $C00B      ; STA to use external Slot 3 ROM (required to detect VidHD in slot 3)
CLR80VID =     $C00C      ; 40 columns (also used to get out of DHGR mode)
SET80VID =     $C00D      ; 80 columns (also used to get into DHGR mode)
PRIMARYCHARSET= $C00E     ; no mousetext for you
SLOT3STATUS =  $C017      ; bit 7 only
TBCOLOR =      $C022      ; IIgs text foreground and background colors (also VidHD)
NEWVIDEO =     $C029      ; IIgs graphics modes (also VidHD)
SPEAKER =      $C030      ; chirp chirp
CLOCKCTL =     $C034      ; bits 0-3 are IIgs border color (also VidHD)
SHADOW =       $C035      ; IIgs auxmem-to-bank-E1 shadowing (also VidHD)
PAGE1 =        $C054      ; page 1 (affects text, HGR, DHGR)
PAGE2 =        $C055      ; page 2 (affects text, HGR, DHGR)
DHIRESON =     $C05E      ; double hi-res on switch
DHIRESOFF =    $C05F      ; double hi-res off switch

; ROM routines and addresses
; (prefixed because so much of the program runs from LC RAM, so don't call
; these without thinking about memory banks first)
ROM_TEXT2COPY =$F962      ; turn on alternate display mode on IIgs
ROM_TEXT =     $FB2F
ROM_MACHINEID =$FBB3
ROM_HOME =     $FC58
ROM_NORMAL =   $FE84      ; NORMAL text (instead of INVERSE or FLASH)
ROM_IN0 =      $FE89      ; SETKBD
ROM_PR0 =      $FE93      ; SETVID

; zero page
PARAM        = $00        ; used by PARAMS_ON_STACK macro, so basically everywhere
PTR          = $02
SRC          = $04
DEST         = $06
SAVE         = $08
HTAB         = $24
VTAB         = $25
RNDSEED      = $4E        ; word
Timeout      = $ED        ; 3 bytes (used by SearchMode)
zpMachineStatus= $F0      ; bit 7 = 1 if machine has joystick
                          ; bit 6 = 1 if machine has 128K
                          ; bit 5 = 1 if machine has a VidHD card
                          ; bit 4 = 1 if machine is a IIgs
                          ; only used during init, then copied to MachineStatus in LC RAM
zpCharMask   = $F1        ; only uesd during init, then clobbered
;              $FE        ; used by ParseGamesList
;              $FF        ; used by ParseGamesList

; main memory
gPathname    = $1F00      ; used by SetPath/AddToPath
gKeyLen      = $1F00      ; used by ParseGamesList
gKey         = $1F01
UILine1      = $1FB0
UILine2      = $1FD8
UI_ToPlay    = $1FF7

gValLen      = $1F80
gVal         = $1F81

; LC RAM 1
gCheatsAvailable = $D000  ; master cheats table, indexed by game index in gGamesListStore
                          ; 1 byte per game, so max size = 256 games
gCheatsEnabled   = $D0FF  ; bit 7 = 1 if cheats are enabled

; actual constants
SUPPORTS_SHR = %00110000  ; AND mask for MachineStatus