annotate clojure/com/aurellem/gb/rlm_assembly.clj @ 385:3f3cfc89be91

working on mode-dispatch
author Robert McIntyre <rlm@mit.edu>
date Thu, 12 Apr 2012 06:20:17 -0500
parents 8013915a07b3
children d8cbbf2a3133
rev   line source
rlm@377 1 (ns com.aurellem.gb.rlm-assembly
rlm@377 2 "Version of main bootstrap program that is valid output for the
rlm@377 3 item-writer program."
rlm@377 4 (:use (com.aurellem.gb gb-driver assembly util vbm constants))
rlm@377 5 (:use (com.aurellem.run bootstrap-1))
rlm@377 6 (:import [com.aurellem.gb.gb_driver SaveState]))
rlm@377 7
rlm@377 8 ;; Specs for Main Bootstrap Program
rlm@377 9
rlm@377 10 ;; Number-Input
rlm@377 11 ;; Number input works using all eight buttons to
rlm@377 12 ;; spell out an 8 bit number. The order of buttons is
rlm@377 13 ;; [:d :u :l :r :start :select :b :a] --> 11111111
rlm@377 14 ;; [ :l :start :a] --> 00101001
rlm@377 15
rlm@377 16 ;;; MODE-SELECT
rlm@377 17 ;; The bootstrap program starts in MODE-SELECT mode.
rlm@377 18 ;; MODE-SELECT transitions to one of three modes depending
rlm@377 19 ;; on which buttons are pressed:
rlm@377 20 ;; 0 (no-buttons) : MODE-SELECT
rlm@377 21 ;; 8 [:start] : WRITE-BYTES
rlm@377 22 ;; 0xFF (all-buttons) : JUMP
rlm@377 23
rlm@377 24 ;;; WRITE-BYTES
rlm@377 25
rlm@377 26 ;; WRITE-BYTES mode writes sequences of arbitray values to
rlm@377 27 ;; arbitray memory locations. It expects you to enter a
rlm@377 28 ;; header of three bytes describing what to write:
rlm@377 29
rlm@377 30 ;; Byte 0 : Number of Bytes to Write
rlm@377 31 ;; Byte 1 : Start Address High Byte
rlm@377 32 ;; Byte 1 : Start Address Low Byte
rlm@377 33
rlm@377 34 ;; Then, you enter the number of bytes specified in Byte 0
rlm@377 35 ;; they are written to the start address in
rlm@377 36 ;; sequence. After the last byte is written control
rlm@377 37 ;; returns to MODE-SELECT mode.
rlm@377 38
rlm@377 39 ;; Example: to write the sequence [1 2 3 4] starting at
rlm@377 40 ;; address 0xC01F enter
rlm@377 41 ;; Byte 0 : 4 (will write four bytes)
rlm@377 42 ;; Byte 1 : 0xC0 (high byte of 0xC01F)
rlm@377 43 ;; Byte 2 : 0x1F (low byte of 0xC01F)
rlm@377 44 ;; Byte 3 : 1 (write 1 to 0xC01F)
rlm@377 45 ;; Byte 4 : 2 (write 2 to 0xC020)
rlm@377 46 ;; Byte 5 : 3 (write 3 to 0xC021)
rlm@377 47 ;; Byte 6 : 4 (write 4 to 0xC022)
rlm@377 48
rlm@377 49 ;;; JUMP
rlm@377 50 ;; JUMP mode jumps program control to any arbitray
rlm@377 51 ;; location. It expects you to enter two bytes which
rlm@377 52 ;; correspond to the high and low bytes of the memory
rlm@377 53 ;; address to which you want to jump.
rlm@377 54 ;; Byte 0 : Jump Address High Byte
rlm@377 55 ;; Byte 1 : Jump Address Low Byte
rlm@377 56
rlm@377 57 ;; Example: to jump to address 0x1234 enter
rlm@377 58 ;; Byte 0 : 0x12 (high byte of 0x1234)
rlm@377 59 ;; Byte 1 : 0x34 (low byte of 0x1234)
rlm@377 60
rlm@377 61
rlm@378 62 (defn ->signed-8-bit [n]
rlm@378 63 (if (< n 0)
rlm@378 64 (+ 256 n) n))
rlm@378 65
rlm@378 66 (defn frame-metronome []
rlm@381 67 (let [timing-loop
rlm@383 68 [0x01 ; \
rlm@383 69 0x43 ; |
rlm@383 70 0xFE ; | load 0xFF44 into BC without repeats
rlm@383 71 0x0C ; |
rlm@383 72 0x04 ; /
rlm@382 73 0x0A] ;; (BC) -> A, now A = LY (vertical line coord)
rlm@379 74 continue-if-144
rlm@379 75 [0xFE
rlm@379 76 144 ;; compare LY (in A) with 144
rlm@379 77 0x20 ;; jump back to beginning if LY != 144 (not-v-blank)
rlm@379 78 (->signed-8-bit
rlm@381 79 (+ -4 (- (count timing-loop))))]
rlm@381 80 spin-loop
rlm@382 81 [0x05 ;; dec B, which is 0xFF
rlm@382 82 0x20 ;; spin until B==0
rlm@381 83 0xFD]]
rlm@381 84 (concat timing-loop continue-if-144 spin-loop)))
rlm@378 85
rlm@379 86 (defn test-frame-metronome
rlm@379 87 "Ensure that frame-metronome ticks exactly once every frame."
rlm@379 88 ([] (test-frame-metronome 151))
rlm@379 89 ([steps]
rlm@382 90 (let [inc-D [0x14 0x18
rlm@379 91 (->signed-8-bit
rlm@379 92 (+ -3 (- (count (frame-metronome)))))]
rlm@382 93 program (concat (frame-metronome) inc-D)
rlm@379 94 count-frames
rlm@379 95 (-> (tick (mid-game))
rlm@379 96 (IE! 0)
rlm@382 97 (DE! 0)
rlm@379 98 (set-memory-range pokemon-list-start program)
rlm@379 99 (PC! pokemon-list-start))
rlm@382 100 D-after-moves (D (run-moves count-frames (repeat steps [])))]
rlm@382 101 (println "D:" D-after-moves)
rlm@382 102 (assert (= steps D-after-moves))
rlm@379 103
rlm@382 104 (println "D =" D-after-moves "after" steps "steps")
rlm@379 105 count-frames)))
rlm@379 106
rlm@384 107 (defn read-user-input []
rlm@384 108 [0x01 ;\
rlm@384 109 0x01 ;|
rlm@384 110 0xFE ;| load 0xFF00 into BC without repeats
rlm@384 111 0x04 ;|
rlm@384 112 0x0D ;/
rlm@384 113
rlm@384 114 0x3E
rlm@384 115 (Integer/parseInt "00100000" 2) ; prepare to measure d-pad
rlm@384 116
rlm@384 117 0x02
rlm@384 118 0x0A ;; get D-pad info
rlm@385 119
rlm@385 120 0xF5 ;; push AF
rlm@385 121
rlm@385 122 0x3E
rlm@385 123 (Integer/parseInt "00010000" 2) ; prepare to measure buttons
rlm@385 124
rlm@385 125 0x02
rlm@385 126 0x0A ;; get button info
rlm@384 127
rlm@385 128
rlm@384 129 0xE6 ;; select bottom bits of A
rlm@384 130 0x0F
rlm@384 131
rlm@385 132 0x47 ;; A->B
rlm@385 133
rlm@385 134 0xF1 ;; pop AF
rlm@385 135
rlm@385 136 0xE6
rlm@385 137 0x0F ;; select bottom bits of A
rlm@385 138
rlm@384 139 0xCB
rlm@384 140 0x37 ;; swap A nybbles
rlm@384 141
rlm@385 142 0xB0 ;; (AND A B) -> A
rlm@384 143
rlm@384 144 0x2F ;; (NOT A) -> A
rlm@384 145 ])
rlm@384 146
rlm@384 147 (defn test-read-user-input []
rlm@384 148 (let [program
rlm@384 149 (concat
rlm@384 150 (frame-metronome) (read-user-input)
rlm@384 151 [0x5F ;; A-> E
rlm@384 152 0x18
rlm@384 153 (->signed-8-bit
rlm@384 154 (+ (- (count (frame-metronome)))
rlm@384 155 (- (count (read-user-input)))
rlm@384 156 (- 3)))])
rlm@384 157 read-input
rlm@384 158 (-> (tick (mid-game))
rlm@384 159 (IE! 0)
rlm@384 160 (set-memory-range pokemon-list-start program)
rlm@384 161 (PC! pokemon-list-start))]
rlm@384 162 (dorun
rlm@385 163 (for [i (range 0x100)]
rlm@385 164 (assert (= (E (step read-input (buttons i))) i))))
rlm@385 165 (println "Tested all inputs.")
rlm@384 166 read-input))
rlm@384 167
rlm@385 168 (def mode-select-mode (Integer/parseInt "00000000" 2))
rlm@385 169 (def write-mode (Integer/parseInt "00000001" 2))
rlm@385 170 (def jump-mode (Integer/parseInt "10000000" 2))
rlm@385 171
rlm@385 172 (def input-high-addr-jump (Integer/parseInt "10000010" 2))
rlm@385 173 (def input-high-addr-write (Integer/parseInt "00000010" 2))
rlm@385 174 (def input-low-addr-jump (Integer/parseInt "10000100" 2))
rlm@385 175 (def input-low-addr-write (Integer/parseInt "00000100" 2))
rlm@385 176
rlm@385 177 (def input-write-num-mode (Integer/parseInt "00001000" 2))
rlm@385 178 (def do-write-mode (Integer/parseInt "00010000" 2))
rlm@385 179
rlm@385 180
rlm@385 181
rlm@385 182
rlm@385 183
rlm@385 184
rlm@384 185
rlm@377 186 (defn main-bootstrap-program [start-address]
rlm@378 187 (let [[start-high start-low] (disect-bytes-2 start-address)
rlm@385 188 jump-distance (+ (count (frame-metronome)
rlm@385 189 (read-user-input)))
rlm@385 190
rlm@385 191 init
rlm@385 192 [0x1E 0xFF 0x1C] ;; 0-> E without repeats
rlm@385 193
rlm@385 194
rlm@385 195 ;; HL -> BC
rlm@385 196 ;; HL = here
rlm@385 197 ;; add E to HL
rlm@385 198 ;; jp HL
rlm@385 199
rlm@385 200 mode-dispatch
rlm@385 201 [0x44
rlm@385 202
rlm@385 203
rlm@385 204
rlm@385 205 ;;(here) jr metronome
rlm@385 206
rlm@385 207 ;;stuff
rlm@385 208 ;;modify E
rlm@385 209 ;;jr metronome
rlm@385 210
rlm@385 211 ;;stuff
rlm@385 212 ;;jr metronome
rlm@385 213
rlm@385 214
rlm@385 215
rlm@385 216
rlm@385 217
rlm@385 218
rlm@385 219
rlm@385 220 mode-dispatch
rlm@385 221 [0xCB
rlm@385 222 0x43 ;; test bit 0
rlm@385 223
rlm@385 224 0xCB
rlm@385 225 0x4B ;; test bit 1
rlm@385 226
rlm@385 227 0xCB
rlm@385 228 0x53 ;; test bit 2
rlm@385 229
rlm@385 230 0xCB
rlm@385 231 0x5B ;; test bit 3
rlm@385 232
rlm@385 233 0xCB
rlm@385 234 0x63 ;; test bit 4
rlm@385 235
rlm@385 236 0xCB
rlm@385 237 0x6B ;; test bit 5
rlm@385 238
rlm@385 239 ];;default
rlm@385 240
rlm@385 241
rlm@385 242 mode-select
rlm@385 243 [0x5F] ;; A->E
rlm@385 244
rlm@385 245 ;; delayed inputs
rlm@385 246 input-high 0x67 ;; A->H
rlm@385 247 input-low 0x6F ;; A->L
rlm@385 248 input-num 0x57 ;; A->D
rlm@385 249
rlm@385 250 ;; final-actions
rlm@385 251 jump 0xE9 ;; jp (HL)
rlm@385 252 write 0x22 ;; A->(HL); inc HL
rlm@385 253 input-mode 0x00 ;; no-op
rlm@385 254
rlm@385 255
rlm@385 256
rlm@385 257 input-high
rlm@385 258 [0x67 ;; A->H
rlm@385 259 0x1E ;; change mode
rlm@385 260 input-low-mode]
rlm@385 261
rlm@385 262
rlm@385 263
rlm@385 264
rlm@385 265 mode-dispatch
rlm@385 266
rlm@385 267
rlm@385 268
rlm@385 269
rlm@385 270
rlm@385 271
rlm@385 272
rlm@378 273 ))
rlm@378 274
rlm@378 275
rlm@378 276
rlm@378 277
rlm@378 278
rlm@378 279
rlm@378 280
rlm@378 281
rlm@378 282
rlm@377 283
rlm@377 284 ;;;;;; TESTS ;;;;;;
rlm@377 285
rlm@377 286 (defn bootstrap-base []
rlm@377 287 (let [program (main-bootstrap-program pokemon-list-start)]
rlm@377 288 ;; make sure program is valid output for item-writer
rlm@377 289 (bootstrap-pattern program)
rlm@377 290 (-> (tick (mid-game))
rlm@377 291 (set-memory-range pokemon-list-start program)
rlm@377 292 (PC! pokemon-list-start))))
rlm@377 293
rlm@377 294 (defn test-write-bytes-mode []
rlm@377 295 (let [target-address 0xC00F
rlm@377 296 [target-high target-low] (disect-bytes-2 target-address)
rlm@377 297 assembly [0xF3 0x18 0xFE 0x12]
rlm@377 298 get-mem-region #(subvec (vec (memory %))
rlm@377 299 target-address (+ target-address 20))
rlm@377 300 before (bootstrap-base)
rlm@377 301 after
rlm@377 302 (-> before
rlm@377 303 (step []) ; make sure it can handle blanks
rlm@377 304 (step []) ; at the beginning.
rlm@377 305 (step [])
rlm@377 306 (step [:start]) ; select WRITE-BYTES mode
rlm@377 307 (step (buttons 4)) ; write 4 bytes
rlm@377 308 (step (buttons target-high))
rlm@377 309 (step (buttons target-low))
rlm@377 310 (step (buttons (nth assembly 0)))
rlm@377 311 (step (buttons (nth assembly 1)))
rlm@377 312 (step (buttons (nth assembly 2)))
rlm@377 313 (step (buttons (nth assembly 3)))
rlm@377 314 (step [])
rlm@377 315 (step [])
rlm@377 316 (step []))]
rlm@377 317 (println "before :" (get-mem-region before))
rlm@377 318 (println "after :" (get-mem-region after))
rlm@377 319 (assert (= assembly (take 4 (get-mem-region after))))
rlm@377 320 after))
rlm@377 321
rlm@377 322 (defn test-jump-mode []
rlm@377 323 (let [target-address 0xC00F
rlm@377 324 [target-high target-low] (disect-bytes-2 target-address)
rlm@377 325 post-jump
rlm@377 326 (-> (test-write-bytes-mode)
rlm@377 327 (step [])
rlm@377 328 (step [])
rlm@377 329 (step [])
rlm@377 330 (step (buttons 0xFF)) ; Select JUMP mode.
rlm@377 331 (step (buttons target-high))
rlm@377 332 (step (buttons target-low)))
rlm@377 333 program-counters
rlm@377 334 (capture-program-counter
rlm@377 335 post-jump
rlm@377 336 10000)]
rlm@377 337 (println program-counters)
rlm@377 338 (assert (contains? (set program-counters) target-address))
rlm@377 339 post-jump))