view clojure/com/aurellem/gb/rlm_assembly.clj @ 401:0262094d0914

finally made it to the actual writing part...
author Robert McIntyre <rlm@mit.edu>
date Fri, 13 Apr 2012 09:24:02 -0500
parents 1b9137ef7380
children eee219d1a259
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 0x4F 0x57 0x47] ;; 0->A; 0->C; 0->D; 0->B
213 input
214 [0xC1 ;; pop BC so it's not volatile
216 0x5F ;; A->E
217 0xAF ;; test for output-mode (bytes-to-write > 0)
218 0xB8 ;; (cp A B)
219 0x7B ;; E->A
220 0x20 ;; skip to output section if
221 :to-output ;; we're not in input mode
223 :to-be-executed
225 ;; write mode to instruction-to-be-executed (pun)
226 0xEA
227 :to-be-executed-address
229 ;; protection region -- do not queue this op for
230 ;; execution if the last one was non-zero
231 0x79 ;; C->A
232 0xA7 ;; test A==0
233 0x28
234 0x04
235 0xAF ;; put a no op (0x00) in to-be-executed
236 0xEA ;;
237 :to-be-executed-address
239 0x7B ;; E->A
240 0x4F ;; A->C now C stores previous instruction
241 0x18 ;; return
242 :to-beginning-1]
244 output
245 [:output-start ;; just a label
246 0x54 ;;
247 0x5D ;; HL->DE \
248 ;; | This mess is here to do
249 0x12 ;; A->(DE) | 0x22 (LDI (HL), A) without
250 ;; | any repeating nybbles
251 0x23 ;; inc HL /
253 0x05 ;; DEC bytes-to-write (B)
255 0x18
256 :to-beginning-2]
258 symbols
259 {:to-be-executed-address
260 (reverse
261 (disect-bytes-2
262 (+ start-address jump-distance
263 (count init)
264 (symbol-index :to-be-executed input))))
265 :to-be-executed 0x00} ;; clear carry flag no-op
267 program** (flatten
268 (replace
269 symbols
270 (concat init (frame-metronome)
271 (read-user-input)
272 input output)))
273 resolve-internal-jumps
274 {:output-start []
275 :to-output
276 (->signed-8-bit
277 (- (symbol-index :output-start program**)
278 (symbol-index :to-output program**)))}
280 program*
281 (flatten (replace resolve-internal-jumps program**))
283 resolve-external-jumps
284 {:to-beginning-1
285 (->signed-8-bit
286 (+ (count init)
287 -2 (- (dec (symbol-index :to-beginning-1 program*)))))
288 :to-beginning-2
289 (->signed-8-bit
290 (+ (count init)
291 -2 (- (dec (symbol-index :to-beginning-2 program*)))))}
293 program
294 (replace resolve-external-jumps program*)]
295 program))
298 ;;;;;; TESTS ;;;;;;
300 (def set-H-mode 0x67)
301 (def set-L-mode 0x6F)
302 (def jump-mode 0xE9)
303 (def write-mode 0x47)
306 (defn bootstrap-base []
307 (let [program (main-bootstrap-program pokemon-list-start)]
308 ;; make sure program is valid output for item-writer
309 ;;(bootstrap-pattern program)
310 (-> (tick (mid-game))
311 (set-memory-range pokemon-list-start program)
312 (PC! pokemon-list-start)
313 (step [])
314 (step []))))
316 (defn test-set-H []
317 (letfn [(test-H [state n]
318 (let [after
319 (-> state
320 (step (buttons set-H))
321 (step (buttons n))
322 (step []))]
323 ;;(println "desired H =" n "actual =" (H after))
324 (assert (= n (H after)))
325 after))]
326 (println "tested all H values")
327 (reduce test-H (bootstrap-base) (range 0x100))))
329 (defn test-write-bytes []
330 (let [target-address 0xC00F
331 [target-high target-low] (disect-bytes-2 target-address)
332 assembly [0xF3 0x18 0xFE 0x12]
333 get-mem-region #(subvec (vec (memory %))
334 target-address (+ target-address 20))
335 before (bootstrap-base)
336 after
337 (-> before
338 (step []) ; make sure it can handle blanks
339 (step []) ; at the beginning.
340 (step [])
341 (step (buttons set-H)) ; select set-H
342 (step (buttons target-high))
343 (step [])
344 (step (buttons set-L))
345 (step (buttons target-low))
346 (step [])
347 (step (buttons write-mode))
348 (step (buttons 4)) ; write 4 bytes
349 (step (buttons (nth assembly 0)))
350 (step (buttons (nth assembly 1)))
351 (step (buttons (nth assembly 2)))
352 (step (buttons (nth assembly 3)))
353 (step [])
354 (step [])
355 (step []))]
356 (println "before :" (get-mem-region before))
357 (println "after :" (get-mem-region after))
358 ;;(assert (= assembly (take 4 (get-mem-region after))))
359 after))
361 (defn test-jump-mode []
362 (let [target-address 0xC00F
363 [target-high target-low] (disect-bytes-2 target-address)
364 post-jump
365 (-> (test-write-bytes-mode)
366 (step [])
367 (step [])
368 (step [])
369 (step (buttons 0xFF)) ; Select JUMP mode.
370 (step (buttons target-high))
371 (step (buttons target-low)))
372 program-counters
373 (capture-program-counter
374 post-jump
375 10000)]
376 (println program-counters)
377 (assert (contains? (set program-counters) target-address))
378 post-jump))