Merge pull request #107 from d-m-bailey/enhanced-oeb

Enhanced oeb checks for caravel/caravan/openframe

Author: jdicorpo

.github/workflows/precheck_test.yml

@@ -22,18 +22,30 @@ jobs:
       fail-fast: false
 
     steps:
+    - name: Checkout current repo
+      uses: actions/checkout@v4
+
     - name: Checkout mpw_precheck
       uses: actions/checkout@v4
       with:
         repository: chipfoundry/mpw_precheck
         path: mpw_precheck
 
     - name: Checkout ${{ matrix.repo }}
+      if: matrix.repo != 'openframe_user_project'
       uses: actions/checkout@v4
       with:
         repository: chipfoundry/${{ matrix.repo }}
         path: ${{ matrix.repo }}
 
+    - name: Checkout ${{ matrix.repo }} using development branch to pass OEB check
+      if: matrix.repo == 'openframe_user_project'
+      uses: actions/checkout@v4
+      with:
+        repository: d-m-bailey/openframe_user_project-cf
+        path: ${{ matrix.repo }}
+        ref: CF_gpio_config
+
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v2
 
@@ -53,8 +65,8 @@ jobs:
           --cache-to=type=local,dest=/tmp/.buildx-cache-new,mode=max \
           --output type=docker \
           --tag mpw_precheck:latest \
-          mpw_precheck/dependencies
-      timeout-minutes: 30
+          ${{ github.workspace }}/dependencies
+      timeout-minutes: 45
 
     - name: Move cache
       run: |
@@ -66,13 +78,34 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ${{ github.workspace }}/pdk
-        key: ${{ runner.os }}-pdk-${{ hashFiles('**/volare.toml') }}
+        key: ${{ runner.os }}-pdk-${{ hashFiles('**/ciel.toml') }}
+
+    - name: Temporarily update caravan gpio definitions to pass OEB check
+      if: matrix.repo == 'caravel_user_project_analog'
+      run: |
+        gawk -i inplace '\
+          /USER_CONFIG_GPIO_11_/ {sub(/INVALID/, "USER_STD_OUTPUT"); print; next} \
+          /USER_CONFIG_GPIO_12_/ {sub(/INVALID/, "USER_STD_OUTPUT"); print; next} \
+          /USER_CONFIG_GPIO_26_/ {sub(/INVALID/, "USER_STD_OUTPUT"); print; next} \
+          /USER_CONFIG_GPIO_27_/ {sub(/INVALID/, "USER_STD_OUTPUT"); print; next} \
+          {sub(/INVALID/, "MGMT_STD_ANALOG"); print}' caravel_user_project_analog/verilog/rtl/user_defines.v
+        cat caravel_user_project_analog/verilog/rtl/user_defines.v
+
+    - name: Temporarily update caravel gpio definitions to pass OEB check
+      if: matrix.repo == 'caravel_user_project'
+      run: |
+        gawk -i inplace '\
+          /USER_CONFIG_GPIO_[567]_/ {sub(/INVALID/, "USER_STD_OUTPUT"); print; next} \
+          /USER_CONFIG_GPIO_3._/ {sub(/INVALID/, "USER_STD_OUTPUT"); print; next} \
+          {sub(/INVALID/, "MGMT_STD_ANALOG"); print}' caravel_user_project/verilog/rtl/user_defines.v
+        cat caravel_user_project/verilog/rtl/user_defines.v
 
-    - name: Install Volare and PDK
+    - name: Install ciel and PDK
       if: steps.cache-pdk.outputs.cache-hit != 'true'
       run: |
-        python3 -m pip install --upgrade --no-cache-dir volare
-        volare enable 6d4d11780c40b20ee63cc98e645307a9bf2b2ab8 --pdk-root ${{ github.workspace }}/pdk
+        python3 -m pip install --upgrade --no-cache-dir ciel
+        export CIEL_DATA_SOURCE=static-web:https://chipfoundry.github.io/ciel-releases
+        ciel enable 3e0e31dcce8519a7dbb82590346db16d91b7244f --pdk-root ${{ github.workspace }}/pdk --pdk sky130A
       env:
         PDK_ROOT: ${{ github.workspace }}/pdk
 
