[PATCH v4 2/6] Update terminology and specification tables
|
This patch updates terminology and specification table in
following ways: 1) Provide complete expansion of terms for APLIC and ACLINT 2) Add links to unprivileged and privileged specifications 3) Add link to legacy PLIC specification 4) Add links to AIA and ACLINT specifications 5) Remove platform policy from specification table 6) Adjust width of columns in both tables 7) Use "RISC-V" prefix for specifications owned by RISC-V international Reviewed-by: Abner Chang <abner.chang@...> Signed-off-by: Anup Patel <anup.patel@...> --- riscv-platform-spec.adoc | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/riscv-platform-spec.adoc b/riscv-platform-spec.adoc index 0b30724..59b53fa 100644 --- a/riscv-platform-spec.adoc +++ b/riscv-platform-spec.adoc @@ -50,7 +50,7 @@ The M platform has the following extensions: == OS-A Platform === Terminology -[cols="1,2", width=80%, align="left", options="header"] +[cols="1,4", width=80%, align="left", options="header"] |=== |TERM | DESCRIPTION |SBI | Supervisor Binary Interface @@ -67,9 +67,9 @@ The M platform has the following extensions: |RV64GC | RISC-V 64-bit general purpose ISA described as RV64IMAFDC. |RAS | Reliability, Availability, and Serviceability |CLINT | Legacy Core-Local Interrupt Controller -|ACLINT | Advanced CLINT +|ACLINT | Advanced Core-Local Interrupt Controller |PLIC | Legacy Platform-Level Interrupt Controller -|APLIC | Advanced PLIC +|APLIC | Advanced Platform-Level Interrupt Controller |AIA | Advanced Interrupt Architecture |IMSIC | Incomning MSI Controller |L1D | L1 Data cache @@ -92,18 +92,22 @@ The M platform has the following extensions: |=== === Specifications -[cols="1,2", width=80%, align="left", options="header"] +[cols="3,1", width=80%, align="left", options="header"] |=== |SPECIFICATION | VERSION |link:https://uefi.org/sites/default/files/resources/UEFI_Spec_2_9_2021_03_18.pdf[UEFI Specification] | v2.9 |link:https://github.com/devicetree-org/devicetree-specification/releases/tag/v0.3[Devicetree Specification] | v0.3 -|link:https://github.com/riscv/riscv-sbi-doc/blob/master/riscv-sbi.adoc[SBI Specification] | v0.3 -|link:[RVA22 Specification] | TBD +|link:https://github.com/riscv/riscv-isa-manual/releases/download/draft-20210726-2026469/riscv-spec.pdf[RISC-V Unprivileged Architecture Specification] | 20191214-draft +|link:https://github.com/riscv/riscv-isa-manual/releases/download/draft-20210726-2026469/riscv-privileged.pdf[RISC-V Privileged Architecture Specification] | v1.12-draft +|link:https://github.com/riscv/riscv-sbi-doc/blob/master/riscv-sbi.adoc[RISC-V SBI Specification] | v0.3 +|link:https://github.com/riscv/riscv-plic-spec/blob/master/riscv-plic.adoc[RISC-V PLIC Specification] | v1.0 +|link:https://github.com/riscv/riscv-aclint/releases/download/v1.0-draft2/riscv-aclint-1.0-draft2.pdf[RISC-V ACLINT Specification] | v1.0-draft2 +|link:https://github.com/riscv/riscv-aia/releases/download/0.2-draft.24/riscv-interrupts-024.pdf[RISC-V AIA Specification] | v0.2-draft.24 +|link:https://github.com/riscv/riscv-profiles/blob/master/profiles.adoc[RISC-V Profiles Specification]| Draft |link:https://arm-software.github.io/ebbr/[EBBR Specification] | v2.0.0 |link:https://uefi.org/sites/default/files/resources/ACPI_Spec_6_4_Jan22.pdf[ACPI Specification] | v6.4 |link:https://uefi.org/specs/ACPI/6.4/18_ACPI_Platform_Error_Interfaces/ACPI_PLatform_Error_Interfaces.html[APEI Specification] | v6.4 |link:https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_3.4.0.pdf[SMBIOS Specification] | v3.4.0 -|link:[Platform Policy] | TBD |=== // Base feature set for OS-A Platform -- 2.25.1 |
|
|
|
Greg Favor
On Fri, Aug 6, 2021 at 11:13 PM Anup Patel <anup.patel@...> wrote: This patch updates terminology and specification table in When I try some of the added links, I end up at "404" pages. Many of these links are to revs of spec's that are current but only temporary - until superseded by a later rev. Ultimately these links should all be to ratified/approved documents - which by definition won't materially change. But in the meantime the current links are quickly going to become stale over the next couple of months. And a couple have already been superseded by more recent revs. These links should instead be to the github pages from which one can then find the PDF and/or adoc of the latest draft of the document. Greg 2) Add links to unprivileged and privileged specifications |SPECIFICATION | VERSION |
|
|
|
Hi Greg,
All these links are in one place so can be easily updated once specs are ratified/approved.
We certainly can’t finalize RISC-V platform spec having links to draft specifications.
Regards, Anup
From: Greg Favor <gfavor@...>
On Fri, Aug 6, 2021 at 11:13 PM Anup Patel <anup.patel@...> wrote:
When I try some of the added links, I end up at "404" pages.
Many of these links are to revs of spec's that are current but only temporary - until superseded by a later rev.
Ultimately these links should all be to ratified/approved documents - which by definition won't materially change. But in the meantime the current links are quickly going to become stale over the next couple of months. And a couple have already been superseded by more recent revs. These links should instead be to the github pages from which one can then find the PDF and/or adoc of the latest draft of the document.
Greg
|
|
|
|
Greg Favor
On Fri, Aug 6, 2021 at 11:36 PM Anup Patel <Anup.Patel@...> wrote:
If possible, it would seem to be better for the coming several months to have links go to the github pages from which one can then find the PDF and/or adoc of the latest draft of the document. Then links won't go stale.
Although when the Platform Specs go to public review they will need to be up-to-date links (if they aren't simply to the github page with the latest draft spec). And since lots of parallel public reviews will be happening this fall, any spec cross-references are going to be to unratified draft specs (albeit frozen). Greg |
|
|
|
Peter Glaskowsky
Greg and Anup,
toggle quoted message
Show quoted text
I think the links are mostly just malformed. For example, the first one was presumably meant to go to and that URL does work for me, but the lack of a space at the end of the URL means that just clicking on it sends me to which does produce a 404. Best, . png
|
|
|
|
Hi Peter,
I think the links are malformed if we directly click from this email because these links are in asciidoc syntax.
The link syntax for asciidoc is: link:<url>[<display_text>]
Based on above syntax <display_text> will be part of generated HTML or PDF which will hyperlinked to the <url>
Regards, Anup
From: Peter Glaskowsky <peter.glaskowsky@...>
Greg and Anup,
I think the links are mostly just malformed.
For example, the first one was presumably meant to go to
and that URL does work for me, but the lack of a space at the end of the URL means that just clicking on it sends me to
which does produce a 404.
Best,
. png
|
|
|
|
atishp@...
On Sat, 2021-08-07 at 11:42 +0530, Anup Patel wrote:
This patch updates terminology and specification table inCurrently, there is no released version of the PLIC spec. We should add that to a TODO list before the platform spec goes out for a public review. +|link:It should be "v2.0.1" Not sure if we should refer to the github repo or the released section. In case you want to change the latter, here is the link. https://github.com/ARM-software/ebbr/releases/tag/v2.0.1 |link: Other than that, LGTM. Reviewed-by: Atish Patra <atish.patra@...> -- Regards, Atish |
|
|
|
Greg Favor
On Mon, Aug 9, 2021 at 11:51 AM Atish Patra <atish.patra@...> wrote: > https://github.com/riscv/riscv-plic-spec/blob/master/riscv-plic.adoc[RISC-V Yes, both the ACLINT and PLIC specs need to go through the process ASAP of becoming approved standards. Obviously that can overlap with the process for the platform specs, but we should get both ACLINT and PLIC started ahead of the platform specs. I know Anup and Philipp are already pursuing this as we speak for ACLINT, but the same also needs to be done for PLIC. Greg |
|
|