luke
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
15,878 Commits 121 Branches 59 Tags 70 MiB
Commit Graph

369 Commits

Author SHA1 Message Date
Krystine Sherwin c429aef60f
docs/rosette: More intro of SMT-LIB backend 
As the intro paragraph (now) says:
> This section will introduce the SMT-LIB functional backend and what changes are needed...

The example is intended to be read without prior knowledge of the SMT-LIB backend, but the previous version glossed over a lot and instead focused on *just* what was changed.
This version should now be easier to follow without prior knowledge, while still being able to learn enough about the `Smt` version to adapt it to a different s-expression target that isn't Rosette.
Also adds a few `literalinclude`s of smtlib.cc, which is now copied to `docs/source/generated` along with producing the rosette diff on the fly (which now also has up to 20 lines of context, enabling the full `Module::write()` diff to be literal included).
 2025-02-22 17:14:13 +13:00
Krystine Sherwin 38746ea5fa
docs: Cross reference contributing 
.md points to .html on latest
.rst points to .md on main (not that it will work before this is merged)
 2025-02-20 14:16:41 +13:00
Miodrag Milanovic b5170e1394 Release version 0.50 2025-02-11 07:55:17 +01:00
Krystine Sherwin 819c3260ec
docs/rosette: Backend section body 2025-02-07 15:33:40 +13:00
Krystine Sherwin b02d2c633e
docs/rosette: Module section body 2025-02-07 15:09:06 +13:00
Krystine Sherwin 34c424be68
docs/rosette: Minor updates 
- Fixing typo
- Reference `write_functional_rosette`
- Adjusting/fixing diff sections
- Comment on why the `code-block:: diff` isn't a `literalinclude`
 2025-02-07 15:08:24 +13:00
Krystine Sherwin dc5a5b7bd1
docs/rosette: Regen rosette.diff 
This time from the actual source, which apparently means changing all of the spaces for tabs.
 2025-02-07 14:13:34 +13:00
Krystine Sherwin d73c58fad1
docs/rosette: Sort, Struct, and PrintVisitor sections 2025-02-04 12:24:34 +13:00
Krystine Sherwin 1b6b6a77ba
docs/rosette: Add details for Scope 
Add a diff file and use it for showing changes from smtlib to rosette.
Also add relevant sections of diff to Sort and Struct sections.
 2025-01-25 09:51:20 +13:00
Martin Povišer 61450e8b6e Update codebase for macc_v2 2025-01-24 12:38:03 +01:00
Krystine Sherwin 242c037158
docs/rosette: Add overview 2025-01-24 13:10:34 +13:00
Miodrag Milanovic 427b5a251b Release version 0.49 2025-01-21 14:59:09 +01:00
Emil J da5c20dcfb
Merge pull request #4849 from YosysHQ/emil/hashlib-merge-top-ops 
hashlib: merge hash_ops with hash_top_ops for plugin compat
 2025-01-21 12:09:27 +01:00
Emil J. Tywoniak a2c26a00f2 hashlib: document merged hash_top_ops with hash_ops 2025-01-20 16:25:52 +01:00
KrystalDelusion 0c61f1a9a8
conf.py: Fix source_directory 2025-01-20 16:30:30 +13:00
KrystalDelusion ab4bda8ae2
Docs: Fix links for view/edit source 2025-01-20 16:19:36 +13:00
Krystine Sherwin f4c7377ac1
functional_ir.rst: Fix typo 2025-01-06 14:30:55 +13:00
Krystine Sherwin 23fa9b2014
functional_ir.rst: Initial skeleton for Rosette 2025-01-06 14:30:29 +13:00
Krystine Sherwin ef7734d610
functional_ir.rst: Formatting 
Line breaks.
Put intro under sub-heading.
 2025-01-06 12:01:21 +13:00
KrystalDelusion 9e039095e9
Docs: Remove restructure note 
It's been almost a year since the restructure, so it's not recent anymore and doesn't need to link back to the old version.
 2025-01-06 11:08:00 +13:00
