# tg-nexus-trace

**Repository Path**: gunsimon/tg-nexus-trace

## Basic Information

- **Project Name**: tg-nexus-trace
- **Description**: 从github中导入的关于RISC-V Nexus Trace TG documentation and reference code的仓库
- **Primary Language**: C
- **License**: CC-BY-4.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-14
- **Last Updated**: 2024-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TG RISC-V Nexus Trace

## Status of each PDF

**2024/04/01 status:**

* **N-Trace PDF**: Version 1.0.0_rc26 ('itype' unification DONE). Inside of [./pdfs](./pdfs) directory.
  * Clarification of SYNC generation is still TODO.
* **Controls PDF**: Version 1.0.0_rc20. Detailed ARC notes DONE. Inside of [./pdfs](./pdfs) directory.
  * Ready for second round of ARC reviews.
* **Connectors PDF**: Version 1.0.0_rc30. Frozen. Inside of [./pdfs](./pdfs) directory.
  * It was accepted by ARC (via email).


**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 sure all PDFs.
* TODO: Make release with all documents 'Frozen' and pass back to ARC for official OK-stamp.
* TODO: Make Public Review announcement (all PDFs Frozen).

**TODO (after ratification approval):**

* TODO: Change status to Ratified.
* TODO: Change date.
* TODO: Remove _rc and make version 1.0.0.
* TODO: Make official release.
* TODO: Place all 3 PDFs into 'public' place (and update/add links).

## Repository Overview

Working repository of the RISC-V Nexus Trace TG report.  Nexus Trace TG Home page is [here](https://lists.riscv.org/g/tech-nexus).

* Main N-Trace specification is defined here: [RISC-V-N-Trace.adoc](./docs/RISC-V-N-Trace.adoc) and PDF version is here: [PDF](./pdfs/RISC-V-N-Trace.pdf).

* Trace Control Interface is defined here: [RISC-V-Trace-Control-Interface.adoc](./docs/RISC-V-Trace-Control-Interface.adoc)  and PDF version is here: [PDF](./pdfs/RISC-V-Trace-Control-Interface.pdf).

* Trace connectors are defined here: [RISC-V-Trace-Connectors.adoc](./docs/RISC-V-Trace-Connectors.adoc) and PDF version is here: [PDF](./pdfs/RISC-V-Trace-Connectors.pdf).

Clicking on ADOC file in the github repo viewer will render a usable version as markdown.

For a better rendering to PDF, use Actions in main menu above.

Reference C code for Nexus Trace dumper/encoder/decoder is [here](./refcode/c) - documentation as README.md file is provided.

This work is licensed under a Creative Commons Attribution 4.0
International License. See the LICENSE file for details.

## Initial Work (Preserved)

For initial document v0.01 (as PDF from MS Word), click [here](./pdfs/RISC-V-Nexus-Trace-Spec-2019-10-29.pdf).
Same file in ADOC format is here: [TG-RISC-V-Nexus-Trace.adoc](./docs/initial/RISC-V-Nexus-Trace-Spec.adoc).

## Additional Resources

- The [Nexus IEEE-ISTO-5001 Standard (2012-v3.0.1)](./docs/nexus-standard/IEEE-ISTO-5001-2012-v3.0.1-Nexus-Standard.pdf) PDF file.

## Documentation generator

PDF version of specification should be generated using Actions menu. See below for more details.

## Dependencies
The PDF built in this project uses AsciiDoctor (Ruby). For more information
on AsciiDoctor, specification guidelines, or building locally, see the 
[RISC-V Documentation Developer Guide](https://github.com/riscv/docs-dev-guide).

## Cloning the project
This project uses 
[GitHub Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) 
to include the RISC-V 
[docs-resources project](https://github.com/riscv/docs-resources)
to achieve a common look and feel.

When cloning this repository for the first time, you must either use 
`git clone --recurse-submodules` or execute `git submodule init` and 
`git submodule update` after the clone to populate the `docs-resources` 
directory. Failure to clone the submodule, will result in the PDF build 
fail with an error message like the following:

```
$ make
asciidoctor-pdf \
-a toc \
-a compress \
-a pdf-style=docs-resources/themes/riscv-pdf.yml \
-a pdf-fontsdir=docs-resources/fonts \
--failure-level=ERROR \
-o profiles.pdf profiles.adoc
asciidoctor: ERROR: could not locate or load the built-in pdf theme `docs-resources/themes/riscv-pdf.yml'; reverting to default theme
No such file or directory - notoserif-regular-subset.ttf not found in docs-resources/fonts
  Use --trace for backtrace
make: *** [Makefile:7: profiles.pdf] Error 1
```