diff options
| author | bigbass1997 <bigbass1997.website@gmail.com> | 2023-09-17 19:51:02 -0500 |
|---|---|---|
| committer | bigbass1997 <bigbass1997.website@gmail.com> | 2023-09-17 19:51:02 -0500 |
| commit | 993ef75a0410c4850322c1033a066b360f62c14a (patch) | |
| tree | 1e0402d5c963866c350171581a865532f0203fbf /src/docs | |
| parent | a668f8772fd00a380ae2ec5ed19c36cd3dd0999d (diff) | |
| download | tasd-993ef75a0410c4850322c1033a066b360f62c14a.tar.gz tasd-993ef75a0410c4850322c1033a066b360f62c14a.zip | |
Added a new "Structure" section to the spec
Diffstat (limited to 'src/docs')
| -rw-r--r-- | src/docs/draft-tasd-spec-0001.xml | 31 |
1 files changed, 27 insertions, 4 deletions
diff --git a/src/docs/draft-tasd-spec-0001.xml b/src/docs/draft-tasd-spec-0001.xml index a9eb859..0fbde6e 100644 --- a/src/docs/draft-tasd-spec-0001.xml +++ b/src/docs/draft-tasd-spec-0001.xml @@ -151,9 +151,30 @@ </section> </section> </section> + <section numbered="true" toc="default"> + <name>Structure</name> + <t><strong>TASD</strong> files <bcp14>MUST</bcp14> begin with a header. The header <bcp14>MUST</bcp14> be followed by <strong>0 or more</strong> packets.</t> + <artwork><![CDATA[ + 0 1 2 3 4 5 6 7... + +-+-+-+-+-+-+-+=============+ + | Header (A) | Packets (A) | + +-+-+-+-+-+-+-+=============+ + + Header (Binary Data) [7 octets] + Packets (Binary Data) [? octets]]]> + </artwork> + <dl newline="true"> + <dt><strong>Header</strong></dt> + <dd>7 octet header as defined in <xref target="header"/>.</dd> + <dt><strong>Packets</strong></dt> + <dd>List of 0 or more packets. Refer to <xref target="packets"/> for packet definitions.</dd> + </dl> + </section> + + <section numbered="true" toc="default" anchor="header"> <name>Header</name> - <t><strong>TASD</strong> files <bcp14>MUST</bcp14> include a header, which <bcp14>MUST</bcp14> be in the following format:</t> + <t>The <strong>TASD</strong> file header <bcp14>MUST</bcp14> be in the following format:</t> <artwork><![CDATA[ 0 1 2 3 4 5 6 +----+----+----+----+------+------+--------------+ @@ -174,9 +195,9 @@ </dl> </section> - <section numbered="true" toc="default"> + <section numbered="true" toc="default" anchor="packets"> <name>Packets</name> - <t>Packets <bcp14>MUST</bcp14> be in the following format:</t> + <t>Each packet <bcp14>MUST</bcp14> be in the following format:</t> <artwork><![CDATA[ +=========+----------+==========+=============+ | Key (A) | PEXP (N) | PLEN (N) | Payload (A) | @@ -197,7 +218,7 @@ <dt><strong>Payload</strong></dt> <dd>Payload/Content of the packet.</dd> <dt><strong>G_KEYLEN</strong></dt> - <dd>Length of <strong>Key</strong> in packets and is specified in the <strong>TASD</strong> file header.</dd> + <dd>Length of <strong>Key</strong> in each packet and is specified in the <strong>TASD</strong> file header.</dd> </dl> <t>All packets are <bcp14>OPTIONAL</bcp14>.</t> <section numbered="true" toc="default"> @@ -1893,6 +1914,8 @@ </section> <!-- Change Log +draft 09 - 2023-09-17 Bigbass Added "Structure" section to better define the overall structure of a TASD file + draft 08 - 2023-09-14 Bigbass Fixed key numbering for packets SNES_OVERREAD, SNES_GAME_GENIE_CODE, and SNES_LATCH_TRAIN in section 3.2.3 draft 07 - 2023-09-14 Bigbass Changed wording on SNES_LATCH_TRAIN to better explain what each interger represents |