Initial documentation about SKY90FD process technology.

Signed-off-by: Tim 'mithro' Ansell <[email protected]>

.gitmodules

@@ -0,0 +1,45 @@
+# sky90fd_fd_pr
+[submodule "libraries/sky90fd_fd_pr/latest"]
+	path = libraries/sky90fd_fd_pr/latest
+	url = https://github.com/google/skywater-pdk-libs-sky90fd_fd_pr.git
+	branch = main
+	shallow = true
+
+# sky90fd_fd_sc_mcu7t5v0
+[submodule "libraries/sky90fd_fd_sc_mcu7t5v0/latest"]
+	path = libraries/sky90fd_fd_sc_mcu7t5v0/latest
+	url = https://github.com/google/skywater-pdk-libs-sky90fd_fd_sc_mcu7t5v0.git
+	branch = main
+	shallow = true
+
+# sky90fd_fd_sc_mcu9t5v0
+[submodule "libraries/sky90fd_fd_sc_mcu9t5v0/latest"]
+	path = libraries/sky90fd_fd_sc_mcu9t5v0/latest
+	url = https://github.com/google/skywater-pdk-libs-sky90fd_fd_sc_mcu9t5v0.git
+	branch = main
+	shallow = true
+
+# sky90fd_fd_bd_sram
+[submodule "libraries/sky90fd_fd_bd_sram/latest"]
+	path = libraries/sky90fd_fd_bd_sram/latest
+	url = https://github.com/google/skywater-pdk-libs-sky90fd_fd_bd_sram.git
+	branch = main
+	shallow = true
+
+# sky90fd_fd_io
+[submodule "libraries/sky90fd_fd_io/latest"]
+	path = libraries/sky90fd_fd_io/latest
+	url = https://github.com/google/skywater-pdk-libs-sky90fd_fd_io.git
+	branch = main
+	shallow = true
+
+# sky90fd_fd_ip_sram
+[submodule "macros/sky90fd_fd_ip_sram/latest"]
+	path = macros/sky90fd_fd_ip_sram/latest
+	url = https://github.com/google/skywater-pdk-ip-sky90fd_fd_ip_sram.git
+	branch = main
+	shallow = true
+
+[submodule "third_party/open-source-pdks"]
+	path = third_party/open-source-pdks
+	url = https://github.com/google/open-source-pdks.git

CODE_OF_CONDUCT.rst

@@ -0,0 +1,9 @@
+This project follows the `Google Open Source Community
+Guidelines <https://opensource.google/conduct>`__.
+
+A copy of these guidelines can be found locally in this repository at
+`docs/open-source-pdks/code-of-conduct.rst <./docs/open-source-pdks/code-of-conduct.rst>`__.
+
+A copy of these guidelines are also `included in the published
+documentation <https://gf180mcu-pdk.readthedocs.io/en/latest//open-source-pdks/code-of-conduct.html>`__
+located at https://gf180mcu-pdk.rtfd.io.

CONTRIBUTING.rst

@@ -0,0 +1,6 @@
+Guidelines for contributing can be found locally in this repository at
+`docs/open-source-pdks/contributing.rst <./docs/open-source-pdks/contributing.rst>`__.
+
+A copy of these guidelines are also `included in the published
+documentation <https://gf180mcu-pdk.readthedocs.io/en/latest//open-source-pdks/contributing.html>`__
+located at https://gf180mcu-pdk.rtfd.io.

README.rst