@@ -88,16 +121,24 @@ jobs:
           SKIP_ARGS="--skip-checks ${{ matrix.skip_checks }}"
         fi
 
-        docker run \
+        docker run --rm \
           -v "$INPUT_DIR":"$INPUT_DIR" \
           -v "$PDK_ROOT":"$PDK_ROOT" \
+          -v ${{ github.workspace }}:/work/cf-precheck \
+          -e PDK_ROOT="$PDK_ROOT" \
+          -e PDK_PATH="$PDK_PATH" \
+          -e PDKPATH="$PDK_PATH" \
+          -e PYTHONPATH=/work/cf-precheck/src \
           mpw_precheck:latest \
-          cf-precheck \
-            -i "$INPUT_DIR" \
-            -p "$PDK_PATH" \
-            -c /opt/caravel \
-            -o "$OUTPUT_DIR" \
-            $SKIP_ARGS
+          bash -lc "
+            python3 -c \"import cf_precheck; print(cf_precheck.__file__)\"
+            python3 -m cf_precheck \
+              -i \"$INPUT_DIR\" \
+              -p \"$PDK_PATH\" \
+              -c /opt/caravel \
+              -o \"$OUTPUT_DIR\" \
+              $SKIP_ARGS
+          "
 
     - name: Upload Precheck results
       uses: actions/upload-artifact@v4

dependencies/Dockerfile

@@ -22,7 +22,7 @@ FROM rockylinux:9.3 as build
 RUN dnf -y update
 RUN dnf -y groupinstall "Development Tools"
 
-RUN dnf -y install cairo-devel csh gperf && \
+RUN dnf -y install cairo-devel csh gperf libcurl-devel expat-devel zlib-devel && \
     dnf -y install mesa-libGLU mesa-libGLU-devel ncurses-devel python3-devel python3-tkinter && \
     dnf -y install readline-devel tcl-devel time.x86_64 tk tk-devel wget Xvfb && \
     dnf -y --enablerepo=crb install epel-release nasm && \
@@ -67,7 +67,7 @@ RUN ./configure --prefix=/build && make -j4 && make install
 # Clone cvc
 RUN dnf -y --enablerepo=crb install libstdc++-static
 ENV CVC_ROOT=./cvc_rv
-RUN git clone --depth=1 --branch v1.1.5 https://github.com/d-m-bailey/cvc.git ${CVC_ROOT}
+RUN git clone --depth=1 --branch v1.1.7 https://github.com/d-m-bailey/cvc.git ${CVC_ROOT}
 WORKDIR $CVC_ROOT
 RUN autoreconf -vif && ./configure --disable-nls --prefix=/build && sed -i 's/api.parser.class/parser_class_name/' src/cdlParser.yy && make -j4 && make install
 

src/cf_precheck/__init__.py

@@ -1 +1 @@
-__version__ = "1.1.0"
+__version__ = "1.2.0"

src/cf_precheck/be_checks/README.md

@@ -147,17 +147,11 @@ Optional variable lists: `*` may be used as a wild card character.
    - If the log file shows errors, look for details in the error file.
    - Error device locations can be found in the respective `precheck_results/<tag>/tmp/ext/*.ext` files. (coordinates should be divided by 200).
 
