cf-precheck 1.0.0__tar.gz

cf_precheck-1.0.0/.github/workflows/precheck_test.yml

@@ -0,0 +1,118 @@
+name: MPW Precheck
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  mpw-precheck:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - repo: 'caravel_user_project'
+            skip_checks: 'default gpio_defines'
+          # - repo: 'caravel_user_mini'
+          #   skip_checks: ''
+          - repo: 'caravel_user_sram'
+            skip_checks: 'gpio_defines lvs'
+          - repo: 'caravel_user_project_analog'
+            skip_checks: 'default gpio_defines lvs'
+          - repo: 'openframe_user_project'
+            skip_checks: ''
+      fail-fast: false
+
+    steps:
+    - name: Checkout chipfoundry/mpw_precheck
+      uses: actions/checkout@v4
+      with:
+        repository: chipfoundry/mpw_precheck
+        path: mpw_precheck
+
+    - name: Checkout ${{ matrix.repo }}
+      uses: actions/checkout@v4
+      with:
+        repository: chipfoundry/${{ matrix.repo }}
+        path: ${{ matrix.repo }}
+
+    - 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 \
+          mpw_precheck/dependencies
+      timeout-minutes: 30  # Increased timeout to 30 minutes
+
+    - 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('**/volare.toml') }}
+
+    - name: Install Volare 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
+      env:
+        PDK_ROOT: ${{ github.workspace }}/pdk
+
+    - name: Run MPW Precheck
+      run: |
+        export INPUT_DIRECTORY=${{ github.workspace }}/${{ matrix.repo }}
+        export PRECHECK_ROOT=${{ github.workspace }}/mpw_precheck
+        export OUTPUT_DIRECTORY=$INPUT_DIRECTORY/mpw_precheck_result
+        export OUTPUT=$OUTPUT_DIRECTORY/logs/precheck.log
+        export PDK_ROOT=${{ github.workspace }}/pdk
+        export PDKPATH=$PDK_ROOT/sky130A
+        
+        SKIP_CHECKS_ARG=""
+        if [ -n "${{ matrix.skip_checks }}" ]; then
+          SKIP_CHECKS_ARG="--skip_checks ${{ matrix.skip_checks }}"
+        fi
+
+        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") \
+                   mpw_precheck:latest \
+                   bash -c "cd $PRECHECK_ROOT && python3 mpw_precheck.py --input_directory $INPUT_DIRECTORY --pdk_path $PDKPATH --output_directory $OUTPUT_DIRECTORY --skip_checks $SKIP_CHECKS_ARG"
+
+        if grep -q "All Checks Passed" "$OUTPUT"; then
+          echo "All checks passed for ${{ matrix.repo }}"
+          exit 0
+        else
+          echo "Checks failed for ${{ matrix.repo }}"
+          exit 1
+        fi
+
+    - name: Upload MPW Precheck output
+      uses: actions/upload-artifact@v4
+      if: failure()
+      with:
+        name: mpw-precheck-results-${{ matrix.repo }}
+        path: ${{ github.workspace }}/${{ matrix.repo }}/mpw_precheck_result

cf_precheck-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Publish Python Package to PyPI
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: Install build tools
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_TOKEN }}

cf_precheck-1.0.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.pyc
+*.pyo
+parser.out
+parsetab.py
+.DS_Store
+
+/.idea/
+/.vscode/
+
+/build/
+/dist/
+*.egg-info/
+/venv/
+
+dependencies/logs/docker/mpw_precheck.build.txt

cf_precheck-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