Emil J. Tywoniak b9b9515bb0 hashlib: hash_eat -> hash_into 2024-12-18 15:09:25 +01:00
Emil J. Tywoniak 0a525f38c2 hashlib: declare YS_HASHING_VERSION = 1 2024-12-18 15:09:25 +01:00
Emil J. Tywoniak 4e29ec1854 hashlib: acc -> eat 2024-12-18 15:09:25 +01:00
Emil J. Tywoniak 79acc141d5 hashlib: add deprecated mkhash function to prevent plugin breakage 2024-12-18 14:58:53 +01:00
Emil J. Tywoniak 6d53454bf5 docs: move hashing-based container details into internal docs from guidelines 2024-12-18 14:58:53 +01:00
Emil J 1401906d81 docs: formatting and fixes 
Co-authored-by: KrystalDelusion <93062060+KrystalDelusion@users.noreply.github.com>
 2024-12-18 14:58:53 +01:00
Krystine Sherwin 0454787443 Docs: Formatting and fixes 2024-12-18 14:58:51 +01:00
Emil J. Tywoniak ad0dc17711 docs: document the ideas behind the hashing interface 2024-12-18 14:58:31 +01:00
Miodrag Milanovic aaa5347494 Release version 0.48 2024-12-11 08:35:36 +01:00
Krystine Sherwin 40af327cb6
Docs/installation: Drop resolved todos 2024-12-05 09:21:13 +13:00
Krystine Sherwin 6b3f2fdc8d
Docs: Installation instructions 
Add warning for Cygwin.
Add commented out instructions for MSYS2 that I tried to get to work but ran into build errors.
 2024-12-05 09:21:13 +13:00
Krystine Sherwin b9d73d0a8e
Docs: Note on releases 2024-12-05 09:21:13 +13:00
Krystine Sherwin a7ea375cfc
Docs/installation: Fix code indentation 
Update FreeBSD line to include CXX as well as CC.
Drop unneeded todo.
 2024-12-05 09:21:13 +13:00
Krystine Sherwin 0aef78245e
Moving primary build instructions to docs 
Also drop visual studio instructions.
 2024-12-05 09:21:13 +13:00
Krystine Sherwin c1f42f725b
Docs: Formatting recent md -> rst converts 2024-12-05 09:21:12 +13:00
Krystine Sherwin 9925b27432
Goodbye guidelines (except GettingStarted) 
Drop the parts that are being dropped.
Move the things that are being moved.
Also move the verilog stuff out of README and into the docs.
GettingStarted is less cut and dry, so hold off on that one.
 2024-12-05 09:21:12 +13:00
Krystine Sherwin f0da1cc67f
Start removing guidelines folder 
Disable the export to docs and remove any references to the guidelines folder.
 2024-12-05 09:18:56 +13:00
KrystalDelusion 6f3376cbe6
Merge pull request #4730 from YosysHQ/krys/downstream-docs 
Improvements for downstream-distro maintainability.
 2024-11-28 14:35:16 +13:00
George Rennie 8148ebd1ad docs: document that assigns must come before switches in case rules 2024-11-21 22:41:13 +01:00
Krystine Sherwin e649c1a8e1
Docs: Accept empty string for release envvar 2024-11-20 12:31:12 +13:00
Krystine Sherwin 44b68fb498
Docs: Add check for envvar to disable todos 2024-11-20 12:18:17 +13:00
KrystalDelusion 22e214ec6d
Merge pull request #4705 from YosysHQ/docs-preview-lintonly 
Emphasise that read_verilog doesn't lint
 2024-11-19 03:57:01 +13:00
Krystine Sherwin 1476eaba00
Docs: Add fallback for missing furo_ys 
This is mainly intended for (latex)pdf builds which do not use the furo-ys html theme, where the yosys script syntax highlighting can safely fallback to plaintext.  This effectively makes `furo-ys` an optional dependency to simplify distro-package maintainability.
See also #4725.
 2024-11-12 16:23:12 +13:00
KrystalDelusion 4343c791cb
Merge pull request #4704 from YosysHQ/krys/drop_ilang 
Remove references to ilang
 2024-11-08 11:28:06 +13:00
