diff --git a/README.md b/README.md index 7317896..5d0c368 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,20 @@ Utilize the same python environment as SiliconCompiler. python3 scgallery/rules.py -cfg -rules -check # Check if run met the rule requirements. python3 scgallery/rules.py -cfg -rules -update # Update rules based on last run. -# To add a design: +# Contributing + +## To add a design: 1. Create a folder with the design name (\) in scgallery/designs 2. add source files to scgallery/designs/\/src 3. add constraints to scgallery/designs/\/constraints (using the name of the library it is associated with) 4. create scgallery/designs/\/\.py 5. add the design to [scgallery/designs/\_\_init\_\_.py](scgallery/designs/__init__.py) + +# Issues / Bugs + +We use [GitHub Issues](https://github.com/siliconcompiler/scgallery/issues) +for tracking requests and bugs. + +# License + +[Apache License 2.0](LICENSE) diff --git a/docs/designs.rst b/docs/designs.rst index f63d176..58ce359 100644 --- a/docs/designs.rst +++ b/docs/designs.rst @@ -1,6 +1,43 @@ designs package ================= +AES +--------- + +.. automodule:: scgallery.designs.aes.aes + +Ariane +--------- + +.. automodule:: scgallery.designs.ariane.ariane + +Black Parrot +------------ + +.. automodule:: scgallery.designs.black_parrot.black_parrot + +Caliptra +--------- + +.. automodule:: scgallery.designs.caliptra.datavault +.. automodule:: scgallery.designs.caliptra.keyvault +.. automodule:: scgallery.designs.caliptra.sha512 + +Chameleon +--------- + +.. automodule:: scgallery.designs.chameleon.chameleon + +Dynamic Node +------------ + +.. automodule:: scgallery.designs.dynamic_node.dynamic_node + +Ethmac +--------- + +.. automodule:: scgallery.designs.ethmac.ethmac + GCD --------- @@ -10,3 +47,54 @@ Heartbeat --------- .. automodule:: scgallery.designs.heartbeat.heartbeat + +IBEX +--------- + +.. automodule:: scgallery.designs.ibex.ibex + +JPEG +--------- + +.. automodule:: scgallery.designs.jpeg.jpeg + +Microwatt +--------- + +.. automodule:: scgallery.designs.microwatt.microwatt + +Mock ALU +--------- + +.. automodule:: scgallery.designs.mock_alu.mock_alu + +openmsp430 +---------- + +.. automodule:: scgallery.designs.openmsp430.openmsp430 + +riscv32i +--------- + +.. automodule:: scgallery.designs.riscv32i.riscv32i + +swerv +--------- + +.. automodule:: scgallery.designs.swerv.swerv + +tiny_rocket +----------- + +.. automodule:: scgallery.designs.tiny_rocket.tiny_rocket + +uart +--------- + +.. automodule:: scgallery.designs.uart.uart + +ZeroSOC +--------- + +.. automodule:: scgallery.designs.zerosoc.run_flat +.. automodule:: scgallery.designs.zerosoc.run_hierarchy diff --git a/orfs/designs/tiny_rocket/rules.json b/orfs/designs/tiny_rocket/rules.json index 43eb0da..ba5863a 100644 --- a/orfs/designs/tiny_rocket/rules.json +++ b/orfs/designs/tiny_rocket/rules.json @@ -188,7 +188,7 @@ "round": false, "value": 0.95 }, - "value": 0.0 + "value": -0.14 }, { "compare": "<=", diff --git a/scgallery/designs/tiny_rocket/rules.json b/scgallery/designs/tiny_rocket/rules.json index 43eb0da..ba5863a 100644 --- a/scgallery/designs/tiny_rocket/rules.json +++ b/scgallery/designs/tiny_rocket/rules.json @@ -188,7 +188,7 @@ "round": false, "value": 0.95 }, - "value": 0.0 + "value": -0.14 }, { "compare": "<=",