pic18-sim.scm

   1 ;;; File: "pic18-sim.scm"
   2
   3 (include "pic18.scm")
   4
   5 ;------------------------------------------------------------------------------
   6
   7 (define pic18-ram   #f)
   8 (define pic18-rom   #f)
   9 (define pic18-stack #f)
  10 (define pic18-pc    #f)
  11 (define pic18-wreg  #f)
  12
  13 (define pic18-carry-flag    #f)
  14 (define pic18-deccarry-flag #f)
  15 (define pic18-zero-flag     #f)
  16 (define pic18-overflow-flag #f)
  17 (define pic18-negative-flag #f)
  18
  19 (define pic18-cycles #f)
  20 (define pic18-exit #f)
  21
  22 (define (get-ram adr)
  23   (cond ((= adr TOSU)
  24          (bitwise-and (arithmetic-shift (get-tos) -16) #xff))
  25         ((= adr TOSH)
  26          (bitwise-and (arithmetic-shift (get-tos) -8) #xff))
  27         ((= adr TOSL)
  28          (bitwise-and (get-tos) #xff))
  29         ((= adr PCL)
  30          (set-ram PCLATU (bitwise-and (arithmetic-shift (get-pc) -16)) #x1f)
  31          (set-ram PCLATH (bitwise-and (arithmetic-shift (get-pc) -8)) #xff)
  32          (bitwise-and (get-pc) #xfe))
  33         ((= adr STATUS)
  34          (+ pic18-carry-flag
  35             (arithmetic-shift pic18-deccarry-flag 1)
  36             (arithmetic-shift pic18-zero-flag 2)
  37             (arithmetic-shift pic18-overflow-flag 3)
  38             (arithmetic-shift pic18-negative-flag 4)))
  39         ((assq adr (list (cons INDF0 (cons FSR0H FSR0L))
  40                          (cons INDF1 (cons FSR1H FSR1L))
  41                          (cons INDF2 (cons FSR2H FSR2L))))
  42          => (lambda (x)
  43               (get-ram (bitwise-ior
  44                         (arithmetic-shift (u8vector-ref pic18-ram
  45                                                         (cadr x))
  46                                           8)
  47                         (u8vector-ref pic18-ram
  48                                       (cddr x))))))
  49         ;; TODO pre/post inc/dec 0..2
  50         (else
  51          (u8vector-ref pic18-ram adr))))
  52
  53 (define (set-ram adr byte)
  54   (cond ((= adr TOSU)
  55          (set-tos (+ (bitwise-and (get-tos) #x00ffff)
  56                      (arithmetic-shift (bitwise-and byte #x1f) 16))))
  57         ((= adr TOSH)
  58          (set-tos (+ (bitwise-and (get-tos) #x1f00ff)
  59                      (arithmetic-shift byte 8))))
  60         ((= adr TOSL)
  61          (set-tos (+ (bitwise-and (get-tos) #x1fff00)
  62                      byte)))
  63         ((= adr PCL)
  64          (set-pc (+ (bitwise-and (arithmetic-shift (get-ram PCLATU) 16) #x1f)
  65                     (bitwise-and (arithmetic-shift (get-ram PCLATH) 8) #xff)
  66                     (bitwise-and byte #xfe))))
  67         ((= adr STATUS)
  68          (set! pic18-carry-flag    (bitwise-and byte 1))
  69          (set! pic18-deccarry-flag (arithmetic-shift (bitwise-and byte 2) -1))
  70          (set! pic18-zero-flag     (arithmetic-shift (bitwise-and byte 4) -2))
  71          (set! pic18-overflow-flag (arithmetic-shift (bitwise-and byte 8) -3))
  72          (set! pic18-negative-flag (arithmetic-shift (bitwise-and byte 16) -4)))
  73         ((assq adr (list (cons INDF0 (cons FSR0H FSR0L))
  74                          (cons INDF1 (cons FSR1H FSR1L))
  75                          (cons INDF2 (cons FSR2H FSR2L))))
  76          => (lambda (x)
  77               (set-ram (bitwise-ior ;; TODO factor common code with get-ram ?
  78                         (arithmetic-shift (u8vector-ref pic18-ram
  79                                                         (cadr x))
  80                                           8)
  81                         (u8vector-ref pic18-ram
  82                                       (cddr x)))
  83                        byte)))
  84         ;; TODO all other special array registers
  85         (else
  86          (u8vector-set! pic18-ram adr byte))))
  87
  88 (define (get-rom adr)
  89   (u8vector-ref pic18-rom adr))
  90
  91 (define (set-rom adr byte)
  92   (u8vector-set! pic18-rom adr byte))
  93
  94 (define (get-stack adr)
  95   (vector-ref pic18-stack adr))
  96
  97 (define (set-stack adr pc)
  98   (vector-set! pic18-stack adr pc))
  99
 100 (define (get-pc)
 101   pic18-pc)
 102
 103 (define (set-pc pc)
 104   (set! pic18-pc pc))
 105
 106 (define (get-sp)
 107   (bitwise-and (get-ram STKPTR) #x1f))
 108
 109 (define (set-sp sp)
 110   (set-ram STKPTR
 111            (bitwise-ior sp
 112                         (bitwise-and (get-ram STKPTR) #xe0))))
 113
 114 (define (get-tos)
 115   (vector-ref pic18-stack (- (get-sp) 1)))
 116
 117 (define (set-tos pc)
 118   (vector-set! pic18-stack (- (get-sp) 1) pc))
 119
 120 (define (stack-push pc)
 121   (set-sp (+ (get-sp) 1))
 122   (set-tos pc))
 123
 124 (define (stack-pop)
 125   (set-pc (get-tos))
 126   (set-sp (- (get-sp) 1)))
 127
 128 (define (get-bsr)
 129   (bitwise-and (get-ram BSR) #x0f))
 130
 131 (define (get-wreg)
 132   pic18-wreg)
 133
 134 (define (set-wreg byte)
 135   (set! pic18-wreg byte))
 136
 137 (define (zero-flag?)
 138   (not (= 0 pic18-zero-flag)))
 139
 140 (define (set-zero-flag flag)
 141   (set! pic18-zero-flag flag))
 142
 143 (define (negative-flag?)
 144   (not (= 0 pic18-negative-flag)))
 145
 146 (define (set-negative-flag flag)
 147   (set! pic18-negative-flag flag))
 148
 149 (define (carry-flag?)
 150   (not (= 0 pic18-carry-flag)))
 151
 152 (define (set-carry-flag flag)
 153   (set! pic18-carry-flag flag))
 154
 155 (define (deccarry-flag?)
 156   (not (= 0 pic18-deccarry-flag)))
 157
 158 (define (set-deccarry-flag flag)
 159   (set! pic18-deccarry-flag flag))
 160
 161 (define (overflow-flag?)
 162   (not (= 0 pic18-overflow-flag)))
 163
 164 (define (set-overflow-flag flag)
 165   (set! pic18-overflow-flag flag))
 166
 167 (define (pic18-sim-setup)
 168   (set! pic18-ram   (make-u8vector #x1000 0))
 169   (set! pic18-rom   (make-u8vector #x2000 0))
 170   (set! pic18-stack (make-vector #x1f 0))
 171   (set-pc 0)
 172   (set-wreg 0)
 173   (set! pic18-carry-flag    0)
 174   (set! pic18-deccarry-flag 0)
 175   (set! pic18-zero-flag     0)
 176   (set! pic18-overflow-flag 0)
 177   (set! pic18-negative-flag 0))
 178
 179 (define (pic18-sim-cleanup)
 180   (set! pic18-ram   #f)
 181   (set! pic18-rom   #f)
 182   (set! pic18-stack #f))
 183
 184 ;------------------------------------------------------------------------------
 185
 186 (define (last-pc)
 187   (let ((pc (- (get-pc) 2)))
 188     (list (get-sp) " " (- pic18-cycles 1) " "
 189           (substring (number->string (+ #x1000000 pc) 16) 1 7)
 190           "     ")))
 191
 192 (define (illegal-opcode opcode)
 193   (if trace-instr
 194       (print (list (last-pc) "  *illegal*")))
 195   (error "illegal opcode" opcode))
 196
 197 (define decode-vector
 198   (make-vector 256 illegal-opcode))
 199
 200 (define (decode-opcode opcode-bits shift action)
 201   (if (< shift 8)
 202       (error "shift=" shift))
 203   (let ((n (arithmetic-shift 1 (- shift 8)))
 204         (base (arithmetic-shift opcode-bits (- shift 8))))
 205     (let loop ((i 0))
 206       (if (< i n)
 207           (begin
 208             (vector-set! decode-vector (+ base i) action)
 209             (loop (+ i 1)))))))
 210
 211 (define (byte-oriented opcode mnemonic flags-changed operation)
 212   (byte-oriented-aux opcode mnemonic flags-changed operation 'wreg))
 213 (define (byte-oriented-file opcode mnemonic flags-changed operation)
 214   (byte-oriented-aux opcode mnemonic flags-changed operation 'file))
 215 (define (byte-oriented-wide opcode mnemonic flags-changed operation dest)
 216   ;; for use with instructions that have results more than a byte wide, such
 217   ;; as multiplication. the result goes at the given addresses
 218   (byte-oriented-aux opcode mnemonic flags-changed operation dest)) ;; TODO do the same for literals
 219
 220 (define (byte-oriented-aux opcode mnemonic flags-changed operation dest)
 221   (let* ((f (bitwise-and opcode #xff))
 222          (adr (if (= 0 (bitwise-and opcode #x100))
 223                   (if (= 0 (bitwise-and f #x80)) f (+ f #xf00))
 224                   (+ f (arithmetic-shift (get-bsr) 8)))))
 225     (if trace-instr
 226         (print (list (last-pc) "        " mnemonic "    "
 227                        (let ((x (assv adr file-reg-names)))
 228                          (if x (cdr x) (list "0x" (number->string adr 16))))
 229                        (if (or (eq? dest 'wreg)
 230                                (= 0 (bitwise-and opcode #x200)))
 231                            ", w"
 232                            "")
 233                        "")))
 234     (let* ((result (operation (get-ram adr)))
 235            (result-8bit (bitwise-and result #xff)))
 236       (cond ((list? dest)
 237              ;; result is more than a byte wide (i.e. multiplication)
 238              ;; put it in the right destinations (dest is a list of addresses)
 239              (let loop ((dest dest) (result result))
 240                (if (not (null? dest))
 241                    ;; the head of the list is the lsb
 242                    (begin (set-ram (car dest) (bitwise-and result #xff))
 243                           (loop (cdr dest) (arithmetic-shift result -8))))))
 244             ((or (eq? dest 'file) (not (= 0 (bitwise-and opcode #x200))))
 245              ;; the result goes in memory (file)
 246              (set-ram adr result-8bit))
 247             ((eq? dest 'wreg)
 248              ;; result goes in wreg
 249              (set-wreg result-8bit)))
 250       (if (not (eq? flags-changed 'none))
 251           (begin
 252             (set-zero-flag (if (= 0 result-8bit) 1 0))
 253             (if (not (eq? flags-changed 'z))
 254                 (begin
 255                   (set-negative-flag (if (> result-8bit #x7f) 1 0))
 256                   (if (not (eq? flags-changed 'z-n))
 257                       (begin
 258                         (set-carry-flag (if (or (> result #xff)
 259                                                 (< result 0))
 260                                             1 0))
 261                         (if (not (eq? flags-changed 'c-z-n))
 262                             (begin
 263                               (set-deccarry-flag 0);;;;;;;;;;;;;;
 264                               (set-overflow-flag 0))))))))))));;;;;;;;;;;;;;
 265
 266 (define (bit-oriented opcode mnemonic operation)
 267   (let* ((f (bitwise-and opcode #xff))
 268          (adr (if (= 0 (bitwise-and opcode #x100))
 269                   (if (= 0 (bitwise-and f #x80)) f (+ f #xf00))
 270                   (+ f (arithmetic-shift (get-bsr) 8))))
 271          (b (bitwise-and (arithmetic-shift opcode -9) 7)))
 272     (if trace-instr
 273         (print (list (last-pc) "        " mnemonic "    "
 274                        (let ((x (assv adr file-reg-names)))
 275                          (if x (cdr x) (list "0x" (number->string adr 16))))
 276                        ", "
 277                        (if (= adr STATUS)
 278                            (cdr (assv b '((0 . C)
 279                                           (1 . DC)
 280                                           (2 . Z)
 281                                           (3 . OV)
 282                                           (4 . N)
 283                                           (5 . 5)
 284                                           (6 . 6)
 285                                           (7 . 7))))
 286                            b)
 287                        "")))
 288     (let* ((result (operation (get-ram adr) b))
 289            (result-8bit (bitwise-and result #xff)))
 290       (set-ram adr result-8bit))))
 291
 292 (define (short-relative-branch opcode mnemonic branch)
 293   (let* ((n (bitwise-and opcode #xff))
 294          (adr (+ (get-pc) (* 2 (if (> n #x7f) (- n #x100) n)))))
 295     (if trace-instr
 296         (print (list (last-pc) "        " mnemonic "    "
 297                        "0x"
 298                        (number->string adr 16)
 299                        "")))
 300     (if (branch)
 301         (begin
 302           (get-program-mem)
 303           (set-pc adr)))))
 304
 305 (define (long-relative-branch opcode mnemonic call?)
 306   (let* ((n (bitwise-and opcode #x7ff))
 307          (adr (+ (get-pc) (* 2 (if (> n #x3ff) (- n #x800) n)))))
 308     (if trace-instr
 309         (print (list (last-pc) "        " mnemonic "    "
 310                        "0x"
 311                        (number->string adr 16)
 312                        "")))
 313     (if call?
 314         (stack-push (get-pc)))
 315     (get-program-mem)
 316     (set-pc adr)))
 317
 318 (define (call-branch opcode mnemonic)
 319   (let ((adr (* 2 (+ (bitwise-and opcode #xff)
 320                      (arithmetic-shift (get-program-mem) 8)))))
 321     (if trace-instr
 322         (print (list (last-pc) "        " mnemonic "    "
 323                        "0x"
 324                        (number->string adr 16)
 325                        (if (= 0 (bitwise-and opcode #x100))
 326                            ""
 327                            ", FAST")
 328                        "")))
 329     (stack-push (get-pc))
 330     (if (not (= 0 (bitwise-and opcode #x100)))
 331         (error "call fast not implemented"))
 332     (set-pc adr)))
 333
 334 (define (goto-branch opcode mnemonic)
 335   (let ((adr (* 2 (+ (bitwise-and opcode #xff)
 336                      (arithmetic-shift (get-program-mem) 8)))))
 337     (if trace-instr
 338         (print (list (last-pc) "        " mnemonic "    "
 339                        "0x"
 340                        (number->string adr 16)
 341                        "")))
 342     (set-pc adr)))
 343
 344 (define (literal-operation opcode mnemonic flags-changed operation)
 345   (let ((k (bitwise-and opcode #xff)))
 346     (if trace-instr
 347         (print (list (last-pc) "        " mnemonic "    "
 348                        (if (< k 10) k (list "0x" (number->string k 16)))
 349                        "")))
 350     (let* ((result (operation k))
 351            (result-8bit (bitwise-and result #xff)))
 352       (set-wreg result-8bit)
 353       (if (not (eq? flags-changed 'none))
 354           (begin
 355             (set-zero-flag (if (= 0 result-8bit) 1 0))
 356             (if (not (eq? flags-changed 'z))
 357                 (begin
 358                   (set-negative-flag (if (> result-8bit #x7f) 1 0))
 359                   (if (not (eq? flags-changed 'z-n))
 360                       (begin
 361                         (set-carry-flag (if (> result #xff) 1 0))
 362                         (if (not (eq? flags-changed 'c-z-n))
 363                             (begin
 364                               (set-deccarry-flag 0);;;;;;;;;;;;;;
 365                               (set-overflow-flag 0))))))))))));;;;;;;;;;;;;;
 366
 367 (define (get-program-mem)
 368   (set! pic18-cycles (+ pic18-cycles 1))
 369   (let* ((pc (get-pc))
 370          (lsb (get-rom pc))
 371          (msb (get-rom (+ pc 1))))
 372     (set-pc (+ (get-pc) 2))
 373     (+ (arithmetic-shift msb 8) lsb)))
 374
 375 (define (skip)
 376   (get-program-mem))
 377
 378 (define (hex n)
 379   (substring (number->string (+ #x100 n) 16) 1 3))
 380
 381 (define (dump-mem)
 382
 383   (print "      ")
 384   (let loop ((i 0))
 385     (if (< i 10)
 386         (begin
 387           (print (list (hex (u8vector-ref pic18-ram i)) " "))
 388           (loop (+ i 1)))))
 389   (print (list "  WREG=" (hex (get-wreg)) "\n")))
 390
 391 (define (pic18-execute)
 392   (set! pic18-exit #f)
 393   (set! pic18-cycles 0)
 394   (if trace-instr
 395       (print "                          "))
 396   (let loop ()
 397     (if trace-instr
 398         (dump-mem))
 399     (if pic18-exit
 400         (begin
 401           (print (list "WREG = d'" (get-wreg) "'\n")))
 402         (let ((opcode (get-program-mem)))
 403           (let ((proc (vector-ref decode-vector (arithmetic-shift opcode -8))))
 404             (proc opcode)
 405             (loop))))))
 406
 407 (define trace-instr #t)
 408
 409 (define (carry)
 410   (if (> pic18-carry-flag 0)
 411       (begin (set! pic18-carry-flag #f) ;; TODO is this how the PIC18 hardware does it ?
 412              1)
 413       0))
 414
 415 ;------------------------------------------------------------------------------
 416
 417 ; Byte-oriented file register operations.
 418
 419 (decode-opcode #b001001 10
 420   (lambda (opcode)
 421     (byte-oriented opcode "addwf" 'c-dc-z-ov-n
 422      (lambda (f)
 423        (+ f (get-wreg))))))
 424
 425 (decode-opcode #b001000 10
 426   (lambda (opcode)
 427     (byte-oriented opcode "addwfc" 'c-dc-z-ov-n
 428      (lambda (f)
 429        (+ f (get-wreg) (carry))))))
 430
 431 (decode-opcode #b000101 10
 432   (lambda (opcode)
 433     (byte-oriented opcode "andwf" 'z-n
 434      (lambda (f)
 435        (bitwise-and f (get-wreg))))))
 436
 437 (decode-opcode #b0110101 9
 438   (lambda (opcode)
 439     (byte-oriented-file opcode "clrf" 'z
 440      (lambda (f)
 441        0))))
 442
 443 (decode-opcode #b000111 10
 444   (lambda (opcode)
 445     (byte-oriented opcode "comf" 'z-n
 446      (lambda (f)
 447        (bitwise-not f)))))
 448
 449 (decode-opcode #b0110001 9
 450   (lambda (opcode)
 451     (byte-oriented-file opcode "cpfseq" 'none
 452      (lambda (f)
 453        (if (= f (get-wreg)) (skip))
 454        f))))
 455
 456 (decode-opcode #b0110010 9
 457   (lambda (opcode)
 458     (byte-oriented-file opcode "cpfsgt" 'none
 459      (lambda (f)
 460        (if (> f (get-wreg)) (skip))
 461        f))))
 462
 463 (decode-opcode #b0110000 9
 464   (lambda (opcode)
 465     (byte-oriented-file opcode "cpfslt" 'none
 466      (lambda (f)
 467        (if (< f (get-wreg)) (skip))
 468        f))))
 469
 470 (decode-opcode #b000001 10
 471   (lambda (opcode)
 472     (byte-oriented opcode "decf" 'c-dc-z-ov-n
 473      (lambda (f)
 474        (- f 1)))))
 475
 476 (decode-opcode #b001011 10
 477   (lambda (opcode)
 478     (byte-oriented opcode "decfsz" 'none
 479      (lambda (f)
 480        (if (= f 1) (skip))
 481        (- f 1)))))
 482
 483 (decode-opcode #b010011 10
 484   (lambda (opcode)
 485     (byte-oriented opcode "dcfsnz" 'none
 486      (lambda (f)
 487        (if (not (= f 1)) (skip))
 488        (- f 1)))))
 489
 490 (decode-opcode #b001010 10
 491   (lambda (opcode)
 492     (byte-oriented opcode "incf" 'c-dc-z-ov-n
 493      (lambda (f)
 494        (+ f 1)))))
 495
 496 (decode-opcode #b001111 10
 497   (lambda (opcode)
 498     (byte-oriented opcode "incfsz" 'none
 499      (lambda (f)
 500        (if (= f #xff) (skip))
 501        (+ f 1)))))
 502
 503 (decode-opcode #b010010 10
 504   (lambda (opcode)
 505     (byte-oriented opcode "infsnz" 'none
 506      (lambda (f)
 507        (if (not (= f #xff)) (skip))
 508        (+ f 1)))))
 509
 510 (decode-opcode #b000100 10
 511   (lambda (opcode)
 512     (byte-oriented opcode "iorwf" 'z-n
 513      (lambda (f)
 514        (bitwise-ior f (get-wreg))))))
 515
 516 (decode-opcode #b010100 10
 517   (lambda (opcode)
 518     (byte-oriented opcode "movf" 'z-n
 519      (lambda (f)
 520        f))))
 521
 522 (decode-opcode #b1100 12
 523   (lambda (opcode)
 524     (let* ((src (bitwise-and opcode #xfff))
 525            ;; the destination is in the second 16-bit part, need to fetch
 526            (dst (bitwise-and (get-program-mem) #xfff)))
 527       (if trace-instr
 528           (print (list (last-pc) "      movff   "
 529                        (let ((x (assv src file-reg-names)))
 530                          (if x (cdr x) (list "0x" (number->string src 16))))
 531                        ", "
 532                        (let ((x (assv dst file-reg-names)))
 533                          (if x (cdr x) (list "0x" (number->string dst 16)))) ;; TODO printing 2 args ruins the formatting
 534                        "")))
 535       (set-ram dst (get-ram src)))))
 536
 537 (decode-opcode #b0110111 9
 538   (lambda (opcode)
 539     (byte-oriented-file opcode "movwf" 'none
 540      (lambda (f)
 541        (get-wreg)))))
 542
 543 (decode-opcode #b0000001 9
 544   (lambda (opcode)
 545     (byte-oriented-wide opcode "mulwf" 'none
 546      (lambda (f)
 547        (* f (get-wreg)))
 548      (list PRODL PRODH))))
 549
 550 (decode-opcode #b0110110 9
 551   (lambda (opcode)
 552     (byte-oriented-file opcode "negf" 'c-dc-z-ov-n
 553      (lambda (f)
 554        (- f)))))
 555
 556 (decode-opcode #b001101 10
 557   (lambda (opcode)
 558     (byte-oriented opcode "rlcf" 'c-z-n
 559      (lambda (f)
 560        (+ (arithmetic-shift f 1) (carry))))))
 561
 562 (decode-opcode #b010001 10
 563   (lambda (opcode)
 564     (byte-oriented opcode "rlncf" 'z-n
 565      (lambda (f)
 566        (+ (arithmetic-shift f 1) (arithmetic-shift f -7))))))
 567
 568 (decode-opcode #b001100 10
 569   (lambda (opcode)
 570     (byte-oriented opcode "rrcf" 'c-z-n
 571      (lambda (f)
 572        (+ (arithmetic-shift f -1) (arithmetic-shift (carry) 7))))))
 573
 574 (decode-opcode #b010000 10
 575   (lambda (opcode)
 576     (byte-oriented opcode "rrncf" 'z-n
 577      (lambda (f)
 578        (+ (arithmetic-shift f -1) (arithmetic-shift f 7))))))
 579
 580 (decode-opcode #b0110100 9
 581   (lambda (opcode)
 582     (byte-oriented-file opcode "setf" 'z
 583      (lambda (f)
 584        #xff))))
 585
 586 (decode-opcode #b010101 10
 587   (lambda (opcode)
 588     (byte-oriented opcode "subfwb" 'c-dc-z-ov-n
 589      (lambda (f)
 590        (- (get-wreg) f (carry)))))) ;; TODO was (- 1 (carry)), but caused problems with the other
 591
 592 (decode-opcode #b010111 10
 593   (lambda (opcode)
 594     (byte-oriented opcode "subwf" 'c-dc-z-ov-n
 595      (lambda (f)
 596        (- f (get-wreg))))))
 597
 598 (decode-opcode #b010110 10
 599   (lambda (opcode)
 600     (byte-oriented opcode "subwfb" 'c-dc-z-ov-n
 601      (lambda (f)
 602        (- f (get-wreg) (carry)))))) ;; TODO !carry didn't work
 603
 604 (decode-opcode #b001110 10
 605   (lambda (opcode)
 606     (byte-oriented opcode "swapf" 'none
 607      (lambda (f)
 608        (+ (arithmetic-shift f -4) (arithmetic-shift f 4))))))
 609
 610 (decode-opcode #b0110011 9
 611   (lambda (opcode)
 612     (byte-oriented-file opcode "tstfsz" 'none
 613      (lambda (f)
 614        (if (= f 0) (skip))))))
 615
 616 (decode-opcode #b000110 10
 617   (lambda (opcode)
 618     (byte-oriented opcode "xorwf" 'z-n
 619      (lambda (f)
 620        (bitwise-xor f (get-wreg))))))
 621
 622 ; Bit-oriented file register operations.
 623
 624 (decode-opcode #b1001 12
 625   (lambda (opcode)
 626     (bit-oriented opcode "bcf"
 627      (lambda (f b)
 628        (bitwise-and f (bitwise-not (arithmetic-shift 1 b)))))))
 629
 630 (decode-opcode #b1000 12
 631   (lambda (opcode)
 632     (bit-oriented opcode "bsf"
 633      (lambda (f b)
 634        (bitwise-ior f (arithmetic-shift 1 b))))))
 635
 636 (decode-opcode #b1011 12
 637   (lambda (opcode)
 638     (bit-oriented opcode "btfsc"
 639      (lambda (f b)
 640        (if (= 0 (bitwise-and f (arithmetic-shift 1 b))) (skip))
 641        f))))
 642
 643 (decode-opcode #b1010 12
 644   (lambda (opcode)
 645     (bit-oriented opcode "btfss"
 646      (lambda (f b)
 647        (if (not (= 0 (bitwise-and f (arithmetic-shift 1 b)))) (skip))
 648        f))))
 649
 650 (decode-opcode #b0111 12
 651   (lambda (opcode)
 652     (bit-oriented opcode "btg"
 653      (lambda (f b)
 654        (bitwise-xor f (arithmetic-shift 1 b))))))
 655
 656 ; Control operations.
 657
 658 (decode-opcode #b11100010 8
 659   (lambda (opcode)
 660     (short-relative-branch opcode "bc"
 661      (lambda ()
 662        (not (= 0 (carry)))))))
 663
 664 (decode-opcode #b11100110 8
 665   (lambda (opcode)
 666     (short-relative-branch opcode "bn"
 667      (lambda ()
 668        (not (= 0 (negative)))))))
 669
 670 (decode-opcode #b11100011 8
 671   (lambda (opcode)
 672     (short-relative-branch opcode "bnc"
 673      (lambda ()
 674        (= 0 (carry))))))
 675
 676 (decode-opcode #b11100111 8
 677   (lambda (opcode)
 678     (short-relative-branch opcode "bnn"
 679      (lambda ()
 680        (= 0 (negative))))))
 681
 682 (decode-opcode #b11100101 8
 683   (lambda (opcode)
 684     (short-relative-branch opcode "bnov"
 685      (lambda ()
 686        (= 0 (overflow))))))
 687
 688 (decode-opcode #b11100001 8
 689   (lambda (opcode)
 690     (short-relative-branch opcode "bnz"
 691      (lambda ()
 692        (= 0 (zero))))))
 693
 694 (decode-opcode #b11100100 8
 695   (lambda (opcode)
 696     (short-relative-branch opcode "bov"
 697      (lambda ()
 698        (not (= 0 (overflow)))))))
 699
 700 (decode-opcode #b11010 11
 701   (lambda (opcode)
 702     (long-relative-branch opcode "bra" #f)))
 703
 704 (decode-opcode #b11100000 8
 705   (lambda (opcode)
 706     (short-relative-branch opcode "bz"
 707      (lambda ()
 708        (not (= 0 (zero)))))))
 709
 710 (decode-opcode #b1110110 9
 711   (lambda (opcode)
 712     (call-branch opcode "call")))
 713
 714 (decode-opcode #b11101111 8
 715   (lambda (opcode)
 716     (goto-branch opcode "goto")))
 717
 718 (decode-opcode #b11011 11
 719   (lambda (opcode)
 720     (long-relative-branch opcode "rcall" #t)))
 721
 722 (decode-opcode #b1111 12
 723   (lambda (opcode)
 724     (if trace-instr
 725         (print (list (last-pc) "        nop     ")))))
 726
 727 (decode-opcode #b00000000 8
 728   (lambda (opcode)
 729     (cond ((= opcode #b0000000000000100)
 730            (if trace-instr
 731                (print (list (last-pc) " clrwdt  ")))
 732            (clrwdt opcode))
 733           ((= opcode #b0000000000000111)
 734            (if trace-instr
 735                (print (list (last-pc) " daw     ")))
 736            (daw opcode))
 737           ((= opcode #b0000000000000000)
 738            (if trace-instr
 739                (print (list (last-pc) " nop     "))))
 740           ((= opcode #b0000000000000110)
 741            (if trace-instr
 742                (print (list (last-pc) " pop     ")))
 743            (stack-pop))
 744           ((= opcode #b0000000000000101)
 745            (if trace-instr
 746                (print (list (last-pc) " push    ")))
 747            (stack-push (get-pc)))
 748           ((= opcode #b0000000011111111)
 749            (if trace-instr
 750                (print (list (last-pc) " reset   ")))
 751            (set-pc 0))
 752           ((= opcode #b0000000000010000)
 753            (if trace-instr
 754                (print (list (last-pc) " retfie  ")))
 755            (get-program-mem)
 756            (stack-pop))
 757           ((= opcode #b0000000000010001)
 758            (if trace-instr
 759                (print (list (last-pc) " retfie  FAST")))
 760            (error "retfie fast not implemented")
 761            (get-program-mem)
 762            (stack-pop))
 763           ((= opcode #b0000000000010010)
 764            (if trace-instr
 765                (print (list (last-pc) " return  ")))
 766            (get-program-mem)
 767            (stack-pop))
 768           ((= opcode #b0000000000010011)
 769            (if trace-instr
 770                (print (list (last-pc) " return  FAST")))
 771            (error "return fast not implemented")
 772            (get-program-mem)
 773            (stack-pop))
 774           ((= opcode #b0000000000000011)
 775            (if trace-instr
 776                (print (list (last-pc) " sleep   ")))
 777            (set! pic18-exit #t))
 778           (else
 779            (if trace-instr
 780                (print (list (last-pc) " ???     ")))
 781            (error "???")))))
 782
 783 ; Literal operations.
 784
 785 (decode-opcode #b00001111 8
 786   (lambda (opcode)
 787     (literal-operation opcode "addlw" 'c-dc-z-ov-n
 788      (lambda (k)
 789        (+ k (get-wreg))))))
 790
 791 (decode-opcode #b00001011 8
 792   (lambda (opcode)
 793     (literal-operation opcode "andlw" 'z-n
 794      (lambda (k)
 795        (bitwise-and k (get-wreg))))))
 796
 797 (decode-opcode #b00001001 8
 798   (lambda (opcode)
 799     (literal-operation opcode "iorlw" 'z-n
 800      (lambda (k)
 801        (bitwise-ior k (get-wreg))))))
 802
 803 '
 804 (define (lfsr f k)
 805   (make-instruction
 806    2
 807    (lambda ()
 808      (make-listing "lfsr" (file-text f) (lit-text k)))
 809    (lambda ()
 810      (asm-16 (bitmask "1110 1110 00ff kkkk" (file f) (quotient (lit k) 256)))
 811      (asm-16 (bitmask "1111 0000 kkkk kkkk" (modulo (lit k) 256))))))
 812
 813 '
 814 (define (movlb k)
 815   (make-instruction
 816    1
 817    (lambda ()
 818      (make-listing "movlb" (lit-text k)))
 819    (lambda ()
 820      (asm-16 (bitmask "0000 0001 0000 kkkk" (lit k))))))
 821
 822 (decode-opcode #b00001110 8
 823   (lambda (opcode)
 824     (literal-operation opcode "movlw" 'none
 825      (lambda (k)
 826        k))))
 827
 828 (decode-opcode #b00001101 8
 829   (lambda (opcode)
 830     (literal-operation opcode "mullw" 'none
 831      (lambda (k)
 832        (* k (get-wreg))))))
 833
 834 (decode-opcode #b00001100 8
 835   (lambda (opcode)
 836     (literal-operation opcode "retlw" 'none
 837      (lambda (k)
 838        (get-program-mem)
 839        (stack-pop)
 840        k))))
 841
 842 (decode-opcode #b00001000 8
 843   (lambda (opcode)
 844     (literal-operation opcode "sublw" 'c-dc-z-ov-n
 845      (lambda (k)
 846        (- k (get-wreg))))))
 847
 848 (decode-opcode #b00001010 8
 849   (lambda (opcode)
 850     (literal-operation opcode "xorlw" 'z-n
 851      (lambda (k)
 852        (bitwise-xor k (get-wreg))))))
 853
 854 ; Program memory operations.
 855
 856 '
 857 (define (tblrd*)
 858   (make-instruction
 859    2
 860    (lambda ()
 861      (make-listing "tblrd*"))
 862    (lambda ()
 863      (asm-16 (bitmask "0000 0000 0000 1000")))))
 864
 865 '
 866 (define (tblrd*+)
 867   (make-instruction
 868    2
 869    (lambda ()
 870      (make-listing "tblrd*+"))
 871    (lambda ()
 872      (asm-16 (bitmask "0000 0000 0000 1001")))))
 873
 874 '
 875 (define (tblrd*-)
 876   (make-instruction
 877    2
 878    (lambda ()
 879      (make-listing "tblrd*-"))
 880    (lambda ()
 881      (asm-16 (bitmask "0000 0000 0000 1010")))))
 882
 883 '
 884 (define (tblrd+*)
 885   (make-instruction
 886    2
 887    (lambda ()
 888      (make-listing "tblrd+*"))
 889    (lambda ()
 890      (asm-16 (bitmask "0000 0000 0000 1011")))))
 891
 892 '
 893 (define (tblwt*)
 894   (make-instruction
 895    2
 896    (lambda ()
 897      (make-listing "tblwt*"))
 898    (lambda ()
 899      (asm-16 (bitmask "0000 0000 0000 1100")))))
 900
 901 '
 902 (define (tblwt*+)
 903   (make-instruction
 904    2
 905    (lambda ()
 906      (make-listing "tblwt*+"))
 907    (lambda ()
 908      (asm-16 (bitmask "0000 0000 0000 1101")))))
 909
 910 '
 911 (define (tblwt*-)
 912   (make-instruction
 913    2
 914    (lambda ()
 915      (make-listing "tblwt*-"))
 916    (lambda ()
 917      (asm-16 (bitmask "0000 0000 0000 1110")))))
 918
 919 '
 920 (define (tblwt+*)
 921   (make-instruction
 922    2
 923    (lambda ()
 924      (make-listing "tblwt+*"))
 925    (lambda ()
 926      (asm-16 (bitmask "0000 0000 0000 1111")))))
 927
 928 ;------------------------------------------------------------------------------
 929
 930 (define (read-hex-file filename)
 931
 932   (define addr-width 32)
 933
 934   (define (syntax-error)
 935     (error "*** Syntax error in HEX file"))
 936
 937   (let ((f
 938          (with-exception-catcher
 939           (lambda (exc)
 940             #f)
 941           (lambda ()
 942             (open-input-file filename)))))
 943
 944     (define mem (make-vector 16 #f))
 945
 946     (define (mem-store! a b)
 947       (let loop ((m mem)
 948                  (a a)
 949                  (x (- addr-width 4)))
 950         (if (= x 0)
 951             (vector-set! m a b)
 952             (let ((i (arithmetic-shift a (- x))))
 953               (let ((v (vector-ref m i)))
 954                 (loop (or v
 955                           (let ((v (make-vector 16 #f)))
 956                             (vector-set! m i v)
 957                             v))
 958                       (- a (arithmetic-shift i x))
 959                       (- x 4)))))))
 960
 961     (define (mem->list)
 962
 963       (define (f m a n tail)
 964
 965         (define (g i a n tail)
 966           (if (>= i 0)
 967               (g (- i 1) (- a n) n (f (vector-ref m i) a n tail))
 968               tail))
 969
 970         (if m
 971             (if (= n 1)
 972                 (cons (cons (- a 1) m) tail)
 973                 (g 15 a (quotient n 16) tail))
 974             tail))
 975
 976       (f mem (expt 2 addr-width) (expt 2 addr-width) '()))
 977
 978     (define hi16
 979       0)
 980
 981     (define (read-hex-nibble)
 982       (let ((c (read-char f)))
 983         (cond ((and (char>=? c #\0) (char<=? c #\9))
 984                (- (char->integer c) (char->integer #\0)))
 985               ((and (char>=? c #\A) (char<=? c #\F))
 986                (+ 10 (- (char->integer c) (char->integer #\A))))
 987               ((and (char>=? c #\a) (char<=? c #\f))
 988                (+ 10 (- (char->integer c) (char->integer #\a))))
 989               (else
 990                (syntax-error)))))
 991
 992     (define (read-hex-byte)
 993       (let* ((a (read-hex-nibble))
 994              (b (read-hex-nibble)))
 995         (+ b (* a 16))))
 996
 997     (if f
 998         (begin
 999           (let loop1 ()
1000             (let ((c (read-char f)))
1001               (cond ((not (char? c)))
1002                     ((or (char=? c #\linefeed)
1003                          (char=? c #\return))
1004                      (loop1))
1005                     ((not (char=? c #\:))
1006                      (syntax-error))
1007                     (else
1008                      (let* ((len (read-hex-byte))
1009                             (a1 (read-hex-byte))
1010                             (a2 (read-hex-byte))
1011                             (type (read-hex-byte)))
1012                        (let* ((adr (+ a2 (* 256 a1)))
1013                               (sum (+ len a1 a2 type)))
1014                          (cond ((= type 0)
1015                                 (let loop2 ((i 0))
1016                                   (if (< i len)
1017                                       (let ((a (+ adr (* hi16 65536)))
1018                                             (b (read-hex-byte)))
1019                                         (mem-store! a b)
1020                                         (set! adr (modulo (+ adr 1) 65536))
1021                                         (set! sum (+ sum b))
1022                                         (loop2 (+ i 1))))))
1023                                ((= type 1)
1024                                 (if (not (= len 0))
1025                                     (syntax-error)))
1026                                ((= type 4)
1027                                 (if (not (= len 2))
1028                                     (syntax-error))
1029                                 (let* ((a1 (read-hex-byte))
1030                                        (a2 (read-hex-byte)))
1031                                   (set! sum (+ sum a1 a2))
1032                                   (set! hi16 (+ a2 (* 256 a1)))))
1033                                (else
1034                                 (syntax-error)))
1035                          (let ((check (read-hex-byte)))
1036                            (if (not (= (modulo (- sum) 256) check))
1037                                (syntax-error)))
1038                          (let ((c (read-char f)))
1039                            (if (or (not (or (char=? c #\linefeed)
1040                                             (char=? c #\return)))
1041                                    (not (= type 1)))
1042                                (loop1)))))))))
1043
1044           (close-input-port f)
1045
1046           (mem->list))
1047         (begin
1048           (error "*** Could not open the HEX file")
1049           #f))))
1050
1051 ;------------------------------------------------------------------------------
1052
1053 (define (execute-hex-file filename)
1054   (let ((program (read-hex-file filename)))
1055     (pic18-sim-setup)
1056     (for-each (lambda (x) (set-rom (car x) (cdr x))) program)
1057     (pic18-execute)
1058     (pic18-sim-cleanup)))