add yosys-plugins

.clang-format

@@ -0,0 +1,12 @@
+# Default Linux style
+BasedOnStyle: LLVM
+IndentWidth: 4
+UseTab: Never
+BreakBeforeBraces: Linux
+AllowShortIfStatementsOnASingleLine: false
+IndentCaseLabels: false
+
+# From CodingReadme
+TabWidth: 4
+ContinuationIndentWidth: 2
+ColumnLimit: 150

.editorconfig

@@ -0,0 +1,16 @@
+# Editor config file, see http://editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{h,cc,tcl}]
+indent_style = space
+indent_size = 4
+
+[*.{v,sv}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -1 +1,11 @@
-/.gitcommit export-subst
+/.gitcommit export-subst
+
+# Settings to improve linguist data reporting (used by GitHub)
+*.v                     linguist-language=Verilog
+*.vh                    linguist-language=Verilog
+*.sql                   linguist-language=SQL
+
+third_party/**          linguist-vendored
+
+# FIXME: All vendor files should be under third_party
+yosys-plugins/xdc/tests/minilitex_ddr_arty/**     linguist-vendored

.github/scripts/build-and-test.sh

@@ -0,0 +1,50 @@
+#! /bin/bash
+# Copyright 2020-2022 F4PGA 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+set -e
+
+source .github/scripts/common.sh
+
+##########################################################################
+
+start_section Building
+
+export CXXFLAGS=-Werror
+make -C yosys-plugins UHDM_INSTALL_DIR=`pwd`/yosys-plugins/env/conda/envs/yosys-plugins/ plugins -j`nproc`
+unset CXXFLAGS
+
+end_section
+
+##########################################################################
+
+start_section Installing
+make -C yosys-plugins install -j`nproc`
+end_section
+
+##########################################################################
+
+start_section Testing
+make -C yosys-plugins test -j`nproc`
+end_section
+
+##########################################################################
+
+start_section Cleanup
+make -C yosys-plugins plugins_clean -j`nproc`
+end_section
+
+##########################################################################

.github/scripts/common.sh

@@ -0,0 +1,54 @@
+#! /bin/bash
+# Copyright 2020-2022 F4PGA 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# Look for location binaries first
+export PATH="$HOME/.local-bin/bin:$PATH"
+
+# OS X specific common setup
+if [[ "x${OS}" == "xmacOS" ]]; then
+	export PATH="/usr/local/opt/ccache/libexec:$PATH"
+fi
+
+# Parallel builds!
+MAKEFLAGS="-j 2"
+
+function action_fold() {
+	if [ "$1" = "start" ]; then
+		echo "::group::$2"
+		SECONDS=0
+	else
+		duration=$SECONDS
+		echo "::endgroup::"
+		printf "${GRAY}took $(($duration / 60)) min $(($duration % 60)) sec.${NC}\n"
+	fi
+	return 0;
+}
+
+function start_section() {
+	action_fold start "$1"
+	echo -e "${PURPLE}SymbiFlow Yosys Plugins${NC}: - $2${NC}"
+	echo -e "${GRAY}-------------------------------------------------------------------${NC}"
+}
+
+export -f start_section
+
+function end_section() {
+	echo -e "${GRAY}-------------------------------------------------------------------${NC}"
+	action_fold end "$1"
+}
+
+export -f end_section

.github/scripts/setup.sh

@@ -0,0 +1,69 @@
+#! /bin/bash
+# Copyright 2020-2022 F4PGA 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+set -e
+
+source .github/scripts/common.sh
+
+##########################################################################
+
+# Output status information.
+start_section Status
+(
+    set +e
+    set -x
+    git status
+    git branch -v
+    git log -n 5 --graph
+    git log --format=oneline -n 20 --graph
+)
+end_section
+
+##########################################################################
+
+# Update submodules
+start_section Submodules
+(
+    git submodule update --init --recursive
+)
+end_section
+
+##########################################################################
+
+#Install yosys
+start_section Install-Yosys
+(
+    echo '================================='
+    echo 'Making env with Yosys and Surelog'
+    echo '================================='
+    make -C yosys-plugins env
+    source yosys-plugins/env/conda/bin/activate yosys-plugins
+    conda list
+)
+end_section
+
+##########################################################################
+
+start_section Yosys-Version
+(
+    source yosys-plugins/env/conda/bin/activate yosys-plugins
+    echo $(which yosys)
+    echo $(which yosys-config)
+    echo $(yosys --version)
+    echo $(yosys-config --datdir)
+)
+end_section

.github/workflows/Pipeline.yml

@@ -35,6 +35,13 @@ jobs:
 
       - name: Check Licenses
         uses: SymbiFlow/actions/checks@main
+        with:
+          exclude_license: |
+            ./yosys-plugins/design_introspection/tests/selection_to_tcl_list/selection_to_tcl_list.v
+            ./third_party/minilitex_ddr_arty/minilitex_ddr_arty.v
+            ./third_party/VexRiscv_Lite/VexRiscv_Lite.v
+          #third_party: |
+          #  ./third_party/googletest/
 
 
   Format:
@@ -276,3 +283,62 @@ jobs:
         run: |
           PYTHONPATH=$(pwd) python3 -m f4pga
           PYTHONPATH=$(pwd) python3 -m f4pga -h
+
+
+  Yosys-plugins:
+    name: 🔌 Plugins
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: 🧰 Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: 🐍 Setup Python
+        uses: actions/setup-python@v4
+
+      - name: 🔧 Install
+        run: |
+          sudo apt-get update
+          sudo apt-get install \
+            bison \
+            build-essential \
+            clang-format-8 \
+            cmake \
+            flex \
+            g++-9 \
+            gawk \
+            git \
+            graphviz \
+            libffi-dev \
+            libboost-system-dev \
+            libboost-python-dev \
+            libboost-filesystem-dev \
+            libreadline-dev \
+            pkg-config \
+            tcl-dev \
+            xdot \
+            zlib1g-dev
+
+      - name: Format
+        run: |
+          set -e
+          source .github/scripts/common.sh
+          make -C yosys-plugins format -j`nproc`
+          test $(git status --porcelain | wc -l) -eq 0 || { git diff; false; }
+
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1
+
+      - name: 🔧 Install Yosys
+        run: |
+          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+          source .github/scripts/setup.sh
+
+      - name: 🚧 Build and test plugins
+        run: |
+          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+          source yosys-plugins/env/conda/bin/activate yosys-plugins
+          source .github/scripts/build-and-test.sh

.gitignore

@@ -1,3 +1,10 @@
 *.pyc
 *.sw*
 /f4pga/build/
+
+*.d
+*.o
+*.so
+*.swp
+*.log
+yosys-plugins/ql-qlf/pmgen/*

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "third_party/make-env"]
 	path = third_party/make-env
-	url = https://github.com/SymbiFlow/make-env/
+	url = https://github.com/SymbiFlow/make-env
+[submodule "third_party/googletest"]
+	path = third_party/googletest
+	url = https://github.com/google/googletest

third_party/VexRiscv_Lite/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Spinal HDL contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

third_party/VexRiscv_Lite/README.yosys-symbiflow-plugins

@@ -0,0 +1,9 @@
+Name: This repository hosts a RISC-V implementation written in SpinalHDL.
+Short Name: VexRiscv
+URL: https://github.com/SpinalHDL/VexRiscv
+Version: 0
+Date: 16/06/2019
+License: MIT License
+
+Description:
+This package is used as stimuli in some test cases that verify that the Yosys plugins produce expected results.