cf_precheck-1.0.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: cf-precheck
+Version: 1.0.0
+Summary: ChipFoundry MPW tapeout precheck tool
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: klayout
+Requires-Dist: numpy
+Requires-Dist: pyverilog
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: rich
+Requires-Dist: strsimpy
+Description-Content-Type: text/markdown
+
+# cf-precheck
+
+ChipFoundry MPW tapeout precheck tool. Validates user projects before shuttle submission by running a sequence of design-rule and consistency checks.
+
+## Installation
+
+```bash
+pip install cf-precheck
+```
+
+### External tool dependencies
+
+Some checks invoke external EDA tools that must be available on `$PATH`:
+
+- [KLayout](https://www.klayout.de/) — used by all Klayout DRC checks and the XOR check
+- [Magic](http://opencircuitdesign.com/magic/) — used by the optional Magic DRC check and LVS
+- [Netgen](http://opencircuitdesign.com/netgen/) — used by the LVS check
+
+## Usage
+
+```
+cf-precheck -i <project_dir> -p <pdk_path> -c <caravel_root> [options] [check ...]
+```
+
+### Required arguments
+
+| Flag | Description |
+|------|-------------|
+| `-i`, `--input-directory` | Path to the user project directory |
+| `-p`, `--pdk-path` | Path to the PDK installation (variant-specific, e.g. `$PDK_ROOT/sky130A`) |
+| `-c`, `--caravel-root` | Path to the golden Caravel root (or set `$GOLDEN_CARAVEL`) |
+
+### Optional arguments
+
+| Flag | Description |
+|------|-------------|
+| `-o`, `--output-directory` | Output directory (default: `<project>/precheck_results/<timestamp>`) |
+| `--magic-drc` | Include the Magic DRC check (off by default) |
+| `--skip-checks check [...]` | Skip specific checks |
+| `-v`, `--verbose` | Show verbose/debug output |
+| `--version` | Print version and exit |
+
+### Positional arguments
+
+Pass one or more check names to run only those checks. If omitted, all applicable checks are run.
+
+### Example
+
+```bash
+# Run all checks
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel
+
+# Run only specific checks
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel topcell_check gpio_defines
+
+# Include the optional Magic DRC check
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel --magic-drc
+
+# Skip certain checks
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel --skip-checks lvs oeb
+```
+
+## Checks
+
+| Check | Description |
+|-------|-------------|
+| `topcell_check` | Validates the top cell name in the GDS |
+| `gpio_defines` | Validates GPIO directives in `verilog/rtl/user_defines.v` |
+| `pdn` | Power distribution network check |
+| `metal_check` | Metal density check |
+| `xor` | XOR comparison against the golden wrapper to detect out-of-bounds edits |
+| `magic_drc` | Full DRC using Magic *(optional, off by default)* |
+| `klayout_feol` | Klayout Front End Of Line DRC |
+| `klayout_beol` | Klayout Back End Of Line DRC |
+| `klayout_offgrid` | Klayout off-grid violations check |
+| `klayout_metal_minimum_clear_area_density` | Klayout metal density check |
+| `klayout_pin_label_purposes_overlapping_drawing` | Klayout pin/label overlap check |
+| `klayout_zero_area` | Klayout zero-area cell check |
+| `spike_check` | Detects voltage spikes in the design |
+| `illegal_cellname_check` | Detects cells with illegal names |
+| `oeb` | Output-enable-bar signal connectivity check |
+| `lvs` | Layout vs. Schematic check |
+
+## Results
+
+Check results are saved to `<project>/.cf/project.json` under the `precheck` key:
+
+```json
+{
+  "precheck": {
+    "version": "1.0.0",
+    "timestamp": "2026-03-17T12:00:00+00:00",
+    "pdk": "sky130A",
+    "passed": false,
+    "checks": {
+      "topcell_check": { "status": "pass", "duration_s": 1.2 },
+      "gpio_defines": { "status": "fail", "duration_s": 0.8, "details": "..." }
+    }
+  }
+}
+```
+
+Detailed logs are written to `<project>/precheck_results/<timestamp>/logs/precheck.log`.
+
+## License
+
+Apache-2.0

cf_precheck-1.0.0/README.md

@@ -0,0 +1,107 @@
+# cf-precheck
+
+ChipFoundry MPW tapeout precheck tool. Validates user projects before shuttle submission by running a sequence of design-rule and consistency checks.
+
+## Installation
+
+```bash
+pip install cf-precheck
+```
+
+### External tool dependencies
+
+Some checks invoke external EDA tools that must be available on `$PATH`:
+
+- [KLayout](https://www.klayout.de/) — used by all Klayout DRC checks and the XOR check
+- [Magic](http://opencircuitdesign.com/magic/) — used by the optional Magic DRC check and LVS
+- [Netgen](http://opencircuitdesign.com/netgen/) — used by the LVS check
+
+## Usage
+
+```
+cf-precheck -i <project_dir> -p <pdk_path> -c <caravel_root> [options] [check ...]
+```
+
+### Required arguments
+
+| Flag | Description |
+|------|-------------|
+| `-i`, `--input-directory` | Path to the user project directory |
+| `-p`, `--pdk-path` | Path to the PDK installation (variant-specific, e.g. `$PDK_ROOT/sky130A`) |
+| `-c`, `--caravel-root` | Path to the golden Caravel root (or set `$GOLDEN_CARAVEL`) |
+
+### Optional arguments
+
+| Flag | Description |
+|------|-------------|
+| `-o`, `--output-directory` | Output directory (default: `<project>/precheck_results/<timestamp>`) |
+| `--magic-drc` | Include the Magic DRC check (off by default) |
+| `--skip-checks check [...]` | Skip specific checks |
+| `-v`, `--verbose` | Show verbose/debug output |
+| `--version` | Print version and exit |
+
+### Positional arguments
+
+Pass one or more check names to run only those checks. If omitted, all applicable checks are run.
+
+### Example
+
+```bash
+# Run all checks
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel
+
+# Run only specific checks
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel topcell_check gpio_defines
+
+# Include the optional Magic DRC check
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel --magic-drc
+
+# Skip certain checks
+cf-precheck -i ./my_project -p $PDK_ROOT/sky130A -c ./caravel --skip-checks lvs oeb
+```
+
+## Checks
+
+| Check | Description |
+|-------|-------------|
+| `topcell_check` | Validates the top cell name in the GDS |
+| `gpio_defines` | Validates GPIO directives in `verilog/rtl/user_defines.v` |
+| `pdn` | Power distribution network check |
+| `metal_check` | Metal density check |
+| `xor` | XOR comparison against the golden wrapper to detect out-of-bounds edits |
+| `magic_drc` | Full DRC using Magic *(optional, off by default)* |
+| `klayout_feol` | Klayout Front End Of Line DRC |
+| `klayout_beol` | Klayout Back End Of Line DRC |
+| `klayout_offgrid` | Klayout off-grid violations check |
+| `klayout_metal_minimum_clear_area_density` | Klayout metal density check |
+| `klayout_pin_label_purposes_overlapping_drawing` | Klayout pin/label overlap check |
+| `klayout_zero_area` | Klayout zero-area cell check |
+| `spike_check` | Detects voltage spikes in the design |
+| `illegal_cellname_check` | Detects cells with illegal names |
+| `oeb` | Output-enable-bar signal connectivity check |
+| `lvs` | Layout vs. Schematic check |
+
+## Results
+
+Check results are saved to `<project>/.cf/project.json` under the `precheck` key:
+
+```json
+{
+  "precheck": {
+    "version": "1.0.0",
+    "timestamp": "2026-03-17T12:00:00+00:00",
+    "pdk": "sky130A",
+    "passed": false,
+    "checks": {
+      "topcell_check": { "status": "pass", "duration_s": 1.2 },
+      "gpio_defines": { "status": "fail", "duration_s": 0.8, "details": "..." }
+    }
+  }
+}
+```
+
+Detailed logs are written to `<project>/precheck_results/<timestamp>/logs/precheck.log`.
+
+## License
+
+Apache-2.0