Skip to content

Commit

Permalink
All: 1.0.0_rc31. Using updated PDF template.
Browse files Browse the repository at this point in the history
  • Loading branch information
mipsrobert committed May 7, 2024
1 parent d1a2c74 commit d47a100
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 87 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

## Status of each PDF

**2024/05/02 status:**
**2024/05/07 status:**

* **N-Trace PDF**: Version 1.0.0_rc27. All known ARC notes DONE. Inside of [./pdfs](./pdfs) directory.
* All known ARC notes DONE (ready for Frozen state).
* **Controls PDF**: Version 1.0.0_rc22. All known ARC notes DONE. Inside of [./pdfs](./pdfs) directory.
* All known ARC notes DONE (ready for Frozen state).
* **Connectors PDF**: Version 1.0.0_rc30. Frozen. Inside of [./pdfs](./pdfs) directory.
* It was accepted by ARC (via email).
All 3 PDFs are using updated PDF template with nice header and footer and are located inside of [./pdfs](./pdfs) directory.

* **N-Trace PDF**: Version 1.0.0_rc31. Ready for Freeze.
* **Controls PDF**: Version 1.0.0_rc31. Ready for Freeze.
* **Connectors PDF**: Version 1.0.0_rc31. Ready for Freeze.

## TODO (before official freeze)

* TODO: Find a way to add nice header/footer at each page (Debug PDF has these).
* TODO: Fix annoying page breaks (manual insert of 'page-break').
* TODO: Make release with all PDFs 'Frozen', same date/version and pass back to ARC for official OK-stamp.
* TODO: Make Public Review announcement (all PDFs Frozen).
Expand Down
47 changes: 24 additions & 23 deletions docs/RISC-V-N-Trace.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[header]]
:description: RISC-V N-Trace (Nexus-based Trace)
:company: RISC-V.org
:revdate: May 02, 2024
:revnumber: 1.0.0_rc27
:revremark: Stable state (Second set of ARC notes DONE)
:revdate: May 07, 2024
:revnumber: 1.0.0_rc31
:revremark: Stable state (ready for Freeze)
:url-riscv: http://riscv.org
:doctype: book
:preface-title: Preamble
Expand Down Expand Up @@ -52,9 +52,9 @@ Change is extremely unlikely.

PDF generated on: {localdatetime}

=== Version 1.0.0_rc27
* 2024-05-02
** Second set of ARC notes DONE
=== Version 1.0.0_rc31
* 2024-05-07
** Ready for Freeze.

[Preface]
== Copyright and license information
Expand Down Expand Up @@ -599,7 +599,7 @@ Message field attributes are described using the following terminology:
* *[Cfg]*: A configurable field, where the existence and size depend on the encoder configuration options.

.Fields in Messages
[cols="26%,9%,7%,7%,9%,17%,8%,10%,7%",options="header",]
[cols="27%,9%,6%,7%,9%,17%,8%,10%,7%",options="header",]
|===========================================================================================
| Message ID/Field [size]|<<field_TCODE,TCODE>> [6]|<<field_SRC,SRC>> [Cfg]|<<field_SYNC,SYNC>> [4]|<<field_B-TYPE,B-TYPE>> [2]|Other fields|<<field_I-CNT,I-CNT>> [Var]|<<Address Compression,x-ADDR>> [Var]|<<field_HIST,HIST>> [Var]
|[[msg_Ownership]]<<msg2_Ownership,Ownership>> |2 |Cfg| | |<<field_PROCESS,PROCESS>> *[Var]* | | |
Expand All @@ -614,7 +614,7 @@ Message field attributes are described using the following terminology:
|[[msg_IndirectBranchHistSync]]<<msg2_IndirectBranchHistSync,IndirectBranchHistSync>>|29 |Cfg|Yes |Yes | |Yes |<<field_F-ADDR,F-ADDR>>|Yes
|[[msg_RepeatBranch]]<<msg2_RepeatBranch,RepeatBranch>> |30 |Cfg| | |<<field_B-CNT,B-CNT>> *[Var]* | | |
|[[msg_ProgTraceCorrelation]]<<msg2_ProgTraceCorrelation,ProgTraceCorrelation>> |33 |Cfg| | |<<field_EVCODE,EVCODE>> *[4]* + <<field_CDF,CDF>> *[2]* |Yes | |*Cfg*
|<<msg_other,Vendor Defined>>|56..62|Cfg 6+| *TCODE* range designated for use by Vendor Defined messages
|<<msg_other,Vendor Defined>>|56..62|Cfg 6+| Designated for use by Vendor Defined messages
|<<msg_other,Reserved>>|other|Cfg 6+| Reserved for future extensions of N-Trace specification
|===========================================================================================

