diff --git a/User-Manual---Command-Reference.md b/User-Manual---Command-Reference.md index 15cf1ef..0c3966e 100644 --- a/User-Manual---Command-Reference.md +++ b/User-Manual---Command-Reference.md @@ -1,10 +1,12 @@ # Table of Contents +Note: this manual describes the functionality of firmware version 0.981 (and later). If you have an earlier version, please consider updating. + [Generic Commands](#generic-commands) * [blist (bl)](#blist-bl) -* [breakrm (breakr)](#breakrm-breakr) -* [breakwm (breakw)](#breakwm-breakw) -* [breakx (break)](#breakx-break) +* [breakr (breakr)](#breakr-breakr) +* [breakw (breakw)](#breakw-breakw) +* [breakx (break)](#breakx-br) * [clear (cl)](#clear-cl) * [compare (com)](#compare-com) * [continue (c)](#continue-c) @@ -18,7 +20,7 @@ * [load (l)](#load-l) * [mem (m)](#mem-m) * [next (n)](#next-n) -* [rdm (rd)](#rdm-rd) +* [rd (rd)](#rd-rd) * [regs (r)](#regs-r) * [reset (res)](#reset-res) * [save (sa)](#save-sa) @@ -28,10 +30,10 @@ * [test (t)](#test-t) * [trace (tr)](#trace-tr) * [trigger (tri)](#trigger-tri) -* [watchrm (watchr)](#watchrm-watchr) -* [watchwm (watchw)](#watchwm-watchw) -* [watchx (watch)](#watchx-watch) -* [wrm (wr)](#wrm-wr) +* [watchr (watchr)](#watchr-watchr) +* [watchw (watchw)](#watchw-watchw) +* [watchx (watch)](#watchx-wa) +* [wr (wr)](#wr-wr) [6502 specific commands](#6502-specific-commands) * [exec (e)](#exec-e) @@ -41,13 +43,13 @@ [6809 specific commands](#6809-specific-commands) [Z80 specific commands](#z80-specific-commands) -* [io (io)](#io-io) -* [rdi (rdi)](#rdi-rdi) -* [breakri (breakri)](#breakri-breakri) -* [breakwi (breakwi)](#breakwi-breakwi) -* [watchri (watchri)](#watchri-watchri) -* [watchwi (watchwi)](#watchwi-watchwi) -* [wri (wri)](#wri-wri) +* [breaki (breaki)](#breaki-breaki) +* [breako (breako)](#breako-breako) +* [in (in)](#in-in) +* [io (i)](#io-i) +* [out (o)](#out-o) +* [watchi (watchi)](#watchi-watchi) +* [watcho (watcho)](#watcho-watcho) # Generic Commands @@ -108,7 +110,7 @@ Trigger Codes: ``` This can be manipulated with the trig command. -## breakrm (breakr) +## breakr (breakr) Sets a memory read breakpoint on an address, or range of addresses. @@ -120,7 +122,7 @@ If \
is omitted, it defaults to FFFF. If \ is omitted if defaults to F (trigger always). -## breakwm (breakw) +## breakw (breakw) Sets a memory write breakpoint on an address, or range of addresses @@ -132,11 +134,11 @@ If \
is omitted, it defaults to FFFF. If \ is omitted if defaults to F (trigger always). -## breakx (break) +## breakx (br) Sets an instruction execute breakpoint on an address, or range of addresses -_Usage: break \ \[ \
\[ \ \] \]_ +_Usage: br \ \[ \
\[ \ \] \]_ This is triggered when the the address of an opcode fetch ANDed with \
matches \, and \ is valid. @@ -481,8 +483,6 @@ This is useful when single stepping, to step over a subroutince call, or to exit The breakpoint is marked as transient, meaning it is automatically deleted when it is hit. -Note, the next command was added in the V0.85 release of the firmware. - ## rdm (rd) Reads a single host memory address. @@ -576,8 +576,6 @@ Legal values are: If called without parameters, the current value is returned. -Note, the special command was added in the V0.80 release of the firmware. - ## srec (sr) Uploads srecords into memory @@ -605,8 +603,6 @@ The linux utility srec_cat can be used to convert an arbitrary file into suitabl ``` This will turn a binary file (somefile) into srecord format (solefile.srec), with a loading address in memory of 0x1900. -Note, the srec command was added in the V0.73 release of the firmware. - ## step (s) Single steps one or more instructions. @@ -772,7 +768,7 @@ Trigger Codes: ``` T0 and T1 refer to external trigger input pins on the GODIL. -## watchrm (watchr) +## watchr (watchr) Sets a memory read watchpoint on an address, or range of addresses. @@ -784,7 +780,7 @@ If \
is omitted, it defaults to FFFF. If \ is omitted if defaults to F (trigger always). -## watchwm (watchw) +## watchw (watchw) Sets a memory write watchpoint on an address, or range of addresses @@ -796,7 +792,7 @@ If \
is omitted, it defaults to FFFF. If \ is omitted if defaults to F (trigger always). -## watchx (watch) +## watchx (wa) Sets an instruction execute watchpoint on an address, or range of addresses @@ -929,50 +925,49 @@ The following additional commands relate to the Z80's seperate IO space commands There usage is identical to the equivalent memory space commands. +## breaki (breaki) + +Sets an IO "in" breakpoint on an address, or range of addresses. + +_Usage: breaki \ \[ \
\[ \ \] \]_ + +## breako (breako) + +Sets an IO "out" breakpoint on an address, or range of addresses. + +_Usage: breako \ \[ \
\[ \ \] \]_ + +## in (in) + +Reads a single host IO address. + +_Usage: in \ \[ \ \]_ + +The optional count parameter causes the operation to be repeated multiple times. If omitted, count defaults to 1. + ## io (io) Dumps a block 256 bytes of host IO space in hex and ascii. _Usage: io \[ \ \]_ -## rdi (rdi) - -Reads a single host IO address. - -_Usage: rdi \ \[ \ \]_ - -The optional count parameter causes the operation to be repeated multiple times. If omitted, count defaults to 1. - -## breakri (breakri) - -Sets an IO read breakpoint on an address, or range of addresses. - -_Usage: breakri \ \[ \
\[ \ \] \]_ - -## breakwi (breakwi) - -Sets an IO write breakpoint on an address, or range of addresses. - -_Usage: breakwi \ \[ \
\[ \ \] \]_ - -## watchri (watchri) - -Sets an IO read watchpoint on an address, or range of addresses. - -_Usage: watchri \ \[ \
\[ \ \] \]_ - -## watchwi (watchwi) - -Sets an IO write watchpoint on an address, or range of addresses. - -_Usage: watchwi \ \[ \
\[ \ \] \]_ - -## wri (wri) +## out (o) Writes a single host IO address. -_Usage: wri \ \ \[ \ \]_ +_Usage: o \ \ \[ \ \]_ The optional count parameter causes the operation to be repeated multiple times. If omitted, count defaults to 1. +## watchi (watchi) + +Sets an IO "in" watchpoint on an address, or range of addresses. + +_Usage: watchi \ \[ \
\[ \ \] \]_ + +## watcho (watcho) + +Sets an IO "out" watchpoint on an address, or range of addresses. + +_Usage: watcho \ \[ \
\[ \ \] \]_