Miodrag Milanovic 647d61dd92 Release version 0.47 2024-11-05 07:59:25 +01:00
Krystine Sherwin e4994554fd
Docs: Fix nested list 2024-11-05 13:48:48 +13:00
Krystine Sherwin b14a651142
Docs: Mention verilator for linting 
Link to verilator in the introduction.
Include `verilator --lint-only fifo.v` in the example synth doc.
Fix linter warnings in fifo.v.
 2024-11-05 13:29:45 +13:00
Krystine Sherwin ee73a91f44
Remove references to ilang 2024-11-05 12:36:31 +13:00
Krystine Sherwin 4ea6119734
cmdref: Move html only section inside cmd:def 
Fixes missing links in body and `??` in tag/command index.
Update synth.rst to match.
 2024-10-17 06:06:57 +13:00
Krystine Sherwin e9d9e92804
Docs: Make code_examples/extensions parallel safe 2024-10-17 04:40:21 +13:00
Krystine Sherwin bc77575c22
Docs: Fix word_logic.rst 
It somehow got lost in the rebase.
 2024-10-15 11:46:21 +13:00
Krystine Sherwin dfe803b5c6
Docs: Comments from @jix 
- Unswap shift/shiftx
- Add brief overview to cell lib
- Clarify $div cell B input
- Clarify unary operators
- What is $modfloor
 2024-10-15 07:37:20 +13:00
Krystine Sherwin 927dc445dd
Docs: Render cell titles 
Also put property lists *after* cell description.
 2024-10-15 07:35:42 +13:00
Krystine Sherwin 7216f07691
Docs: Define is_evaluable 2024-10-15 07:35:41 +13:00
Krystine Sherwin 9d808caba6
Docs: Add note on $check 2024-10-15 07:35:41 +13:00
Krystine Sherwin e40134c856
Docs: Update for properties 
Add properties page, move cell_gate and cell_word under a singular cell_index along with properties.  Fix links accordingly.

Also drop x-aware and x-output todos since they are resolved.
 2024-10-15 07:35:41 +13:00
Krystine Sherwin e3d939b719
Docs: Drop fifo.out and fifo.stat 
These two files can now be safely .gitignore'd.
 2024-10-15 07:35:41 +13:00
Krystine Sherwin 1a2401816a
Docs: Add cell title TODO 2024-10-15 07:35:41 +13:00
Krystine Sherwin 9ce6952131
Docs: TODOs block, todos don't 2024-10-15 07:35:41 +13:00
Krystine Sherwin f70a66f5b3
Docs: Assert cell has group 
Explicitly assign $_TBUF_ to `gate_other` and remove catch if a cell has no group.
 2024-10-15 07:35:40 +13:00
Krystine Sherwin 5c4f7b4deb
Docs: $eqx aka case equality 2024-10-15 07:35:40 +13:00
Krystine Sherwin 217c2a15dd
Docs: Add todos from JF 2024-10-15 07:35:40 +13:00
Krystine Sherwin 00050833ef
Docs: Add gate_other page 
Drop word_other block since it raises a warning, which will cause the RTDs build to fail.
 2024-10-15 07:35:40 +13:00
Krystine Sherwin 5473b60aec
Docs: Split gate-level cells into subpages 2024-10-15 07:35:40 +13:00
Krystine Sherwin b0bc29e215
Docs: Add todo for $check 2024-10-15 07:35:40 +13:00
Krystine Sherwin 78b9dbd4ea
Docs: Assign remaining word cells to groups 
Move todos to correct place.
Add todo for x-prop cells.
 2024-10-15 07:35:40 +13:00
Krystine Sherwin c6414e08eb
Docs: Switch to furo-ys for YoscryptLexer 2024-10-15 07:34:53 +13:00
Krystine Sherwin e78841ba45
Docs: Fix invalid autorefs 2024-10-15 07:34:53 +13:00
Krystine Sherwin be5572ca0e
Docs: Less leading backslashes 2024-10-15 07:34:52 +13:00
Krystine Sherwin 2b4a4cb536
Docs: Fix fsm.rst 
`$mux-tree` should be `$mux`-tree.
 2024-10-15 07:34:52 +13:00
Krystine Sherwin 46580cebb3
Docs: Move rtlil_text (back) to appendix 2024-10-15 07:34:52 +13:00
Krystine Sherwin 1374fc2e2b
cellref: Deprecate cell_library.rst 
Most of the word/coarse level cells have an assigned group and individual page.
The gate/fine level cells are all on one page.
Fix links to `cell_library.rst`.
 2024-10-15 07:34:52 +13:00