Expand Down Expand Up @@ -1137,21 +1137,22 @@ Rules when generating addresses:
** To decode the full address from the relative address (U-ADDR) can be XORed with the previously decoded full address.
* Address fields are sent beginning with bit 1 since all execution addresses are on a 2-byte boundaries (the least significant bit is always 0 and never sent).

Example:

[#Address XOR Compression]
.Address XOR Compression Example
[cols="10%,35%,44%,11%",options="header",]
|====
|Address |U-ADDR XOR calculations |F-ADDR/U-ADDR field sent | New REF Address
|0x3FC04 | |F-ADDR=1_1111_1110_0000_0010=0x1FE02| 0x3FC04
|0x3F368 | REF =0011_1111_1100_0000_0100 +
addr=0011_1111_0011_0110_1000 +
XOR =0000_0000_1111_0110_1100 |U-ADDR=111_1011_0110=0x7B6 | 0x3F368
|0x3E100 | REF =0011_1111_0011_0110_1000 +
addr=0011_1110_0001_0000_0000 +
XOR =0000_0001_0010_0110_1000 |U-ADDR=1001_0011_0100=0x934 | 0x3E100
|====
*Address XOR Calculation Examples*

==============================================================================================
| Address | U-ADDR XOR calculations | F-ADDR/U-ADDR field sent | New REF |
| | | | Address |
==============================================================================================
|0x3FC04 | | F-ADDR=1_1111_1110_0000_0010=0x1FE02 | 0x3FC04 |
----------------------------------------------------------------------------------------------
|0x3F368 | REF =0011_1111_1100_0000_0100 | | |
| | addr=0011_1111_0011_0110_1000 | | |
| | XOR =0000_0000_1111_0110_1100 | U-ADDR=111_1011_0110=0x7B6 | 0x3F368 |
----------------------------------------------------------------------------------------------
|0x3E100 | REF =0011_1111_0011_0110_1000 | | |
| | addr=0011_1110_0001_0000_0000 | | |
| | XOR =0000_0001_0010_0110_1000 | U-ADDR=1001_0011_0100=0x934 | 0x3E100 |
==============================================================================================

=== Virtual Addresses Optimization

Expand Down
16 changes: 8 additions & 8 deletions docs/RISC-V-Trace-Connectors.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[header]]
:description: RISC-V Trace Connectors
:company: RISC-V.org
:revdate: Mar 30, 2024
:revnumber: 1.0.0_rc30
:revremark: Frozen state
:revdate: May 07, 2024
:revnumber: 1.0.0_rc31
:revremark: Stable state (ready for Freeze)
:url-riscv: http://riscv.org
:doctype: book
:preface-title: Preamble
Expand Down Expand Up @@ -42,19 +42,19 @@ RISC-V N-Trace Task Group

// Preamble
[WARNING]
.This document is in the link:http://riscv.org/spec-state[Frozen state]
.This document is in the link:http://riscv.org/spec-state[Stable state]
====
Change is extremely unlikely. A high threshold will be used, and a change will only occur because of some truly critical issue being identified during the public review cycle. Any other desired or needed changes can be the subject of a follow-on new extension
Change is extremely unlikely.
====

[preface]
== Change Log

PDF generated on: {localdatetime}

=== Version 1.0.0_rc30
* 2024-03-30 (Frozen)
** ARC reviews taken into account (confirmed by email)
=== Version 1.0.0_rc31
* 2024-05-07
** Ready for Freeze.

[Preface]
== Copyright and license information
Expand Down
Loading

0 comments on commit d47a100

Please sign in to comment.