Tim 'mithro' Ansell
4abbce3cf3
docs: Adding summary of foundry provided cells.
...
Provides a little bit of summary information on each of the foundry
provided standard cells.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-10-12 04:28:33 -07:00
Tim 'mithro' Ansell
b79a54e235
docs: Renaming so docs match `sky130_fd_pr` cell names.
...
* Make the directory names consistent with cell names.
* Add `:model:` and `:cell:` around object names.
* Small other cleanups.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:46:39 -07:00
Tim 'mithro' Ansell
0a35656db1
docs: Improve sort order of device-details page.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell
a335a40331
docs: Fixing the sign on the Low Voltage PMOS FETs.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell
7738f321ff
docs: Split the 3V and 5V native NMOS FETs.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell
788451177d
docs: Adding details for various supported devices.
...
Each type of device includes;
- General device description
- Details about the spice model and operating conditions.
- Images of the symbols for the device.
- Image showing the cross-section of the device.
The devices included are;
- Bipolar (NPN)
- Bipolar (PNP)
- MiM Capacitor
- Vertical Parallel Plate (VPP) capacitors
- SONOS cells
- SRAM cells
- Diodes
- 11V/16V NMOS FET
- 1.8V NMOS FET
- 1.8V low-VT NMOS FET
- 20V NMOS FET
- 20V isolated NMOS FET
- 20V native NMOS FET
- 20V NMOS zero-VT FET
- 3.0V and 5.0V native NMOS FET
- 5.0V/10.5V NMOS FET
- NMOS ESD FET
- 10V/16V PMOS FET
- 1.8V PMOS FET
- 1.8V high-VT PMOS FET
- 1.8V low-VT PMOS FET
- 20V PMOS FET
- 5.0V/10.5V PMOS FET
- Generic Resistors
- P- poly precision resistors
- P+ poly precision resistors
- Varactors
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
Temp.
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell
fa5e348b4a
docs: Makefile for generating a combined device-details.rst file.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:47 -07:00
Tim 'mithro' Ansell
0fccbdc534
docs: Adding `cell` role to Sphinx.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 17:27:39 -07:00
Tim 'mithro' Ansell
0de3fb356b
docs: Adding useful rstdoc tool.
...
- `rstlisttable` - Convert RST grid tables to list-tables
- `rstreflow` - Reflow paragraphs and tables
- `rstretable` -Transforms list tables to grid tables
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-30 12:07:57 -07:00
Tim 'mithro' Ansell
bd804a00c1
docs: Reworking favicon.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-24 17:29:17 -07:00
Tim 'mithro' Ansell
012ecba3a1
docs: Adding skywater-favicon.png file.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-24 17:06:45 -07:00
interfect
caabe665e2
Fix typo: "an approximations"
...
The values should probably be described just as "approximations".
2020-09-20 13:19:38 -07:00
Tim 'mithro' Ansell
94015f5cc6
docs: Fix html_context values.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-19 14:37:28 -07:00
Tim 'mithro' Ansell
d19cd14395
docs: Fix name in the extensions list.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-19 14:36:30 -07:00
Tim 'mithro' Ansell
73fd000ff4
docs: Fixing requirements.txt
...
* Install sphinx-verilog-domain.
* Update for the sphinxcontrib-verilog-diagrams name change.
* Use the SymbiFlow version of Symbolator.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-19 14:28:08 -07:00
Tim 'mithro' Ansell
5113b97155
docs: Fixing capacitance / resistance CSV files.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-14 12:30:16 -07:00
Tim 'mithro' Ansell
b844d2f081
docs: Adding basic values for capacitance + resistance.
...
Values taken from the following Google Spreadsheet
[SKY130 Stackup Capacitance Data" spreadsheet](https://docs.google.com/spreadsheets/d/1N9To-xTiA7FLfQ1SNzWKe-wMckFEXVE9WPkPPjYkaxE/edit#gid=226894802 )
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-14 12:26:29 -07:00
Tim 'mithro' Ansell
0acfbf84e8
docs: Small fixes to layers.rst file.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-14 12:25:56 -07:00
Tim 'mithro' Ansell
56e133c2c8
docs: Remove the old names in device LVS other table.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 20:18:03 -07:00
Tim 'mithro' Ansell
571710bb6f
docs: Fixup the naming in the mask table.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 20:06:14 -07:00
Tim 'mithro' Ansell
cae6d125ea
docs: Cleaning up rcx-all.csv table.
...
Formatted version found in
[SKY130 Stackup Capacitance Data - RCX Model Information](https://docs.google.com/spreadsheets/d/1N9To-xTiA7FLfQ1SNzWKe-wMckFEXVE9WPkPPjYkaxE/edit#gid=1391862914 )
sheet.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 19:43:28 -07:00
Tim 'mithro' Ansell
b581da870a
docs: Whitespace fixes.
2020-09-10 16:51:10 -07:00
Tim 'mithro' Ansell
6e8b54e3c9
docs: Adding original source of the metal_stack diagram.
...
Source file can be used with
[xcircuit](https://github.com/RTimothyEdwards/xcircuit ).
Export to SVG from xcircuit using menu item "File->Export->Export SVG"
(from the first page).
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:43:22 -07:00
Tim 'mithro' Ansell
f3d86a6952
docs: Adding `:stub-columns:` to all csv tables.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:43:22 -07:00
Tim 'mithro' Ansell
bcb4ed0684
docs: Adding antenna rules.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:43:15 -07:00
Tim 'mithro' Ansell
1fb5d531b6
docs: Adding Parasitic Layout Extraction docs.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:39:07 -07:00
Tim 'mithro' Ansell
45fad831cb
docs: Adding WLCSP design rules.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:39:07 -07:00
Tim 'mithro' Ansell
0dcc767be6
docs: Add high (and ultra high) voltage methodology.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:39:07 -07:00
Tim 'mithro' Ansell
0c5a7b285e
docs: Adding the summary data pages.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:39:07 -07:00
Tim 'mithro' Ansell
a34b187d76
docs: Adding layers tables and LVS info.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:39:00 -07:00
Tim 'mithro' Ansell
8b5a8cede1
docs: Adding layer information from section C documentation.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:29:17 -07:00
Tim 'mithro' Ansell
8c11d93428
docs: Adding information about the masks used in SKY130.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-09-10 16:29:17 -07:00
Kane York
c62246da3b
Undo attempt to add headings
2020-08-08 17:24:38 -07:00
Kane York
487438bd69
Add brief description of antenna rules, headings
...
attempt to make headings render
2020-08-08 17:19:29 -07:00
Kane York
33ff0a2065
glossary: Add suggestions from Slack
...
Alphabetize the acronyms section.
Fix the link to Mentor Graphics.
2020-08-08 17:03:39 -07:00
Sylvain Munaut
2c69332cad
docs: Add CSV file with the GDS layer informations and comments
...
This is from https://docs.google.com/spreadsheets/d/176OcP2h_TT_pDP2-zBLijlgFUP38LVgMQPlDtpLcrsk/edit?ts=5eff8387#gid=459375686
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2020-07-11 23:57:51 +02:00
Tim 'mithro' Ansell
96f1f3edf9
docs: Adding verification tools placeholders.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-07-08 18:55:10 -07:00
Tim 'mithro' Ansell
a7baa587e3
docs: Adding placeholder pages for various tools.
...
* Analog tooling
- Generators BAG, FASoC, etc
- Manual tools KLayout, Magic, Innovus, etc
* Digital tooling
- Cadence Innovus
- OpenROAD
* Simulation tooling
- ngspice
- Cadence Spectre
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-07-08 18:55:10 -07:00
Tim 'mithro' Ansell
3dac1a7340
docs: Adding glossary plus previous nomenclature page.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-07-08 18:55:10 -07:00
Tim 'mithro' Ansell
59d34f1635
docs: Adding new library to the docs.
...
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2020-07-08 18:55:10 -07:00
Karol Gugala
e0a5bbcde6
docs: partners: fix auc logo
2020-06-30 18:34:18 +02:00
Karol Gugala
34097bd491
docs: partners: fix displaying on mobile devices
2020-06-30 16:45:56 +02:00
Tim Ansell
9d5fe0d7cb
Merge pull request #29 from antmicro/partners
...
Add partners page
2020-06-29 14:16:34 -07:00
Karol Gugala
efbcfff366
docs: partners: add links to logos
2020-06-29 23:09:24 +02:00
Karol Gugala
f19821e512
docs: partners: move logos to separate dir
2020-06-29 21:20:59 +02:00
Karol Gugala
3eb45ffe74
Docs: add partners page
2020-06-29 20:58:11 +02:00
Tim 'mithro' Ansell
acd53975a2
docs: Cleanup a bunch of sphinx warnings.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-25 19:24:22 -07:00
Tim 'mithro' Ansell
1fc041f575
docs: Adding example cell.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-25 19:23:19 -07:00
Tim 'mithro' Ansell
6926ce51f0
docs: Adding the start of the contents section.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:22:23 -07:00
Tim 'mithro' Ansell
c1cdafb1a8
docs: Adding error messages output.
...
Updates and documentation originally improved and then release by
Kevin Kelly <kevin.kelley@skywatertechnology.com> to Google for imported
into the docutils RST format by Tim 'mithro' Ansell <tansell@google.com>.
Signed-off-by: Kevin Kelley <kevin.kelley@skywatertechnology.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell
7303dab0db
docs: Adding periphery rules.
...
Updates and documentation originally improved and then release by
Kevin Kelly <kevin.kelley@skywatertechnology.com> to Google for imported
into the docutils RST format by Tim 'mithro' Ansell <tansell@google.com>.
Signed-off-by: Kevin Kelley <kevin.kelley@skywatertechnology.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell
2c2b22787b
docs: Initial start on process design rules.
...
Updates and documentation originally improved and then release by
Kevin Kelly <kevin.kelley@skywatertechnology.com> to Google for imported
into the docutils RST format by Tim 'mithro' Ansell <tansell@google.com>.
Signed-off-by: Kevin Kelley <kevin.kelley@skywatertechnology.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell
4ace14a741
docs: Fixing header length in known_issues.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell
8dc828766a
docs: Stick the table headers to the top of table.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell
87725fd57d
docs: Fix the header links.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-19 14:13:40 -07:00
Tim 'mithro' Ansell
1a2769740a
docs: Fix centering of images.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 18:55:20 -07:00
Tim 'mithro' Ansell
5ed81fd4d4
docs: Adding the image from the README into the docs.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 18:28:24 -07:00
Tim 'mithro' Ansell
83779dee6a
docs: Small cleanup of auto-generated name outputs.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 16:14:15 -07:00
Tim 'mithro' Ansell
0f9c5cafec
Fix the flash build space name.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 15:49:38 -07:00
Tim 'mithro' Ansell
9ee1ae5204
Adding SVG image of the metal_stack.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
Signed-off-by: Tim Edwards <tim@efabless.com>
2020-06-17 11:56:14 -07:00
Tim 'mithro' Ansell
ce5576edff
docs: Adding the Python API to output docs.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-11 14:03:54 -07:00
Tim 'mithro' Ansell
3e225d611a
docs: Adding missing CSS file.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:30:28 -07:00
Tim 'mithro' Ansell
271859fc68
docs: Move the code of conduct under the contributing section.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:29:38 -07:00
Tim 'mithro' Ansell
9036e6fb82
docs: Improve the current status heading.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:11:50 -07:00
Tim 'mithro' Ansell
cfc7208f97
docs: Add missing license header.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:11:50 -07:00
Tim 'mithro' Ansell
24e4310472
docs: Small improvements.
...
* Clean up sphinx warnings.
* Include status in multiple locations.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 17:20:32 -07:00
Tim 'mithro' Ansell
87baa793ce
docs: Put current status at the top of the known issues page.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 14:55:34 -07:00
Tim 'mithro' Ansell
8b323f8504
docs: Adding initial Sphinx doc structure.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 14:55:24 -07:00
Tim 'mithro' Ansell
ac8ba83bc7
scripts: Adding license header checking.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 21:32:12 -07:00
Tim 'mithro' Ansell
7a530fcf20
docs: Fixing the verbatim in versioning.rst file.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:25 -07:00
Tim 'mithro' Ansell
1242fab66e
docs: Adding danger block around status warning.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell
d982b0aea7
docs: Change levels of two headings.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell
8d719604ef
docs: Generate README.rst to work around GitHub not rendering `.. include::` in rst files.
...
This work might look like extensive for just fixing a small issue like
the include rendering, but it will all be heavily reused by the
skywater-pdk scripts that will be released soon.
This commit;
- Adds Makefile for creating a self contained conda environment under
`env/conda`
- Installs required Python dependencies into the environment (which is
currently just the `rst_include` tool).
- Has a Makefile to generate `README.rst` from `README.src.rst`
- Has Travis CI run on repository and check that the `README.rst` file
has been rebuilt and committed if any of the dependencies have
change.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell
409742e19c
docs: Adding "Known Issues" and "Versioning" sections of the documentation.
...
Extracted the status page into a separate file which can be included by
both the known issues and README files.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:16 -07:00
Tim 'mithro' Ansell
cff5c08524
Adding initial README.rst file.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 09:30:06 -07:00
Tim 'mithro' Ansell
15547a70a3
Convert docs from Markdown to RST.
...
This repository will use RST heavily for all it's documentation and it
is good for these documents to be the same.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-07 14:35:04 -07:00
Tim 'mithro' Ansell
53e4356d8a
Boilerplate for new Google open source project
...
Based on bc6327f077d9a712f022310f1e8c8258fa297b8d from
https://github.com/google/new-project template.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-07 14:34:53 -07:00