Krystine Sherwin c662529316
Docs: Move binary operators to cell appendix 
Add binary group tag to relevant cells.
Remove content from `cell_library.rst` that is already moved.
 2024-10-15 07:31:47 +13:00
Krystine Sherwin b127ac07f8
Docs: Preliminary autocellgroup usage 
Remove `/source/cell` from .gitignore.
Add a few initial cell pages.
Add YosysCellGroup documenter and cell:group directive.
Update Documenters to use nested json.
Better nested tocs for group.module.source layout.
 2024-10-15 07:26:04 +13:00
Krystine Sherwin 5a4a4191af
Docs: Update conf.py for cellref 2024-10-15 07:26:04 +13:00
Krystine Sherwin 65723200e5
Docs: Delete unused cell_ref.rst 2024-10-15 07:26:04 +13:00
Krystine Sherwin a119d41303
Docs: Move appendix toc to main toc 
Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
 2024-10-15 07:25:27 +13:00
Krystine Sherwin 7eb33f1933
Docs: Testing autocell 2024-10-15 07:24:14 +13:00
Krystine Sherwin ccd3bace23
Docs: Add cells loc config value 2024-10-15 07:24:14 +13:00
Krystine Sherwin 1b0d8633c4
Docs: Add root to ToC 2024-10-15 07:24:14 +13:00
Krystine Sherwin a66e94c5da
Docs: Switch to furo-ys 2024-10-15 07:24:14 +13:00
Krystine Sherwin e5f54dd7cd
Docs: Cell reference as a custom documenter 
Use autodocs to perform cell reference docs generation instead of generating rst files directly.
e.g.
```
.. autocell:: simlib.v:$alu
   :source:
   :linenos:
```
 2024-10-15 07:23:45 +13:00
Krystine Sherwin 40ba92e956
Docs: Reflow line length 2024-10-15 07:23:45 +13:00
Krystine Sherwin 829e02ec5b
Docs: Shorten cmd:ref 2024-10-15 07:22:04 +13:00
Krystine Sherwin e4ec3717bc
Docs: Update internal cells to autoref 2024-10-15 07:18:28 +13:00
Krystine Sherwin c0f9828b3c
Docs: Add autoref role 
Use new `autoref` role when using single backticks. Allows automatic mapping to a cmd ref or a cell ref.
 2024-10-15 07:17:36 +13:00
Krystine Sherwin d629aa6bf1
cellhelp: Split gate-level and word-level cells 2024-10-15 07:17:35 +13:00
Krystine Sherwin a6641da73c
Docs: Initial version of cell_ref autogen 2024-10-15 07:16:39 +13:00
Miodrag Milanovic e97731b9dd Release version 0.46 2024-10-09 08:08:00 +02:00
Krystine Sherwin edf29e725e
Docs: Add functional_ir to index 2024-10-07 22:20:22 +13:00
Krystine Sherwin 13d7b5fd6a
Docs: Ignore example outputs 2024-10-07 22:01:56 +13:00
Krystine Sherwin 0b1b94d85e
Docs: Clean example outputs 2024-10-07 22:00:28 +13:00
Krystine Sherwin 468a019c30
docs: Makefile tidying 
examples and dots are now orthogonal.
 2024-10-07 21:56:23 +13:00
TG 5841b44543 docs: Simplify images generation to allow parallel build 
- remove the tidy target from the main target.
  * aux/log file are already excluded in a .gititgnore file
  * allow parallel generation as the tidy target imposes sequential build
 2024-10-06 08:38:16 +02:00
Miodrag Milanović b20df72e1e
Merge pull request #4536 from YosysHQ/functional 
Functional Backend
 2024-09-06 10:05:04 +02:00
