rlm@377: (ns com.aurellem.gb.rlm-assembly
rlm@377:   "Version of main bootstrap program that is valid output for the
rlm@377:    item-writer program."
rlm@377:   (:use (com.aurellem.gb gb-driver assembly util vbm constants))
rlm@377:   (:use (com.aurellem.run bootstrap-1))
rlm@377:   (:import [com.aurellem.gb.gb_driver SaveState]))
rlm@377: 
rlm@390: 
rlm@390: ;; MODE-SELECT
rlm@390: ;; SET-LENGTH
rlm@390: ;; SET-TARGET
rlm@390: ;; WRITE
rlm@390: ;; JUMP
rlm@390: 
rlm@377: ;; Specs for Main Bootstrap Program
rlm@377: 
rlm@377: ;; Number-Input
rlm@377: ;; Number input works using all eight buttons to
rlm@377: ;;   spell out an 8 bit number.  The order of buttons is
rlm@377: ;;   [:d :u :l :r :start :select :b :a]  -->  11111111
rlm@377: ;;   [      :l    :start            :a]  -->  00101001
rlm@377: 
rlm@377: ;;; MODE-SELECT
rlm@377: ;;   The bootstrap program starts in MODE-SELECT mode.
rlm@377: ;;   MODE-SELECT transitions to one of three modes depending
rlm@377: ;;   on which buttons are pressed:
rlm@377: ;;       0   (no-buttons)  :  MODE-SELECT
rlm@377: ;;       8   [:start]      :  WRITE-BYTES
rlm@377: ;;    0xFF   (all-buttons) :  JUMP
rlm@377: 
rlm@377: ;;; WRITE-BYTES
rlm@377: 
rlm@377: ;;   WRITE-BYTES mode writes sequences of arbitray values to
rlm@377: ;;   arbitray memory locations. It expects you to enter a
rlm@377: ;;   header of three bytes describing what to write:
rlm@377: 
rlm@377: ;;    Byte 0  : Number of Bytes to Write
rlm@377: ;;    Byte 1  : Start Address High Byte
rlm@377: ;;    Byte 1  : Start Address Low  Byte
rlm@377: 
rlm@377: ;;   Then, you enter the number of bytes specified in Byte 0
rlm@377: ;;   they are written to the start address in
rlm@377: ;;   sequence. After the last byte is written control
rlm@377: ;;   returns to MODE-SELECT mode.
rlm@377: 
rlm@377: ;;   Example: to write the sequence [1 2 3 4] starting at
rlm@377: ;;   address 0xC01F enter
rlm@377: ;;    Byte 0  : 4 (will write four bytes)
rlm@377: ;;    Byte 1  : 0xC0  (high byte of 0xC01F)
rlm@377: ;;    Byte 2  : 0x1F  (low  byte of 0xC01F)
rlm@377: ;;    Byte 3  : 1 (write 1 to 0xC01F)
rlm@377: ;;    Byte 4  : 2 (write 2 to 0xC020)
rlm@377: ;;    Byte 5  : 3 (write 3 to 0xC021)
rlm@377: ;;    Byte 6  : 4 (write 4 to 0xC022)
rlm@377: 
rlm@377: ;;; JUMP 
rlm@377: ;;   JUMP mode jumps program control to any arbitray
rlm@377: ;;   location. It expects you to enter two bytes which
rlm@377: ;;   correspond to the high and low bytes of the memory
rlm@377: ;;   address to which you want to jump.
rlm@377: ;;    Byte 0  : Jump Address High Byte
rlm@377: ;;    Byte 1  : Jump Address Low  Byte
rlm@377: 
rlm@377: ;;   Example: to jump to address 0x1234 enter
rlm@377: ;;    Byte 0  : 0x12 (high byte of 0x1234)
rlm@377: ;;    Byte 1  : 0x34 (low  byte of 0x1234)
rlm@377: 
rlm@377: 
rlm@378: (defn ->signed-8-bit [n]
rlm@378:   (if (< n 0)
rlm@378:     (+ 256 n) n))
rlm@378: 
rlm@378: (defn frame-metronome []
rlm@390:   (let [init [0xC5] ;; save value of BC
rlm@390:         timing-loop
rlm@388:         [0x01 ; \
rlm@388:          0x43 ;  |
rlm@388:          0xFE ;  |  load 0xFF44 into BC without repeats
rlm@388:          0x0C ;  |
rlm@388:          0x04 ; /
rlm@388:          0x0A] ;; (BC) -> A, now A = LY (vertical line coord)
rlm@379:         continue-if-144
rlm@379:         [0xFE
rlm@379:          144     ;; compare LY (in A) with 144
rlm@379:          0x20    ;; jump back to beginning if LY != 144 (not-v-blank)
rlm@379:          (->signed-8-bit
rlm@381:           (+ -4 (- (count timing-loop))))]
rlm@381:         spin-loop
rlm@388:         [0x05 ;; dec B, which is 0xFF
rlm@382:          0x20 ;; spin until B==0
rlm@381:          0xFD]]
rlm@390:     (concat init timing-loop continue-if-144 spin-loop)))
rlm@378: 
rlm@379: (defn test-frame-metronome
rlm@379:   "Ensure that frame-metronome ticks exactly once every frame."
rlm@379:   ([] (test-frame-metronome 151))
rlm@379:   ([steps]
rlm@388:      (let [inc-E [0x1C 0x18
rlm@379:                   (->signed-8-bit
rlm@379:                    (+ -3 (- (count (frame-metronome)))))]
rlm@388:            program (concat (frame-metronome) inc-E)
rlm@379:            count-frames
rlm@379:            (-> (tick (mid-game))
rlm@379:                (IE! 0)
rlm@388:                (DE! 0)
rlm@379:                (set-memory-range pokemon-list-start program)
rlm@379:                (PC! pokemon-list-start))
rlm@390:            E-after-moves
rlm@390:            (E (run-moves count-frames (repeat steps [])))]
rlm@388:        (println "E:" E-after-moves) 
rlm@388:        (assert (= steps E-after-moves))
rlm@379: 
rlm@388:        (println "E =" E-after-moves "after" steps "steps")
rlm@379:        count-frames)))
rlm@379: 
rlm@384: (defn read-user-input []
rlm@388:   [0x3E
rlm@388:    0x20 ; prepare to measure d-pad
rlm@384: 
rlm@388:    0x01 ;\
rlm@388:    0x01 ; |
rlm@388:    0xFE ; |  load 0xFF00 into BC without repeats
rlm@388:    0x04 ; |
rlm@388:    0x0D ;/
rlm@386:    
rlm@388:    0x02 
rlm@388:    0x0A ;; get D-pad info
rlm@385:    
rlm@385:    0xF5 ;; push AF
rlm@385:       
rlm@385:    0x3E
rlm@388:    0x10 ; prepare to measure buttons
rlm@388: 
rlm@388:    0x3F ;; clear carry flag no-op to prevent repeated nybbbles
rlm@385:    
rlm@388:    0x02
rlm@388:    0x0A ;; get button info
rlm@385:    
rlm@384:    0xE6 ;; select bottom bits of A
rlm@384:    0x0F
rlm@384: 
rlm@388:    0x47 ;; A->B
rlm@385: 
rlm@385:    0xF1 ;; pop AF
rlm@385: 
rlm@385:    0xE6
rlm@385:    0x0F ;; select bottom bits of A
rlm@385: 
rlm@384:    0xCB
rlm@384:    0x37 ;; swap A nybbles
rlm@387: 
rlm@388:    0xB0 ;; (or A B) -> A
rlm@387:  
rlm@384:    0x2F ;; (NOT A) -> A
rlm@390:    
rlm@384:    ])
rlm@384: 
rlm@384: (defn test-read-user-input []
rlm@384:   (let [program
rlm@384:         (concat
rlm@384:          (frame-metronome) (read-user-input)
rlm@388:          [0x5F ;; A-> E
rlm@384:           0x18
rlm@384:           (->signed-8-bit
rlm@384:            (+ (- (count (frame-metronome)))
rlm@384:               (- (count (read-user-input)))
rlm@384:               (- 3)))])
rlm@384:         read-input
rlm@384:         (-> (tick (mid-game))
rlm@384:             (IE! 0)
rlm@384:             (set-memory-range pokemon-list-start program)
rlm@384:             (PC! pokemon-list-start))]
rlm@384:     (dorun
rlm@385:       (for [i (range 0x100)]
rlm@388:         (assert (= (E (step read-input (buttons i))) i))))
rlm@385:      (println "Tested all inputs.")
rlm@384:     read-input))
rlm@384: 
rlm@393: (def symbol-index
rlm@393:   (fn [symbol sequence]
rlm@393:     (count (take-while
rlm@393:             (partial not= symbol)
rlm@393:             sequence))))
rlm@385: 
rlm@385: 
rlm@377: (defn main-bootstrap-program [start-address]
rlm@390:   ;; Register Use:
rlm@390:   
rlm@391:   ;; ED non-volitale scratch
rlm@391:   
rlm@390:   ;; A  user-input
rlm@390:   ;; HL target-address
rlm@391:   ;; B  bytes-to-write
rlm@393:   ;; C  non-volatile scratch
rlm@390: 
rlm@391:   ;; Modes (with codes) are:
rlm@390: 
rlm@390:   ;; single-action-modes:
rlm@391:   ;; SET-TARGET-HIGH     0x67 ;; A->H
rlm@391:   ;; SET-TARGET-LOW      0x6F ;; A->L
rlm@391:   ;; JUMP                0xE9 ;; jump to (HL)
rlm@390: 
rlm@390:   ;; multi-action-modes
rlm@391:   ;; WRITE               0x47 ;; A->B
rlm@390: 
rlm@378:   (let [[start-high start-low] (disect-bytes-2 start-address)
rlm@390:         jump-distance (+ (count (frame-metronome))
rlm@392:                          (count (read-user-input)))
rlm@385: 
rlm@385:         init
rlm@398:         [0xAF 0x4F 0x57 0x47] ;; 0->A; 0->C; 0->D; 0->B
rlm@388: 
rlm@391:         input
rlm@391:         [0xC1  ;; pop BC so it's not volatile
rlm@391: 
rlm@397:          0x5F  ;; A->E
rlm@396:          0xAF  ;; test for output-mode (bytes-to-write > 0)
rlm@401:          0xB8  ;; (cp A B)
rlm@397:          0x7B  ;; E->A
rlm@400:          0x20       ;; skip to output section if
rlm@396:          :to-output ;; we're not in input mode 
rlm@398:        
rlm@391:          :to-be-executed
rlm@388: 
rlm@392:          ;; write mode to instruction-to-be-executed (pun)
rlm@391:          0xEA
rlm@391:          :to-be-executed-address
rlm@398: 
rlm@400:          ;; protection region -- do not queue this op for
rlm@400:          ;; execution if the last one was non-zero
rlm@400:          0x79 ;; C->A
rlm@400:          0xA7 ;; test A==0
rlm@399:          0x28
rlm@398:          0x04
rlm@398:          0xAF ;; put a no op (0x00) in to-be-executed
rlm@400:          0xEA ;; 
rlm@398:          :to-be-executed-address
rlm@398:          
rlm@400:          0x7B ;; E->A
rlm@400:          0x4F ;; A->C now C stores previous instruction
rlm@391:          0x18           ;; return
rlm@392:          :to-beginning-1]
rlm@392:         
rlm@391:         output
rlm@392:         [:output-start ;; just a label
rlm@401:          0x54 ;;
rlm@401:          0x5D ;; HL->DE  \
rlm@401:               ;;          | This mess is here to do
rlm@401:          0x12 ;; A->(DE)  | 0x22 (LDI (HL), A) without
rlm@391:               ;;          | any repeating nybbles
rlm@401:          0x23 ;; inc HL  /
rlm@391: 
rlm@401:          0x05 ;; DEC bytes-to-write (B)
rlm@392: 
rlm@401:          0x18
rlm@401:          :to-beginning-2]
rlm@394:         
rlm@392:         symbols
rlm@392:         {:to-be-executed-address
rlm@393:          (reverse
rlm@393:           (disect-bytes-2
rlm@393:            (+ start-address jump-distance
rlm@393:               (count init)
rlm@393:               (symbol-index :to-be-executed input))))
rlm@396:          :to-be-executed 0x00} ;; clear carry flag no-op
rlm@391: 
rlm@392:         program** (flatten
rlm@392:                   (replace
rlm@392:                    symbols
rlm@392:                    (concat init (frame-metronome)
rlm@392:                            (read-user-input)
rlm@392:                            input output)))
rlm@392:         resolve-internal-jumps
rlm@392:         {:output-start []
rlm@392:          :to-output
rlm@392:          (->signed-8-bit
rlm@402:           (dec
rlm@402:            (- (symbol-index :output-start program**)
rlm@402:               (symbol-index :to-output program**))))}
rlm@389: 
rlm@392:         program*
rlm@392:         (flatten (replace resolve-internal-jumps program**))
rlm@392:         
rlm@392:         resolve-external-jumps
rlm@392:         {:to-beginning-1
rlm@392:          (->signed-8-bit
rlm@393:           (+ (count init)
rlm@396:              -2 (- (dec (symbol-index :to-beginning-1 program*)))))
rlm@392:          :to-beginning-2
rlm@392:          (->signed-8-bit
rlm@393:           (+ (count init)
rlm@396:              -2 (- (dec (symbol-index :to-beginning-2 program*)))))}
rlm@389: 
rlm@392:         program
rlm@392:         (replace resolve-external-jumps program*)]
rlm@392:     program))
rlm@378:         
rlm@378:     
rlm@377: ;;;;;; TESTS ;;;;;;
rlm@377: 
rlm@401: (def set-H-mode 0x67)
rlm@401: (def set-L-mode 0x6F)
rlm@401: (def jump-mode  0xE9)
rlm@401: (def write-mode 0x47)
rlm@401: 
rlm@401: 
rlm@377: (defn bootstrap-base []
rlm@377:   (let [program (main-bootstrap-program pokemon-list-start)]
rlm@377:     ;; make sure program is valid output for item-writer
rlm@392:     ;;(bootstrap-pattern program)
rlm@377:     (-> (tick (mid-game))
rlm@377:         (set-memory-range pokemon-list-start program)
rlm@400:         (PC! pokemon-list-start)
rlm@400:         (step [])
rlm@400:         (step []))))
rlm@377: 
rlm@400: (defn test-set-H []
rlm@400:   (letfn [(test-H [state n]
rlm@400:             (let [after
rlm@400:                   (-> state
rlm@402:                       (step (buttons set-H-mode))
rlm@400:                       (step (buttons n))
rlm@400:                       (step []))]
rlm@401:               ;;(println "desired H =" n "actual =" (H after))
rlm@400:               (assert (= n (H after)))
rlm@400:               after))]
rlm@400:     (println "tested all H values")
rlm@400:     (reduce test-H (bootstrap-base) (range 0x100))))
rlm@400: 
rlm@401: (defn test-write-bytes []
rlm@377:   (let [target-address 0xC00F
rlm@377:         [target-high target-low] (disect-bytes-2 target-address)
rlm@377:         assembly [0xF3 0x18 0xFE 0x12]
rlm@377:         get-mem-region  #(subvec (vec (memory %))
rlm@377:                                  target-address (+ target-address 20))
rlm@377:         before (bootstrap-base)
rlm@377:         after
rlm@377:         (-> before
rlm@392:             (step [])           ; make sure it can handle blanks
rlm@392:             (step [])           ; at the beginning.
rlm@377:             (step [])                      
rlm@402:             (step (buttons set-H-mode))     ; select set-H
rlm@401:             (step (buttons target-high))
rlm@401:             (step [])
rlm@402:             (step (buttons set-L-mode))
rlm@401:             (step (buttons target-low))
rlm@401:             (step [])
rlm@401:             (step (buttons write-mode))
rlm@392:             (step (buttons 4))  ; write 4 bytes
rlm@377:             (step (buttons (nth assembly 0)))
rlm@377:             (step (buttons (nth assembly 1)))
rlm@377:             (step (buttons (nth assembly 2)))
rlm@377:             (step (buttons (nth assembly 3)))
rlm@377:             (step [])
rlm@377:             (step [])
rlm@377:             (step []))]
rlm@377:             (println "before :" (get-mem-region before))
rlm@377:             (println "after  :" (get-mem-region after))
rlm@402:             (assert (= assembly (take 4 (get-mem-region after))))
rlm@377:     after))
rlm@377: 
rlm@402: (defn test-jump []
rlm@377:   (let [target-address 0xC00F
rlm@377:         [target-high target-low] (disect-bytes-2 target-address)
rlm@377:         post-jump
rlm@402:         (-> (test-write-bytes)
rlm@402:             (step (buttons set-H-mode))     ; select set-H
rlm@402:             (step (buttons target-high))
rlm@377:             (step [])
rlm@402:             (step (buttons set-L-mode))
rlm@402:             (step (buttons target-low))
rlm@377:             (step [])
rlm@402:             (step (buttons jump-mode)))           ; Select JUMP mode.
rlm@377:         program-counters
rlm@377:         (capture-program-counter 
rlm@377:          post-jump
rlm@377:          10000)]
rlm@377:     (assert (contains? (set program-counters) target-address))
rlm@402:     (println "jump test passed")
rlm@377:     post-jump))
rlm@402: 
rlm@402: 
rlm@402: (defn run-all-tests []
rlm@402:   (test-frame-metronome)
rlm@402:   (test-read-user-input)
rlm@402:   (test-set-H)
rlm@402:   (test-write-bytes)
rlm@402:   (test-jump))