Compare commits
50 Commits
cef035329a
...
v0.6.1
Author | SHA1 | Date | |
---|---|---|---|
5d8d995a04 | |||
36f6e7314a
|
|||
bc8ae46b4a | |||
dde2363ad7
|
|||
32e3b51a77
|
|||
da387f2ee6
|
|||
08679c2680
|
|||
7b6f9ef224
|
|||
6ca389d5cb
|
|||
1d7bc19965
|
|||
175bf4882a
|
|||
0d26c42f8a
|
|||
fa7e738b7e
|
|||
60c4ca19b1
|
|||
38d4c7d5f3
|
|||
9d33b6e8be
|
|||
dde3b5dc5d
|
|||
6d6b731033
|
|||
8196eb3929
|
|||
5083852c29
|
|||
215e4aa545
|
|||
d78bfcc408
|
|||
8ed550f451
|
|||
37b684fd2d
|
|||
7cf69aa16f
|
|||
9274461d7a
|
|||
b79b7559f2
|
|||
22266f2947 | |||
c7b2970949 | |||
6271eb0998 | |||
308de700a2 | |||
f1315dc458 | |||
ba8cc2ef94 | |||
f87b08441f | |||
52f5a8fe24 | |||
836a5bf643 | |||
ffd8d6eac9 | |||
44f2f15dc5 | |||
d6d792c9e6 | |||
07922f8a54 | |||
29d04a25f0 | |||
bbe5d7f2b1 | |||
84800c25a5 | |||
e58c0897ce | |||
277a16e126 | |||
ad4ba6e412 | |||
2f3e0d375f | |||
528907fabe | |||
fae19340cc | |||
a57062a3f8 |
5
.gitea/default_merge_message/MERGE_TEMPLATE.md
Normal file
5
.gitea/default_merge_message/MERGE_TEMPLATE.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
chore(pr): ${PullRequestTitle} ${PullRequestReference}
|
||||||
|
|
||||||
|
${PullRequestDescription}
|
||||||
|
|
||||||
|
Merged from ${HeadBranch} into ${BaseBranch}
|
45
.gitea/scripts/cleanup_versions.sh
Executable file
45
.gitea/scripts/cleanup_versions.sh
Executable file
@@ -0,0 +1,45 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# cleanup_dev_versions.sh - Delete old PyPI dev versions from Gitea package registry
|
||||||
|
|
||||||
|
# Required environment variables
|
||||||
|
USERNAME="${TWINE_USERNAME}"
|
||||||
|
TOKEN="${TWINE_PASSWORD}"
|
||||||
|
REPO="${GITHUB_REPOSITORY}" # e.g., maxp/repocat
|
||||||
|
API_BASE="${GITHUB_API_URL%/}" # Strip trailing slash if present
|
||||||
|
|
||||||
|
OWNER="${REPO%%/*}"
|
||||||
|
PACKAGE_NAME="${REPO##*/}"
|
||||||
|
API_URL="${API_BASE}/packages/${OWNER}/pypi/${PACKAGE_NAME}"
|
||||||
|
|
||||||
|
# Fetch the list of versions
|
||||||
|
response=$(curl -s -u "$USERNAME:$TOKEN" "$API_URL")
|
||||||
|
|
||||||
|
# Extract all .dev versions, sort by creation time
|
||||||
|
mapfile -t versions_to_delete < <(echo "$response" | jq -r '
|
||||||
|
map(select(.version | test("\\.dev"))) |
|
||||||
|
sort_by(.created_at) |
|
||||||
|
.[0:-1][] |
|
||||||
|
.version')
|
||||||
|
|
||||||
|
# Determine latest version to keep
|
||||||
|
latest_version=$(echo "$response" | jq -r '
|
||||||
|
map(select(.version | test("\\.dev"))) |
|
||||||
|
sort_by(.created_at) |
|
||||||
|
last.version')
|
||||||
|
|
||||||
|
if [[ -z "$latest_version" || ${#versions_to_delete[@]} -eq 0 ]]; then
|
||||||
|
echo "No old .dev versions to delete."
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Keeping latest .dev version: $latest_version"
|
||||||
|
|
||||||
|
# Delete old .dev versions
|
||||||
|
for version in "${versions_to_delete[@]}"; do
|
||||||
|
echo "Deleting old .dev version: $version"
|
||||||
|
curl -s -X DELETE -u "$USERNAME:$TOKEN" "$API_URL/$version"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "Cleanup complete."
|
21
.gitea/scripts/get-release-id.sh
Executable file
21
.gitea/scripts/get-release-id.sh
Executable file
@@ -0,0 +1,21 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Eingaben
|
||||||
|
TAG="$1"
|
||||||
|
TOKEN="${ACTIONS_RUNTIME_TOKEN:-<fallback_token>}"
|
||||||
|
REPO="${GITHUB_REPOSITORY:-owner/example}"
|
||||||
|
API="${GITHUB_API_URL:-https://gitea.example.tld/api/v1}"
|
||||||
|
|
||||||
|
OWNER=$(echo "$REPO" | cut -d/ -f1)
|
||||||
|
NAME=$(echo "$REPO" | cut -d/ -f2)
|
||||||
|
|
||||||
|
RESPONSE=$(curl -sf \
|
||||||
|
-H "Authorization: token $TOKEN" \
|
||||||
|
"$API/repos/$OWNER/$NAME/releases/tags/$TAG")
|
||||||
|
|
||||||
|
RELEASE_ID=$(echo "$RESPONSE" | jq -r '.id')
|
||||||
|
echo "Release-ID für $TAG ist: $RELEASE_ID"
|
||||||
|
|
||||||
|
# Für GitHub Actions als Umgebungsvariable
|
||||||
|
echo "GT_RELEASE_ID=$RELEASE_ID" >> "$GITHUB_ENV"
|
14
.gitea/scripts/set_poetry_version.sh
Executable file
14
.gitea/scripts/set_poetry_version.sh
Executable file
@@ -0,0 +1,14 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
BASE_VERSION=$(cat VERSION)
|
||||||
|
NIGHTLY_SUFFIX=""
|
||||||
|
|
||||||
|
if [[ "$1" == "nightly" ]]; then
|
||||||
|
# Beispiel: 20240511.1358 → 11. Mai, 13:58 Uhr
|
||||||
|
NIGHTLY_SUFFIX=".dev$(date +%Y%m%d%H%M)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
FULL_VERSION="${BASE_VERSION}${NIGHTLY_SUFFIX}"
|
||||||
|
|
||||||
|
echo "Using version: $FULL_VERSION"
|
||||||
|
poetry version "$FULL_VERSION"
|
21
.gitea/scripts/sync_version_from_poetry.sh
Executable file
21
.gitea/scripts/sync_version_from_poetry.sh
Executable file
@@ -0,0 +1,21 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Stelle sicher, dass wir im Projektverzeichnis sind
|
||||||
|
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||||
|
cd "$ROOT_DIR"
|
||||||
|
|
||||||
|
PYPROJECT="pyproject.toml"
|
||||||
|
VERSION_FILE="VERSION"
|
||||||
|
|
||||||
|
# Extrahiere die Version mit grep + sed (keine externen Abhängigkeiten nötig)
|
||||||
|
VERSION=$(grep -E '^version\s*=' "$PYPROJECT" | head -n1 | sed -E 's/.*=\s*"([^"]+)".*/\1/')
|
||||||
|
|
||||||
|
if [[ -z "$VERSION" ]]; then
|
||||||
|
echo "❌ Version konnte nicht aus $PYPROJECT gelesen werden."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
printf "%s" "$VERSION" > "$VERSION_FILE"
|
||||||
|
echo "✅ Version synchronisiert: $VERSION → $VERSION_FILE"
|
40
.gitea/scripts/upload-asset.sh
Executable file
40
.gitea/scripts/upload-asset.sh
Executable file
@@ -0,0 +1,40 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Eingabeparameter
|
||||||
|
FILE_PATH="$1" # z. B. ./dist/build.zip
|
||||||
|
CUSTOM_NAME="${2:-}" # optional: anderer Name unter dem das Asset gespeichert werden soll
|
||||||
|
RELEASE_ID="${GT_RELEASE_ID:-}" # aus Umgebung
|
||||||
|
|
||||||
|
# Validierung
|
||||||
|
if [[ -z "$RELEASE_ID" ]]; then
|
||||||
|
echo "❌ RELEASE_ID ist nicht gesetzt. Abbruch."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ! -f "$FILE_PATH" ]]; then
|
||||||
|
echo "❌ Datei '$FILE_PATH' existiert nicht. Abbruch."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Default-Konfiguration
|
||||||
|
TOKEN="${ACTIONS_RUNTIME_TOKEN:-<fallback_token>}"
|
||||||
|
REPO="${GITHUB_REPOSITORY:-owner/example}"
|
||||||
|
API="${GITHUB_API_URL:-https://gitea.example.tld/api/v1}"
|
||||||
|
|
||||||
|
# Owner/Repo auflösen
|
||||||
|
OWNER=$(echo "$REPO" | cut -d/ -f1)
|
||||||
|
NAME=$(echo "$REPO" | cut -d/ -f2)
|
||||||
|
|
||||||
|
# Dateiname setzen
|
||||||
|
FILENAME="${CUSTOM_NAME:-$(basename "$FILE_PATH")}"
|
||||||
|
|
||||||
|
echo "🔼 Uploading '$FILE_PATH' as '$FILENAME' to release ID $RELEASE_ID"
|
||||||
|
|
||||||
|
# Upload
|
||||||
|
curl -sf -X POST \
|
||||||
|
-H "Authorization: token $TOKEN" \
|
||||||
|
-F "attachment=@$FILE_PATH" \
|
||||||
|
"$API/repos/$OWNER/$NAME/releases/$RELEASE_ID/assets?name=$FILENAME"
|
||||||
|
|
||||||
|
echo "✅ Upload abgeschlossen: $FILENAME"
|
62
.gitea/workflows/build-and-deploy-nightly.yml
Normal file
62
.gitea/workflows/build-and-deploy-nightly.yml
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
name: Build and Publish nightly package
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths-ignore:
|
||||||
|
- 'CHANGELOG.md'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-publish:
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout Repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: 🐍 Setup Python
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
|
||||||
|
- name: 🔄 Restore cache
|
||||||
|
uses: https://git.0xmax42.io/actions/cache@v1
|
||||||
|
with:
|
||||||
|
key: poetry-v1-${{ runner.os }}-${{ hashFiles('poetry.lock') }}
|
||||||
|
paths: |
|
||||||
|
~/.cache/pypoetry
|
||||||
|
~/.cache/pip
|
||||||
|
|
||||||
|
- name: Install Poetry
|
||||||
|
run: |
|
||||||
|
pip install poetry
|
||||||
|
|
||||||
|
- name: Install Project Dependencies
|
||||||
|
working-directory: .
|
||||||
|
run: |
|
||||||
|
poetry install
|
||||||
|
|
||||||
|
- name: Set version from VERSION file (with nightly suffix)
|
||||||
|
run: ./.gitea/scripts/set_poetry_version.sh nightly
|
||||||
|
|
||||||
|
- name: Build Package
|
||||||
|
working-directory: .
|
||||||
|
run: |
|
||||||
|
poetry build
|
||||||
|
|
||||||
|
- name: Publish to Gitea Package Registry
|
||||||
|
working-directory: .
|
||||||
|
env:
|
||||||
|
TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
|
||||||
|
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
|
||||||
|
run: |
|
||||||
|
poetry run twine upload --repository-url ${{ secrets.TWINE_URL }} dist/*
|
||||||
|
|
||||||
|
- name: Cleanup old dev versions
|
||||||
|
run: |
|
||||||
|
.gitea/scripts/cleanup_versions.sh '\.dev'
|
||||||
|
env:
|
||||||
|
TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
|
||||||
|
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
|
64
.gitea/workflows/build-and-deploy-release.yml
Normal file
64
.gitea/workflows/build-and-deploy-release.yml
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
name: Build and Publish nightly package
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-publish:
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout Repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.release.tag_name }}
|
||||||
|
|
||||||
|
- name: 🐍 Setup Python
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
|
||||||
|
- name: 🔄 Restore cache
|
||||||
|
uses: https://git.0xmax42.io/actions/cache@v1
|
||||||
|
with:
|
||||||
|
key: poetry-v1-${{ runner.os }}-${{ hashFiles('poetry.lock') }}
|
||||||
|
paths: |
|
||||||
|
~/.cache/pypoetry
|
||||||
|
~/.cache/pip
|
||||||
|
|
||||||
|
- name: Install Poetry
|
||||||
|
run: |
|
||||||
|
pip install poetry
|
||||||
|
|
||||||
|
- name: Install Project Dependencies
|
||||||
|
working-directory: .
|
||||||
|
run: |
|
||||||
|
poetry install
|
||||||
|
|
||||||
|
- name: Build Package
|
||||||
|
working-directory: .
|
||||||
|
run: |
|
||||||
|
poetry build
|
||||||
|
|
||||||
|
- name: Get built wheel filename
|
||||||
|
id: get_whl
|
||||||
|
run: |
|
||||||
|
echo "whl_file=$(basename dist/*.whl)" >> $GITHUB_OUTPUT
|
||||||
|
echo "sdist_file=$(basename dist/*.tar.gz)" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Publish to Gitea Package Registry
|
||||||
|
working-directory: .
|
||||||
|
env:
|
||||||
|
TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
|
||||||
|
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
|
||||||
|
run: |
|
||||||
|
poetry run twine upload --repository-url ${{ secrets.TWINE_URL }} dist/*
|
||||||
|
|
||||||
|
- name: Get Release ID from tag
|
||||||
|
run: .gitea/scripts/get-release-id.sh "${{ github.event.release.tag_name }}"
|
||||||
|
|
||||||
|
- name: Upload assets
|
||||||
|
run: |
|
||||||
|
.gitea/scripts/upload-asset.sh ./dist/${{ steps.get_whl.outputs.whl_file }}
|
||||||
|
.gitea/scripts/upload-asset.sh ./dist/${{ steps.get_whl.outputs.sdist_file }}
|
18
.gitea/workflows/release.yml
Normal file
18
.gitea/workflows/release.yml
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
name: Auto Changelog & (Release)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Release
|
||||||
|
uses: https://git.0xmax42.io/actions/auto-changelog-release-action@v0
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.RELEASE_PUBLISH_TOKEN }}
|
63
.github/workflows/build-deb.yml
vendored
63
.github/workflows/build-deb.yml
vendored
@@ -1,63 +0,0 @@
|
|||||||
name: Build Wheels
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch: # <-- Nur manuell über GitHub startbar
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: ⚙️ Prepare Environment Variables
|
|
||||||
run: |
|
|
||||||
echo "AGENT_TOOLSDIRECTORY=/home/runner/toolcache" >> $GITHUB_ENV
|
|
||||||
mkdir -p /home/runner/toolcache
|
|
||||||
|
|
||||||
- name: 🛒 Checkout Repository
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: 🐍 Setup Python
|
|
||||||
uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: "3.12"
|
|
||||||
|
|
||||||
- name: 📦 Install Poetry
|
|
||||||
run: |
|
|
||||||
curl -sSL https://install.python-poetry.org | python3 -
|
|
||||||
echo "$HOME/.local/bin" >> $GITHUB_PATH
|
|
||||||
poetry self add poetry-plugin-export
|
|
||||||
|
|
||||||
- name: 🔧 Install Project Dependencies
|
|
||||||
run: |
|
|
||||||
poetry install
|
|
||||||
|
|
||||||
- name: 📝 Export requirements.txt
|
|
||||||
run: |
|
|
||||||
poetry export --without-hashes --format=requirements.txt > requirements.txt
|
|
||||||
|
|
||||||
- name: 📥 Download Wheels for Dependencies
|
|
||||||
run: |
|
|
||||||
mkdir -p dist/wheels
|
|
||||||
pip install wheel
|
|
||||||
pip download --only-binary=:all: --dest dist/wheels -r requirements.txt
|
|
||||||
|
|
||||||
- name: 🛠 Build Project Wheel
|
|
||||||
run: |
|
|
||||||
poetry build -f wheel
|
|
||||||
|
|
||||||
- name: 🔌 Install pipx and wheel2deb
|
|
||||||
run: |
|
|
||||||
python3 -m pip install --user pipx
|
|
||||||
python3 -m pipx ensurepath
|
|
||||||
pipx install wheel2deb
|
|
||||||
|
|
||||||
- name: 🛠 Convert Wheel to DEB
|
|
||||||
run: |
|
|
||||||
mkdir -p dist/debs
|
|
||||||
wheel2deb dist/*.whl -d dist/debs
|
|
||||||
|
|
||||||
- name: 📤 Upload dist/ artifacts
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: dist
|
|
||||||
path: dist/
|
|
11
.vscode/settings.json
vendored
11
.vscode/settings.json
vendored
@@ -2,5 +2,14 @@
|
|||||||
"python.envFile": "${workspaceFolder}/.env",
|
"python.envFile": "${workspaceFolder}/.env",
|
||||||
"python.analysis.extraPaths": [
|
"python.analysis.extraPaths": [
|
||||||
"src"
|
"src"
|
||||||
]
|
],
|
||||||
|
"workbench.colorCustomizations": {
|
||||||
|
"activityBar.activeBackground": "#8dc4ff",
|
||||||
|
"activityBar.background": "#8dc4ff",
|
||||||
|
"activityBar.foreground": "#15202b",
|
||||||
|
"activityBar.inactiveForeground": "#15202b99",
|
||||||
|
"activityBarBadge.background": "#ff007b",
|
||||||
|
"activityBarBadge.foreground": "#e7e7e7"
|
||||||
|
},
|
||||||
|
"peacock.color": "#5aaaff"
|
||||||
}
|
}
|
31
CHANGELOG.md
Normal file
31
CHANGELOG.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## [0.6.1] - 2025-07-16
|
||||||
|
|
||||||
|
### 🚀 Features
|
||||||
|
|
||||||
|
- *(ci)* Add workflows for nightly builds and releases - ([da387f2](https://git.0xmax42.io/maxp/hdlbuild/commit/da387f2ee602390d616c79bf4057ccf941e21462))
|
||||||
|
|
||||||
|
### 🚜 Refactor
|
||||||
|
|
||||||
|
- Use typer for CLI argument parsing - ([6ca389d](https://git.0xmax42.io/maxp/hdlbuild/commit/6ca389d5cbbeff53faab9d61376a8c77ed097b6c))
|
||||||
|
- Improves project configuration - ([175bf48](https://git.0xmax42.io/maxp/hdlbuild/commit/175bf4882a8f172ee536d726b31136690572be36))
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
|
||||||
|
- *(readme)* Expand README with detailed usage and setup - ([fa7e738](https://git.0xmax42.io/maxp/hdlbuild/commit/fa7e738b7eade5a627218741a6fb4bd1617f7801))
|
||||||
|
|
||||||
|
### 🎨 Styling
|
||||||
|
|
||||||
|
- *(pyproject)* Simplify include array formatting - ([08679c2](https://git.0xmax42.io/maxp/hdlbuild/commit/08679c2680b49119e0414688a80e8dc2659236b4))
|
||||||
|
- Updates VS Code editor color scheme - ([1d7bc19](https://git.0xmax42.io/maxp/hdlbuild/commit/1d7bc1996522ab54970348b5118ad319849a6a1f))
|
||||||
|
|
||||||
|
### ⚙️ Miscellaneous Tasks
|
||||||
|
|
||||||
|
- *(config)* Add git-cliff configuration file - ([dde2363](https://git.0xmax42.io/maxp/hdlbuild/commit/dde2363ad7dd2fd2d48c6154e3b88c1c4a6867fd))
|
||||||
|
- Updates project version to 0.6.0 - ([7b6f9ef](https://git.0xmax42.io/maxp/hdlbuild/commit/7b6f9ef2240864b103903e79c895a76db59c14fa))
|
||||||
|
- Remove build-deb.yml workflow file - ([0d26c42](https://git.0xmax42.io/maxp/hdlbuild/commit/0d26c42f8ae419d509aa47d3f7a23bfdd08cf79b))
|
||||||
|
|
||||||
|
|
168
README.md
168
README.md
@@ -1,2 +1,168 @@
|
|||||||
# hdlbuild
|
# HDLBuild
|
||||||
|
|
||||||
|
HDLBuild is a flexible build management tool for FPGA projects. It simplifies the process of managing dependencies, building, testing, and deploying FPGA designs using Xilinx ISE tools.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Dependency Management**: Automatically resolves and manages project dependencies from Git repositories.
|
||||||
|
- **Build Automation**: Supports synthesis, implementation, and bitstream generation for FPGA designs.
|
||||||
|
- **Testbench Execution**: Automates the process of building and running testbenches.
|
||||||
|
- **Customizable Tool Options**: Provides extensive configuration options for Xilinx ISE tools.
|
||||||
|
- **Project Initialization**: Quickly set up new projects with predefined templates.
|
||||||
|
- **Rich Console Output**: Provides detailed and interactive console feedback using `rich`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Python 3.10 or higher
|
||||||
|
- Poetry (for dependency management)
|
||||||
|
- Xilinx ISE (14.7) installed and configured
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
1. Clone the repository:
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/your-repo/hdlbuild.git
|
||||||
|
cd hdlbuild
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install dependencies:
|
||||||
|
```bash
|
||||||
|
poetry install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Add the `hdlbuild` CLI to your PATH:
|
||||||
|
```bash
|
||||||
|
poetry shell
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### CLI Commands
|
||||||
|
|
||||||
|
HDLBuild provides a command-line interface (CLI) for managing FPGA projects. Below are the available commands:
|
||||||
|
|
||||||
|
#### 1. **Initialize a New Project**
|
||||||
|
```bash
|
||||||
|
hdlbuild init
|
||||||
|
```
|
||||||
|
- Creates a new project with a project.yml configuration file and a .gitignore file.
|
||||||
|
|
||||||
|
#### 2. **Resolve Dependencies**
|
||||||
|
```bash
|
||||||
|
hdlbuild dep
|
||||||
|
```
|
||||||
|
- Clones and resolves all project dependencies defined in project.yml.
|
||||||
|
|
||||||
|
#### 3. **Build the Project**
|
||||||
|
```bash
|
||||||
|
hdlbuild build
|
||||||
|
```
|
||||||
|
- Runs the full build process, including synthesis, implementation, and bitstream generation.
|
||||||
|
|
||||||
|
- To only synthesize the design:
|
||||||
|
```bash
|
||||||
|
hdlbuild build synth
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 4. **Run Testbenches**
|
||||||
|
```bash
|
||||||
|
hdlbuild test <testbench_name>
|
||||||
|
```
|
||||||
|
- Builds and runs the specified testbench.
|
||||||
|
|
||||||
|
#### 5. **Clean Build Artifacts**
|
||||||
|
```bash
|
||||||
|
hdlbuild clean
|
||||||
|
```
|
||||||
|
- Removes build artifacts.
|
||||||
|
|
||||||
|
- To clean all generated files:
|
||||||
|
```bash
|
||||||
|
hdlbuild clean all
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
The project is configured using a project.yml file. Below is an example configuration:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
name: MyFPGAProject
|
||||||
|
topmodule: top_module
|
||||||
|
target_device: xc3s1200e-4-fg320
|
||||||
|
xilinx_path: /opt/Xilinx/14.7/ISE_DS/ISE
|
||||||
|
|
||||||
|
constraints: constraints.ucf
|
||||||
|
|
||||||
|
sources:
|
||||||
|
vhdl:
|
||||||
|
- path: src/*.vhd
|
||||||
|
library: work
|
||||||
|
|
||||||
|
testbenches:
|
||||||
|
vhdl:
|
||||||
|
- path: tests/*.vhd
|
||||||
|
library: work
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
- git: "https://github.com/example/dependency.git"
|
||||||
|
rev: "main"
|
||||||
|
|
||||||
|
build:
|
||||||
|
build_dir: working
|
||||||
|
report_dir: reports
|
||||||
|
copy_target_dir: output
|
||||||
|
|
||||||
|
tool_options:
|
||||||
|
xst:
|
||||||
|
- "-opt_mode Speed"
|
||||||
|
- "-opt_level 2"
|
||||||
|
map:
|
||||||
|
- "-detail"
|
||||||
|
- "-timing"
|
||||||
|
par: []
|
||||||
|
bitgen:
|
||||||
|
- "-g StartupClk:JtagClk"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Building the Package
|
||||||
|
|
||||||
|
To build the Python package:
|
||||||
|
```bash
|
||||||
|
poetry build
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## GitHub Actions
|
||||||
|
|
||||||
|
The project includes GitHub workflows for building and deploying the package:
|
||||||
|
|
||||||
|
1. **Build and Publish**: build-and-deploy.yml
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Contributions are welcome! Please follow these steps:
|
||||||
|
|
||||||
|
1. Fork the repository.
|
||||||
|
2. Create a new branch for your feature or bugfix.
|
||||||
|
3. Submit a pull request.
|
||||||
|
104
cliff.toml
Normal file
104
cliff.toml
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
# CLIFF_VERSION=2.8.0
|
||||||
|
# git-cliff ~ default configuration file
|
||||||
|
# https://git-cliff.org/docs/configuration
|
||||||
|
#
|
||||||
|
# Lines starting with "#" are comments.
|
||||||
|
# Configuration options are organized into tables and keys.
|
||||||
|
# See documentation for more information on available options.
|
||||||
|
[remote.gitea]
|
||||||
|
owner = "maxp"
|
||||||
|
repo = "hdlbuild"
|
||||||
|
|
||||||
|
[changelog]
|
||||||
|
# postprocessors
|
||||||
|
postprocessors = [
|
||||||
|
{ pattern = '<GITEA_URL>', replace = "https://git.0xmax42.io" }, # replace gitea url
|
||||||
|
]
|
||||||
|
|
||||||
|
# template for the changelog header
|
||||||
|
header = """
|
||||||
|
# Changelog\n
|
||||||
|
All notable changes to this project will be documented in this file.\n
|
||||||
|
"""
|
||||||
|
# template for the changelog body
|
||||||
|
# https://keats.github.io/tera/docs/#introduction
|
||||||
|
body = """
|
||||||
|
{%- macro remote_url() -%}
|
||||||
|
<GITEA_URL>/{{ remote.gitea.owner }}/{{ remote.gitea.repo }}
|
||||||
|
{%- endmacro -%}
|
||||||
|
|
||||||
|
{% if version %}\
|
||||||
|
{% if previous.version %}\
|
||||||
|
## [{{ version | trim_start_matches(pat="v") }}]\
|
||||||
|
({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
|
||||||
|
{% else %}\
|
||||||
|
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
||||||
|
{% endif %}\
|
||||||
|
{% else %}\
|
||||||
|
## [unreleased]
|
||||||
|
{% endif %}\
|
||||||
|
{% for group, commits in commits | group_by(attribute="group") %}
|
||||||
|
### {{ group | striptags | trim | upper_first }}
|
||||||
|
{% for commit in commits %}
|
||||||
|
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
|
||||||
|
{% if commit.breaking %}[**breaking**] {% endif %}\
|
||||||
|
{{ commit.message | upper_first }} - \
|
||||||
|
([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
|
||||||
|
{% endfor %}
|
||||||
|
{% endfor %}\n
|
||||||
|
"""
|
||||||
|
# template for the changelog footer
|
||||||
|
footer = """
|
||||||
|
|
||||||
|
"""
|
||||||
|
# remove the leading and trailing s
|
||||||
|
trim = true
|
||||||
|
|
||||||
|
# render body even when there are no releases to process
|
||||||
|
# render_always = true
|
||||||
|
# output file path
|
||||||
|
# output = "test.md"
|
||||||
|
|
||||||
|
[git]
|
||||||
|
# parse the commits based on https://www.conventionalcommits.org
|
||||||
|
conventional_commits = true
|
||||||
|
# filter out the commits that are not conventional
|
||||||
|
filter_unconventional = true
|
||||||
|
# process each line of a commit as an individual commit
|
||||||
|
split_commits = false
|
||||||
|
# regex for preprocessing the commit messages
|
||||||
|
commit_preprocessors = [
|
||||||
|
# Replace issue numbers
|
||||||
|
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
|
||||||
|
# Check spelling of the commit with https://github.com/crate-ci/typos
|
||||||
|
# If the spelling is incorrect, it will be automatically fixed.
|
||||||
|
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
|
||||||
|
]
|
||||||
|
# regex for parsing and grouping commits
|
||||||
|
commit_parsers = [
|
||||||
|
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
|
||||||
|
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
|
||||||
|
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
|
||||||
|
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
|
||||||
|
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
|
||||||
|
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
|
||||||
|
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
|
||||||
|
{ message = "^chore\\(changelog\\)", skip = true },
|
||||||
|
{ message = "^chore\\(version\\)", skip = true },
|
||||||
|
{ message = "^chore\\(release\\): prepare for", skip = true },
|
||||||
|
{ message = "^chore\\(deps.*\\)", skip = true },
|
||||||
|
{ message = "^chore\\(pr\\)", skip = true },
|
||||||
|
{ message = "^chore\\(pull\\)", skip = true },
|
||||||
|
{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
|
||||||
|
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
|
||||||
|
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
|
||||||
|
{ message = ".*", group = "<!-- 10 -->💼 Other" },
|
||||||
|
]
|
||||||
|
# Regex to select git tags that represent releases.
|
||||||
|
tag_pattern = "v[0-9]+\\.[0-9]+\\.[0-9]+"
|
||||||
|
# filter out the commits that are not matched by commit parsers
|
||||||
|
filter_commits = false
|
||||||
|
# sort the tags topologically
|
||||||
|
topo_order = false
|
||||||
|
# sort the commits inside sections by oldest/newest order
|
||||||
|
sort_commits = "newest"
|
@@ -1,41 +1,268 @@
|
|||||||
name: VGA_Test
|
name:
|
||||||
topmodule: VGA_Test_Top
|
topmodule:
|
||||||
target_device: xc3s1200e-4-fg320
|
target_device: xc3s1200e-4-fg320
|
||||||
xilinx_path: /opt/Xilinx/14.7/ISE_DS/ISE
|
xilinx_path: /opt/Xilinx/14.7/ISE_DS/ISE
|
||||||
|
|
||||||
|
constraints:
|
||||||
|
|
||||||
sources:
|
sources:
|
||||||
vhdl:
|
vhdl:
|
||||||
- path: src/vga/*.vhd
|
- path: src/*.vhd
|
||||||
library: work
|
library: work
|
||||||
- path: src/common/*.vhd
|
|
||||||
library: work
|
|
||||||
- path: src/VGA_test_top.vhd
|
|
||||||
library: work
|
|
||||||
|
|
||||||
verilog:
|
|
||||||
- path: src/old_modules/*.v
|
|
||||||
library: work
|
|
||||||
|
|
||||||
dependencies:
|
|
||||||
- name: AsyncFIFO
|
|
||||||
git: "https://github.com/0xMax32/Asynchronous-FIFO-AXI-Handshake.git"
|
|
||||||
rev: "main"
|
|
||||||
library: asyncfifo
|
|
||||||
- name: GrayCounter
|
|
||||||
git: "https://github.com/0xMax32/Gray-Counter.git"
|
|
||||||
rev: "v1.0.0"
|
|
||||||
library: graycounter
|
|
||||||
|
|
||||||
testbenches:
|
testbenches:
|
||||||
vhdl:
|
vhdl:
|
||||||
- path: src/tests/*.vhd
|
- path: tests/*.vhd
|
||||||
library: work
|
library: work
|
||||||
|
|
||||||
verilog: []
|
dependencies:
|
||||||
|
# - git: "https://git.0xmax42.io/maxp/Asynchronous-FIFO-AXI-Handshake.git"
|
||||||
constraints: constraints/VGA_Test.ucf
|
# rev: "hdlbuild"
|
||||||
|
|
||||||
build:
|
build:
|
||||||
build_dir: working
|
build_dir: working
|
||||||
report_dir: reports
|
report_dir: reports
|
||||||
copy_target_dir: output
|
copy_target_dir: output
|
||||||
|
|
||||||
|
# Tool Optionen
|
||||||
|
tool_options:
|
||||||
|
common:
|
||||||
|
- "-intstyle"
|
||||||
|
- "xflow"
|
||||||
|
|
||||||
|
ngdbuild: []
|
||||||
|
|
||||||
|
map:
|
||||||
|
- "-detail"
|
||||||
|
- "-timing"
|
||||||
|
- "-ol"
|
||||||
|
- "high"
|
||||||
|
|
||||||
|
par: []
|
||||||
|
|
||||||
|
bitgen:
|
||||||
|
- "-g"
|
||||||
|
- "StartupClk:JtagClk"
|
||||||
|
|
||||||
|
trace:
|
||||||
|
- "-v"
|
||||||
|
- "3"
|
||||||
|
- "-n"
|
||||||
|
- "3"
|
||||||
|
|
||||||
|
fuse:
|
||||||
|
- "-incremental"
|
||||||
|
|
||||||
|
isim:
|
||||||
|
- "-gui"
|
||||||
|
|
||||||
|
xst:
|
||||||
|
# Optimization goal: prioritize speed or area.
|
||||||
|
# Values: Speed | Area
|
||||||
|
- "-opt_mode Speed"
|
||||||
|
|
||||||
|
# Optimization level: more aggressive optimizations at level 2.
|
||||||
|
# Values: 1 | 2
|
||||||
|
- "-opt_level 2"
|
||||||
|
|
||||||
|
# Use the new XST parser (recommended for modern designs).
|
||||||
|
# Values: yes | no
|
||||||
|
- "-use_new_parser yes"
|
||||||
|
|
||||||
|
# Preserve design hierarchy or allow flattening for optimization.
|
||||||
|
# Values: Yes | No | Soft
|
||||||
|
- "-keep_hierarchy No"
|
||||||
|
|
||||||
|
# Determines how hierarchy is preserved in the netlist.
|
||||||
|
# Values: As_Optimized | Rebuilt
|
||||||
|
- "-netlist_hierarchy As_Optimized"
|
||||||
|
|
||||||
|
# Global optimization strategy for nets.
|
||||||
|
# Values: AllClockNets | Offset_In_Before | Offset_Out_After | Inpad_To_Outpad | Max_Delay
|
||||||
|
- "-glob_opt AllClockNets"
|
||||||
|
|
||||||
|
## Misc ##
|
||||||
|
|
||||||
|
# Enable reading of IP cores.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-read_cores YES"
|
||||||
|
|
||||||
|
# Do not write timing constraints into synthesis report.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-write_timing_constraints NO"
|
||||||
|
|
||||||
|
# Analyze paths across different clock domains.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-cross_clock_analysis NO"
|
||||||
|
|
||||||
|
# Character used to separate hierarchy levels in instance names.
|
||||||
|
# Default: /
|
||||||
|
- "-hierarchy_separator /"
|
||||||
|
|
||||||
|
# Delimiters used for bus signals.
|
||||||
|
# Values: <> | [] | () | {}
|
||||||
|
- "-bus_delimiter <>"
|
||||||
|
|
||||||
|
# Maintain original case of identifiers.
|
||||||
|
# Values: Maintain | Upper | Lower
|
||||||
|
- "-case Maintain"
|
||||||
|
|
||||||
|
# Target maximum utilization ratio for slices.
|
||||||
|
# Values: 1–100
|
||||||
|
- "-slice_utilization_ratio 100"
|
||||||
|
|
||||||
|
# Target maximum utilization ratio for BRAMs.
|
||||||
|
# Values: 1–100
|
||||||
|
- "-bram_utilization_ratio 100"
|
||||||
|
|
||||||
|
# Use Verilog 2001 syntax features.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-verilog2001 YES"
|
||||||
|
|
||||||
|
#### HDL Options ####
|
||||||
|
|
||||||
|
## FSM ##
|
||||||
|
|
||||||
|
# Extract FSMs (Finite State Machines) from HDL code.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-fsm_extract YES"
|
||||||
|
|
||||||
|
# Encoding strategy for FSMs.
|
||||||
|
# Values: Auto | Gray | One-Hot | Johnson | Compact | Sequential | Speed1 | User
|
||||||
|
- "-fsm_encoding Auto"
|
||||||
|
|
||||||
|
# Add safe logic for undefined FSM states.
|
||||||
|
# Values: Yes | No
|
||||||
|
- "-safe_implementation No"
|
||||||
|
|
||||||
|
# Structure used to implement FSMs.
|
||||||
|
# Values: LUT | BRAM
|
||||||
|
- "-fsm_style LUT"
|
||||||
|
|
||||||
|
## RAM/ROM ##
|
||||||
|
|
||||||
|
# Extract RAM inference from HDL.
|
||||||
|
# Values: Yes | No
|
||||||
|
- "-ram_extract Yes"
|
||||||
|
|
||||||
|
# Style used to implement RAM.
|
||||||
|
# Values: Auto | Block | Distributed
|
||||||
|
- "-ram_style Auto"
|
||||||
|
|
||||||
|
# Extract ROM inference from HDL.
|
||||||
|
# Values: Yes | No
|
||||||
|
- "-rom_extract Yes"
|
||||||
|
|
||||||
|
# Style used for implementing ROM.
|
||||||
|
# Values: Auto | Distributed | Block
|
||||||
|
- "-rom_style Auto"
|
||||||
|
|
||||||
|
# Enable or disable automatic BRAM packing.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-auto_bram_packing NO"
|
||||||
|
|
||||||
|
## MUX/Decoder/Shift Register ##
|
||||||
|
|
||||||
|
# Extract multiplexers where possible.
|
||||||
|
# Values: Yes | No | Force
|
||||||
|
- "-mux_extract Yes"
|
||||||
|
|
||||||
|
# Style used for implementing MUX logic.
|
||||||
|
# Values: Auto | MUXCY | MUXF
|
||||||
|
- "-mux_style Auto"
|
||||||
|
|
||||||
|
# Extract decoder logic from behavioral code.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-decoder_extract YES"
|
||||||
|
|
||||||
|
# Extract and optimize priority encoder structures.
|
||||||
|
# Values: Yes | No | Force
|
||||||
|
- "-priority_extract Yes"
|
||||||
|
|
||||||
|
# Extract shift register logic.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-shreg_extract YES"
|
||||||
|
|
||||||
|
# Extract simple shift operations into dedicated hardware.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-shift_extract YES"
|
||||||
|
|
||||||
|
## Multiplier ##
|
||||||
|
|
||||||
|
# Style for implementing multipliers.
|
||||||
|
# Values: Auto | LUT | Pipe_LUT | Pipe_Block | Block
|
||||||
|
- "-mult_style Auto"
|
||||||
|
|
||||||
|
## Misc ##
|
||||||
|
|
||||||
|
# Collapse XOR trees where beneficial.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-xor_collapse YES"
|
||||||
|
|
||||||
|
# Share resources like adders or multipliers between logic blocks.
|
||||||
|
# Values: YES | NO | Force
|
||||||
|
- "-resource_sharing YES"
|
||||||
|
|
||||||
|
# Convert asynchronous resets to synchronous where possible.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-async_to_sync NO"
|
||||||
|
|
||||||
|
#### Xilinx Specific Options ####
|
||||||
|
|
||||||
|
## Optimization ##
|
||||||
|
|
||||||
|
# Enable removal of logically equivalent registers.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-equivalent_register_removal YES"
|
||||||
|
|
||||||
|
# Duplicate registers to reduce fanout or improve timing.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-register_duplication YES"
|
||||||
|
|
||||||
|
# Move registers across logic to balance timing.
|
||||||
|
# Values: Yes | No | Forward | Backward
|
||||||
|
- "-register_balancing No"
|
||||||
|
|
||||||
|
# Use clock enable signals where possible.
|
||||||
|
# Values: Auto | Yes | No
|
||||||
|
- "-use_clock_enable Yes"
|
||||||
|
|
||||||
|
# Use synchronous set (preset) signals when available.
|
||||||
|
# Values: Auto | Yes | No
|
||||||
|
- "-use_sync_set Yes"
|
||||||
|
|
||||||
|
# Use synchronous reset signals where possible.
|
||||||
|
# Values: Auto | Yes | No
|
||||||
|
- "-use_sync_reset Yes"
|
||||||
|
|
||||||
|
## I/O ##
|
||||||
|
|
||||||
|
# Insert IO buffers for top-level ports.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-iobuf YES"
|
||||||
|
|
||||||
|
# Placement strategy for IOB registers (Auto = let tools decide).
|
||||||
|
# Values: Auto | YES | NO
|
||||||
|
- "-iob Auto"
|
||||||
|
|
||||||
|
## Misc ##
|
||||||
|
|
||||||
|
# Maximum allowed fanout for a net.
|
||||||
|
# Values: integer (e.g., 500)
|
||||||
|
- "-max_fanout 500"
|
||||||
|
|
||||||
|
# Maximum number of BUFGs (global buffers) to use.
|
||||||
|
# Values: 0–32 (device-dependent)
|
||||||
|
- "-bufg 24"
|
||||||
|
|
||||||
|
# Enable logic packing into slices.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-slice_packing YES"
|
||||||
|
|
||||||
|
# Try to reduce the number of primitive instances used.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-optimize_primitives NO"
|
||||||
|
|
||||||
|
# Margin in percent beyond the target slice utilization.
|
||||||
|
# Values: 0–100
|
||||||
|
- "-slice_utilization_ratio_maxmargin 5"
|
@@ -1,11 +1,12 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "hdlbuild"
|
name = "hdlbuild"
|
||||||
version = "0.2.0"
|
version = "0.6.1"
|
||||||
description = "Flexible FPGA Build System"
|
description = "Flexible FPGA Build System"
|
||||||
authors = ["0xMax42 <Mail@0xMax42.io>"]
|
authors = ["0xMax42 <Mail@0xMax42.io>"]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
packages = [{ include = "hdlbuild", from = "src" }]
|
packages = [{ include = "hdlbuild", from = "src" }]
|
||||||
|
include = ["src/hdlbuild/templates/*"]
|
||||||
|
|
||||||
[tool.poetry.scripts]
|
[tool.poetry.scripts]
|
||||||
hdlbuild = "hdlbuild.cli:main"
|
hdlbuild = "hdlbuild.cli:main"
|
||||||
@@ -13,10 +14,13 @@ hdlbuild = "hdlbuild.cli:main"
|
|||||||
[tool.poetry.dependencies]
|
[tool.poetry.dependencies]
|
||||||
python = "^3.10"
|
python = "^3.10"
|
||||||
pyyaml = "^6.0.2"
|
pyyaml = "^6.0.2"
|
||||||
doit = "^0.36.0"
|
|
||||||
pydantic = "^2.11.3"
|
pydantic = "^2.11.3"
|
||||||
rich = "^14.0.0"
|
rich = "^14.0.0"
|
||||||
gitpython = "^3.1.44"
|
gitpython = "^3.1.44"
|
||||||
|
typer = "^0.16.0"
|
||||||
|
|
||||||
|
[tool.poetry.group.dev.dependencies]
|
||||||
|
twine = "^6.1.0"
|
||||||
|
|
||||||
[build-system]
|
[build-system]
|
||||||
requires = ["poetry-core"]
|
requires = ["poetry-core"]
|
||||||
|
@@ -1,98 +1,32 @@
|
|||||||
import argparse
|
import typer
|
||||||
import sys
|
from importlib.metadata import version, PackageNotFoundError
|
||||||
|
|
||||||
from hdlbuild.dependencies.resolver import DependencyResolver
|
from hdlbuild.commands.build import cli as build_cli
|
||||||
from hdlbuild.models.config import DIRECTORIES
|
from hdlbuild.commands.clean import cli as clean_cli
|
||||||
from hdlbuild.tools.xilinx_ise.isim import build_testbench, generate_simulation_project_file, run_testbench
|
from hdlbuild.commands.dep import cli as dep_cli
|
||||||
from hdlbuild.tools.xilinx_ise.main import xilinx_ise_all, xilinx_ise_synth
|
from hdlbuild.commands.test import cli as test_cli
|
||||||
from hdlbuild.utils.console_utils import ConsoleUtils
|
from hdlbuild.commands.init import cli as init_cli
|
||||||
from hdlbuild.utils.directory_manager import clear_build_directories, clear_directories, ensure_directories_exist
|
|
||||||
from hdlbuild.utils.project_loader import load_project_config
|
|
||||||
|
|
||||||
project = load_project_config()
|
def get_version() -> str:
|
||||||
console_utils = ConsoleUtils("hdlbuild")
|
try:
|
||||||
|
return version("hdlbuild")
|
||||||
|
except PackageNotFoundError:
|
||||||
|
return "unknown"
|
||||||
|
|
||||||
def clear(args):
|
app = typer.Typer(
|
||||||
"""Clears the build artifacts."""
|
rich_help_panel="ℹ️ HDLBuild – FPGA‑Build‑Tool",
|
||||||
if args.target == "all":
|
help=f"hdlbuild v{get_version()} – Build‑Management for FPGA projects"
|
||||||
console_utils.print("Starting clear all process...")
|
)
|
||||||
clear_directories()
|
|
||||||
console_utils.print("All cleared.")
|
|
||||||
else:
|
|
||||||
console_utils.print("Clearing build artifacts...")
|
|
||||||
clear_build_directories()
|
|
||||||
console_utils.print("Build artifacts cleared.")
|
|
||||||
|
|
||||||
def build(args):
|
|
||||||
"""Starts the build process."""
|
|
||||||
console_utils.print("Starting build process...")
|
|
||||||
ensure_directories_exist(True)
|
|
||||||
xilinx_ise_all(project)
|
|
||||||
|
|
||||||
def synth(args):
|
|
||||||
"""Starts the build process."""
|
|
||||||
console_utils.print("Starting build process...")
|
|
||||||
ensure_directories_exist()
|
|
||||||
xilinx_ise_synth(project)
|
|
||||||
|
|
||||||
def dep(args):
|
|
||||||
"""Starts the dependencies process."""
|
|
||||||
console_utils.print("Starting dependencies process...")
|
|
||||||
DependencyResolver(project).resolve_all()
|
|
||||||
|
|
||||||
def test(args):
|
|
||||||
"""Starts the test process."""
|
|
||||||
console_utils.print("Starting test process...")
|
|
||||||
build_testbench(project, args.target)
|
|
||||||
run_testbench(args.target)
|
|
||||||
|
|
||||||
|
# Unter‑Kommandos registrieren (entspricht add_subparsers)
|
||||||
|
app.add_typer(build_cli, name="build", help="Build the project")
|
||||||
|
app.add_typer(clean_cli, name="clean", help="Clean build artifacts")
|
||||||
|
app.add_typer(dep_cli, name="dep", help="Resolve dependencies")
|
||||||
|
app.add_typer(test_cli, name="test", help="Run simulations/testbenches")
|
||||||
|
app.add_typer(init_cli, name="init", help="Initialize project")
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
parser = argparse.ArgumentParser(
|
app()
|
||||||
description="hdlbuild - Build management tool for FPGA projects",
|
|
||||||
formatter_class=argparse.RawTextHelpFormatter
|
|
||||||
)
|
|
||||||
|
|
||||||
subparsers = parser.add_subparsers(
|
|
||||||
title="Commands",
|
|
||||||
description="Available commands",
|
|
||||||
dest="command",
|
|
||||||
required=True
|
|
||||||
)
|
|
||||||
|
|
||||||
# Clear command
|
|
||||||
parser_clear = subparsers.add_parser("clear", help="Clear build artifacts")
|
|
||||||
parser_clear.add_argument(
|
|
||||||
"target",
|
|
||||||
nargs="?",
|
|
||||||
choices=["all"],
|
|
||||||
help="Specify 'all' to clear everything (optional)"
|
|
||||||
)
|
|
||||||
parser_clear.set_defaults(func=clear)
|
|
||||||
|
|
||||||
# Build command
|
|
||||||
parser_build = subparsers.add_parser("build", help="Start the build process")
|
|
||||||
parser_build.set_defaults(func=build)
|
|
||||||
|
|
||||||
# Synth command
|
|
||||||
parser_synth = subparsers.add_parser("synth", help="Start the synth process")
|
|
||||||
parser_synth.set_defaults(func=synth)
|
|
||||||
|
|
||||||
# Dependencies command
|
|
||||||
parser_dep = subparsers.add_parser("dep", help="Start the dependencies process")
|
|
||||||
parser_dep.set_defaults(func=dep)
|
|
||||||
|
|
||||||
# Tests command
|
|
||||||
parser_test = subparsers.add_parser("test", help="Start the Tests process")
|
|
||||||
parser_test.set_defaults(func=test)
|
|
||||||
parser_test.add_argument(
|
|
||||||
"target",
|
|
||||||
nargs="?",
|
|
||||||
help="Select the target to test"
|
|
||||||
)
|
|
||||||
|
|
||||||
args = parser.parse_args()
|
|
||||||
args.func(args)
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
main()
|
main()
|
34
src/hdlbuild/commands/build.py
Normal file
34
src/hdlbuild/commands/build.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import typer
|
||||||
|
|
||||||
|
from hdlbuild.tools.xilinx_ise.main import xilinx_ise_all, xilinx_ise_synth
|
||||||
|
from hdlbuild.utils.console_utils import ConsoleUtils
|
||||||
|
from hdlbuild.utils.directory_manager import ensure_directories_exist
|
||||||
|
from hdlbuild.utils.project_loader import load_project_config
|
||||||
|
|
||||||
|
cli = typer.Typer(rich_help_panel="🔨 Build Commands")
|
||||||
|
|
||||||
|
@cli.callback(invoke_without_command=True)
|
||||||
|
def build(
|
||||||
|
target: str = typer.Argument(
|
||||||
|
None,
|
||||||
|
help="Optional: 'synth' to run synthesis only",
|
||||||
|
show_default=False,
|
||||||
|
rich_help_panel="🔨 Build Commands",
|
||||||
|
)
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
Run the full build flow or synthesis only.
|
||||||
|
|
||||||
|
* `hdlbuild build` → full flow
|
||||||
|
* `hdlbuild build synth` → synthesis only
|
||||||
|
"""
|
||||||
|
console = ConsoleUtils("hdlbuild")
|
||||||
|
project = load_project_config()
|
||||||
|
|
||||||
|
ensure_directories_exist(True)
|
||||||
|
if target == "synth":
|
||||||
|
console.print("Starting synthesis …")
|
||||||
|
xilinx_ise_synth(project)
|
||||||
|
else:
|
||||||
|
console.print("Starting full build …")
|
||||||
|
xilinx_ise_all(project)
|
35
src/hdlbuild/commands/clean.py
Normal file
35
src/hdlbuild/commands/clean.py
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import typer
|
||||||
|
|
||||||
|
from hdlbuild.utils.console_utils import ConsoleUtils
|
||||||
|
from hdlbuild.utils.directory_manager import clear_build_directories, clear_directories
|
||||||
|
|
||||||
|
cli = typer.Typer(rich_help_panel="🧹 Clean Commands")
|
||||||
|
|
||||||
|
@cli.callback(invoke_without_command=True)
|
||||||
|
def clean(
|
||||||
|
target: str = typer.Argument(
|
||||||
|
None,
|
||||||
|
help="Optional: 'all' → wipe *all* artefacts, otherwise only the build directory",
|
||||||
|
show_default=False,
|
||||||
|
)
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
Remove build artefacts (`build/*`) or *everything* (`all`).
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
```bash
|
||||||
|
hdlbuild clean # build/* and temporary files only
|
||||||
|
hdlbuild clean all # also caches, logs, etc.
|
||||||
|
```
|
||||||
|
"""
|
||||||
|
console = ConsoleUtils("hdlbuild")
|
||||||
|
|
||||||
|
if target == "all":
|
||||||
|
console.print("Starting clean‑all …")
|
||||||
|
clear_directories()
|
||||||
|
console.print("All artefacts removed.")
|
||||||
|
else:
|
||||||
|
console.print("Removing build artefacts …")
|
||||||
|
clear_build_directories()
|
||||||
|
console.print("Build artefacts removed.")
|
23
src/hdlbuild/commands/dep.py
Normal file
23
src/hdlbuild/commands/dep.py
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
import typer
|
||||||
|
|
||||||
|
from hdlbuild.dependencies.resolver import DependencyResolver
|
||||||
|
from hdlbuild.utils.console_utils import ConsoleUtils
|
||||||
|
from hdlbuild.utils.project_loader import load_project_config
|
||||||
|
|
||||||
|
cli = typer.Typer(rich_help_panel="🔗 Dependency Commands")
|
||||||
|
|
||||||
|
@cli.callback(invoke_without_command=True)
|
||||||
|
def dep() -> None:
|
||||||
|
"""
|
||||||
|
Resolve all project dependencies.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hdlbuild dep
|
||||||
|
```
|
||||||
|
"""
|
||||||
|
console = ConsoleUtils("hdlbuild")
|
||||||
|
project = load_project_config()
|
||||||
|
|
||||||
|
console.print("Resolving dependencies …")
|
||||||
|
DependencyResolver(project).resolve_all()
|
||||||
|
console.print("Dependencies resolved.")
|
35
src/hdlbuild/commands/init.py
Normal file
35
src/hdlbuild/commands/init.py
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import shutil
|
||||||
|
from pathlib import Path
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from hdlbuild.utils.console_utils import ConsoleUtils
|
||||||
|
|
||||||
|
cli = typer.Typer(rich_help_panel="🆕 Init Commands")
|
||||||
|
|
||||||
|
@cli.callback(invoke_without_command=True)
|
||||||
|
def init() -> None:
|
||||||
|
"""
|
||||||
|
Initialise a new HDLBuild project in the current directory.
|
||||||
|
|
||||||
|
Copies `.gitignore` and `project.yml` from the template folder.
|
||||||
|
"""
|
||||||
|
console = ConsoleUtils("hdlbuild")
|
||||||
|
project_dir = Path.cwd()
|
||||||
|
|
||||||
|
script_dir = Path(__file__).parent.resolve()
|
||||||
|
template_dir = (script_dir / ".." / "templates").resolve()
|
||||||
|
|
||||||
|
files = [
|
||||||
|
("gitignore.template", ".gitignore"),
|
||||||
|
("project.yml.template", "project.yml"),
|
||||||
|
]
|
||||||
|
|
||||||
|
for template_name, target_name in files:
|
||||||
|
template_path = template_dir / template_name
|
||||||
|
target_path = project_dir / target_name
|
||||||
|
|
||||||
|
if not target_path.exists():
|
||||||
|
shutil.copy(template_path, target_path)
|
||||||
|
console.print(f"Created {target_name}")
|
||||||
|
else:
|
||||||
|
console.print(f"{target_name} already exists – skipping.")
|
31
src/hdlbuild/commands/test.py
Normal file
31
src/hdlbuild/commands/test.py
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
import typer
|
||||||
|
|
||||||
|
from hdlbuild.tools.xilinx_ise.isim import build_testbench, run_testbench
|
||||||
|
from hdlbuild.utils.console_utils import ConsoleUtils
|
||||||
|
from hdlbuild.utils.project_loader import load_project_config
|
||||||
|
|
||||||
|
cli = typer.Typer(rich_help_panel="🧪 Test Commands")
|
||||||
|
|
||||||
|
@cli.callback(invoke_without_command=True)
|
||||||
|
def test(
|
||||||
|
target: str = typer.Argument(
|
||||||
|
None,
|
||||||
|
help="Name of the test target (leave empty to run all)",
|
||||||
|
show_default=False,
|
||||||
|
)
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
Build and run testbenches.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hdlbuild test # run all TBs
|
||||||
|
hdlbuild test alu # run TB 'alu' only
|
||||||
|
```
|
||||||
|
"""
|
||||||
|
console = ConsoleUtils("hdlbuild")
|
||||||
|
project = load_project_config()
|
||||||
|
|
||||||
|
console.print("Starting test flow …")
|
||||||
|
build_testbench(project, target)
|
||||||
|
run_testbench(project, target)
|
||||||
|
console.print("Tests finished.")
|
@@ -14,6 +14,7 @@ class ToolOptions(BaseModel):
|
|||||||
bitgen: List[str] = Field(default_factory=list)
|
bitgen: List[str] = Field(default_factory=list)
|
||||||
trace: List[str] = Field(default_factory=list)
|
trace: List[str] = Field(default_factory=list)
|
||||||
fuse: List[str] = Field(default_factory=list)
|
fuse: List[str] = Field(default_factory=list)
|
||||||
|
isim: List[str] = Field(default_factory=list)
|
||||||
|
|
||||||
class Dependency(BaseModel):
|
class Dependency(BaseModel):
|
||||||
name: Optional[str] = None # Name ist jetzt optional
|
name: Optional[str] = None # Name ist jetzt optional
|
||||||
|
6
src/hdlbuild/templates/gitignore.template
Normal file
6
src/hdlbuild/templates/gitignore.template
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
.hdlbuild_deps/
|
||||||
|
.working/
|
||||||
|
reports/
|
||||||
|
output/
|
||||||
|
.locale/
|
||||||
|
vhdl_ls.toml
|
268
src/hdlbuild/templates/project.yml.template
Normal file
268
src/hdlbuild/templates/project.yml.template
Normal file
@@ -0,0 +1,268 @@
|
|||||||
|
name:
|
||||||
|
topmodule:
|
||||||
|
target_device: xc3s1200e-4-fg320
|
||||||
|
xilinx_path: /opt/Xilinx/14.7/ISE_DS/ISE
|
||||||
|
|
||||||
|
constraints:
|
||||||
|
|
||||||
|
sources:
|
||||||
|
vhdl:
|
||||||
|
- path: src/*.vhd
|
||||||
|
library: work
|
||||||
|
|
||||||
|
testbenches:
|
||||||
|
vhdl:
|
||||||
|
- path: tests/*.vhd
|
||||||
|
library: work
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
# - git: "https://git.0xmax42.io/maxp/Asynchronous-FIFO-AXI-Handshake.git"
|
||||||
|
# rev: "hdlbuild"
|
||||||
|
|
||||||
|
build:
|
||||||
|
build_dir: working
|
||||||
|
report_dir: reports
|
||||||
|
copy_target_dir: output
|
||||||
|
|
||||||
|
# Tool Optionen
|
||||||
|
tool_options:
|
||||||
|
common:
|
||||||
|
- "-intstyle"
|
||||||
|
- "xflow"
|
||||||
|
|
||||||
|
ngdbuild: []
|
||||||
|
|
||||||
|
map:
|
||||||
|
- "-detail"
|
||||||
|
- "-timing"
|
||||||
|
- "-ol"
|
||||||
|
- "high"
|
||||||
|
|
||||||
|
par: []
|
||||||
|
|
||||||
|
bitgen:
|
||||||
|
- "-g"
|
||||||
|
- "StartupClk:JtagClk"
|
||||||
|
|
||||||
|
trace:
|
||||||
|
- "-v"
|
||||||
|
- "3"
|
||||||
|
- "-n"
|
||||||
|
- "3"
|
||||||
|
|
||||||
|
fuse:
|
||||||
|
- "-incremental"
|
||||||
|
|
||||||
|
isim:
|
||||||
|
- "-gui"
|
||||||
|
|
||||||
|
xst:
|
||||||
|
# Optimization goal: prioritize speed or area.
|
||||||
|
# Values: Speed | Area
|
||||||
|
- "-opt_mode Speed"
|
||||||
|
|
||||||
|
# Optimization level: more aggressive optimizations at level 2.
|
||||||
|
# Values: 1 | 2
|
||||||
|
- "-opt_level 2"
|
||||||
|
|
||||||
|
# Use the new XST parser (recommended for modern designs).
|
||||||
|
# Values: yes | no
|
||||||
|
- "-use_new_parser yes"
|
||||||
|
|
||||||
|
# Preserve design hierarchy or allow flattening for optimization.
|
||||||
|
# Values: Yes | No | Soft
|
||||||
|
- "-keep_hierarchy No"
|
||||||
|
|
||||||
|
# Determines how hierarchy is preserved in the netlist.
|
||||||
|
# Values: As_Optimized | Rebuilt
|
||||||
|
- "-netlist_hierarchy As_Optimized"
|
||||||
|
|
||||||
|
# Global optimization strategy for nets.
|
||||||
|
# Values: AllClockNets | Offset_In_Before | Offset_Out_After | Inpad_To_Outpad | Max_Delay
|
||||||
|
- "-glob_opt AllClockNets"
|
||||||
|
|
||||||
|
## Misc ##
|
||||||
|
|
||||||
|
# Enable reading of IP cores.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-read_cores YES"
|
||||||
|
|
||||||
|
# Do not write timing constraints into synthesis report.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-write_timing_constraints NO"
|
||||||
|
|
||||||
|
# Analyze paths across different clock domains.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-cross_clock_analysis NO"
|
||||||
|
|
||||||
|
# Character used to separate hierarchy levels in instance names.
|
||||||
|
# Default: /
|
||||||
|
- "-hierarchy_separator /"
|
||||||
|
|
||||||
|
# Delimiters used for bus signals.
|
||||||
|
# Values: <> | [] | () | {}
|
||||||
|
- "-bus_delimiter <>"
|
||||||
|
|
||||||
|
# Maintain original case of identifiers.
|
||||||
|
# Values: Maintain | Upper | Lower
|
||||||
|
- "-case Maintain"
|
||||||
|
|
||||||
|
# Target maximum utilization ratio for slices.
|
||||||
|
# Values: 1–100
|
||||||
|
- "-slice_utilization_ratio 100"
|
||||||
|
|
||||||
|
# Target maximum utilization ratio for BRAMs.
|
||||||
|
# Values: 1–100
|
||||||
|
- "-bram_utilization_ratio 100"
|
||||||
|
|
||||||
|
# Use Verilog 2001 syntax features.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-verilog2001 YES"
|
||||||
|
|
||||||
|
#### HDL Options ####
|
||||||
|
|
||||||
|
## FSM ##
|
||||||
|
|
||||||
|
# Extract FSMs (Finite State Machines) from HDL code.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-fsm_extract YES"
|
||||||
|
|
||||||
|
# Encoding strategy for FSMs.
|
||||||
|
# Values: Auto | Gray | One-Hot | Johnson | Compact | Sequential | Speed1 | User
|
||||||
|
- "-fsm_encoding Auto"
|
||||||
|
|
||||||
|
# Add safe logic for undefined FSM states.
|
||||||
|
# Values: Yes | No
|
||||||
|
- "-safe_implementation No"
|
||||||
|
|
||||||
|
# Structure used to implement FSMs.
|
||||||
|
# Values: LUT | BRAM
|
||||||
|
- "-fsm_style LUT"
|
||||||
|
|
||||||
|
## RAM/ROM ##
|
||||||
|
|
||||||
|
# Extract RAM inference from HDL.
|
||||||
|
# Values: Yes | No
|
||||||
|
- "-ram_extract Yes"
|
||||||
|
|
||||||
|
# Style used to implement RAM.
|
||||||
|
# Values: Auto | Block | Distributed
|
||||||
|
- "-ram_style Auto"
|
||||||
|
|
||||||
|
# Extract ROM inference from HDL.
|
||||||
|
# Values: Yes | No
|
||||||
|
- "-rom_extract Yes"
|
||||||
|
|
||||||
|
# Style used for implementing ROM.
|
||||||
|
# Values: Auto | Distributed | Block
|
||||||
|
- "-rom_style Auto"
|
||||||
|
|
||||||
|
# Enable or disable automatic BRAM packing.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-auto_bram_packing NO"
|
||||||
|
|
||||||
|
## MUX/Decoder/Shift Register ##
|
||||||
|
|
||||||
|
# Extract multiplexers where possible.
|
||||||
|
# Values: Yes | No | Force
|
||||||
|
- "-mux_extract Yes"
|
||||||
|
|
||||||
|
# Style used for implementing MUX logic.
|
||||||
|
# Values: Auto | MUXCY | MUXF
|
||||||
|
- "-mux_style Auto"
|
||||||
|
|
||||||
|
# Extract decoder logic from behavioral code.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-decoder_extract YES"
|
||||||
|
|
||||||
|
# Extract and optimize priority encoder structures.
|
||||||
|
# Values: Yes | No | Force
|
||||||
|
- "-priority_extract Yes"
|
||||||
|
|
||||||
|
# Extract shift register logic.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-shreg_extract YES"
|
||||||
|
|
||||||
|
# Extract simple shift operations into dedicated hardware.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-shift_extract YES"
|
||||||
|
|
||||||
|
## Multiplier ##
|
||||||
|
|
||||||
|
# Style for implementing multipliers.
|
||||||
|
# Values: Auto | LUT | Pipe_LUT | Pipe_Block | Block
|
||||||
|
- "-mult_style Auto"
|
||||||
|
|
||||||
|
## Misc ##
|
||||||
|
|
||||||
|
# Collapse XOR trees where beneficial.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-xor_collapse YES"
|
||||||
|
|
||||||
|
# Share resources like adders or multipliers between logic blocks.
|
||||||
|
# Values: YES | NO | Force
|
||||||
|
- "-resource_sharing YES"
|
||||||
|
|
||||||
|
# Convert asynchronous resets to synchronous where possible.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-async_to_sync NO"
|
||||||
|
|
||||||
|
#### Xilinx Specific Options ####
|
||||||
|
|
||||||
|
## Optimization ##
|
||||||
|
|
||||||
|
# Enable removal of logically equivalent registers.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-equivalent_register_removal YES"
|
||||||
|
|
||||||
|
# Duplicate registers to reduce fanout or improve timing.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-register_duplication YES"
|
||||||
|
|
||||||
|
# Move registers across logic to balance timing.
|
||||||
|
# Values: Yes | No | Forward | Backward
|
||||||
|
- "-register_balancing No"
|
||||||
|
|
||||||
|
# Use clock enable signals where possible.
|
||||||
|
# Values: Auto | Yes | No
|
||||||
|
- "-use_clock_enable Yes"
|
||||||
|
|
||||||
|
# Use synchronous set (preset) signals when available.
|
||||||
|
# Values: Auto | Yes | No
|
||||||
|
- "-use_sync_set Yes"
|
||||||
|
|
||||||
|
# Use synchronous reset signals where possible.
|
||||||
|
# Values: Auto | Yes | No
|
||||||
|
- "-use_sync_reset Yes"
|
||||||
|
|
||||||
|
## I/O ##
|
||||||
|
|
||||||
|
# Insert IO buffers for top-level ports.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-iobuf YES"
|
||||||
|
|
||||||
|
# Placement strategy for IOB registers (Auto = let tools decide).
|
||||||
|
# Values: Auto | YES | NO
|
||||||
|
- "-iob Auto"
|
||||||
|
|
||||||
|
## Misc ##
|
||||||
|
|
||||||
|
# Maximum allowed fanout for a net.
|
||||||
|
# Values: integer (e.g., 500)
|
||||||
|
- "-max_fanout 500"
|
||||||
|
|
||||||
|
# Maximum number of BUFGs (global buffers) to use.
|
||||||
|
# Values: 0–32 (device-dependent)
|
||||||
|
- "-bufg 24"
|
||||||
|
|
||||||
|
# Enable logic packing into slices.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-slice_packing YES"
|
||||||
|
|
||||||
|
# Try to reduce the number of primitive instances used.
|
||||||
|
# Values: YES | NO
|
||||||
|
- "-optimize_primitives NO"
|
||||||
|
|
||||||
|
# Margin in percent beyond the target slice utilization.
|
||||||
|
# Values: 0–100
|
||||||
|
- "-slice_utilization_ratio_maxmargin 5"
|
@@ -4,6 +4,7 @@ from typing import List
|
|||||||
from hdlbuild.models.project import ProjectConfig
|
from hdlbuild.models.project import ProjectConfig
|
||||||
from hdlbuild.models.config import DIRECTORIES
|
from hdlbuild.models.config import DIRECTORIES
|
||||||
from hdlbuild.dependencies.resolver import DependencyResolver
|
from hdlbuild.dependencies.resolver import DependencyResolver
|
||||||
|
from hdlbuild.tools.xilinx_ise.common import run_tool
|
||||||
from hdlbuild.utils.console_utils import ConsoleTask
|
from hdlbuild.utils.console_utils import ConsoleTask
|
||||||
from hdlbuild.utils.source_resolver import expand_all_sources, expand_testbenches
|
from hdlbuild.utils.source_resolver import expand_all_sources, expand_testbenches
|
||||||
|
|
||||||
@@ -86,28 +87,24 @@ def build_testbench(project: ProjectConfig, testbench_name: str):
|
|||||||
testbench_name=testbench_name
|
testbench_name=testbench_name
|
||||||
)
|
)
|
||||||
|
|
||||||
# 2. Befehl bauen
|
# 2. FUSE-Befehl ausführen mit `run_tool`
|
||||||
xilinx_path = project.xilinx_path
|
mandatory_arguments = [
|
||||||
xilinx_bin_dir = os.path.join(xilinx_path, "bin", "lin64") # oder nt64 bei Windows
|
|
||||||
fuse_executable = os.path.join(xilinx_bin_dir, "fuse")
|
|
||||||
|
|
||||||
cmd = [
|
|
||||||
fuse_executable,
|
|
||||||
"-intstyle", "xflow",
|
|
||||||
"-prj", f"{project.name}_sim.prj",
|
"-prj", f"{project.name}_sim.prj",
|
||||||
"-o", isim_exe_name,
|
"-o", isim_exe_name,
|
||||||
f"work.{testbench_name.replace('.vhd', '').replace('.v', '')}",
|
f"work.{testbench_name.replace('.vhd', '').replace('.v', '')}",
|
||||||
"work.glbl"
|
"work.glbl"
|
||||||
]
|
]
|
||||||
|
|
||||||
# 3. Ausführen mit Konsole
|
run_tool(
|
||||||
task = ConsoleTask(prefix="hdlbuild", title=f"FUSE {testbench_name}")
|
project=project,
|
||||||
result = task.run_command(cmd, cwd=DIRECTORIES.build)
|
tool_executable_name="fuse",
|
||||||
|
tool_option_attr="fuse",
|
||||||
|
mandatory_arguments=mandatory_arguments,
|
||||||
|
working_dir=DIRECTORIES.build,
|
||||||
|
silent=False
|
||||||
|
)
|
||||||
|
|
||||||
if result != 0:
|
def run_testbench(project: ProjectConfig, testbench_name: str):
|
||||||
raise RuntimeError(f"FUSE fehlgeschlagen für Testbench {testbench_name}")
|
|
||||||
|
|
||||||
def run_testbench(testbench_name: str):
|
|
||||||
"""
|
"""
|
||||||
Führt eine gebaute Testbench-Executable aus (ISim Simulation).
|
Führt eine gebaute Testbench-Executable aus (ISim Simulation).
|
||||||
|
|
||||||
@@ -116,7 +113,6 @@ def run_testbench(testbench_name: str):
|
|||||||
"""
|
"""
|
||||||
# Pfade
|
# Pfade
|
||||||
isim_exe_name = f"isim_{testbench_name.replace('.vhd', '').replace('.v', '')}"
|
isim_exe_name = f"isim_{testbench_name.replace('.vhd', '').replace('.v', '')}"
|
||||||
isim_exe_path = os.path.join(DIRECTORIES.build, isim_exe_name)
|
|
||||||
|
|
||||||
isim_cmd_file = os.path.join(DIRECTORIES.build, f"{isim_exe_name}.cmd")
|
isim_cmd_file = os.path.join(DIRECTORIES.build, f"{isim_exe_name}.cmd")
|
||||||
|
|
||||||
@@ -124,13 +120,17 @@ def run_testbench(testbench_name: str):
|
|||||||
with open(isim_cmd_file, "w") as f:
|
with open(isim_cmd_file, "w") as f:
|
||||||
f.write("")
|
f.write("")
|
||||||
|
|
||||||
|
cmd = [f"./{isim_exe_name}"]
|
||||||
|
|
||||||
|
tool_opts = getattr(project.tool_options, "isim", [])
|
||||||
|
if tool_opts:
|
||||||
|
cmd.extend(tool_opts)
|
||||||
|
|
||||||
# 2. Kommando bauen
|
# 2. Kommando bauen
|
||||||
cmd = [
|
cmd.extend([
|
||||||
f"./{isim_exe_name}",
|
|
||||||
"-gui",
|
|
||||||
"-tclbatch",
|
"-tclbatch",
|
||||||
f"{isim_exe_name}.cmd"
|
f"{isim_exe_name}.cmd"
|
||||||
]
|
])
|
||||||
|
|
||||||
# 3. Ausführen
|
# 3. Ausführen
|
||||||
task = ConsoleTask(prefix="hdlbuild", title=f"RUN {testbench_name}")
|
task = ConsoleTask(prefix="hdlbuild", title=f"RUN {testbench_name}")
|
||||||
|
Reference in New Issue
Block a user