Emily Schmidt 7de8be1451 functional_ir.rst: fix typo, document SExprWriter::flush 2024-09-03 14:30:56 +01:00
Emily Schmidt 75ed6d38fc fix rst formatting in functional_ir.rst 2024-09-03 14:21:56 +01:00
Miodrag Milanovic 9ed031ddd5 Fix TODOs in docs 2024-09-03 12:28:25 +02:00
Miodrag Milanovic 3e0dc2ff1e Release version 0.45 2024-09-03 10:28:56 +02:00
Emily (aiju) c0ce0b82a8 docs: gvpack on macos requires the file name to appear after the flags 2024-09-03 08:38:29 +02:00
Krystine Sherwin 558f313a78
Docs: Show todos in previews 
That includes local builds.
Also fix release version numbers.
 2024-09-03 11:53:43 +12:00
Krystine Sherwin 840c515ffc
RTDs: Fail on warning 
Fix outstanding sphinx warnings;
- Change mycells.lib to use `text` parsing instead of (currently) unsupported `Liberty`.
- Remove unused `troubleshooting.rst`, moving the todo into the index.
 2024-09-03 10:20:24 +12:00
Emily Schmidt 4eeb8d326a functional backend: rename "type" to either "kind" or "sort" to make the terminology consistent 2024-08-28 12:39:41 +01:00
Emily Schmidt 27efed27c2 functional backend: more documentation 2024-08-28 11:28:24 +01:00
Emily Schmidt 459e6b913a add functional ir documentation 2024-08-27 11:11:02 +01:00
Krystine Sherwin ecff434886
Docs: Use version name from readthedocs 
Latest still gets -dev, but if it's a docs preview use the tag/branch name.
 2024-08-27 10:21:31 +12:00
Krystine Sherwin 98d26bdd2c
Docs: Fix nested list on build_verific page 2024-08-27 10:06:26 +12:00
Krystine Sherwin 5d5d890d5b
Docs: macos-safe build 
Swap `cp -u` for `rsync -t`.
Drop the workaround to get the list of dot files after copying them, and instead just run the makefile twice.
Swap `$(wildcard **/*.x)` for `$(shell find . -name *.x)`,
 2024-08-27 10:06:25 +12:00
Krystine Sherwin 2e1335a023
Docs: Fix local builds 
Based on the docs-test-fork PR branch, includes PR preview announcement, linking to the relevant tyrtd page
 2024-08-27 10:06:25 +12:00
Krystine Sherwin 583d820dc2
Docs: Apply verific docs suggestions 2024-08-23 09:23:57 +12:00
Krystine Sherwin 3317d80480
Docs: Clarify verific caveats 2024-08-22 10:04:00 +12:00
Krystine Sherwin 6431534c24
Docs: Some other fixes 2024-08-22 10:03:59 +12:00
Krystine Sherwin 8145461c78
Docs: Fix Verific builds table formatting 
PDF don't like the long headers, so instead use placeholders a-d with elaborations below.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 0327ad97f2
Docs: Fix code formatting 
Gets me everytime
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 36ad07e1d5
Docs: Update build_verific 
Clarify partially supported builds section.
Update parameter defaults.
Include note on finding compile options with `yosys-config`.
Fix remaining references to `/yosys_source/`.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 88bb785dcd
Docs: Verific but with sentences 2024-08-22 10:03:59 +12:00
Krystine Sherwin cfba26ca8b
Docs: Verific progress 2024-08-22 10:03:59 +12:00
Krystine Sherwin 00bb3b6fc2
Docs: Merge yosys_source into extending_yosys 
Move abc_flow content into synthesis/abc document.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 8e618cac45
Docs: Update build_verific.rst 
Move patch section to top.
Add todos for open questions.
Reformat partially supported builds into a single table.
General language tidy up/reflow.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 53b223f0df
Docs: Initial build_verific.rst 
From verific.md

Co-authored-by: Miodrag Milanovic <mmicko@gmail.com>
 2024-08-22 10:03:59 +12:00
Krystine Sherwin d97a243c22
Docs: Intro to Yosys source section 2024-08-22 10:03:59 +12:00
Krystine Sherwin e18a2f1e27
Docs: Section/folder for yosys source details 
Move test_suites page into said folder.
Placeholder page for building with verific.
 2024-08-22 10:03:58 +12:00
Krystine Sherwin 2ffafadf22
Docs: Add note on verific 
Having a verific license does not provide access to the verific frontend.
 2024-08-22 10:03:58 +12:00
