view clojure/com/aurellem/gb/rlm_assembly.clj @ 396:c7a43f4ffd9d

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