From d96a9b2d004d2867052cadac26af895cdf15b969 Mon Sep 17 00:00:00 2001 From: Govardhan Date: Sun, 6 Apr 2025 13:09:54 +0530 Subject: [PATCH 1/8] Add WIP Vector Permutation Design Doc Template --- CONTRIBUTORS.md | 18 ++-- docs/vector_permutation.adoc | 154 +++++++++++++++++++++++++++++++++++ 2 files changed, 163 insertions(+), 9 deletions(-) create mode 100644 docs/vector_permutation.adoc diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 9f84396f..b40e460b 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -2,17 +2,17 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this The following people from multiple organizations have contributed to this project: -* (Ventana Micro Systems)[https://www.ventanamicro.com] - * (Arup Chakraborty)[https://github.com/arupc] +* [Ventana Micro Systems]([https://www.ventanamicro.com) + * [Arup Chakraborty](https://github.com/arupc) -* (MIPS)[https://mips.com] - * (Knute Lingaard)[https://github.com/klingaard] - * (Kathlene Magnus)[https://github.com/kathlenemagnus] +* [MIPS](https://mips.com) + * [Knute Lingaard](https://github.com/klingaard) + * [Kathlene Magnus](https://github.com/kathlenemagnus) -* (Condor Computing)[https://condorcomputing.com] - * (Jeff Nye)[https://github.com/jeffnye-gh] +* [Condor Computing](https://condorcomputing.com) + * [Jeff Nye](https://github.com/jeffnye-gh) -* (InCore Semiconductors)[https://incoresemi.com/] - * (Sai Govardhan)[https://github.com/govardhnn] +* [InCore Semiconductors](https://incoresemi.com/) + * [Sai Govardhan](https://github.com/govardhnn) List is incomplete and more contributor names/organizations to be added. diff --git a/docs/vector_permutation.adoc b/docs/vector_permutation.adoc new file mode 100644 index 00000000..69225994 --- /dev/null +++ b/docs/vector_permutation.adoc @@ -0,0 +1,154 @@ +:doctitle: Olympia Vector Permutation Design Document + +:toc: + +[[Document_Information]] +== Document Information + +TODO + +[[Revision_History]] +=== Revision History + +[width="100%",cols="11%,11%,16%,62%",options="header",] +|=== +|*Revision* |*Date* |*Author* |*Summary of Changes* +|0.1 | 2025.04.TODO | Sai Govardhan | Initial Vector Permutations Desig Document +|=== + +[[Conventions_and_Terminology]] +=== Conventions and Terminology + + +[width="100%",cols="17%,83%",options="header",] +|=== +|Label |Description +| VLSU | Vector Load Store Unit +| | +|=== + +[[Related_Documents]] +=== Related Documents + +// + +[width="100%",cols="25%,75%",options="header",] +|=== +|*Title* |*Description* +| The RISC-V Vector ISA (v1.0) | TODO +| Saturn Vectors | TODO +| The vector thesis | TODO +|=== + + +[[Notes_Open_Issues]] +=== Notes/Open Issues + +// + +* Note1 +* Note 2 + +[[OVERVIEW]] +== OVERVIEW + +// + + +[[Overview_Block_Diagram]] +=== Overview Block Diagram + +// + +[[Functional_Description]] +== Functional Description + +// + +[[Unit_Block_Diagram]] +=== Unit Block Diagram + +// +// image:media/image1.png[image,width=576,height=366] +// Figure 1 - Sample Figure + + +[[Block_Diagram_Description]] +=== Block Diagram Description + +// + +// [[Description_of_Block_B1]] +// == Description of Block + +// + +[[Operation]] +=== Operation + +// + +[[Interfaces]] +=== Interfaces + +// + +[width="100%",cols="18%,21%,61%",options="header",] +|=== +|*Name* |*C++ Type* |*Purpose/Description* +| | | +| | | +| | | +|=== + +[[CPP_Class_Description]] +=== C++ Class Description + +//