sync_up: Formatting fixes
[libreriscv.git] / index.mdwn
index c3a24afb6312bb91ef7bc5e2e608b96524d62197..0a51220b6187054c517af8158a776a6f37f15635 100644 (file)
-# Welcome to Libre-SoC ([provisionally renamed](http://lists.libre-riscv.org/pipermail/libre-riscv-dev/2020-January/003580.html) from Libre-RISCV)!
-## Why a Libre SOC?
-
-Its quite hard to guarantee that a performant processors(think pipelined, out-of-order) are functionally perfectly correct. In fact, it often turns out that they [aren’t](https://meltdownattack.com):
-
-There are entire [dissertations](http://www.kroening.com/diss/diss-kroe.pdf) dedicated to the subject matter of merely functionally verifying a pipeline(this doesn’t even consider out of order execution).
-
-Given the fact that [high performing]bug free processors don’t exist anymore, how can you trust your processor? The next best thing is have access to a processor’s design files. Not only have access to them, you need to be able to study and improve them.
-
-Such a processor is referred to as a Libre processor. However, processors themselves are only a part of the picture. Nowadays, most contemporary computing tasks involve artificial intelligence, media consumption, wireless connectivity, etc.
-
-## What we Do
-LibreSOC strives to deliver a fully capable and competitive Libre integrated System on Chip. We want to maximize the degree of trust a customer can place in his or her processor. We do this by providing the customer the freedom to  study, modify, and redistribute the SOC source from HDL to VLSI.
-
-Right now, we're targeting a (quad core, 800mhz, dual issue, GPU, VPU, [and later an ML inference core] ) SOC.
-
-## But Why do I need a LibreSOC?
-Its entirely possible that you're OK with the fact that modern processors have
-[backdoors](https://www.csoonline.com/article/3220476/researchers-say-now-you-too-can-disable-intel-me-backdoor-thanks-to-the-nsa.html) that bad actors 
-regularly exploit.
-
-But beyond the contemporary ever increasing cry for privacy, is a very real need for reliable safety critical processors.
-LibreSOC poses to you that it is impossible to trust a processor in a safety critical environment without both access
-to that processor's source and a cycle accurate HDL simulator that guarantees developer's their code behaves as they 
-expect. An ISA level simulator is no longer satisfactory.
-
-Refer to this [paper](https://ieeexplore.ieee.org/document/4519604) authored by Cyberphysical System expert Ed-Lee for more details.
-
-## Still Got Questions?
-Read about the business and practical benefits of a LibreSOC below.
-
-[[why_a_libresoc]]
-
-
-# Join us in Realizing the First Market Ready LibreSOC!
-
-First. join the
-[mailing list](http://lists.libre-riscv.org/mailman/listinfo/libre-riscv-dev),
-introduce yourself, and read through
-[recent posts](http://lists.libre-riscv.org/pipermail/libre-riscv-dev/)
-and the [[charter]].
-
-The next thing you should do is read through the [bugs
-list](http://bugs.libre-riscv.org) and see if there are any bugs that
-pique your interest.
-
-We do have funding available (see [[nlnet]]) upon completion of issues -
-we are also working on procuring more funding which gets the project to
-nanometre scale tapeout.
-
-After all this, if you feel that Libre-SoC is a good cause that
-you would like to contribute to, add yourself to the [[current_members]]
-page, fill in some information about yourself, and join the mailing list
-and say hello.
-
-Also note that you can edit this wiki. See the last section of this page.
+<div class="jumbotron">
+  <h1 class="display-5">Welcome to Libre-SOC</h1>
+<blockquote>
+  <p>We're building a chip. A fast chip. A safe chip. A trusted chip.
+  </p>
+
+  <p>A chip with lots of peripherals. And it's a VPU.  And it's a 3D GPU...
+  </p>
+
+  <p>Oh and here, have the
+     <a href="http://git.libre-soc.org">Libre-SOC source code</a>...
+   </p>
+</blockquote>
+  <hr class="my-4">
+
+<h2 class="display-5">Why should I care?</h2>
+
+With Libre-SOC, you can take complex algorithms usually intended for
+power hungry servers with big fat GPUs, and run them on tiny devices
+like smartwatches, cellphones, and pocket drones without changing your
+code at all.
+
+  <hr class="my-4">
+
+<h2 class="display-5">Hasn't Somebody Already Done This?</h2>
+
+To the best of our knowledge, no. The closest systems would be ARM Cortex
+devices which currently offer mediocre GPU and OpenCL support. Often
+times, it is quite difficult for customers to get their hands on the
+drivers and install them due to their locked down nature. Libre-SOC is
+providing our own Free/Libre drivers. Easy as 1, 2, 3!
+
+  <hr class="my-4">
+
+<h2 class="display-5">Does Open Hardware Really Work?</h2>
+<p>A few names come to mind:</p>
+
+<ul>
+<li><a href="https://www.arduino.cc">Arduino</a></li>
+<li><a href="https://www.raptorcs.com">Raptor Computing Systems</a></li>
+<li><a href="https://www.bitcraze.io">CrazyFlie</a></li>
+<li><a href="https://www.scopefun.com">ScopeFun</a></li>
+</ul>
+
+  <p class="lead">
+    <a class="btn btn-primary btn-lg" href="https://libre-soc.org/why_a_libresoc/" role="button">Learn more</a>
+
+</div>
+
+# Our Team
+
+We are proud of our talented and diverse [team](about_us)
+located all across the world: UK US Canada Germany Greece India
+Kuwait.
+
+# Our sponsors and partners
+
+* [NLnet](https://nlnet.nl) who have very kindly sponsored us with
+  over EUR 550,000 in various separate grants.
+* [NGI POINTER](https://www.ngi.eu/ngi-projects/ngi-pointer/) who have
+  sponsored us with a EUR 200,000 Horizon 2020 Grant.
+* [Mythic Beasts](http://mythic-beasts.com) who don't overcommit on
+  their VPS allocations (no memory ballooning), and put servers on
+  the fastest backbone Internet points.
+* [Purism](http://puri.sm) donates to us through [NLNet](nlnet)
+  charitable gifting
+* [Raptor CS](http://raptorcs.com) has given us access to a powerful
+  18-core 128 GB RAM TALOS II workstation, online.
+* [Raptor Engineering](https://raptorengineering.com) is providing
+  additional assistance including access to an [[shakti/m_class/LPC]]
+  interface (more to come)
+* [MarketNext](http://marketnext.org) is helping us connect to developer
+  resources in Emerging markets, for completion of NLNet-funded tasks.
+* The [[PowerPC Notebook]] Project
+* [RED Semiconductor](http://redsemiconductor.com) is the commercial realisation of Libre-SOC technology that respects and actively supports Libre principles in its business objectives.
+* [[fed4fire]] for supercomputer access for verilator simulations,
+  with thanks to Ghent University / IMEC.
+
+# How Can I Help?
+
+If you would like to fund us, see [[funding]]. We currently have some
+funding and always appreciate more!  If you are a Corporation or an
+individual you can donate tax-free to NLNet, and they can in turn gift
+our developers.  Contact lkcl@lkcl.net for more information.
+
+# How Can I Help as a Developer? <a name="help_as_developer"></a>
+
+If you want to write code with us (and receive donations from NLNet
+for doing so), keep reading.  If you want to *learn*
+so that you can write code with us, see "How can I learn" section,
+below.  If there is anything else,
+just get in touch on the list, there is plenty to do.
+
+1. First, join the
+  [mailing list](http://lists.libre-soc.org/mailman/listinfo/libre-soc-dev),
+  introduce yourself (people will happily say "hello" back) and
+  the Libera IRC channel
+  (#libre-soc at irc.libera.chat port 6697, see
+https://libera.chat/guides/connect),
+  it's also accessible via Libera.Chat's Matrix Bridge
+  (`#libre-soc:libera.chat`)
+  [logs here](https://libre-soc.org/irclog/latest.log.html).
+  Read through
+  [recent posts](http://lists.libre-soc.org/pipermail/libre-soc-dev/)
+  and the [[charter]], ask questions if you have any and let everyone know,
+  on the list that you're happy with it and agree to it.
+2. The next thing you should do is read through the
+  [bugs list](http://bugs.libre-soc.org) and
+  see if there are any bugs that pique your interest.
+  A fascinating way to do that is to view the
+  [dependency graph](https://bugs.libre-soc.org/showdependencygraph.cgi?id=1&display=web&rankdir=LR)
+3. After that, go ahead and take a look at the
+   [git repositories](https://git.libre-soc.org).
+4. If you plan to do HDL work, you should familiarize yourself with our
+  [[HDL_workflow]].  If you would like to help with the ASIC layout,
+  see [[HDL_workflow/coriolis2]]
+5. We do have funding available (see [[nlnet]]) upon completion of issues -
+  we are also working on procuring more funding which gets the project to
+  nanometre scale tapeout.
+6. After all this, if you feel that Libre-SOC is a something
+  that you would like to contribute to, add yourself to the
+  [current_members](about_us) page, fill in some information about yourself,
+  and join the mailing list and say hello.
+
+Also note that you can edit this wiki.  You can experiment in the [[Sandbox]].
+
+## Quick peek at the code
+
+The full install process may be automated using scripts found
+here: <https://git.libre-soc.org/?p=dev-env-setup.git;a=summary>
+which you can clone with:
+
+    git clone https://git.libre-soc.org/git/dev-env-setup.git
+
+A convenient page which gives easy step-by-step instructions is: 
+[[HDL_workflow/devscripts]], and you can get started with a
+[[docs/firststeps]] tutorial.
+
+## How can I learn?
+
+The whole purpose of this project is to be a learning environment as well
+as an actual business.  If you want to learn how to do ASIC design, with
+a view to contributing or starting your own ASIC business, start here:
+[[3d_gpu/tutorial]]. Yes, really: do not let anyone tell you that you
+can't learn this stuff too.
+
+Along the way, if you find any [[resources]] or links that you found
+particularly helpful, please add them to that page so that other people
+can also benefit (and you have a place to remember them, too).
 
 ## Needed Skills
 
 Most labor is currently being applied to developing the GPU portion of
-the Libre-SoC.
-
-The highest priority needed at the moment is a c++ engineer to work on
-a MESA 3D driver. This will begin life similar to SwiftShader however
-retaining the vectorisation and predication intrinsics as well as hardware accelerated opcodes (all of which SwiftShader lacks)
+the Libre-SOC.
 
-Medium to long-term we need HDL engineers. Particularly those familiar
+Our highest priority short-term and medium-term: we need HDL engineers.
+Particularly those familiar
 with nMigen or just python.  Most of the techniques being used require
 software engineering skills (OO design, polymorphism) than they do more
 traditional HDL programming skills. Basically if you have experience in 2
 of the following you'll do fine: python, nmigen, verilog/VHDL/gate-level
 design. See [[HDL_workflow]]
 
+We also need to find a c++ engineer with compiler experience to work on
+a MESA 3D driver. This will begin life similar to SwiftShader however
+retaining the vectorisation and predication intrinsics then adding
+hardware accelerated opcodes (all of which SwiftShader lacks)
+
 Also, individuals with experience in formal mathematical verification
 are quite welcome.
 
-TODO: add a list of upcoming project tasks/milestones (link to
-bugtracker).
-
-# Resources
-
-* Mailing Lists <http://lists.libre-riscv.org> -
-  Archives at <http://lists.libre-riscv.org/pipermail>
-* Git repositories <http://git.libre-riscv.org>
-  may be cloned publicly with
-  git clone https://git.libre-riscv.org/git/repositoryname.git
-* Bugzilla at <http://bugs.libre-riscv.org/>
-* Kazan (Vulkan driver) at <https://salsa.debian.org/Kazan-team/kazan>
-* Further Information [[resources]]
-
-# Main Pages
-
-* Libre-SoC [[charter]]
-* [[shakti/m_class]]
-* [[alt_rvp]]
-* [[3d_gpu]]
-* [[vpu]]
-* [[simple_v_extension]]
-* [[zfpacc_proposal]]
-* [[ztrans_proposal]]
-* [[simple_v_extension/specification/mv.x]]
-* [[simple_v_extension/specification/ld.x]]
-* Specifications and [[resources]]
-
-# Spike Emulator
-* [Set-Up Instructions][1]
-
-[1]: https://libre-riscv.org/3d_gpu/spike_sv/
-
-# Current Members
-
-[[current_members]]
-
-# Wiki Structure
+# Documentation
 
-This is a publicly editable wiki.
+ - [Source Code](/docs/)
+ - [Architecture](3d_gpu/architecture)
 
-All wikis are supposed to have a [[SandBox]], so this one does too.
+# Autism and Asperger's
 
-This wiki is powered by [[ikiwiki]].
+A number of our team have Autism, specifically a variant called Asperger's.
+Please be mindful and aware when interacting with us.  More information
+may be found here:
 
-This is the sitemap: [[sitemap]]
+* <https://foodforthebrain.org/autism/>
+* <https://m.youtube.com/watch?v=Grrbekq-6kw>