@@ -0,0 +1,155 @@
+SkyWater SKY90FD Open Source PDK
+================================
+
+.. image:: https://img.shields.io/github/license/google/sky90fd-pdk
+   :alt: GitHub license - Apache 2.0
+   :target: https://github.com/google/sky90fd-pdk
+
+.. image:: https://readthedocs.org/projects/sky90fd-pdk/badge/?version=latest&style=flat
+   :alt: ReadTheDocs Badge - https://sky90fd-pdk.rtfd.io
+   :target: https://sky90fd-pdk.rtfd.io
+
+.. image:: https://img.shields.io/github/v/tag/google/sky90fd-pdk?include_prereleases&sort=semver
+   :alt: Latest GitHub tag (including pre-releases)
+   :target: https://gitHub.com/google/sky90fd-pdk/commit/
+
+.. image:: https://img.shields.io/github/commits-since/google/sky90fd-pdk/v0.0.0
+   :alt: GitHub commits since latest release (v0.0.0)
+   :target: https://gitHub.com/google/sky90fd-pdk/commit/
+
+The SKY90FD Open Source PDK is a collaboration between Google and SkyWater Technology Foundry to provide a fully open source `Process Design Kit <https://en.wikipedia.org/wiki/Process_design_kit>`_ and related resources, which can be used to create manufacturable designs at SkyWater’s facility on their new 90nm FDSOI process technology.
+
+The SKY90FD Open Source PDK documentation can be found at <https://sky90fd-pdk.rtfd.io>.
+
+.. image:: docs/_static/sky90fd-pdk-logo.png
+   :alt: Google + SkyWater Logo Image
+   :align: center
+   :target: https://github.com/google/sky90fd-pdk
+   :width: 80%
+
+.. |current-status| replace:: **Experimental Preview**
+
+Current Status -- |current-status|
+==================================
+
+.. current_status_text
+
+*Warning*
+   Google and SkyWater are currently treating the current content as an **experimental preview** / **alpha release**.
+
+
+Google, SkyWater and our partners are currently doing internal validation and test designs, including silicon validation or the released data and plan to publish these results.
+
+The PDK will be tagged with a production version when ready to do production design, see the "`Versioning Information <docs/versioning.rst>`_" section for a full description of the version numbering scheme.
+
+To get notified about future new releases of the PDK, and other important news, please sign up on the
+`sky90fd-pdk-announce mailing list <https://groups.google.com/forum/#!forum/sky90fd-pdk-announce>`_
+[`join link <https://groups.google.com/forum/#!forum/sky90fd-pdk-announce/join>`_].
+
+See both the `Known Issues <docs/known_issues.rst>`_ section and the `SKY90FD PDK GitHub issue list <https://github.com/google/sky90fd-pdk/issues>`_ to get more detailed information around currently known issues.
+
+Resources
+=========
+
+The latest design resources can be viewed at the following locations:
+
+* `On Github @ google/sky90fd-pdk <https://github.com/google/sky90fd-pdk>`_
+* `Google CodeSearch interface @ https://cs.opensource.google/sky90fd-pdk <https://cs.opensource.google/sky90fd-pdk>`_
+* `foss-eda-tools.googlesource.com/sky90fd-pdk <https://foss-eda-tools.googlesource.com/sky90fd-pdk/>`_
+
+SKY90FD Process Node
+====================
+
+The SKY90-FD is a 90nm FDSOI process. Unlike a traditional CMOS BULK process, SKY90-FD features a thin layer of insulator material between the substrate and the upper silicon layer. This thin oxide process allows the transistor to be significantly thinner than in the BULK process, allowing the device to be “fully depleted,” and simplifying the fabrication process. This extra insulation greatly reduces parasitic current leakage and lowers junction capacitances, providing improved speed and power performance under various environmental conditions.
+
+The SKY90FD Process node technology stack consists of;
+
+* 5 layers of copper interconnect
+* 2 layers of aluminum interconnect
+
+If your needs extend beyond the standard included functionality in the `SKY90FD Process Node`_, please see `Contacting SkyWater`_ as they specializes in enabling production volume of process customization include `the addition of specialized materials like Nb, Ge, V2O5, Carbon Nanotubes <https://www.skywatertechnology.com/technology/>`_. Google and SkyWater continuing to explore new options to be included in the `SKY90FD Open Source PDK`_ and `SKY90FD Process Node`_ that enable new innovative solutions to traditional design problems.
+
+
+Typical usages of 130nm Process Nodes
+-------------------------------------
+
+
+Prerequisites
+=============
+
+At a minimum:
+
+-  Git 2.35+
+-  Python 3.6+
+
+On Ubuntu, simply
+------------------
+
+``apt install -y build-essential virtualenv python3``
+
+Building the documentation
+==========================
+
+To build documentation locally, you could use the following commands:
+
+.. code:: bash
+
+   # Download the repository
+   git clone https://github.com/google/sky90fd-pdk.git
+   cd sky90fd-pdk/docs
+
+   # Create a Python virtual environment and install requirements into it.
+   virtualenv env --python=python3
+   . env/activate
+   pip install -r requirements.txt
+
+   # Build the documentation
+   make html
+
+Support
+=======
+
+Like many open source projects there are multiple ways to get support on the SKY90FD PDK.
+
+SkyWater has created a Market Partner Ecosystem to be able to provide support from design through back end package and test.  If you are interested in getting additional support through the ASIC development process, reach out to SkyWater using the information in the `Contacting SkyWater`_ section below.
+
+There is also a `users mailing list  <https://groups.google.com/forum/#!forum/sky90fd-pdk-users>`_ [`join link <https://groups.google.com/forum/#!forum/sky90fd-pdk-users/join>`_] to allow like minded users of the PDK to provide support to each other.
+
+Google does not provide external support for using the SkyWater Open Source PDK and is distributing this repository on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the license_ section for the full terms.
+
+
+About SkyWater Technology Foundry
+=================================
+
+SkyWater is a solely U.S.-based and U.S.-owned, DoD-accredited, Trusted Foundry. Through its Technology Foundry model, SkyWater provides custom design and development services, design IP, and volume manufacturing for integrated circuits and micro devices. The Company’s world-class operations and unique processing capabilities enable mixed-signal CMOS, power, rad-hard and ROIC solutions. SkyWater’s Innovation Engineering Services empower development of superconducting and 3D ICs, along with carbon nanotube, photonic and MEMS devices. SkyWater serves customers in growing markets such as aerospace & defense, automotive, cloud & computing, consumer, industrial, IoT and medical. For more information, please visit: www.skywatertechnology.com/.
+
+SkyWater is building from a long heritage in the microelectronics industry. The SkyWater facility was originally established by Minnesota based Control Data Corporation (CDC) in the 1980s. The CDC fab was acquired by Cypress Semiconductor in 1991. During the Cypress era, the facility was expanded and upgraded multiple times, keeping pace with Moore's Law into the late 2000s and was known for being a US-based production facility that was competitive with Asian-based fabs. SkyWater spun-off from Cypress in 2017 with private equity backing from Minnesota based Oxbow Industries.
+
+Contacting SkyWater
+-------------------
+Requests for more information about SKY130 and other standard and customer foundry technologies can be emailed to <[email protected]> or `submitted via this webform <https://www.skywatertechnology.com/contact/>`_.
+
+
+License
+=======
+
+The SKY90FD Open Source PDK is released under the `Apache 2.0 license <https://github.com/google/sky90fd-pdk/blob/master/LICENSE>`_.
+
+The copyright details (which should also be found at the top of every file) are;
+
+::
+
+   Copyright 2022 SkyWater PDK Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

