Merge pull request #281 from antmicro/umarcor/f4pga
s/SymbiFlow/F4PGA/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d5615e4..e92bb22 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,18 +1,16 @@
-# Contributing to Yosys SymbiFlow Plugins
+# Contributing to Yosys F4PGA Plugins
-There are a couple of guidelines when contributing to Yosys SymbiFlow Plugins
-which are listed here.
+There are a couple of guidelines when contributing to Yosys F4PGA Plugins which are listed here.
### Sending
-All contributions should be sent as
-[GitHub Pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
+All contributions should be sent as [GitHub Pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
### License
-All software (code, associated documentation, support files, etc) in the
-Yosys SymbiFlow Plugins repository are licensed under the very permissive
-[ISC Licence](COPYING). A copy can be found in the [`COPYING`](COPYING) file.
+All software (code, associated documentation, support files, etc) in the Yosys F4PGA Plugins repository are licensed
+under the very permissive [ISC Licence](COPYING).
+A copy can be found in the [`COPYING`](COPYING) file.
All new contributions must also be released under this license.
diff --git a/README.md b/README.md
index 9ca9b69..ad1cce8 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,15 @@
-# Yosys SymbiFlow Plugins
+# Yosys F4PGA Plugins
-This repository contains plugins for
-[Yosys](https://github.com/YosysHQ/yosys.git) developed as
-[part of the SymbiFlow project](https://symbiflow.github.io).
+This repository contains plugins for [Yosys](https://github.com/YosysHQ/yosys.git) developed as [part of the F4PGA project](https://f4pga.org).
-## List of plugins
-1. [Design introspection](#design-introspection-plugin)
-2. [FASM](#fasm-plugin)
-3. [Integrate inverters](#integrate-inverters-plugin)
-4. [Parameters](#parameters-plugin)
-5. [QuickLogic IOBs](#quicklogic-iob-plugin)
-6. [QuickLogic QLF FPGAs](#quicklogic-qlf-plugin)
-7. [SDC](#sdc-plugin)
-8. [XDC](#xdc-plugin)
-9. [SystemVerilog](#systemverilog-plugin)
+## Design introspection plugin
-## Summary
-
-### Design introspection plugin
-
-Adds several commands that allow for collecting information about cells, nets, pins and ports in the design or a selection of objects.
+Adds several commands that allow for collecting information about cells, nets, pins and ports in the design or a
+selection of objects.
Additionally provides functions to convert selection on TCL lists.
Following commands are added with the plugin:
+
* get_cells
* get_nets
* get_pins
@@ -30,49 +17,58 @@
* get_count
* selection_to_tcl_list
-### FASM plugin
+## FASM plugin
-Writes out the design's [fasm features](https://symbiflow.readthedocs.io/en/latest/fasm/docs/specification.html) based on the parameter annotations on a design cell.
+Writes out the design's [fasm features](https://fasm.readthedocs.io/en/latest/) based on the parameter annotations on a
+design cell.
The plugin adds the following command:
+
* write_fasm
-### Integrate inverters plugin
+## Integrate inverters plugin
Implements a pass that integrates inverters into cells that have ports with the 'invertible_pin' attribute set.
The plugin adds the following command:
+
* integrateinv
-### Parameters plugin
+## Parameters plugin
Reads the specified parameter on a selected object.
The plugin adds the following command:
+
* getparam
-### QuickLogic IOB plugin
+## QuickLogic IOB plugin
-[QuickLogic IOB plugin](./ql-iob-plugin/) annotates IO buffer cells with information from IO placement constraints. Used during synthesis for QuickLogic EOS-S3 architecture.
+[QuickLogic IOB plugin](./ql-iob-plugin/) annotates IO buffer cells with information from IO placement constraints.
+Used during synthesis for QuickLogic EOS-S3 architecture.
The plugin adds the following command:
+
* quicklogic_iob
-### QuickLogic QLF FPGAs plugin
+## QuickLogic QLF FPGAs plugin
[QuickLogic QLF plugin](./ql-qlf-plugin) extends Yosys with synthesis support for `qlf_k4n8` and `qlf_k6n10` architectures.
The plugin adds the following command:
+
* synth_quicklogic
* ql_dsp
Detailed help on the supported command(s) can be obtained by running `help <command_name>` in Yosys.
-### SDC plugin
+## SDC plugin
-Reads Standard Delay Format (SDC) constraints, propagates these constraints across the design and writes out the complete SDC information.
+Reads Standard Delay Format (SDC) constraints, propagates these constraints across the design and writes out the
+complete SDC information.
The plugin adds the following commands:
+
* read_sdc
* write_sdc
* create_clock
@@ -82,28 +78,31 @@
* set_max_delay
* set_clock_groups
-### XDC plugin
+## XDC plugin
Reads Xilinx Design Constraints (XDC) files and annotates the specified cells parameters with properties such as:
+
* INTERNAL_VREF
* IOSTANDARD
* SLEW
* DRIVE
* IN_TERM
* LOC
-* PACKAGE_PIN
+* PACKAGE_PIN
The plugin adds the following commands:
+
* read_xdc
* get_iobanks
* set_property
* get_bank_tiles
-### SystemVerilog plugin
+## SystemVerilog plugin
Reads SystemVerilog and UHDM files and processes them into yosys AST.
The plugin adds the following commands:
+
* read_systemverilog
* read_uhdm
diff --git a/design_introspection-plugin/tests/get_cells/get_cells.tcl b/design_introspection-plugin/tests/get_cells/get_cells.tcl
index 047b150..d077924 100644
--- a/design_introspection-plugin/tests/get_cells/get_cells.tcl
+++ b/design_introspection-plugin/tests/get_cells/get_cells.tcl
@@ -3,7 +3,7 @@
yosys -import ;# ingest plugin commands
read_verilog $::env(DESIGN_TOP).v
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
diff --git a/design_introspection-plugin/tests/get_nets/get_nets.tcl b/design_introspection-plugin/tests/get_nets/get_nets.tcl
index 6ef2426..5dc7ae4 100644
--- a/design_introspection-plugin/tests/get_nets/get_nets.tcl
+++ b/design_introspection-plugin/tests/get_nets/get_nets.tcl
@@ -3,7 +3,7 @@
yosys -import ;# ingest plugin commands
read_verilog $::env(DESIGN_TOP).v
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
diff --git a/design_introspection-plugin/tests/get_pins/get_pins.tcl b/design_introspection-plugin/tests/get_pins/get_pins.tcl
index d6a64fe..43ab60c 100644
--- a/design_introspection-plugin/tests/get_pins/get_pins.tcl
+++ b/design_introspection-plugin/tests/get_pins/get_pins.tcl
@@ -3,7 +3,7 @@
yosys -import ;# ingest plugin commands
read_verilog $::env(DESIGN_TOP).v
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
diff --git a/design_introspection-plugin/tests/get_ports/get_ports.tcl b/design_introspection-plugin/tests/get_ports/get_ports.tcl
index 47d8fce..7724e28 100644
--- a/design_introspection-plugin/tests/get_ports/get_ports.tcl
+++ b/design_introspection-plugin/tests/get_ports/get_ports.tcl
@@ -3,7 +3,7 @@
yosys -import ;# ingest plugin commands
read_verilog $::env(DESIGN_TOP).v
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
help get_ports
diff --git a/sdc-plugin/propagation.cc b/sdc-plugin/propagation.cc
index cfee89a..02fa865 100644
--- a/sdc-plugin/propagation.cc
+++ b/sdc-plugin/propagation.cc
@@ -225,7 +225,7 @@
RTLIL::Wire *wire = FindSinkWireOnPort(cell, output);
// Don't add clocks on dangling wires
// TODO Remove the workaround with the WireHasSinkCell check once the following issue is fixed:
- // https://github.com/SymbiFlow/yosys-symbiflow-plugins/issues/59
+ // https://github.com/SymbiFlow/yosys-f4pga-plugins/issues/59
if (wire && WireHasSinkCell(wire)) {
float clkout_period(pll.clkout_period.at(output));
float clkout_rising_edge(pll.clkout_rising_edge.at(output));
diff --git a/sdc-plugin/tests/set_clock_groups/set_clock_groups.tcl b/sdc-plugin/tests/set_clock_groups/set_clock_groups.tcl
index cefcaca..1994806 100644
--- a/sdc-plugin/tests/set_clock_groups/set_clock_groups.tcl
+++ b/sdc-plugin/tests/set_clock_groups/set_clock_groups.tcl
@@ -3,7 +3,7 @@
yosys -import ;# ingest plugin commands
read_verilog $::env(DESIGN_TOP).v
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
set_clock_groups -group clk1 clk2
diff --git a/sdc-plugin/tests/set_false_path/set_false_path.tcl b/sdc-plugin/tests/set_false_path/set_false_path.tcl
index 29c0178..e755e7e 100644
--- a/sdc-plugin/tests/set_false_path/set_false_path.tcl
+++ b/sdc-plugin/tests/set_false_path/set_false_path.tcl
@@ -3,7 +3,7 @@
yosys -import ;# ingest plugin commands
read_verilog $::env(DESIGN_TOP).v
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
# -to inter_wire net
diff --git a/sdc-plugin/tests/set_max_delay/set_max_delay.tcl b/sdc-plugin/tests/set_max_delay/set_max_delay.tcl
index 92d4c55..4957485 100644
--- a/sdc-plugin/tests/set_max_delay/set_max_delay.tcl
+++ b/sdc-plugin/tests/set_max_delay/set_max_delay.tcl
@@ -3,7 +3,7 @@
yosys -import ;# ingest plugin commands
read_verilog $::env(DESIGN_TOP).v
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
# -to inter_wire net
diff --git a/xdc-plugin/tests/counter-dict/counter-dict.tcl b/xdc-plugin/tests/counter-dict/counter-dict.tcl
index 91d4624..b6eb5b5 100644
--- a/xdc-plugin/tests/counter-dict/counter-dict.tcl
+++ b/xdc-plugin/tests/counter-dict/counter-dict.tcl
@@ -6,7 +6,7 @@
read_verilog $::env(DESIGN_TOP).v
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
#Read the design constraints
diff --git a/xdc-plugin/tests/counter/counter.tcl b/xdc-plugin/tests/counter/counter.tcl
index 0a3a62b..9347071 100644
--- a/xdc-plugin/tests/counter/counter.tcl
+++ b/xdc-plugin/tests/counter/counter.tcl
@@ -6,7 +6,7 @@
read_verilog $::env(DESIGN_TOP).v
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
#Read the design constraints
diff --git a/xdc-plugin/tests/io_loc_pairs/io_loc_pairs.tcl b/xdc-plugin/tests/io_loc_pairs/io_loc_pairs.tcl
index 7d99d29..d7f5506 100644
--- a/xdc-plugin/tests/io_loc_pairs/io_loc_pairs.tcl
+++ b/xdc-plugin/tests/io_loc_pairs/io_loc_pairs.tcl
@@ -12,7 +12,7 @@
hierarchy -check -top top
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp -run prepare:check
#Read the design constraints
diff --git a/xdc-plugin/tests/minilitex_ddr_arty/minilitex_ddr_arty.tcl b/xdc-plugin/tests/minilitex_ddr_arty/minilitex_ddr_arty.tcl
index 3c5fcd5..df2555c 100644
--- a/xdc-plugin/tests/minilitex_ddr_arty/minilitex_ddr_arty.tcl
+++ b/xdc-plugin/tests/minilitex_ddr_arty/minilitex_ddr_arty.tcl
@@ -6,7 +6,7 @@
read_verilog $::env(DESIGN_TOP).v
read_verilog [file dirname [info script]]/VexRiscv_Lite.v
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
#Read the design constraints
diff --git a/xdc-plugin/tests/non_zero_port_indexes/non_zero_port_indexes.tcl b/xdc-plugin/tests/non_zero_port_indexes/non_zero_port_indexes.tcl
index 60552c2..50872c0 100644
--- a/xdc-plugin/tests/non_zero_port_indexes/non_zero_port_indexes.tcl
+++ b/xdc-plugin/tests/non_zero_port_indexes/non_zero_port_indexes.tcl
@@ -11,7 +11,7 @@
hierarchy -check -top top
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp -run prepare:check
#Read the design constraints
diff --git a/xdc-plugin/tests/package_pins-dict-space/package_pins-dict-space.tcl b/xdc-plugin/tests/package_pins-dict-space/package_pins-dict-space.tcl
index 506097a..7625c92 100644
--- a/xdc-plugin/tests/package_pins-dict-space/package_pins-dict-space.tcl
+++ b/xdc-plugin/tests/package_pins-dict-space/package_pins-dict-space.tcl
@@ -5,7 +5,7 @@
read_verilog $::env(DESIGN_TOP).v
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
#Read the design constraints
diff --git a/xdc-plugin/tests/package_pins/package_pins.tcl b/xdc-plugin/tests/package_pins/package_pins.tcl
index 7f059e7..90298eb 100644
--- a/xdc-plugin/tests/package_pins/package_pins.tcl
+++ b/xdc-plugin/tests/package_pins/package_pins.tcl
@@ -5,7 +5,7 @@
read_verilog $::env(DESIGN_TOP).v
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
#Read the design constraints
diff --git a/xdc-plugin/tests/port_indexes/port_indexes.tcl b/xdc-plugin/tests/port_indexes/port_indexes.tcl
index 2472ffa..c2c148a 100644
--- a/xdc-plugin/tests/port_indexes/port_indexes.tcl
+++ b/xdc-plugin/tests/port_indexes/port_indexes.tcl
@@ -6,7 +6,7 @@
read_verilog $::env(DESIGN_TOP).v
# -flatten is used to ensure that the output eblif has only one module.
-# Some of symbiflow expects eblifs with only one module.
+# Some of F4PGA expects eblifs with only one module.
synth_xilinx -flatten -abc9 -nosrl -noclkbuf -nodsp
if {[info procs unknown] != ""} {
