name: Tape Out CI

# Tape outs require much more CPU and RAM than github runners provide
# (currently 2 VCPUs and 7GB RAM), so we run the tape out manually but
# trigger the tape out CI on push of the GDS.

on:
  push:
    paths: 'gds/user_project_wrapper.gds*'
  pull_request:
    paths: 'gds/user_project_wrapper.gds*'
  workflow_dispatch:

jobs:
  mpw_precheck:
    timeout-minutes: 720
    runs-on: ubuntu-22.04

    env:
          PDK: sky130B
          PDK_ROOT: ${{ github.workspace }}/pdk
          PDKPATH: ${{ github.workspace }}/pdk/sky130B
          # Make sure this doesn't overlap the caravel_user_project/openlane directory 
          OPENLANE_ROOT: ${{ github.workspace }}/Openlane
          INPUT_DIRECTORY: ${{ github.workspace }}
          PRECHECK_ROOT: ${{ github.workspace }}/mpw_precheck
          OUTPUT_DIRECTORY: ${{ github.workspace }}/mpw_precheck_result
          OUTPUT: ${{ github.workspace }}/mpw_precheck_result/logs/precheck.log

    steps:
      - uses: actions/checkout@v3

      - name: Install dependencies
        run: |
          sudo mkdir -p $PDK_ROOT
          sudo chown -R $USER:$USER $PDK_ROOT
          make install
          make openlane
          make pdk-with-volare
          .github/sram_no_verbose.sh

      - name: Run MPW-Precheck
        run: |
          git clone --depth=1 -b mpw-7a https://github.com/efabless/mpw_precheck.git

          docker run -v "$PRECHECK_ROOT":"$PRECHECK_ROOT" -v "$INPUT_DIRECTORY":"$INPUT_DIRECTORY" -v "$PDK_ROOT":"$PDK_ROOT" -e INPUT_DIRECTORY="$INPUT_DIRECTORY" -e PDK_ROOT="$PDK_ROOT" -e PDKPATH="$PDKPATH" -u $(id -u "$USER"):$(id -g "$USER") efabless/mpw_precheck:latest bash -c "cd $PRECHECK_ROOT; python3 mpw_precheck.py --input_directory $INPUT_DIRECTORY --pdk_path $PDKPATH --output_directory $OUTPUT_DIRECTORY license makefile consistency xor magic_drc klayout_beol klayout_feol klayout_met_min_ca_density klayout_offgrid klayout_pin_label_purposes_overlapping_drawing klayout_zeroarea"

          cnt=$(grep -c "All Checks Passed" "$OUTPUT")
          if ! [[ $cnt ]]; then cnt=0; fi
          if [[ $cnt -eq 1 ]]; then exit 0; fi
          exit 2
      - name: upload failure logs
        if: failure()
        uses: actions/upload-artifact@v3
        with:
          name: mpw_precheck.error
          path: |
            ${{ github.workspace }}/mpw_precheck_result/logs/*

  gl_tests:
    timeout-minutes: 60
    runs-on: ubuntu-22.04
    strategy:
      fail-fast: false
      max-parallel: 3
      matrix:
        task: [
          "jtag",
          #"minimal",
          #"uart",
          #"memory_test",
          #"spi_flash",
          #"simplebus_minimal",
          #"simplebus_micropython",
        ]

    steps:
      - uses: actions/checkout@v3

      - name: Create environment variables
        run: |
          echo "PDK=sky130B" >> $GITHUB_ENV
          echo "PDK_ROOT=/home/runner/work/pdk" >> $GITHUB_ENV
          echo "OPENLANE_ROOT=/home/runner/work/caravel_user_project/openlane" >> $GITHUB_ENV

      - name: Install packages
        run: |
          sudo apt-get -y install iverilog gcc-powerpc64le-linux-gnu

      - name: Install dependencies
        run: |
          sudo mkdir -p ${{ env.PDK_ROOT }}
          sudo chown -R $USER:$USER ${{ env.PDK_ROOT }}
          make install
          make install_mcw
          make openlane
          make pdk-with-volare
          .github/sram_no_verbose.sh
          make gpio_defaults

      - name: Run test
        run: |
          cd verilog/dv/microwatt/${{ matrix.task }}
          make SIM=GL