docs/.gitignore

@@ -0,0 +1,3 @@
+_build
+venv
+env

docs/Makefile

@@ -0,0 +1,39 @@
+# SPDX-FileCopyrightText: 2022 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# The top directory where environment will be created.
+DOCS_DIR := $(dir $(lastword $(MAKEFILE_LIST)))
+TOP_DIR := $(realpath $(DOCS_DIR)/..)
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS     ?= -j auto
+SPHINXBUILD     = sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
+SPHINXPROJ      = gf180mcuPDK
+SOURCEDIR       = $(DOCS_DIR)
+BUILDDIR        = $(DOCS_DIR)/_build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/favicon/browserconfig.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/_static/favicon/mstile-150x150.png"/>
+            <TileColor>#00aba9</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>

docs/_static/favicon/html_code.html

@@ -0,0 +1,9 @@
+<link rel="apple-touch-icon" sizes="152x152" href="/_static/favicon/apple-touch-icon.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/_static/favicon/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/_static/favicon/favicon-16x16.png">
+<link rel="manifest" href="/_static/favicon/site.webmanifest">
+<link rel="mask-icon" href="/_static/favicon/safari-pinned-tab.svg" color="#5bbad5">
+<link rel="shortcut icon" href="/_static/favicon/favicon.ico">
+<meta name="msapplication-TileColor" content="#00aba9">
+<meta name="msapplication-config" content="/_static/favicon/browserconfig.xml">
+<meta name="theme-color" content="#ffffff">

docs/_static/favicon/site.webmanifest

@@ -0,0 +1,13 @@
+{
+    "name": "",
+    "short_name": "",
+    "icons": [
+        {
+            "src": "/_static/favicon/android-chrome-144x144.png",
+            "sizes": "144x144",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff"
+}