Skip to content

Commit

Permalink
Setup basic document sections and structure
Browse files Browse the repository at this point in the history
Add specification sections to match expected work items.  Organize document
corresponding to ultimate future disposition of each section.
  • Loading branch information
darius-bluespec committed Dec 23, 2024
1 parent 773c67b commit 0be748a
Show file tree
Hide file tree
Showing 14 changed files with 93 additions and 57 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
47 changes: 0 additions & 47 deletions src/chapter2.adoc

This file was deleted.

23 changes: 16 additions & 7 deletions src/spec-sample.adoc → src/composable-custom-extensions.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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[]
Expand Down
3 changes: 1 addition & 2 deletions src/contributors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
This RISC-V specification has been contributed to directly or indirectly by:

[%hardbreaks]
* Author1 <required1@email.com>
* Author2 <required2@email.com>
* Darius Rad <darius@bluespec.com>
6 changes: 6 additions & 0 deletions src/criteria.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[[criteria]]
== Composability criteria

=== Basic Criteria

=== Composable Memory Access Behavior
41 changes: 41 additions & 0 deletions src/external.adoc
Original file line number Diff line number Diff line change
@@ -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
10 changes: 10 additions & 0 deletions src/guidance.adoc
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions src/isa-priv.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[[isa-priv]]
== Privileged Opcode and State Multiplexing
2 changes: 2 additions & 0 deletions src/isa-state.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[[isa-state]]
== Privileged State Management
2 changes: 2 additions & 0 deletions src/isa-unpriv.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[[isa-unpriv]]
== Unprivileged Opcode and State Multiplexing
5 changes: 5 additions & 0 deletions src/isa.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[[isa]]
= ISA Specification

This section contains the ISA specification for RISC-V Composable
Custom Extensions.
2 changes: 2 additions & 0 deletions src/li.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[[li]]
== Logic Interface
5 changes: 5 additions & 0 deletions src/non-isa.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[[non-isa]]
= Non-ISA Specification

This section contains the non-ISA specification for RISC-V Composable
Custom Extensions.

0 comments on commit 0be748a

Please sign in to comment.