Krystine Sherwin 6df0c3d9ec
docs: Fix synth_flow generation 2024-08-19 21:25:51 +12:00
Krystine Sherwin 3b63ab07ae
docs: Build RTD artifacts directly 
Use rtds-action instead of yosys-cmd-ref repo.
Add rtds_action to docs configuration.
Add `.readthedocs.yaml`.
Update `DOCS_USAGE_` make target to be able to use pre-generated executables without forcing a remake.
 2024-08-16 10:43:51 +12:00
Miodrag Milanovic 80ba43d262 Release version 0.44 2024-08-06 09:42:28 +02:00
Emil J e21dd292fc
Merge pull request #4502 from YosysHQ/emil/build-opt-levels 
Release build configuration improvements
 2024-07-29 15:13:52 +02:00
James Meech 1c41db6978
Update interactive_investigation.rst 
The text starting at line 118 refers to proc twice but it should refer to opt and then to proc.
 2024-07-26 13:53:08 +01:00
Emil J. Tywoniak a947572f38 Add lld to clang build environments and Dockerfile 2024-07-22 21:33:46 +02:00
Miodrag Milanovic c6e5e0b26b Release version 0.43 2024-07-09 09:11:59 +02:00
Martin Povišer f9b7b8fff0 Update documentation for C++17 switch 2024-06-17 17:08:13 +02:00
Krystine Sherwin df4e630ac4
Docs: Add section for script parsing 
Document `!` and `:`.
Add warning that semicolons need spaces.
 2024-06-11 13:17:56 +12:00
Miodrag Milanovic 9b6afcf3f8 Release version 0.42 2024-06-07 08:29:48 +02:00
Emil J 111b747d27
Merge pull request #4420 from YosysHQ/emil/doc-demux-todo 
docs: add todo for $demux
 2024-05-30 17:45:19 +02:00
Emil J. Tywoniak 02ad56a132 docs: add todo for $demux 2024-05-27 22:39:42 +02:00
Miodrag Milanovic 229300bb4a replace unicode chars in rst to make pdf work 2024-05-13 17:37:24 +02:00
Miodrag Milanovic fa19abad98 Fix rst syntax error 2024-05-13 16:44:42 +02:00
Miodrag Milanović eba5fa8d64
Merge pull request #4387 from YosysHQ/emil/document-lut-sop 
docs: Document $lut and $sop
 2024-05-13 15:05:07 +02:00
Krystine Sherwin 3a36612ec7
Docs: Apply invert-helper where needed 2024-05-11 10:40:54 +12:00
Krystine Sherwin 9be7089f4f
Docs-css: Add invert-helper class for images 
Use svg color filter matrix from @jix to invert brightness for images when using dark theme.

Co-authored-by: Jannis Harder <me@jix.one>
 2024-05-11 10:40:28 +12:00
Emil J. Tywoniak fd84a3378e docs: Document $lut and $sop 2024-05-09 18:31:18 +02:00
Miodrag Milanovic c1ad37779e Release version 0.41 2024-05-08 08:52:10 +02:00
Miodrag Milanovic 71f2540cd8 docs conf.py change Release -> Version 2024-05-07 15:55:52 +02:00
Miodrag Milanovic b4034a881e Keep docs version in conf.py 2024-05-07 15:35:25 +02:00
Krystine Sherwin bb0be8c7a2
Docs: Set release to YOSYS_VER 
If building from read the docs, and the current build is "latest", add `-dev` to the version string.
Requires `YOSYS_VER` to be exported by .readthedocs.yaml.
 2024-05-04 16:51:29 +12:00
Krystine Sherwin 73d021562f
Docs: Rename source/temp to source/generated 2024-04-15 10:13:22 +12:00
Krystine Sherwin 953f5bbe6c
Docs: Remove end-before tag for yosys-abc 2024-04-15 09:50:46 +12:00
Krystine Sherwin b3024289c6
Docs: Force read_verilog to avoid verific header 2024-04-13 11:33:04 +12:00
Krystine Sherwin 1d7b7ddfd7
Docs: Skip footer in logs 2024-04-13 11:29:11 +12:00
Miodrag Milanovic e2cfcbcf25 fix .gitignore 2024-04-10 10:12:05 +02:00