format: finish lint and formatting scripts

Author: thommythomaso

.github/workflows/license.yml

@@ -0,0 +1,61 @@
+# Copyright 2026 ETH Zurich and University of Bologna.
+# Solderpad Hardware License, Version 0.51, see LICENSE for details.
+# SPDX-License-Identifier: SHL-0.51
+
+# Authors:
+# - Thomas Benz <tbenz@iis.ee.ethz.ch>
+
+header-regex: >
+  (?:#\!/.*\n)*[/|#]+ Copyright (\(c\))* *([0-9]+) ETH Zurich and University of Bologna\.\n[/|#]+ (Solderpad Hardware License, Version 0\.51|Licensed under the Apache License, Version 2.0), see LICENSE for details\.\n[/|#]+ SPDX-License-Identifier: (SHL-0\.51|Apache-2.0)
+
+excludes:
+  - CHANGELOG.md
+  - LICENSE.md
+  - README.md
+  - vsim/transcript
+
+exclude-ext:
+  - aig
+  - fst
+  - html
+  - ini
+  - jpg
+  - json
+  - local
+  - lock
+  - log
+  - patched
+  - svg
+  - vcd
+  - wlf
+
+exclude-paths:
+  - artistic/artistic
+  - artistic/meerkat_work
+  - artistic/renderics
+  - ihp13/bondpad
+  - ihp13/patches
+  - ihp13/pdk
+  - klayout/out
+  - openroad/out
+  - openroad/reports
+  - openroad/save
+  - sw/bin
+  - verilator/obj_dir
+  - vsim/reports
+  - vsim/work
+  - xilinx/build
+  - xilinx/out
+  - yosys/out
+  - yosys/reports
+  - yosys/tmp
+
+
+allowed-years:
+  - 2020
+  - 2021
+  - 2022
+  - 2023
+  - 2024
+  - 2025
+  - 2026

scripts/format.sh

@@ -0,0 +1,87 @@
+# Copyright 2026 ETH Zurich and University of Bologna.
+# Solderpad Hardware License, Version 0.51, see LICENSE for details.
+# SPDX-License-Identifier: SHL-0.51
+
+# Authors:
+# - Thomas Benz <tbenz@iis.ee.ethz.ch>
+
+"""Lints the header ensuring consistent file headers"""
+import glob
+import os
+import sys
+import re
+import yaml
+
+
+def lint_license(file: str, config: dict) -> int:
+    """Lint headers"""
+    # filter paths
+    if not os.path.isfile(file):
+        # print(f'Path ignore:      {file}')
+        return 0
+
+    # filter binary files
+    try:
+        with open(file, "r", encoding="utf-8") as fh:
+            content = fh.read()
+    except UnicodeDecodeError:
+        return 0
+
+    # filter certain dirs
+    for path in config["exclude-paths"]:
+        if file.startswith(path):
+            return 0
+
+    # filter extension
+    ext = file.split(".")[-1]
+    if ext in config["exclude-ext"]:
+        return 0
+
+    # filter file
+    if file in config["excludes"]:
+        return 0
+
+    # parse header
+    header_info = re.findall(config["header-regex"], content)
+
+    # check if there is no match at all -> error
+    if len(header_info) == 0:
+        print(f"[WARNING][LICENSE-LINT] {file} Wrong or missing license header ")
+        return 1
+
+    # check year
+    if not int(header_info[0][1]) in config["allowed-years"]:
+        print(f"[WARNING][LICENSE-LINT] {file} Copyright outdated")
+        return 1
+
+    # all checks pass
+    print(f"[INFO][LICENSE-LINT] {file}")
+    return 0
+
+
+def main():
+    errors = 0
+    error_files = []
+
+    # get arguments
+    _, cfg_file = sys.argv
+
+    # read cfg file
+    with open(cfg_file, "r") as cfh:
+        config = yaml.safe_load(cfh)
+
+    # fetch file list
+    all_files = sorted(glob.glob("**/*", recursive=True))
+
+    # check all files
+    for file in all_files:
+        if lint_license(file, config):
+            error_files.append(file)
+            errors += 1
+
+    # return the accumulated errors
+    return errors
+
+
+if __name__ == "__main__":
+    sys.exit(main())

scripts/license_cfg.yml

@@ -0,0 +1,126 @@
+#!/bin/bash
+# Copyright (c) 2026 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Authors:
+# - Thomas Benz     <tbenz@iis.ee.ethz.ch>
+
+set -e  # Exit on error
+set -u  # Error on undefined vars
+
+################
+# Helpers
+################
+
+show_help() {
+    cat << EOF
+Checks Coordinator
+
+Usage:
+    scripts/run_checks.sh [OPTIONS]
+
+Options:
+    --help, -h          Show this help message
+    --dry-run, -n       Only print commands instead of executing
+    --verbose, -v       Print commands while executing
+    --sv                Lint SystemVerilog files
+    --license           Lint license headers
+    --python            Lint and format python files
+    --cxx               Lint and format C code
+
+Example:
+    scripts/run_checks.sh --sv --license --python --cxx
+
+EOF
+    exit 0
+}
+
+
+run_cmd() {
+    if [ "$DRYRUN" = 1 ]; then
+        echo $1
+    else
+        eval $1
+    fi
+}
+
+
+lint_sv() {
+    run_cmd "echo [INFO][Verible] Check SystemVerilog sources"
+    run_cmd "verible-verilog-lint $(find . -name '*.sv' -exec realpath {} \;) --lint_fatal --waiver_files scripts/verible.waver"
+}
+
+
+lint_license() {
+    run_cmd "echo [INFO][Verible] Check license headers"
+    run_cmd "python3 scripts/lint_license.py scripts/license_cfg.yml"
+}
+
+
+lint_and_format_python() {
+    run_cmd "echo -e [INFO][Black] Formatting Python Code..."
+    run_cmd "black */*.py"
+}
+
+
+lint_and_format_c() {
+    run_cmd "echo -e [INFO][ClangFormat] Formatting C Code..."
+    run_cmd "python scripts/run_clang_format.py -ir sw/ --clang-format-executable=clang-format"
+}
+
+
+####################
+# Parse Arguments
+####################
+
+DRYRUN=0
+
+# default action if no argument is given
+if [ $# -eq 0 ]; then
+    show_help
+    return 0
+fi
+
+# check for global arguments
+for arg in "$@"; do
+    [[ "$arg" == -v || "$arg" == --verbose ]] && set -x
+    [[ "$arg" == -n || "$arg" == --dry-run ]] && DRYRUN=1
+done
+
+# parse arguments
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        --help|-h)
+            show_help
+            ;;
+        --verbose|-v)
+            shift
+            ;;
+        --dry-run|-n)
+            shift
+            ;;
+        # script-specific commands
+        --sv)
+            lint_sv
+            shift
+            ;;
+        --license)
+            lint_license
+            shift
+            ;;
+        --python)
+            lint_and_format_python
+            shift
+            ;;
+        --cxx)
+            lint_and_format_c
+            shift
+            ;;
+        # Error handling
+        *)
+            echo "[ERROR] Unknown option: $1 (use --help for usage)" >&2
+            exit 1
+            ;;
+    esac
+done

scripts/lint_license.py

@@ -0,0 +1,6 @@
+# Copyright 2026 ETH Zurich and University of Bologna.
+# Solderpad Hardware License, Version 0.51, see LICENSE for details.
+# SPDX-License-Identifier: SHL-0.51
+
+# Authors:
+# - Thomas Benz <tbenz@iis.ee.ethz.ch>