From 0c7cae3d3c97ce48618d83bfc1697a1f7f57fc94 Mon Sep 17 00:00:00 2001 From: Sunil V L Date: Thu, 5 Sep 2024 09:32:47 +0530 Subject: [PATCH 1/4] Move changelog to the document Signed-off-by: Sunil V L --- CHANGELOG.md | 9 --------- src/changelog.adoc | 10 ++++++++++ 2 files changed, 10 insertions(+), 9 deletions(-) delete mode 100644 CHANGELOG.md create mode 100644 src/changelog.adoc diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 1dc0933..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,9 +0,0 @@ -# Changelog - -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/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [0.0.1] -- Initial draft for PRS TG review diff --git a/src/changelog.adoc b/src/changelog.adoc new file mode 100644 index 0000000..46af06e --- /dev/null +++ b/src/changelog.adoc @@ -0,0 +1,10 @@ +== Changelog + +- *Version 1.0.0-rc1* + * Draft for internal review. + * Added ID mapping examples. + * Documentation template changes. + * Addressed PRS TG feedback. + +- *Version 0.0.1* + * Initial draft for PRS TG review From d3fb4241c58b88c6518832ec7062e672be6333c3 Mon Sep 17 00:00:00 2001 From: Sunil V L Date: Thu, 5 Sep 2024 09:33:35 +0530 Subject: [PATCH 2/4] Update contributor list Signed-off-by: Sunil V L --- src/contributors.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/contributors.adoc b/src/contributors.adoc index e859aa3..7a7b698 100644 --- a/src/contributors.adoc +++ b/src/contributors.adoc @@ -5,7 +5,9 @@ This RISC-V specification has been contributed to directly or indirectly by: [%hardbreaks] * Aaron Durbin * Anup Patel +* Atish Kumar Patra * Bin Meng +* Samuel Holland * Sebastien Boeuf * Sunil V L * Tomasz Jeznach From 7c642af0146af883f45b58e038b97ebf2d76b364 Mon Sep 17 00:00:00 2001 From: Sunil V L Date: Thu, 5 Sep 2024 09:34:08 +0530 Subject: [PATCH 3/4] Add references and other minor updates Signed-off-by: Sunil V L --- src/example.bib | 36 ------------------------------ src/rimt-spec.adoc | 55 +++++++++++++++++++--------------------------- src/rimt.bib | 8 +++++++ 3 files changed, 30 insertions(+), 69 deletions(-) delete mode 100644 src/example.bib create mode 100644 src/rimt.bib diff --git a/src/example.bib b/src/example.bib deleted file mode 100644 index 4c368b1..0000000 --- a/src/example.bib +++ /dev/null @@ -1,36 +0,0 @@ -@inproceedings{riscI-isca1981, - title = {{RISC I}: {A} Reduced Instruction Set {VLSI} Computer}, - author = {David A. Patterson and Carlo H. S\'{e}quin}, - booktitle = {ISCA}, - location = {Minneapolis, Minnesota, USA}, - pages = {443-458}, - year = {1981} -} - -@inproceedings{Katevenis:1983, - author = {Manolis G.H. Katevenis and Robert W. Sherburne Jr. and David A. Patterson and Carlo H. S\'{e}quin}, - title = {The {RISC II} micro-architecture}, - booktitle = {Proceedings VLSI 83 Conference}, - year = {1983}, - month = {August} -} - -@inproceedings{Ungar:1984, - author = {David Ungar and Ricki Blau and Peter Foley and Dain Samples and David Patterson}, - title = {Architecture of {SOAR}: {Smalltalk} on a {RISC}}, - booktitle = {ISCA}, - address = {Ann Arbor, MI}, - year = {1984}, - pages = {188-197} -} - -@article{spur-jsscc1989, - author = {David D. Lee and Shing I. Kong and Mark D. Hill and George S. Taylor and David A. Hodges and Randy H. Katz and David A. Patterson}, - title = {A {VLSI} Chip Set for a Multiprocessor Workstation--{Part I}: An {RISC} Microprocessor with Coprocessor Interface and Support for Symbolic Processing}, - journal = {IEEE JSSC}, - year = {1989}, - volume = {24}, - number = {6}, - pages = {1688-1698}, - month = {December} -} diff --git a/src/rimt-spec.adoc b/src/rimt-spec.adoc index 6e235aa..d7899e9 100644 --- a/src/rimt-spec.adoc +++ b/src/rimt-spec.adoc @@ -3,7 +3,7 @@ :docgroup: Platform Runtime Services Task Group :description: RISC-V IO Mapping Table (RIMT) :company: RISC-V.org -:revdate: 8/2024 +:revdate: 9/2024 :revnumber: 1.0 :revremark: This document is under development. Expect potential changes. Visit http://riscv.org/spec-state for further details. :revinfo: @@ -21,9 +21,9 @@ //:WaveDromEditorApp: app/wavedrom-editor.app :imagesoutdir: images //:srcdir: src -:bibtex-file: src/example.bib +:bibtex-file: src/rimt.bib :bibtex-order: alphabetical -:bibtex-style: apa +:bibtex-style: ieee :icons: font :lang: en :listing-caption: Listing @@ -73,6 +73,9 @@ Copyright 2024 by RISC-V International. include::contributors.adoc[] [preface] +include::changelog.adoc[] + + == Introduction The RISC-V IO Mapping Table (RIMT) provides information about the RISC-V IOMMU and the relationship @@ -80,7 +83,7 @@ between the IO topology and the IOMMU in ACPI based RISC-V platforms. The RIMT i components are behind IOMMU and how they are connected together. RISC-V IOMMU can be implemented as either a PCI device or a platform device. -=== Terms and Abbreviations +== Terms and Abbreviations This specification uses the following terms and abbreviations: @@ -89,9 +92,7 @@ This specification uses the following terms and abbreviations: | Term | Meaning | ACPI | Advanced Configuration and Power Interface Specification -| ASL | ACPI Source Language -| AML | ACPI Machine Language -| OSPM | Operating System-directed configuration and Power Management +| IOMMU | Input-Output Memory Management Unit | RCiEP | Root Complex Integrated End Point |=== @@ -371,43 +372,31 @@ device only. <>. |=== -== References - -* link:https://github.com/riscv-non-isa/riscv-iommu/releases/download/v1.0.0/riscv-iommu.pdf[RISC-V IOMMU Specification], v1.0.0 -* link:https://uefi.org/specs/ACPI/6.5/[ACPI Specification], Version: v6.5 - [[Mapping-Examples]] == ID Mapping Examples -=== IOMMU as a PCI device - -.PCIe device ID mapping -[[pci_rc_id_mapping_1]] -[cols="2,2,2,2,1", width=95%, options="header"] -|=== -| *Source ID Base* | *Number of IDs* | *Destination Device ID Base* | *Destination IOMMU Offset* | *Flags* -| 0x0100 | 0xFEFF | 0x0100 | IOMMU0 | 0x3 -|=== - -=== IOMMU as a memory mapped device - -.PCIe device ID mapping +.PCIe device ID mapping example [[pci_rc_id_mapping_2]] -[cols="2,2,2,2,1", width=95%, options="header"] +[cols="2,2,2,4,1", width=95%, options="header"] |=== | *Source ID Base* | *Number of IDs* | *Destination Device ID Base* | *Destination IOMMU Offset* | *Flags* -| 0x0000 | 0x10 | 0x0 | IOMMU1 | 0 -| 0x0100 | 0x10 | 0x10 | IOMMU1 | 0 +| 0x0000 | 0x10 | 0x0 | IOMMU0_OFFSET_IN_RIMT | 0 +| 0x0100 | 0x10 | 0x10 | IOMMU0_OFFSET_IN_RIMT | 0 |=== -.Platform device ID mapping +.Platform device ID mapping example [[platform_id_mapping]] -[cols="2,2,2,2,1", width=95%, options="header"] +[cols="2,2,2,4,1", width=95%, options="header"] |=== | *Source ID Base* | *Number of IDs* | *Destination Device ID Base* | *Destination IOMMU Offset* | *Flags* -| 0x0000 | 0x1 | 0x20 | IOMMU1 | 0 +| 0x0000 | 0x1 | 0x20 | IOMMU0_OFFSET_IN_RIMT | 0 |=== +== References + +* link:https://github.com/riscv-non-isa/riscv-iommu/releases/download/v1.0.0/riscv-iommu.pdf[RISC-V IOMMU Specification], v1.0.0 +* link:https://uefi.org/specs/ACPI/6.5/[ACPI Specification], Version: v6.5 + // The index must precede the bibliography -include::index.adoc[] -include::bibliography.adoc[] +//include::index.adoc[] +//include::bibliography.adoc[] diff --git a/src/rimt.bib b/src/rimt.bib new file mode 100644 index 0000000..e2d0a5f --- /dev/null +++ b/src/rimt.bib @@ -0,0 +1,8 @@ +@electronic{IOMMU-SPEC, + title = {RISC-V IOMMU Specification 1.0.0}, + url = {https://github.com/riscv-non-isa/riscv-iommu/releases/download/v1.0.0/riscv-iommu.pdf} +} +@electronic{ACPI-SPEC, + title = {Advanced Configuration and Power Interface Specification 6.6}, + url = {https://uefi.org/specifications} +} From f9766c0c34fbfa2f6ad5703027da1be9eedd7ae2 Mon Sep 17 00:00:00 2001 From: Sunil V L Date: Thu, 5 Sep 2024 09:34:44 +0530 Subject: [PATCH 4/4] Update the version to 1.0.0-rc1 for internal review Signed-off-by: Sunil V L --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 688c2fd..abbb6d6 100644 --- a/Makefile +++ b/Makefile @@ -16,7 +16,7 @@ DOCS := \ rimt-spec.adoc DATE ?= $(shell date +%Y-%m-%d) -VERSION ?= v0.0.1 +VERSION ?= 1.0.0-rc1 REVMARK ?= Draft DOCKER_IMG := riscvintl/riscv-docs-base-container-image:latest ifneq ($(SKIP_DOCKER),true) @@ -48,7 +48,7 @@ OPTIONS := --trace \ --failure-level=ERROR REQUIRES := --require=asciidoctor-bibtex \ --require=asciidoctor-diagram \ - --require=asciidoctor-lists \ + --require=asciidoctor-lists \ --require=asciidoctor-mathematical .PHONY: all build clean build-container build-no-container build-docs