From f21297e56da08f008e04ba9ac99243d4c81d7568 Mon Sep 17 00:00:00 2001 From: Vi Grey Date: Mon, 25 Sep 2023 00:56:47 +0000 Subject: 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 --- CHANGELOG.md | 16 ++++++++++-- docs/latest/draft-tasd-spec.html | 20 +++++++++------ docs/latest/draft-tasd-spec.txt | 5 ++-- docs/tasd-spec-0001/draft-tasd-spec-0001.html | 20 +++++++++------ docs/tasd-spec-0001/draft-tasd-spec-0001.txt | 5 ++-- 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 {
Independent TAS Console Replay Research Group
Published:
- +
Authors:
@@ -1983,16 +1983,20 @@ li > p:last-of-type:only-child { 4.1.3. SNES Specific Keys
-
[02 02]
-
SNES_CLOCK_FILTER +
[02 01]
+
SNES_LATCH_FILTER
-
[02 04]
-
SNES_GAME_GENIE_CODE +
[02 02]
+
SNES_CLOCK_FILTER
-
[02 05]
-
SNES_LATCH_TRAIN +
[02 04]
+
SNES_GAME_GENIE_CODE +
+
+
[02 05]
+
SNES_LATCH_TRAIN
@@ -2210,7 +2214,7 @@ li > p:last-of-type:only-child {
-[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 and a TASD file SHOULD NOT contain more than 1 of this packet type in direct form. Discussed in (Section 4.3.3.1).
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 {
Independent TAS Console Replay Research Group
Published:
- +
Authors:
@@ -1983,16 +1983,20 @@ li > p:last-of-type:only-child { 4.1.3. SNES Specific Keys
-
[02 02]
-
SNES_CLOCK_FILTER +
[02 01]
+
SNES_LATCH_FILTER
-
[02 04]
-
SNES_GAME_GENIE_CODE +
[02 02]
+
SNES_CLOCK_FILTER
-
[02 05]
-
SNES_LATCH_TRAIN +
[02 04]
+
SNES_GAME_GENIE_CODE +
+
+
[02 05]
+
SNES_LATCH_TRAIN
@@ -2210,7 +2214,7 @@ li > p:last-of-type:only-child {
-[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 and a TASD file SHOULD NOT contain more than 1 of this packet type in direct form. Discussed in (Section 4.3.3.1).
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 @@
Key
Packet type (Packet key).
PEXP
-
Length of PLEN. PEXP MUST be a value greater than 0.
+
Length of PLEN. PEXP MUST be a value greater than 0.
PLEN
Length of Payload.
Payload
@@ -262,6 +262,7 @@
SNES Specific Keys
+
[02 01]
SNES_LATCH_FILTER
[02 02]
SNES_CLOCK_FILTER
[02 04]
SNES_GAME_GENIE_CODE
[02 05]
SNES_LATCH_TRAIN
@@ -359,7 +360,7 @@
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 and a TASD file SHOULD NOT contain more than 1 of this packet type in direct form. Discussed in ().
[02 02] - SNES_CLOCK_FILTER
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 SHOULD be accepted by the replay device. This packet type is OPTIONAL and a TASD file SHOULD NOT contain more than 1 of this packet type in direct form. Discussed in ().
@@ -917,10 +918,10 @@
Specifies the controller type connected to the Port. (RESERVED) specifies that the controller type is not described in this document, but the byte values are reserved for a later version of the TASD file format protocol. Input formats for specific controller types are described in ().
-
- PORT_OVERREAD Packet - PORT_OVERREAD packets MUST be in the following format: - + PORT_OVERREAD Packet + PORT_OVERREAD packets MUST be in the following format: + - -
-
Port
-
Controller port number (Port number MUST be 1-indexed).
-
High
-
Boolean value that is TRUE if overread bits are set to high and FALSE if overread bits are set to low.
-
-
+ +
+
Port
+
Controller port number (Port number MUST be 1-indexed).
+
High
+
Boolean value that is TRUE if overread bits are set to high and FALSE if overread bits are set to low.
+
+
NES Specific Key Payload Formats @@ -1175,9 +1176,9 @@
Input Type
Determines specific timing type for start of transition.
Port
-
Controller port number of input index. If Index Type is [05], Port MUST be 1-indexed Port number, otherwise Port MAY be any value.
+
Controller port number of input index. If Index Type is [05], Port MUST be 1-indexed Port number, otherwise Port MAY be any value.
Index
-
Time or offset value to start transition. If Index Type is [05], Index MUST be the byte offset of INPUT_CHUNK data from INPUT_CHUNK packets for the controller port specified by Port.
+
Time or offset value to start transition. If Index Type is [05], Index MUST be the byte offset of INPUT_CHUNK data from INPUT_CHUNK packets for the controller port specified by Port.
Type
Type of transition. If Type is [FF], the transition action will be interpreting a TASD packet.
Inner Packet
@@ -1419,7 +1420,7 @@
Bit 0:
Direction (0: up; 1: down)
-
+
SNES Super Multitap Single Input Length: 5 Octets Octet 0 : -- cgit v1.2.3