From 0be748a3b5aa47cee104fec1180e0126b04e167f Mon Sep 17 00:00:00 2001 From: Darius Rad Date: Mon, 23 Dec 2024 12:38:28 -0500 Subject: [PATCH] Setup basic document sections and structure Add specification sections to match expected work items. Organize document corresponding to ultimate future disposition of each section. --- Makefile | 2 +- src/{example.bib => biblio.bib} | 0 src/chapter2.adoc | 47 ------------------- ...adoc => composable-custom-extensions.adoc} | 23 ++++++--- src/contributors.adoc | 3 +- src/criteria.adoc | 6 +++ src/external.adoc | 41 ++++++++++++++++ src/guidance.adoc | 10 ++++ src/isa-priv.adoc | 2 + src/isa-state.adoc | 2 + src/isa-unpriv.adoc | 2 + src/isa.adoc | 5 ++ src/li.adoc | 2 + src/non-isa.adoc | 5 ++ 14 files changed, 93 insertions(+), 57 deletions(-) rename src/{example.bib => biblio.bib} (100%) delete mode 100644 src/chapter2.adoc rename src/{spec-sample.adoc => composable-custom-extensions.adoc} (77%) create mode 100644 src/criteria.adoc create mode 100644 src/external.adoc create mode 100644 src/guidance.adoc create mode 100644 src/isa-priv.adoc create mode 100644 src/isa-state.adoc create mode 100644 src/isa-unpriv.adoc create mode 100644 src/isa.adoc create mode 100644 src/li.adoc create mode 100644 src/non-isa.adoc diff --git a/Makefile b/Makefile index c09d1b5..519e617 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ # the Doc Template for RISC-V Extensions. DOCS := \ - spec-sample.adoc + composable-custom-extensions.adoc DATE ?= $(shell date +%Y-%m-%d) VERSION ?= v0.0.0 diff --git a/src/example.bib b/src/biblio.bib similarity index 100% rename from src/example.bib rename to src/biblio.bib diff --git a/src/chapter2.adoc b/src/chapter2.adoc deleted file mode 100644 index 8c11820..0000000 --- a/src/chapter2.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[[chapter2]] -== The Second Chapter - -. The first item. - -. The second item. -+ -.. The first sub item. - -.. The second sub item. -+ -[CAUTION] -==== -A moment of caution is required for this block of text must be read and apreciated for its importance. -==== - -. Yet another item. - -. Again, an item. - -.. A multi-line item. -+ -This item has multiple lines. -+ -By multiple lines, this is what we mean. -+ -Seriously, multiple. - -=== An example table - -[cols="^1,^1,^1,^1,^3,^3",stripes=even,options="header"] -|=== -4+|Letters _and_ bits {set:cellbgcolor:green} 2+|A much longer area -|L|R|W|X|Quarter 1|Quarter 2 -|{set:cellbgcolor:!} 0|0|0|0 2+|Rows alternate colors -|0|0|0|1|Thing 1|Thing 2 -|1|0|0|0|Thing 3|Thing 4 -|1|1|1|1 2+|Span Thing 1 and 2 -|=== - -=== Sub section - -Diam donec adipiscing tristique risus indexterm:[risus]. Nisl rhoncus mattis rhoncus urna. Egestas egestas fringilla phasellus faucibus scelerisque eleifend donec pretium vulputate. Porta non pulvinar neque laoreet suspendisse interdum consectetur libero id. Massa vitae tortor condimentum lacinia quis vel. Donec ac odio tempor orci. Mi sit amet mauris commodo quis imperdiet massa tincidunt. Quis enim lobortis scelerisque fermentum dui. Lacus viverra vitae congue eu. Sed faucibus turpis in eu mi bibendum neque. Sit amet porttitor eget dolor. Aliquet eget sit amet tellus cras adipiscing enim. Id cursus metus aliquam eleifend mi. Vestibulum lorem sed risus ultricies tristique nulla aliquet. - -=== Yet another subsection - -Quam lacus suspendisse faucibus interdum posuere lorem ipsum. Nulla aliquet enim tortor at auctor urna nunc id cursus. Massa massa ultricies mi quis hendrerit dolor magna. Integer enim neque volutpat ac tincidunt. Dolor magna eget est lorem ipsum dolor. Urna neque viverra justo nec. Neque gravida in fermentum et. Fringilla ut morbi tincidunt augue interdum velit euismod. Dolor sit amet consectetur adipiscing elit. Eu facilisis sed odio morbi. In cursus turpis massa tincidunt dui. Orci indexterm:[orci] phasellus egestas tellus rutrum tellus. Semper eget duis at tellus at urna condimentum. Orci porta non pulvinar neque laoreet suspendisse interdum consectetur. diff --git a/src/spec-sample.adoc b/src/composable-custom-extensions.adoc similarity index 77% rename from src/spec-sample.adoc rename to src/composable-custom-extensions.adoc index d802da6..7dec105 100644 --- a/src/spec-sample.adoc +++ b/src/composable-custom-extensions.adoc @@ -1,10 +1,10 @@ -= RISC-V Example Specification Document (Zexmpl) -Authors: Author 1, Author 2 += RISC-V Composable Custom Extensions (Ztodo) +Authors: RISC-V Composable Custom Extensions Task Group :docgroup: RISC-V Task Group -:description: RISC-V Example Specification Document (Zexmpl) +:description: RISC-V Composable Custom Extensions Specification Document (Ztodo) :company: RISC-V.org -:revdate: 1/2023 -:revnumber: 1.0 +:revdate: 2024-12-23 +:revnumber: 0.0 :revremark: This document is under development. Expect potential changes. Visit http://riscv.org/spec-state for further details. :revinfo: :url-riscv: http://riscv.org @@ -21,7 +21,7 @@ Authors: Author 1, Author 2 //:WaveDromEditorApp: app/wavedrom-editor.app :imagesoutdir: ../build/images :srcdir: src -:bibtex-file: {srcdir}/example.bib +:bibtex-file: {srcdir}/biblio.bib :bibtex-order: alphabetical :bibtex-style: apa :icons: font @@ -61,7 +61,16 @@ Copyright 2024 by RISC-V International. include::contributors.adoc[] include::intro.adoc[] -include::chapter2.adoc[] +include::isa.adoc[] +include::isa-priv.adoc[] +include::isa-unpriv.adoc[] +include::isa-state.adoc[] +include::non-isa.adoc[] +include::criteria.adoc[] +include::li.adoc[] + +include::external.adoc[] +include::guidance.adoc[] // The index must precede the bibliography include::index.adoc[] diff --git a/src/contributors.adoc b/src/contributors.adoc index 13fd776..36bff70 100644 --- a/src/contributors.adoc +++ b/src/contributors.adoc @@ -3,5 +3,4 @@ This RISC-V specification has been contributed to directly or indirectly by: [%hardbreaks] -* Author1 -* Author2 +* Darius Rad diff --git a/src/criteria.adoc b/src/criteria.adoc new file mode 100644 index 0000000..d34de84 --- /dev/null +++ b/src/criteria.adoc @@ -0,0 +1,6 @@ +[[criteria]] +== Composability criteria + +=== Basic Criteria + +=== Composable Memory Access Behavior diff --git a/src/external.adoc b/src/external.adoc new file mode 100644 index 0000000..b603790 --- /dev/null +++ b/src/external.adoc @@ -0,0 +1,41 @@ +[[external]] +[appendix] += External Specifications + +This section contains changes to external specifications for RISC-V +Composable Custom Extensions. It is intended that as these sections +are incorporated into the upstream specification or similar, they will +be removed from this document. External specifications include both +RISC-V and non-RISC-V specifications and other information +specification mechanisms. + +=== Devicetree + +=== ACPI + +[NOTE] +==== +This section will be incorporated into the ACPI Specification. +==== + +=== User Space ABI + +[NOTE] +==== +This section will be incorporated into the RISC-V psABI Specification. +==== + +==== Composable Custom Extension Aware Calling Convention + +==== Legacy Interoperability Calling Convention + +=== User Space API + +=== SBI + +[NOTE] +==== +This section will be incorporated into the RISC-V SBI Specification. +==== + +=== Linux diff --git a/src/guidance.adoc b/src/guidance.adoc new file mode 100644 index 0000000..8aefcd9 --- /dev/null +++ b/src/guidance.adoc @@ -0,0 +1,10 @@ +[[guidance]] +[appendix] += Guidance + +This section provides guidance for developing Composable Custom +Extensions. This entire section is non-normative. + +=== Software Recommendations + +=== Hardware Recommendations diff --git a/src/isa-priv.adoc b/src/isa-priv.adoc new file mode 100644 index 0000000..1840e82 --- /dev/null +++ b/src/isa-priv.adoc @@ -0,0 +1,2 @@ +[[isa-priv]] +== Privileged Opcode and State Multiplexing diff --git a/src/isa-state.adoc b/src/isa-state.adoc new file mode 100644 index 0000000..eee4842 --- /dev/null +++ b/src/isa-state.adoc @@ -0,0 +1,2 @@ +[[isa-state]] +== Privileged State Management diff --git a/src/isa-unpriv.adoc b/src/isa-unpriv.adoc new file mode 100644 index 0000000..c21a350 --- /dev/null +++ b/src/isa-unpriv.adoc @@ -0,0 +1,2 @@ +[[isa-unpriv]] +== Unprivileged Opcode and State Multiplexing diff --git a/src/isa.adoc b/src/isa.adoc new file mode 100644 index 0000000..826fad0 --- /dev/null +++ b/src/isa.adoc @@ -0,0 +1,5 @@ +[[isa]] += ISA Specification + +This section contains the ISA specification for RISC-V Composable +Custom Extensions. diff --git a/src/li.adoc b/src/li.adoc new file mode 100644 index 0000000..4f284ae --- /dev/null +++ b/src/li.adoc @@ -0,0 +1,2 @@ +[[li]] +== Logic Interface diff --git a/src/non-isa.adoc b/src/non-isa.adoc new file mode 100644 index 0000000..ddecd20 --- /dev/null +++ b/src/non-isa.adoc @@ -0,0 +1,5 @@ +[[non-isa]] += Non-ISA Specification + +This section contains the non-ISA specification for RISC-V Composable +Custom Extensions.