Mercurial > vba-clojure

annotate clojure/com/aurellem/gb/rlm_assembly.clj @ 402:eee219d1a259

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
all tests passed.
author Robert McIntyre <rlm@mit.edu>
date Fri, 13 Apr 2012 09:47:34 -0500
parents 0262094d0914
children ea37e98e188e
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@390 8
rlm@390 9 ;; MODE-SELECT
rlm@390 10 ;; SET-LENGTH
rlm@390 11 ;; SET-TARGET
rlm@390 12 ;; WRITE
rlm@390 13 ;; JUMP
rlm@390 14
rlm@377 15 ;; Specs for Main Bootstrap Program
rlm@377 16
rlm@377 17 ;; Number-Input
rlm@377 18 ;; Number input works using all eight buttons to
rlm@377 19 ;; spell out an 8 bit number. The order of buttons is
rlm@377 20 ;; [:d :u :l :r :start :select :b :a] --> 11111111
rlm@377 21 ;; [ :l :start :a] --> 00101001
rlm@377 22
rlm@377 23 ;;; MODE-SELECT
rlm@377 24 ;; The bootstrap program starts in MODE-SELECT mode.
rlm@377 25 ;; MODE-SELECT transitions to one of three modes depending
rlm@377 26 ;; on which buttons are pressed:
rlm@377 27 ;; 0 (no-buttons) : MODE-SELECT
rlm@377 28 ;; 8 [:start] : WRITE-BYTES
rlm@377 29 ;; 0xFF (all-buttons) : JUMP
rlm@377 30
rlm@377 31 ;;; WRITE-BYTES
rlm@377 32
rlm@377 33 ;; WRITE-BYTES mode writes sequences of arbitray values to
rlm@377 34 ;; arbitray memory locations. It expects you to enter a
rlm@377 35 ;; header of three bytes describing what to write:
rlm@377 36
rlm@377 37 ;; Byte 0 : Number of Bytes to Write
rlm@377 38 ;; Byte 1 : Start Address High Byte
rlm@377 39 ;; Byte 1 : Start Address Low Byte
rlm@377 40
rlm@377 41 ;; Then, you enter the number of bytes specified in Byte 0
rlm@377 42 ;; they are written to the start address in
rlm@377 43 ;; sequence. After the last byte is written control
rlm@377 44 ;; returns to MODE-SELECT mode.
rlm@377 45
rlm@377 46 ;; Example: to write the sequence [1 2 3 4] starting at
rlm@377 47 ;; address 0xC01F enter
rlm@377 48 ;; Byte 0 : 4 (will write four bytes)
rlm@377 49 ;; Byte 1 : 0xC0 (high byte of 0xC01F)
rlm@377 50 ;; Byte 2 : 0x1F (low byte of 0xC01F)
rlm@377 51 ;; Byte 3 : 1 (write 1 to 0xC01F)
rlm@377 52 ;; Byte 4 : 2 (write 2 to 0xC020)
rlm@377 53 ;; Byte 5 : 3 (write 3 to 0xC021)
rlm@377 54 ;; Byte 6 : 4 (write 4 to 0xC022)
rlm@377 55
rlm@377 56 ;;; JUMP
rlm@377 57 ;; JUMP mode jumps program control to any arbitray
rlm@377 58 ;; location. It expects you to enter two bytes which
rlm@377 59 ;; correspond to the high and low bytes of the memory
rlm@377 60 ;; address to which you want to jump.
rlm@377 61 ;; Byte 0 : Jump Address High Byte
rlm@377 62 ;; Byte 1 : Jump Address Low Byte
rlm@377 63
rlm@377 64 ;; Example: to jump to address 0x1234 enter
rlm@377 65 ;; Byte 0 : 0x12 (high byte of 0x1234)
rlm@377 66 ;; Byte 1 : 0x34 (low byte of 0x1234)
rlm@377 67
rlm@377 68
rlm@378 69 (defn ->signed-8-bit [n]
rlm@378 70 (if (< n 0)
rlm@378 71 (+ 256 n) n))
rlm@378 72
rlm@378 73 (defn frame-metronome []
rlm@390 74 (let [init [0xC5] ;; save value of BC
rlm@390 75 timing-loop
rlm@388 76 [0x01 ; \
rlm@388 77 0x43 ; |
rlm@388 78 0xFE ; | load 0xFF44 into BC without repeats
rlm@388 79 0x0C ; |
rlm@388 80 0x04 ; /
rlm@388 81 0x0A] ;; (BC) -> A, now A = LY (vertical line coord)
rlm@379 82 continue-if-144
rlm@379 83 [0xFE
rlm@379 84 144 ;; compare LY (in A) with 144
rlm@379 85 0x20 ;; jump back to beginning if LY != 144 (not-v-blank)
rlm@379 86 (->signed-8-bit
rlm@381 87 (+ -4 (- (count timing-loop))))]
rlm@381 88 spin-loop
rlm@388 89 [0x05 ;; dec B, which is 0xFF
rlm@382 90 0x20 ;; spin until B==0
rlm@381 91 0xFD]]
rlm@390 92 (concat init timing-loop continue-if-144 spin-loop)))
rlm@378 93
rlm@379 94 (defn test-frame-metronome
rlm@379 95 "Ensure that frame-metronome ticks exactly once every frame."
rlm@379 96 ([] (test-frame-metronome 151))
rlm@379 97 ([steps]
rlm@388 98 (let [inc-E [0x1C 0x18
rlm@379 99 (->signed-8-bit
rlm@379 100 (+ -3 (- (count (frame-metronome)))))]
rlm@388 101 program (concat (frame-metronome) inc-E)
rlm@379 102 count-frames
rlm@379 103 (-> (tick (mid-game))
rlm@379 104 (IE! 0)
rlm@388 105 (DE! 0)
rlm@379 106 (set-memory-range pokemon-list-start program)
rlm@379 107 (PC! pokemon-list-start))
rlm@390 108 E-after-moves
rlm@390 109 (E (run-moves count-frames (repeat steps [])))]
rlm@388 110 (println "E:" E-after-moves)
rlm@388 111 (assert (= steps E-after-moves))
rlm@379 112
rlm@388 113 (println "E =" E-after-moves "after" steps "steps")
rlm@379 114 count-frames)))
rlm@379 115
rlm@384 116 (defn read-user-input []
rlm@388 117 [0x3E
rlm@388 118 0x20 ; prepare to measure d-pad
rlm@384 119
rlm@388 120 0x01 ;\
rlm@388 121 0x01 ; |
rlm@388 122 0xFE ; | load 0xFF00 into BC without repeats
rlm@388 123 0x04 ; |
rlm@388 124 0x0D ;/
rlm@386 125
rlm@388 126 0x02
rlm@388 127 0x0A ;; get D-pad info
rlm@385 128
rlm@385 129 0xF5 ;; push AF
rlm@385 130
rlm@385 131 0x3E
rlm@388 132 0x10 ; prepare to measure buttons
rlm@388 133
rlm@388 134 0x3F ;; clear carry flag no-op to prevent repeated nybbbles
rlm@385 135
rlm@388 136 0x02
rlm@388 137 0x0A ;; get button info
rlm@385 138
rlm@384 139 0xE6 ;; select bottom bits of A
rlm@384 140 0x0F
rlm@384 141
rlm@388 142 0x47 ;; A->B
rlm@385 143
rlm@385 144 0xF1 ;; pop AF
rlm@385 145
rlm@385 146 0xE6
rlm@385 147 0x0F ;; select bottom bits of A
rlm@385 148
rlm@384 149 0xCB
rlm@384 150 0x37 ;; swap A nybbles
rlm@387 151
rlm@388 152 0xB0 ;; (or A B) -> A
rlm@387 153
rlm@384 154 0x2F ;; (NOT A) -> A
rlm@390 155
rlm@384 156 ])
rlm@384 157
rlm@384 158 (defn test-read-user-input []
rlm@384 159 (let [program
rlm@384 160 (concat
rlm@384 161 (frame-metronome) (read-user-input)
rlm@388 162 [0x5F ;; A-> E
rlm@384 163 0x18
rlm@384 164 (->signed-8-bit
rlm@384 165 (+ (- (count (frame-metronome)))
rlm@384 166 (- (count (read-user-input)))
rlm@384 167 (- 3)))])
rlm@384 168 read-input
rlm@384 169 (-> (tick (mid-game))
rlm@384 170 (IE! 0)
rlm@384 171 (set-memory-range pokemon-list-start program)
rlm@384 172 (PC! pokemon-list-start))]
rlm@384 173 (dorun
rlm@385 174 (for [i (range 0x100)]
rlm@388 175 (assert (= (E (step read-input (buttons i))) i))))
rlm@385 176 (println "Tested all inputs.")
rlm@384 177 read-input))
rlm@384 178
rlm@393 179 (def symbol-index
rlm@393 180 (fn [symbol sequence]
rlm@393 181 (count (take-while
rlm@393 182 (partial not= symbol)
rlm@393 183 sequence))))
rlm@385 184
rlm@385 185
rlm@377 186 (defn main-bootstrap-program [start-address]
rlm@390 187 ;; Register Use:
rlm@390 188
rlm@391 189 ;; ED non-volitale scratch
rlm@391 190
rlm@390 191 ;; A user-input
rlm@390 192 ;; HL target-address
rlm@391 193 ;; B bytes-to-write
rlm@393 194 ;; C non-volatile scratch
rlm@390 195
rlm@391 196 ;; Modes (with codes) are:
rlm@390 197
rlm@390 198 ;; single-action-modes:
rlm@391 199 ;; SET-TARGET-HIGH 0x67 ;; A->H
rlm@391 200 ;; SET-TARGET-LOW 0x6F ;; A->L
rlm@391 201 ;; JUMP 0xE9 ;; jump to (HL)
rlm@390 202
rlm@390 203 ;; multi-action-modes
rlm@391 204 ;; WRITE 0x47 ;; A->B
rlm@390 205
rlm@378 206 (let [[start-high start-low] (disect-bytes-2 start-address)
rlm@390 207 jump-distance (+ (count (frame-metronome))
rlm@392 208 (count (read-user-input)))
rlm@385 209
rlm@385 210 init
rlm@398 211 [0xAF 0x4F 0x57 0x47] ;; 0->A; 0->C; 0->D; 0->B
rlm@388 212
rlm@391 213 input
rlm@391 214 [0xC1 ;; pop BC so it's not volatile
rlm@391 215
rlm@397 216 0x5F ;; A->E
rlm@396 217 0xAF ;; test for output-mode (bytes-to-write > 0)
rlm@401 218 0xB8 ;; (cp A B)
rlm@397 219 0x7B ;; E->A
rlm@400 220 0x20 ;; skip to output section if
rlm@396 221 :to-output ;; we're not in input mode
rlm@398 222
rlm@391 223 :to-be-executed
rlm@388 224
rlm@392 225 ;; write mode to instruction-to-be-executed (pun)
rlm@391 226 0xEA
rlm@391 227 :to-be-executed-address
rlm@398 228
rlm@400 229 ;; protection region -- do not queue this op for
rlm@400 230 ;; execution if the last one was non-zero
rlm@400 231 0x79 ;; C->A
rlm@400 232 0xA7 ;; test A==0
rlm@399 233 0x28
rlm@398 234 0x04
rlm@398 235 0xAF ;; put a no op (0x00) in to-be-executed
rlm@400 236 0xEA ;;
rlm@398 237 :to-be-executed-address
rlm@398 238
rlm@400 239 0x7B ;; E->A
rlm@400 240 0x4F ;; A->C now C stores previous instruction
rlm@391 241 0x18 ;; return
rlm@392 242 :to-beginning-1]
rlm@392 243
rlm@391 244 output
rlm@392 245 [:output-start ;; just a label
rlm@401 246 0x54 ;;
rlm@401 247 0x5D ;; HL->DE \
rlm@401 248 ;; | This mess is here to do
rlm@401 249 0x12 ;; A->(DE) | 0x22 (LDI (HL), A) without
rlm@391 250 ;; | any repeating nybbles
rlm@401 251 0x23 ;; inc HL /
rlm@391 252
rlm@401 253 0x05 ;; DEC bytes-to-write (B)
rlm@392 254
rlm@401 255 0x18
rlm@401 256 :to-beginning-2]
rlm@394 257
rlm@392 258 symbols
rlm@392 259 {:to-be-executed-address
rlm@393 260 (reverse
rlm@393 261 (disect-bytes-2
rlm@393 262 (+ start-address jump-distance
rlm@393 263 (count init)
rlm@393 264 (symbol-index :to-be-executed input))))
rlm@396 265 :to-be-executed 0x00} ;; clear carry flag no-op
rlm@391 266
rlm@392 267 program** (flatten
rlm@392 268 (replace
rlm@392 269 symbols
rlm@392 270 (concat init (frame-metronome)
rlm@392 271 (read-user-input)
rlm@392 272 input output)))
rlm@392 273 resolve-internal-jumps
rlm@392 274 {:output-start []
rlm@392 275 :to-output
rlm@392 276 (->signed-8-bit
rlm@402 277 (dec
rlm@402 278 (- (symbol-index :output-start program**)
rlm@402 279 (symbol-index :to-output program**))))}
rlm@389 280
rlm@392 281 program*
rlm@392 282 (flatten (replace resolve-internal-jumps program**))
rlm@392 283
rlm@392 284 resolve-external-jumps
rlm@392 285 {:to-beginning-1
rlm@392 286 (->signed-8-bit
rlm@393 287 (+ (count init)
rlm@396 288 -2 (- (dec (symbol-index :to-beginning-1 program*)))))
rlm@392 289 :to-beginning-2
rlm@392 290 (->signed-8-bit
rlm@393 291 (+ (count init)
rlm@396 292 -2 (- (dec (symbol-index :to-beginning-2 program*)))))}
rlm@389 293
rlm@392 294 program
rlm@392 295 (replace resolve-external-jumps program*)]
rlm@392 296 program))
rlm@378 297
rlm@378 298
rlm@377 299 ;;;;;; TESTS ;;;;;;
rlm@377 300
rlm@401 301 (def set-H-mode 0x67)
rlm@401 302 (def set-L-mode 0x6F)
rlm@401 303 (def jump-mode 0xE9)
rlm@401 304 (def write-mode 0x47)
rlm@401 305
rlm@401 306
rlm@377 307 (defn bootstrap-base []
rlm@377 308 (let [program (main-bootstrap-program pokemon-list-start)]
rlm@377 309 ;; make sure program is valid output for item-writer
rlm@392 310 ;;(bootstrap-pattern program)
rlm@377 311 (-> (tick (mid-game))
rlm@377 312 (set-memory-range pokemon-list-start program)
rlm@400 313 (PC! pokemon-list-start)
rlm@400 314 (step [])
rlm@400 315 (step []))))
rlm@377 316
rlm@400 317 (defn test-set-H []
rlm@400 318 (letfn [(test-H [state n]
rlm@400 319 (let [after
rlm@400 320 (-> state
rlm@402 321 (step (buttons set-H-mode))
rlm@400 322 (step (buttons n))
rlm@400 323 (step []))]
rlm@401 324 ;;(println "desired H =" n "actual =" (H after))
rlm@400 325 (assert (= n (H after)))
rlm@400 326 after))]
rlm@400 327 (println "tested all H values")
rlm@400 328 (reduce test-H (bootstrap-base) (range 0x100))))
rlm@400 329
rlm@401 330 (defn test-write-bytes []
rlm@377 331 (let [target-address 0xC00F
rlm@377 332 [target-high target-low] (disect-bytes-2 target-address)
rlm@377 333 assembly [0xF3 0x18 0xFE 0x12]
rlm@377 334 get-mem-region #(subvec (vec (memory %))
rlm@377 335 target-address (+ target-address 20))
rlm@377 336 before (bootstrap-base)
rlm@377 337 after
rlm@377 338 (-> before
rlm@392 339 (step []) ; make sure it can handle blanks
rlm@392 340 (step []) ; at the beginning.
rlm@377 341 (step [])
rlm@402 342 (step (buttons set-H-mode)) ; select set-H
rlm@401 343 (step (buttons target-high))
rlm@401 344 (step [])
rlm@402 345 (step (buttons set-L-mode))
rlm@401 346 (step (buttons target-low))
rlm@401 347 (step [])
rlm@401 348 (step (buttons write-mode))
rlm@392 349 (step (buttons 4)) ; write 4 bytes
rlm@377 350 (step (buttons (nth assembly 0)))
rlm@377 351 (step (buttons (nth assembly 1)))
rlm@377 352 (step (buttons (nth assembly 2)))
rlm@377 353 (step (buttons (nth assembly 3)))
rlm@377 354 (step [])
rlm@377 355 (step [])
rlm@377 356 (step []))]
rlm@377 357 (println "before :" (get-mem-region before))
rlm@377 358 (println "after :" (get-mem-region after))
rlm@402 359 (assert (= assembly (take 4 (get-mem-region after))))
rlm@377 360 after))
rlm@377 361
rlm@402 362 (defn test-jump []
rlm@377 363 (let [target-address 0xC00F
rlm@377 364 [target-high target-low] (disect-bytes-2 target-address)
rlm@377 365 post-jump
rlm@402 366 (-> (test-write-bytes)
rlm@402 367 (step (buttons set-H-mode)) ; select set-H
rlm@402 368 (step (buttons target-high))
rlm@377 369 (step [])
rlm@402 370 (step (buttons set-L-mode))
rlm@402 371 (step (buttons target-low))
rlm@377 372 (step [])
rlm@402 373 (step (buttons jump-mode))) ; Select JUMP mode.
rlm@377 374 program-counters
rlm@377 375 (capture-program-counter
rlm@377 376 post-jump
rlm@377 377 10000)]
rlm@377 378 (assert (contains? (set program-counters) target-address))
rlm@402 379 (println "jump test passed")
rlm@377 380 post-jump))
rlm@402 381
rlm@402 382
rlm@402 383 (defn run-all-tests []
rlm@402 384 (test-frame-metronome)
rlm@402 385 (test-read-user-input)
rlm@402 386 (test-set-H)
rlm@402 387 (test-write-bytes)
rlm@402 388 (test-jump))