precheck_test.yml

name: Precheck CI

on:
  push:
  pull_request:
  workflow_dispatch:

jobs:
  precheck:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - repo: 'caravel_user_project'
            skip_checks: 'gpio_defines'
          - repo: 'caravel_user_sram'
            skip_checks: 'gpio_defines lvs'
          - repo: 'caravel_user_project_analog'
            skip_checks: 'gpio_defines lvs'
          - repo: 'openframe_user_project'
            skip_checks: ''
      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

    - name: Cache Docker layers
      uses: actions/cache@v4
      with:
        path: /tmp/.buildx-cache
        key: ${{ runner.os }}-buildx-${{ hashFiles('mpw_precheck/dependencies/Dockerfile') }}
        restore-keys: |
          ${{ runner.os }}-buildx-

    - name: Build Docker image
      run: |
        docker buildx create --use
        docker buildx build \
          --cache-from=type=local,src=/tmp/.buildx-cache \
          --cache-to=type=local,dest=/tmp/.buildx-cache-new,mode=max \
          --output type=docker \
          --tag mpw_precheck:latest \
          ${{ github.workspace }}/dependencies
      timeout-minutes: 45

    - name: Move cache
      run: |
        rm -rf /tmp/.buildx-cache
        mv /tmp/.buildx-cache-new /tmp/.buildx-cache

    - name: Cache PDK
      id: cache-pdk
      uses: actions/cache@v4
      with:
        path: ${{ github.workspace }}/pdk
        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 ciel and PDK
      if: steps.cache-pdk.outputs.cache-hit != 'true'
      run: |
        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

    - name: Run Precheck
      run: |
        INPUT_DIR=${{ github.workspace }}/${{ matrix.repo }}
        OUTPUT_DIR=$INPUT_DIR/precheck_results
        PDK_ROOT=${{ github.workspace }}/pdk
        PDK_PATH=$PDK_ROOT/sky130A

        SKIP_ARGS=""
        if [ -n "${{ matrix.skip_checks }}" ]; then
          SKIP_ARGS="--skip-checks ${{ matrix.skip_checks }}"
        fi

        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 \
          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
      if: failure()
      with:
        name: precheck-results-${{ matrix.repo }}
        path: ${{ github.workspace }}/${{ matrix.repo }}/precheck_results