diff options
| author | Vi Grey <vi@vigrey.com> | 2023-09-25 00:56:47 +0000 |
|---|---|---|
| committer | Vi Grey <vi@vigrey.com> | 2023-09-25 00:56:47 +0000 |
| commit | f21297e56da08f008e04ba9ac99243d4c81d7568 (patch) | |
| tree | a7e0d6dd0a95733bb09f304851142b5bcf885479 | |
| parent | b65c44c4a8e86a4af2f2d96c26a1fe16753637ba (diff) | |
| download | tasd-f21297e56da08f008e04ba9ac99243d4c81d7568.tar.gz tasd-f21297e56da08f008e04ba9ac99243d4c81d7568.zip | |
Fix SNES_LATCH_FILTER typos and missing content
This commit fixes some issues related to SNES_LATCH_FILTER in the spec,
which includes adding it to the "Assigned Packet Keys Without
Descriptions" section, fixing the key
This commit also fixes some incorrect data in the CHANGELOG for the
2023-09-24 commit list of changes.
To prevent any of the packet diagrams from aligning incorrectly, all
tabs in the spec xml file have been replaced by 2 spaces.
The previous commit summary had errors in it. It should have stated:
Changed
- Specify INPUT_CHUNK offset for Index Value of TRANSITION packet
Fixed
- EXPERIMENTAL packet drawing error and packet value length
Added
- PORT_OVERREAD packet
- SNES_LATCH_FILTER packet
- Port value to TRANSITION packet
Removed
- SNES_OVERREAD and NES_OVERREAD packets
| -rw-r--r-- | CHANGELOG.md | 16 | ||||
| -rw-r--r-- | docs/latest/draft-tasd-spec.html | 20 | ||||
| -rw-r--r-- | docs/latest/draft-tasd-spec.txt | 5 | ||||
| -rw-r--r-- | docs/tasd-spec-0001/draft-tasd-spec-0001.html | 20 | ||||
| -rw-r--r-- | docs/tasd-spec-0001/draft-tasd-spec-0001.txt | 5 | ||||
| -rw-r--r-- | src/docs/draft-tasd-spec-0001.xml | 35 |
6 files changed, 62 insertions, 39 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index d654b09..df256d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), although currently without version numbers added. +## 2023-09-25 + +### Changed +- Replaced all tabs in xml file with 2 spaces to prevent diagrams from aligning incorrectly + +### Fixed +- 2023-09-24 CHANGELOG data +- SNES_LATCH_FILTER packet description now has correct key +- SNES_LATCH_FILTER packet without description is now in the spec + + ## 2023-09-24 ### Changed @@ -13,11 +24,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - EXPERIMENTAL packet drawing error and packet value length ### Added -- SNES_LATCH_FILTER +- PORT_OVERREAD packet +- SNES_LATCH_FILTER packet - Port value to TRANSITION packet ### Removed -- SNES_OVERREAD and NES_OVERREAD +- SNES_OVERREAD and NES_OVERREAD packets ## 2023-09-18 diff --git a/docs/latest/draft-tasd-spec.html b/docs/latest/draft-tasd-spec.html index 7fec116..c05495f 100644 --- a/docs/latest/draft-tasd-spec.html +++ b/docs/latest/draft-tasd-spec.html @@ -1207,7 +1207,7 @@ li > p:last-of-type:only-child { <dd class="workgroup">Independent TAS Console Replay Research Group</dd> <dt class="label-published">Published:</dt> <dd class="published"> -<time datetime="2023-09-24" class="published">24 September 2023</time> +<time datetime="2023-09-25" class="published">25 September 2023</time> </dd> <dt class="label-authors">Authors:</dt> <dd class="authors"> @@ -1983,16 +1983,20 @@ li > p:last-of-type:only-child { <a href="#section-4.1.3" class="section-number selfRef">4.1.3. </a><a href="#name-snes-specific-keys" class="section-name selfRef">SNES Specific Keys</a> </h4> <span class="break"></span><dl class="dlCompact dlParallel" id="section-4.1.3-1"> - <dt id="section-4.1.3-1.1"><code>[02 02]</code></dt> - <dd style="margin-left: 1.5em" id="section-4.1.3-1.2">SNES_CLOCK_FILTER<a href="#section-4.1.3-1.2" class="pilcrow">¶</a> + <dt id="section-4.1.3-1.1"><code>[02 01]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.2">SNES_LATCH_FILTER<a href="#section-4.1.3-1.2" class="pilcrow">¶</a> </dd> <dd class="break"></dd> -<dt id="section-4.1.3-1.3"><code>[02 04]</code></dt> - <dd style="margin-left: 1.5em" id="section-4.1.3-1.4">SNES_GAME_GENIE_CODE<a href="#section-4.1.3-1.4" class="pilcrow">¶</a> +<dt id="section-4.1.3-1.3"><code>[02 02]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.4">SNES_CLOCK_FILTER<a href="#section-4.1.3-1.4" class="pilcrow">¶</a> </dd> <dd class="break"></dd> -<dt id="section-4.1.3-1.5"><code>[02 05]</code></dt> - <dd style="margin-left: 1.5em" id="section-4.1.3-1.6">SNES_LATCH_TRAIN<a href="#section-4.1.3-1.6" class="pilcrow">¶</a> +<dt id="section-4.1.3-1.5"><code>[02 04]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.6">SNES_GAME_GENIE_CODE<a href="#section-4.1.3-1.6" class="pilcrow">¶</a> +</dd> + <dd class="break"></dd> +<dt id="section-4.1.3-1.7"><code>[02 05]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.8">SNES_LATCH_TRAIN<a href="#section-4.1.3-1.8" class="pilcrow">¶</a> </dd> <dd class="break"></dd> </dl> @@ -2210,7 +2214,7 @@ li > p:last-of-type:only-child { </h4> <span class="break"></span><dl class="dlNewline" id="section-4.2.3-1"> <dt id="section-4.2.3-1.1"> -<code>[01 01]</code> - SNES_LATCH_FILTER</dt> +<code>[02 01]</code> - SNES_LATCH_FILTER</dt> <dd style="margin-left: 1.5em" id="section-4.2.3-1.2">Specifies a latch filter time in microseconds for how long how long to wait after a latch signal until new latch signals <span class="bcp14">SHOULD</span> be accepted by the replay device. This packet type is <span class="bcp14">OPTIONAL</span> and a <strong>TASD</strong> file <span class="bcp14">SHOULD NOT</span> contain more than 1 of this packet type in direct form. Discussed in (<a href="#snes_latch_filter" class="auto internal xref">Section 4.3.3.1</a>).<a href="#section-4.2.3-1.2" class="pilcrow">¶</a> </dd> <dd class="break"></dd> diff --git a/docs/latest/draft-tasd-spec.txt b/docs/latest/draft-tasd-spec.txt index f309c4b..96d9f43 100644 --- a/docs/latest/draft-tasd-spec.txt +++ b/docs/latest/draft-tasd-spec.txt @@ -7,7 +7,7 @@ Independent TAS Console Replay Research Group V. Grey Bigbass rasteri - 24 September 2023 + 25 September 2023 TASD File Format Specification Version 1 @@ -416,6 +416,7 @@ Table of Contents 4.1.3. SNES Specific Keys + [02 01] SNES_LATCH_FILTER [02 02] SNES_CLOCK_FILTER [02 04] SNES_GAME_GENIE_CODE [02 05] SNES_LATCH_TRAIN @@ -600,7 +601,7 @@ Table of Contents 4.2.3. SNES Specific Key Descriptions - [01 01] - SNES_LATCH_FILTER + [02 01] - SNES_LATCH_FILTER Specifies a latch filter time in microseconds for how long how long to wait after a latch signal until new latch signals SHOULD be accepted by the replay device. This packet type is OPTIONAL diff --git a/docs/tasd-spec-0001/draft-tasd-spec-0001.html b/docs/tasd-spec-0001/draft-tasd-spec-0001.html index 7fec116..c05495f 100644 --- a/docs/tasd-spec-0001/draft-tasd-spec-0001.html +++ b/docs/tasd-spec-0001/draft-tasd-spec-0001.html @@ -1207,7 +1207,7 @@ li > p:last-of-type:only-child { <dd class="workgroup">Independent TAS Console Replay Research Group</dd> <dt class="label-published">Published:</dt> <dd class="published"> -<time datetime="2023-09-24" class="published">24 September 2023</time> +<time datetime="2023-09-25" class="published">25 September 2023</time> </dd> <dt class="label-authors">Authors:</dt> <dd class="authors"> @@ -1983,16 +1983,20 @@ li > p:last-of-type:only-child { <a href="#section-4.1.3" class="section-number selfRef">4.1.3. </a><a href="#name-snes-specific-keys" class="section-name selfRef">SNES Specific Keys</a> </h4> <span class="break"></span><dl class="dlCompact dlParallel" id="section-4.1.3-1"> - <dt id="section-4.1.3-1.1"><code>[02 02]</code></dt> - <dd style="margin-left: 1.5em" id="section-4.1.3-1.2">SNES_CLOCK_FILTER<a href="#section-4.1.3-1.2" class="pilcrow">¶</a> + <dt id="section-4.1.3-1.1"><code>[02 01]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.2">SNES_LATCH_FILTER<a href="#section-4.1.3-1.2" class="pilcrow">¶</a> </dd> <dd class="break"></dd> -<dt id="section-4.1.3-1.3"><code>[02 04]</code></dt> - <dd style="margin-left: 1.5em" id="section-4.1.3-1.4">SNES_GAME_GENIE_CODE<a href="#section-4.1.3-1.4" class="pilcrow">¶</a> +<dt id="section-4.1.3-1.3"><code>[02 02]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.4">SNES_CLOCK_FILTER<a href="#section-4.1.3-1.4" class="pilcrow">¶</a> </dd> <dd class="break"></dd> -<dt id="section-4.1.3-1.5"><code>[02 05]</code></dt> - <dd style="margin-left: 1.5em" id="section-4.1.3-1.6">SNES_LATCH_TRAIN<a href="#section-4.1.3-1.6" class="pilcrow">¶</a> +<dt id="section-4.1.3-1.5"><code>[02 04]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.6">SNES_GAME_GENIE_CODE<a href="#section-4.1.3-1.6" class="pilcrow">¶</a> +</dd> + <dd class="break"></dd> +<dt id="section-4.1.3-1.7"><code>[02 05]</code></dt> + <dd style="margin-left: 1.5em" id="section-4.1.3-1.8">SNES_LATCH_TRAIN<a href="#section-4.1.3-1.8" class="pilcrow">¶</a> </dd> <dd class="break"></dd> </dl> @@ -2210,7 +2214,7 @@ li > p:last-of-type:only-child { </h4> <span class="break"></span><dl class="dlNewline" id="section-4.2.3-1"> <dt id="section-4.2.3-1.1"> -<code>[01 01]</code> - SNES_LATCH_FILTER</dt> +<code>[02 01]</code> - SNES_LATCH_FILTER</dt> <dd style="margin-left: 1.5em" id="section-4.2.3-1.2">Specifies a latch filter time in microseconds for how long how long to wait after a latch signal until new latch signals <span class="bcp14">SHOULD</span> be accepted by the replay device. This packet type is <span class="bcp14">OPTIONAL</span> and a <strong>TASD</strong> file <span class="bcp14">SHOULD NOT</span> contain more than 1 of this packet type in direct form. Discussed in (<a href="#snes_latch_filter" class="auto internal xref">Section 4.3.3.1</a>).<a href="#section-4.2.3-1.2" class="pilcrow">¶</a> </dd> <dd class="break"></dd> diff --git a/docs/tasd-spec-0001/draft-tasd-spec-0001.txt b/docs/tasd-spec-0001/draft-tasd-spec-0001.txt index f309c4b..96d9f43 100644 --- a/docs/tasd-spec-0001/draft-tasd-spec-0001.txt +++ b/docs/tasd-spec-0001/draft-tasd-spec-0001.txt @@ -7,7 +7,7 @@ Independent TAS Console Replay Research Group V. Grey Bigbass rasteri - 24 September 2023 + 25 September 2023 TASD File Format Specification Version 1 @@ -416,6 +416,7 @@ Table of Contents 4.1.3. SNES Specific Keys + [02 01] SNES_LATCH_FILTER [02 02] SNES_CLOCK_FILTER [02 04] SNES_GAME_GENIE_CODE [02 05] SNES_LATCH_TRAIN @@ -600,7 +601,7 @@ Table of Contents 4.2.3. SNES Specific Key Descriptions - [01 01] - SNES_LATCH_FILTER + [02 01] - SNES_LATCH_FILTER Specifies a latch filter time in microseconds for how long how long to wait after a latch signal until new latch signals SHOULD be accepted by the replay device. This packet type is OPTIONAL diff --git a/src/docs/draft-tasd-spec-0001.xml b/src/docs/draft-tasd-spec-0001.xml index e63af21..30ab2b6 100644 --- a/src/docs/draft-tasd-spec-0001.xml +++ b/src/docs/draft-tasd-spec-0001.xml @@ -212,7 +212,7 @@ <dt><strong>Key</strong></dt> <dd>Packet type (Packet key).</dd> <dt><strong>PEXP</strong></dt> - <dd>Length of <strong>PLEN</strong>. <strong>PEXP</strong> <bcp14>MUST</bcp14> be a value greater than 0.</dd> + <dd>Length of <strong>PLEN</strong>. <strong>PEXP</strong> <bcp14>MUST</bcp14> be a value greater than 0.</dd> <dt><strong>PLEN</strong></dt> <dd>Length of <strong>Payload</strong>.</dd> <dt><strong>Payload</strong></dt> @@ -262,6 +262,7 @@ <section numbered="true" toc="default"> <name>SNES Specific Keys</name> <dl spacing="compact"> + <dt><tt>[02 01]</tt></dt> <dd>SNES_LATCH_FILTER</dd> <dt><tt>[02 02]</tt></dt> <dd>SNES_CLOCK_FILTER</dd> <dt><tt>[02 04]</tt></dt> <dd>SNES_GAME_GENIE_CODE</dd> <dt><tt>[02 05]</tt></dt> <dd>SNES_LATCH_TRAIN</dd> @@ -359,7 +360,7 @@ <section numbered="true" toc="default"> <name>SNES Specific Key Descriptions</name> <dl newline="true"> - <dt><tt>[01 01]</tt> - SNES_LATCH_FILTER</dt> + <dt><tt>[02 01]</tt> - SNES_LATCH_FILTER</dt> <dd>Specifies a latch filter time in microseconds for how long how long to wait after a latch signal until new latch signals <bcp14>SHOULD</bcp14> be accepted by the replay device. This packet type is <bcp14>OPTIONAL</bcp14> and a <strong>TASD</strong> file <bcp14>SHOULD NOT</bcp14> contain more than 1 of this packet type in direct form. Discussed in (<xref target="snes_latch_filter"/>).</dd> <dt><tt>[02 02]</tt> - SNES_CLOCK_FILTER</dt> <dd>Specifies a clock filter time in tenths of a microsecond (0.1 microseconds or 100 nanoseconds) for how long to wait after a clock pulse until new clock pulses <bcp14>SHOULD</bcp14> be accepted by the replay device. This packet type is <bcp14>OPTIONAL</bcp14> and a <strong>TASD</strong> file <bcp14>SHOULD NOT</bcp14> contain more than 1 of this packet type in direct form. Discussed in (<xref target="snes_clock_filter"/>).</dd> @@ -917,10 +918,10 @@ <dd>Specifies the controller type connected to the <strong>Port</strong>. <strong>(RESERVED)</strong> specifies that the controller type is not described in this document, but the byte values are reserved for a later version of the <strong>TASD</strong> file format protocol. Input formats for specific controller types are described in (<xref target="controller_inputs"/>).</dd> </dl> </section> - <section numbered="true" toc="default" anchor="port_overread"> - <name>PORT_OVERREAD Packet</name> - <t>PORT_OVERREAD packets <bcp14>MUST</bcp14> be in the following format:</t> - <artwork><![CDATA[ + <section numbered="true" toc="default" anchor="port_overread"> + <name>PORT_OVERREAD Packet</name> + <t>PORT_OVERREAD packets <bcp14>MUST</bcp14> be in the following format:</t> + <artwork><![CDATA[ 0 1 +----------+----------+ | Port (N) | High (B) | @@ -928,14 +929,14 @@ Port (N) [1 octet] High (Boolean) [1 octet]]]> - </artwork> - <dl newline="true"> - <dt><strong>Port</strong></dt> - <dd>Controller port number (<strong>Port</strong> number <bcp14>MUST</bcp14> be <strong>1-indexed</strong>).</dd> - <dt><strong>High</strong></dt> - <dd>Boolean value that is <strong>TRUE</strong> if overread bits are set to high and <strong>FALSE</strong> if overread bits are set to low.</dd> - </dl> - </section> + </artwork> + <dl newline="true"> + <dt><strong>Port</strong></dt> + <dd>Controller port number (<strong>Port</strong> number <bcp14>MUST</bcp14> be <strong>1-indexed</strong>).</dd> + <dt><strong>High</strong></dt> + <dd>Boolean value that is <strong>TRUE</strong> if overread bits are set to high and <strong>FALSE</strong> if overread bits are set to low.</dd> + </dl> + </section> </section> <section numbered="true" toc="default"> <name>NES Specific Key Payload Formats</name> @@ -1175,9 +1176,9 @@ <dt><strong>Input Type</strong></dt> <dd>Determines specific timing type for start of transition.</dd> <dt><strong>Port</strong></dt> - <dd>Controller port number of input index. If <strong>Index Type</strong> is <tt>[05]</tt>, <strong>Port</strong> <bcp14>MUST</bcp14> be <strong>1-indexed</strong> Port number, otherwise <strong>Port</strong> <bcp14>MAY</bcp14> be any value.</dd> + <dd>Controller port number of input index. If <strong>Index Type</strong> is <tt>[05]</tt>, <strong>Port</strong> <bcp14>MUST</bcp14> be <strong>1-indexed</strong> Port number, otherwise <strong>Port</strong> <bcp14>MAY</bcp14> be any value.</dd> <dt><strong>Index</strong></dt> - <dd>Time or offset value to start transition. If <strong>Index Type</strong> is <tt>[05]</tt>, <strong>Index</strong> <bcp14>MUST</bcp14> be the byte offset of <strong>INPUT_CHUNK</strong> data from <strong>INPUT_CHUNK</strong> packets for the controller port specified by <strong>Port</strong>.</dd> + <dd>Time or offset value to start transition. If <strong>Index Type</strong> is <tt>[05]</tt>, <strong>Index</strong> <bcp14>MUST</bcp14> be the byte offset of <strong>INPUT_CHUNK</strong> data from <strong>INPUT_CHUNK</strong> packets for the controller port specified by <strong>Port</strong>.</dd> <dt><strong>Type</strong></dt> <dd>Type of transition. If <strong>Type</strong> is <tt>[FF]</tt>, the transition action will be interpreting a <strong>TASD</strong> packet.</dd> <dt><strong>Inner Packet</strong></dt> @@ -1419,7 +1420,7 @@ <dt>Bit 0:</dt><dd>Direction (0: up; 1: down)</dd> </dl> </section> - <section numbered="true" toc="default"> + <section numbered="true" toc="default"> <name>SNES Super Multitap</name> <t>Single Input Length: 5 Octets</t> <t><strong>Octet 0</strong> : </t> |
