# Resources and Specifications
This page aims to collect all the resources and specifications we need
in one place for quick access. We will try our best to keep links here
up-to-date. Feel free to add more links here.
[[!toc ]]
# Getting Started
This section is primarily a series of useful links found online
* [FSiC2019](https://wiki.f-si.org/index.php/FSiC2019)
* Fundamentals to learn to get started [[3d_gpu/tutorial]]
## Is Open Source Hardware Profitable?
[RaptorCS on FOSS Hardware Interview](https://www.youtube.com/watch?v=o5Ihqg72T3c&feature=youtu.be)
# OpenPOWER ISA
* [3.0 PDF](https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0)
* [2.07 PDF](https://openpowerfoundation.org/?resource_lib=ibm-power-isa-version-2-07-b)
## Overview of the user ISA:
* [Raymond Chen's PowerPC series](https://devblogs.microsoft.com/oldnewthing/20180806-00/?p=99425)
* Power ISA listings
## OpenPOWER OpenFSI Spec (2016)
* [OpenPOWER OpenFSI Spec](http://openpowerfoundation.org/wp-content/uploads/resources/OpenFSI-spec-100/OpenFSI-spec-20161212.pdf)
* [OpenPOWER OpenFSI Compliance Spec](http://openpowerfoundation.org/wp-content/uploads/resources/openpower-fsi-thts-1.0/openpower-fsi-thts-20180130.pdf)
# Energy-efficient cores
* https://arxiv.org/abs/2002.10143
# Communities
*
*
*
* Open tape-out mailing list
# Other GPU Specifications
*
* https://developer.amd.com/wp-content/resources/RDNA_Shader_ISA.pdf
* https://developer.amd.com/wp-content/resources/Vega_Shader_ISA_28July2017.pdf
* MALI Midgard
* [Nyuzi](https://github.com/jbush001/NyuziProcessor)
* VideoCore IV
* etnaviv
# JTAG
* [Useful JTAG implementation reference: Design Of IEEE 1149.1 TAP Controller IP Core by Shelja, Nandakumar and Muruganantham, DOI:10.5121/csit.2016.60910](https://web.archive.org/web/20201021174944/https://airccj.org/CSCP/vol6/csit65610.pdf)
Abstract
"The objective of this work is to design and implement a TAP controller IP core compatible with IEEE 1149.1-2013 revision of the standard. The test logic architecture also includes the Test Mode Persistence controller and its associated logic. This work is expected to serve as a ready to use module that can be directly inserted in to a new digital IC designs with little modifications."
# Radix MMU
- [Qemu emulation](https://github.com/qemu/qemu/commit/d5fee0bbe68d5e61e2d2beb5ff6de0b9c1cfd182)
# D-Cache
- [A Primer on Memory Consistency and Cache Coherence
](https://www.morganclaypool.com/doi/10.2200/S00962ED2V01Y201910CAC049)
## D-Cache Possible Optimizations papers and links
- [ACDC: Small, Predictable and High-Performance Data Cache](https://dl.acm.org/doi/10.1145/2677093)
- [Stop Crying Over Your Cache Miss Rate: Handling Efficiently Thousands of
Outstanding Misses in FPGAs](https://dl.acm.org/doi/abs/10.1145/3289602.3293901)
# BW Enhancing Shared L1 Cache Design research done in cooperation with AMD
- [Youtube video PACT 2020 - Analyzing and Leveraging Shared L1 Caches in GPUs](https://m.youtube.com/watch?v=CGIhOnt7F6s)
- [Url to PDF of paper on author's website (clicking will download the pdf)](https://adwaitjog.github.io/docs/pdf/sharedl1-pact20.pdf)
# RTL Arithmetic SQRT, FPU etc.
## Wallace vs Dadda Multipliers
* [Paper comparing efficiency of Wallace and Dadda Multipliers in RTL implementations (clicking will download the pdf from archive.org)](https://web.archive.org/web/20180717013227/http://ieeemilestones.ethw.org/images/d/db/A_comparison_of_Dadda_and_Wallace_multiplier_delays.pdf)
## Sqrt
* [Fast Floating Point Square Root](https://pdfs.semanticscholar.org/5060/4e9aff0e37089c4ab9a376c3f35761ffe28b.pdf)
* [Reciprocal Square Root Algorithm](http://www.acsel-lab.com/arithmetic/arith15/papers/ARITH15_Takagi.pdf)
* [Fast Calculation of Cube and Inverse Cube Roots Using a Magic Constant and Its Implementation on Microcontrollers (clicking will download the pdf)](https://res.mdpi.com/d_attachment/energies/energies-14-01058/article_deploy/energies-14-01058-v2.pdf)
* [Modified Fast Inverse Square Root and Square Root Approximation Algorithms: The Method of Switching Magic Constants (clicking will download the pdf)](https://res.mdpi.com/d_attachment/computation/computation-09-00021/article_deploy/computation-09-00021-v3.pdf)
## CORDIC and related algorithms
* research into CORDIC
*
* [BKM (log(x) and e^x)](https://en.wikipedia.org/wiki/BKM_algorithm)
* [CORDIC](http://www.andraka.com/files/crdcsrvy.pdf)
- Does not have an easy way of computing tan(x)
* [zipcpu CORDIC](https://zipcpu.com/dsp/2017/08/30/cordic.html)
* [Low latency and Low error floating point TCORDIC](https://ieeexplore.ieee.org/document/7784797) (email Michael or Cole if you don't have IEEE access)
* MyHDL version of CORDIC
*
## IEEE Standard for Floating-Point Arithmetic (IEEE 754)
Almost all modern computers follow the IEEE Floating-Point Standard. Of
course, we will follow it as well for interoperability.
* IEEE 754-2019:
Note: Even though this is such an important standard used by everyone,
it is unfortunately not freely available and requires a payment to
access. However, each of the Libre-SOC members already have access
to the document.
* [Lecture notes - Floating Point Appreciation](http://pages.cs.wisc.edu/~markhill/cs354/Fall2008/notes/flpt.apprec.html)
Among other things, has a nice explanation on arithmetic, rounding modes and the sticky bit.
* [What Every Computer Scientist Should Know About Floating-Point Arithmetic](https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html)
Nice resource on rounding errors (ulps and epsilon) and the "table maker's dilemma".
## Past FPU Mistakes to learn from
* [Intel Underestimates Error Bounds by 1.3 quintillion on
Random ASCII – tech blog of Bruce Dawson ](https://randomascii.wordpress.com/2014/10/09/intel-underestimates-error-bounds-by-1-3-quintillion/)
* [Intel overstates FPU accuracy 06/01/2013](http://notabs.org/fpuaccuracy)
* How not to design an ISA
Meester Forsyth
# Khronos Standards
The Khronos Group creates open standards for authoring and acceleration
of graphics, media, and computation. It is a requirement for our hybrid
CPU/GPU to be compliant with these standards *as well* as with IEEE754,
in order to be commercially-competitive in both areas: especially Vulkan
and OpenCL being the most important. SPIR-V is also important for the
Kazan driver.
Thus the [[zfpacc_proposal]] has been created which permits runtime dynamic
switching between different accuracy levels, in userspace applications.
[**SPIR-V Main Page Link**](https://www.khronos.org/registry/spir-v/)
* [SPIR-V 1.5 Specification Revision 1](https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html)
* [SPIR-V OpenCL Extended Instruction Set](https://www.khronos.org/registry/spir-v/specs/unified1/OpenCL.ExtendedInstructionSet.100.html)
* [SPIR-V GLSL Extended Instruction Set](https://www.khronos.org/registry/spir-v/specs/unified1/GLSL.std.450.html)
[**Vulkan Main Page Link**](https://www.khronos.org/registry/vulkan/)
* [Vulkan 1.1.122](https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/index.html)
[**OpenCL Main Page**](https://www.khronos.org/registry/OpenCL/)
* [OpenCL 2.2 API Specification](https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_API.html)
* [OpenCL 2.2 Extension Specification](https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_Ext.html)
* [OpenCL 2.2 SPIR-V Environment Specification](https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_Env.html)
* OpenCL released the proposed OpenCL 3.0 spec for comments in april 2020
* [Announcement video](https://youtu.be/h0_syTg6TtY)
* [Announcement video slides (PDF)](https://www.khronos.org/assets/uploads/apis/OpenCL-3.0-Launch-Apr20.pdf)
Note: We are implementing hardware accelerated Vulkan and
OpenCL while relying on other software projects to translate APIs to
Vulkan. E.g. Zink allows for OpenGL-to-Vulkan in software.
# Open Source (CC BY + MIT) DirectX specs (by Microsoft, but not official specs)
https://github.com/Microsoft/DirectX-Specs
# Graphics and Compute API Stack
I found this informative post that mentions Kazan and a whole bunch of
other stuff. It looks like *many* APIs can be emulated on top of Vulkan,
although performance is not evaluated.
* Pixilica is heading up an initiative to create a RISC-V graphical ISA
* [Pixilica 3D Graphical ISA Slides](https://b5792ddd-543e-4dd4-9b97-fe259caf375d.filesusr.com/ugd/841f2a_c8685ced353b4c3ea20dbb993c4d4d18.pdf)
# 3D Graphics Texture compression software and hardware
* [Proprietary Rad Game Tools Oddle Texture Software Compression](https://web.archive.org/web/20200913122043/http://www.radgametools.com/oodle.htm)
* [Blog post by one of the engineers who developed the proprietary Rad Game Tools Oddle Texture Software Compression and the Oodle Kraken decompression software and hardware decoder used in the ps5 ssd](https://archive.vn/oz0pG)
# Various POWER Communities
- [An effort to make a 100% Libre POWER Laptop](https://www.powerpc-notebook.org/en/)
The T2080 is a POWER8 chip.
- [Power Progress Community](https://www.powerprogress.org/campaigns/donations-to-all-the-power-progress-community-projects/)
Supporting/Raising awareness of various POWER related open projects on the FOSS
community
- [OpenPOWER](https://openpowerfoundation.org)
Promotes and ensure compliance with the Power ISA amongst members.
- [OpenCapi](https://opencapi.org)
High performance interconnect for POWER machines. One of the big advantages
of the POWER architecture. Notably more performant than PCIE Gen4, and is
designed to be layered on top of the physical PCIE link.
- [OpenPOWER “Virtual Coffee” Calls](https://openpowerfoundation.org/openpower-virtual-coffee-calls/)
Truly open bi-weekly teleconference lines for anybody interested in helping
advance or adopting the POWER architecture.
# Conferences
see [[conferences]]
# Coriolis2
* LIP6's Coriolis - a set of backend design tools:
Note: The rest of LIP6's website is in French, but there is a UK flag
in the corner that gives the English version.
# Logical Equivalence and extraction
* NETGEN
* CVC https://github.com/d-m-bailey/cvc
# Klayout
* KLayout - Layout viewer and editor:
# image to GDS-II
* https://nazca-design.org/convert-image-to-gds/
# The OpenROAD Project
OpenROAD seeks to develop and foster an autonomous, 24-hour, open-source
layout generation flow (RTL-to-GDS).
*
# Other RISC-V GPU attempts
*
*
*
TODO: Get in touch and discuss collaboration
# Tests, Benchmarks, Conformance, Compliance, Verification, etc.
## RISC-V Tests
RISC-V Foundation is in the process of creating an official conformance
test. It's still in development as far as I can tell.
* //TODO LINK TO RISC-V CONFORMANCE TEST
## IEEE 754 Testing/Emulation
IEEE 754 has no official tests for floating-point but there are
well-known third party tools to check such as John Hauser's TestFloat.
There is also his SoftFloat library, which is a software emulation
library for IEEE 754.
*
Jacob is also working on an IEEE 754 software emulation library written
in Rust which also has Python bindings:
* Source:
* Crate:
* Autogenerated Docs:
A cool paper I came across in my research is "IeeeCC754++ : An Advanced
Set of Tools to Check IEEE 754-2008 Conformity" by Dr. Matthias Hüsken.
* Direct link to PDF:
## Khronos Tests
OpenCL Conformance Tests
*
Vulkan Conformance Tests
*
MAJOR NOTE: We are **not** allowed to say we are compliant with any of
the Khronos standards until we actually make an official submission,
do the paperwork, and pay the relevant fees.
## Formal Verification
Formal verification of Libre RISC-V ensures that it is bug-free in
regards to what we specify. Of course, it is important to do the formal
verification as a final step in the development process before we produce
thousands or millions of silicon.
* Possible way to speed up our solvers for our formal proofs
* Algorithms (papers) submitted for 2018 International SAT Competition
* Minisail - compiler
for SAIL into c
Some learning resources I found in the community:
* ZipCPU: ZipCPU provides a comprehensive
tutorial for beginners and many exercises/quizzes/slides:
* Western Digital's SweRV CPU blog (I recommend looking at all their
posts):
*
*
## Automation
*
# Bus Architectures
* Avalon
* CXM
# Vector Processors
* THOR
* NEC SX-Aurora
* RVV
* MRISC32
# LLVM
## Adding new instructions:
*
# Branch Prediction
*
# Python RTL Tools
* pylog fpga
* [Migen - a Python RTL](https://jeffrey.co.in/blog/2014/01/d-flip-flop-using-migen/)
* [Migen Tutorial](http://blog.lambdaconcept.com/doku.php?id=migen:tutorial>)
* There is a great guy, Robert Baruch, who has a good
[tutorial](https://github.com/RobertBaruch/nmigen-tutorial) on nMigen.
He also build an FPGA-proven Motorola 6800 CPU clone with nMigen and put
[the code](https://github.com/RobertBaruch/n6800) and
[instructional videos](https://www.youtube.com/playlist?list=PLEeZWGE3PwbbjxV7_XnPSR7ouLR2zjktw)
online.
There is now a page [[docs/learning_nmigen]].
* [Using our Python Unit Tests(old)](http://lists.libre-riscv.org/pipermail/libre-riscv-dev/2019-March/000705.html)
*
# Other
* Cray-1 Pocket Reference
* Prefix-tree generation scripts
* N1
* Libre Cell Library
*
*
*
* pipeline skid buffer
* GTKwave
* - console-based vcd viewer
* - Waveform Analysis
*
Synchronous Resets? Asynchronous Resets? I am so confused! How will I
ever know which to use? by Clifford E. Cummings
*
Clock Domain Crossing (CDC) Design & Verification Techniques Using
SystemVerilog, by Clifford E. Cummings
In particular, see section 5.8.2: Multi-bit CDC signal passing using
1-deep / 2-register FIFO synchronizer.
*
Understanding Latency Hiding on GPUs, by Vasily Volkov
* Efabless "Openlane"
* example of openlane with nmigen
* Co-simulation plugin for verilator, transferring to ECP5
* Multi-read/write ported memories
* Data-dependent fail-on-first aka "Fault-tolerant speculative vectorisation"
* OpenPOWER Foundation Membership
* Clock switching (and formal verification)
* Circuit of Compunit
* Circuitverse 16-bit
* Nice example model of a Tomasulo-based architecture, with multi-issue, in-order issue, out-of-order execution, in-order commit, with reservation stations and reorder buffers, and hazard avoidance.
* adrian_b architecture comparison
* ericandecscent RISC-V
# Real/Physical Projects
* [Samuel's KC5 code](http://chiselapp.com/user/kc5tja/repository/kestrel-3/dir?ci=6c559135a301f321&name=cores/cpu)
*
*
*
*
*
*
*
# ASIC tape-out pricing
*
# Funding
*
* [NLNet Applications](http://bugs.libre-riscv.org/buglist.cgi?columnlist=assigned_to%2Cbug_status%2Cresolution%2Cshort_desc%2Ccf_budget&f1=cf_nlnet_milestone&o1=equals&query_format=advanced&resolution=---&v1=NLnet.2019.02)
# Good Programming/Design Practices
* [Liskov Substitution Principle](https://en.wikipedia.org/wiki/Liskov_substitution_principle)
* [Principle of Least Astonishment](https://en.wikipedia.org/wiki/Principle_of_least_astonishment)
*
* [Rust-Lang Philosophy and Consensus](http://smallcultfollowing.com/babysteps/blog/2019/04/19/aic-adventures-in-consensus/)
*
*
* Fundamentals of Modern VLSI Devices
# 12 skills summary
*
# Analog Simulation
*
*
*
*
# Libre-SOC Standards
This list auto-generated from a page tag "standards":
[[!inline pages="tagged(standards)" actions="no" archive="yes" quick="yes"]]
# Server setup
* [[resources/server-setup/web-server]]
* [[resources/server-setup/git-mirroring]]
* [[resources/server-setup/nagios-monitoring]]
# Testbeds
*
# Really Useful Stuff
*
*
# Digilent Arty
* https://store.digilentinc.com/pmod-sf3-32-mb-serial-nor-flash/
* https://store.digilentinc.com/arty-a7-artix-7-fpga-development-board-for-makers-and-hobbyists/
* https://store.digilentinc.com/pmod-vga-video-graphics-array/
* https://store.digilentinc.com/pmod-microsd-microsd-card-slot/
* https://store.digilentinc.com/pmod-rtcc-real-time-clock-calendar/
* https://store.digilentinc.com/pmod-i2s2-stereo-audio-input-and-output/
# CircuitJS experiments
* [[resources/high-speed-serdes-in-circuitjs]]
# Logic Simulator 2
*
[Live web version](https://dkilfoyle.github.io/logic2/)
> ## Features
> 1. Micro-subset verilog-like DSL for coding the array of logic gates (parsed using Antlr)
> 2. Monaco-based code editor with automatic linting/error reporting, smart indentation, code folding, hints
> 3. IDE docking ui courtesy of JupyterLab's Lumino widgets
> 4. Schematic visualisation courtesy of d3-hwschematic
> 5. Testbench simulation with graphical trace output and schematic animation
> 6. Circuit description as gates, boolean logic or verilog behavioural model
> 7. Generate arbitrary outputs from truth table and Sum of Products or Karnaugh Map
[from the GitHub page. As of 2021/03/29]
# ASIC Timing and Design flow resources
*
*
*
*
# Geometric Haskell Library
*
*
*
*
# TODO investigate
```
https://github.com/idea-fasoc/OpenFASOC
https://www.quicklogic.com/2020/06/18/the-tipping-point/
https://www.quicklogic.com/blog/
https://www.quicklogic.com/2020/09/15/why-open-source-ecosystems-make-good-business-sense/
https://www.quicklogic.com/qorc/
https://en.wikipedia.org/wiki/RAD750
The RAD750 system has a price that is comparable to the RAD6000, the latter of which as of 2002 was listed at US$200,000 (equivalent to $284,292 in 2019).
https://theamphour.com/525-open-fpga-toolchains-and-machine-learning-with-brian-faith-of-quicklogic/
https://github.blog/2021-03-22-open-innovation-winning-strategy-digital-sovereignty-human-progress/
https://github.com/olofk/edalize
https://github.com/hdl/containers
https://twitter.com/OlofKindgren/status/1374848733746192394
You might also want to check out https://umarcor.github.io/osvb/index.html
https://www.linkedin.com/pulse/1932021-python-now-replaces-tcl-all-besteda-apis-avidan-efody/
“TCL has served us well, over the years, allowing us to provide an API, and at the same time ensure nobody will ever use it. I will miss it”.
https://sphinxcontrib-hdl-diagrams.readthedocs.io/en/latest/examples/comb-full-adder.html
https://sphinxcontrib-hdl-diagrams.readthedocs.io/en/latest/examples/carry4.html
FuseSoC is used by MicroWatt and Western Digital cores
OpenTitan also uses FuseSoC
LowRISC is UK based
https://antmicro.com/blog/2020/12/ibex-support-in-verilator-yosys-via-uhdm-surelog/
https://cirosantilli.com/x86-paging
https://stackoverflow.com/questions/18431261/how-does-x86-paging-work
http://denninginstitute.com/modules/vm/red/i486page.html
```