-5. OEB check. Check for user oeb signal output to gpio cells.
-   The following conditions are errors.
-   - gpio with both digital (io_in/io_out) and analog (analog_io/gpio_analog) connections
-   - gpio with analog (analog_io/gpio_analog) and oeb not high
-   - gpio with only input (io_in) but oeb not high
-   - gpio with output (io_out) but oeb never low
-   The following condition is a warning.
-   - gpio with both input (io_in) and output (io_out) and oeb always low
+5. OEB check. Check user connections to gpio against configuration.
+   See [Chipfoundry gpio configuration checks](https://docs.google.com/spreadsheets/d/1nYYAiqxi1V9ZBvW9GzFHaRDODuWXLOA9Znsbq4re1Ek/edit?usp=sharing) for a table of ERRORS and warnings.
 
    Output:
-   - `precheck_results/<tag>/tmp/ext/<top_layout>.cdl.gz`: CDL file converted from extracted spice file.
-   - `precheck_results/<tag>/tmp/cvc.oeb.error.gz`: Detailed errors results.
+   - `precheck_results/<tag>/tmp_oeb/<top_layout>.cdl.gz`: CDL file converted from extracted spice file.
+   - `precheck_results/<tag>/tmp_oeb/cvc.oeb.error.gz`: Detailed errors results.
    - `precheck_results/<tag>/logs/cvc.oeb.log`: Log file with error summary.
    - `precheck_results/<tag>/outputs/reports/cvc.oeb.report`: List of each gpio, connection counts, and errors

src/cf_precheck/be_checks/run_be_checks

@@ -32,6 +32,7 @@ SKIP_OEB=no
 while [[ "$1" == "--"* ]]; do
 	if [[ "$1" == "--noextract" ]]; then
 		export EXTRACT_LAYOUT=no
+		extract_option="--noextract"
 		shift
 	elif [[ "$1" == "--nooeb" ]]; then
 		SKIP_OEB=yes
@@ -106,15 +107,17 @@ start_time=$SECONDS
 $LVS_ROOT/run_hier_check $TOP_SOURCE "$(echo $LVS_VERILOG_FILES | sed 's/#[^ ]*//g')" $TOP_LAYOUT $LAYOUT_FILE "${PDK%?}_([^/_]*_)*_"
 hier_status=$?
 
-if [[ $EXTRACT_LAYOUT == yes ]]; then
-	$LVS_ROOT/run_scheck
+# Default is to not run softcheck - only run softcheck if RUN_SOFTCHECK is set to 1.
+# If softcheck is run, subsequent extractions are not needed.
+if [[ "$RUN_SOFTCHECK" == 1 ]]; then
+	$LVS_ROOT/run_scheck $extract_option
 	scheck_status=$?
+	extract_option="--noextract"
 else
-	$LVS_ROOT/run_scheck --noextract
-	scheck_status=$?
+	scheck_status=""
 fi
 
-$LVS_ROOT/run_full_lvs --noextract
+$LVS_ROOT/run_full_lvs $extract_option
 lvs_status=$?
 
 if [[ -f $LVS_ROOT/tech/$PDK/cvc.power.$TOP_SOURCE || -f ${CONFIG_FILE%/*}/cvc.power.$TOP_SOURCE ]]; then
@@ -130,15 +133,17 @@ if [[ $TOP_SOURCE == *user_*project* && $SKIP_OEB == no ]]; then
 	oeb_status=$?
 fi
 
-echo "
+if [[ -f $LOG_ROOT/soft.log ]]; then
+	echo "
 Soft check result:"
-tail -n 20 $LOG_ROOT/soft.log | awk '/Final result/,/Logging/' | grep -v ^Logging
-if [[ $scheck_status -ne 0 ]]; then
-	echo "Soft check problem: check the following files
+	tail -n 20 $LOG_ROOT/soft.log | awk '/Final result/,/Logging/' | grep -v ^Logging
+	if [[ $scheck_status -ne 0 ]]; then
+		echo "Soft check problem: check the following files
 $LOG_ROOT/ext.log
 $LOG_ROOT/nowell.ext.log
 $LOG_ROOT/soft.log
 $SIGNOFF_ROOT/soft.report"
+	fi
 fi
 
 echo "
@@ -172,23 +177,19 @@ printf "\nRuntime: %d:%02d:%02d (hh:mm:ss)\n" $hours $minutes $seconds
 
 # If any of the checks had an error, set return code.
 # NOTE: ignores hierarchy check errors
-# NOTE: cvc_status and oeb_status ignored if not run
-if [[ $scheck_status -eq 0 && $lvs_status -eq 0 && ${cvc_status:=0} -eq 0 && ${oeb_status:=0} -eq 0 ]]; then
+# NOTE: scheck_status, cvc_status and oeb_status ignored if not run
+if [[ ${scheck_status:-0} -eq 0 && $lvs_status -eq 0 && ${cvc_status:-0} -eq 0 && ${oeb_status:-0} -eq 0 ]]; then
 	echo "
 No errors detected"
 	exit 0
 
-elif [[ $scheck_status -eq 0 && $lvs_status -eq 0 && ${cvc_status:=0} -eq 4 && ${oeb_status:=0} -eq 0 ]]; then
+elif [[ ${scheck_status:-0} -eq 0 && $lvs_status -eq 0 && ${cvc_status:-0} -ne 0 && ${oeb_status:-0} -eq 0 ]]; then
 	echo "
 WARNING: possible errors CVC $cvc_status"
 	exit 4
 
-elif [[ $SKIP_OEB == no ]]; then
-	echo "
-WARNING: possible errors SOFT $scheck_status LVS $lvs_status CVC $cvc_status OEB $oeb_status"
-	exit 1
 else
 	echo "
-WARNING: possible errors SOFT $scheck_status LVS $lvs_status CVC $cvc_status"
+WARNING: possible errors SOFT ${scheck_status:--} LVS $lvs_status CVC ${cvc_status:--} OEB ${oeb_status:--}"
 	exit 1
 fi

src/cf_precheck/be_checks/run_extract

@@ -65,14 +65,32 @@ fi
 echo "LOG FILE: $LOG_ROOT/${LOG_FILE:=ext.log}"
 rm -f $LOG_ROOT/$LOG_FILE $WORK_ROOT/$LOG_FILE
 
-if cmp -s $PDK_ROOT/$PDK/libs.tech/magic/$PDK.tech $LVS_ROOT/tech/$PDK/$PDK.tech; then
-	awk 'NF > 1 && /version/' $LVS_ROOT/tech/$PDK/$PDK.tech
+# Add subcut output to tech file, if needed
+if grep -q '^style subcutout' $PDK_ROOT/$PDK/libs.tech/magic/${PDK}.tech; then
+	echo "Tech file already contains subcutout style. Patch not necessary."
+	cp $PDK_ROOT/$PDK/libs.tech/magic/${PDK}.tech $WORK_ROOT/.
 else
-	echo "Tech files do not match:"
-	grep version $PDK_ROOT/$PDK/libs.tech/magic/$PDK.tech $LVS_ROOT/tech/$PDK/$PDK.tech |
-		awk 'NF > 2 && ! /^ *#/'
-	echo "Results may be incorrect. Contact efabless to update the soft connection rules."
-	#exit 1
+	echo "Adding subcutout style to tech file."
+	awk '
+	/^cifoutput/ {searching=1}
+	searching && /^end$/ {
+		print BLOCK
+		searching=0
+	}
+	{print}
+	' BLOCK="$(cat $LVS_ROOT/tech/$PDK/subcutout.txt)" $PDK_ROOT/$PDK/libs.tech/magic/$PDK.tech >$WORK_ROOT/$PDK.tech
+fi
+
+grep -H version $PDK_ROOT/$PDK/libs.tech/magic/$PDK.tech |
+	awk 'NF > 2 && ! /^ *#/'
+if [[ "${EXTRACT_STYLE:-}" == "nowell" ]]; then
+	if ! cmp -s $PDK_ROOT/$PDK/libs.tech/magic/$PDK.tech $LVS_ROOT/tech/$PDK/$PDK.tech; then
+		grep -H version $LVS_ROOT/tech/$PDK/$PDK.tech |
+			awk 'NF > 2 && ! /^ *#/'
+		echo "Tech files do not match:"
+		echo "Results may be incorrect. Contact support to update the soft connection rules."
+		#exit 1
+	fi
 fi
 
 if [[ ! -f $WORK_ROOT/layout.cells ]]; then