Merge pull request #8 from vlsunil/fix_bib

Updates after internal review
riscv-non-isa · Oct 2, 2024 · cfd1478 · cfd1478
2 parents 58ca785 + e45e398
commit cfd1478
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 17 deletions.
diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@
 # the Doc Template for RISC-V Extensions.
 
 DATE ?= $(shell date +%Y-%m-%d)
-VERSION ?= v1.0.0-rc1
+VERSION ?= v1.0.0-rc2
 REVMARK ?= Draft
 DOCKER_RUN := docker run --rm -v ${PWD}:/build -w /build \
 riscvintl/riscv-docs-base-container-image:latest

diff --git a/src/bibliography.adoc b/src/bibliography.adoc
@@ -1,8 +1,4 @@
 [bibliography]
-== References
+== Bibliography
 
-* 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
-
-// REVISIT
-//bibliography::[]
+bibliography::[]
diff --git a/src/changelog.adoc b/src/changelog.adoc
@@ -1,5 +1,11 @@
 == Changelog
 
+- *Version 1.0.0-rc2*
+  * Draft for ARC review.
+  * Addressed internal review feedback.
+  * Used IEEE style bibliography.
+  * Allowed HW ID to be valid for PCI IOMMU as well.
+
 - *Version 1.0.0-rc1*
   * Draft for internal review.
   * Added ID mapping examples.

diff --git a/src/contributors.adoc b/src/contributors.adoc
@@ -4,6 +4,7 @@ This RISC-V specification has been contributed to directly or indirectly by:
 
 [%hardbreaks]
 * Aaron Durbin <adurbin@rivosinc.com>
+* Andrew Jones <ajones@ventanamicro.com>
 * Anup Patel <apatel@ventanamicro.com>
 * Atish Kumar Patra <atishp@rivosinc.com>
 * Bin Meng <bmeng@tinylab.org>

diff --git a/src/intro.adoc b/src/intro.adoc
@@ -1,6 +1,7 @@
 == Introduction
 
-The RISC-V IO Mapping Table (RIMT)  provides information about the RISC-V IOMMU and the relationship
-between the IO topology and the IOMMU in ACPI based RISC-V platforms. The RIMT identifies which
-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.
+The RISC-V IO Mapping Table (RIMT)  provides information about the RISC-V IOMMU
+cite:[IOMMU-SPEC] and the relationship between the IO topology and the IOMMU in
+ACPI cite:[ACPI-SPEC] based RISC-V platforms. The RIMT identifies which
+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.
diff --git a/src/rimt-main.adoc b/src/rimt-main.adoc
@@ -81,8 +81,9 @@ the structure in RIMT used to report the configuration and capabilities of each
                                                                by the IOMMU.
 | Reserved                   | 2             | 4             | Must be zero.
 | ID                         | 2             | 6             | Unique ID of this IOMMU.
-| Hardware ID                | 8             | 8             | ACPI ID. This field is valid only for
-                                                               an IOMMU that is a platform device.
+| Hardware ID                | 8             | 8             | ACPI ID of the platform IOMMU device
+                                                               or PCI ID (Vendor ID + Device ID) for
+                                                               the PCI IOMMU device.
 | Base Address               | 8             | 16            | Base address of the IOMMU registers.
                                                                This field is valid only for an IOMMU
                                                                that is a platform device. If IOMMU

diff --git 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: 9/2024
+:revdate: 10/2024
 :revnumber: 1.0
 :revremark: This document is under development. Expect potential changes. Visit http://riscv.org/spec-state for further details.
 :revinfo:
@@ -23,7 +23,7 @@
 //:srcdir: src
 :bibtex-file: src/rimt.bib
 :bibtex-order: alphabetical
-:bibtex-style: apa
+:bibtex-style: ieee
 :icons: font
 :lang: en
 :listing-caption: Listing

diff --git a/src/rimt.bib b/src/rimt.bib
@@ -3,6 +3,6 @@ @electronic{IOMMU-SPEC
   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}
+  title = {Advanced Configuration and Power Interface Specification 6.5},
+  url = {https://uefi.org/specs/ACPI/6.5}
 }