PCILeechFWGenerator 0.5.7__tar.gz

pcileechfwgenerator-0.5.7/.coveragerc

@@ -0,0 +1,28 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source = pcileechfwgenerator
+# omit = bad_file.py
+
+[paths]
+source =
+    src/
+    */site-packages/
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

pcileechfwgenerator-0.5.7/.dockerignore

@@ -0,0 +1,137 @@
+# Git files and version control
+.git/
+.gitignore
+.gitattributes
+.gitmodules
+
+# Documentation and markdown files
+README.md
+*.md
+docs/
+CHANGELOG*
+CONTRIBUTING*
+AUTHORS*
+
+# Build artifacts and output
+output/
+build/
+!src/build.py
+dist/
+*.bin
+*.bit
+*.log
+*.out
+*.exe
+*.dll
+*.dylib
+*.a
+*.lib
+
+# Python cache and bytecode
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+.Python
+*.so
+*.egg-info/
+.pytest_cache/
+.coverage
+.tox/
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.vim/
+.emacs.d/
+*.sublime-*
+
+# OS-specific files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+desktop.ini
+
+# Temporary and cache files
+*.tmp
+*.temp
+*.cache
+/tmp/
+.cache/
+node_modules/
+
+# Container and deployment files
+Containerfile
+Dockerfile*
+.dockerignore
+docker-compose*.yml
+.env
+.env.*
+
+# Installation and setup scripts (not needed in container)
+install.sh
+setup.sh
+configure.sh
+
+# License and legal files (not needed for runtime)
+LICENSE*
+COPYING*
+COPYRIGHT*
+
+# Test files and directories
+tests/
+test/
+*_test.py
+test_*.py
+*.test
+
+# Configuration files that shouldn't be in container
+.editorconfig
+.pre-commit-config.yaml
+pyproject.toml
+setup.cfg
+tox.ini
+
+# Backup files
+*.bak
+*.backup
+*.orig
+*.rej
+
+# Archive files
+*.tar
+*.tar.gz
+*.tar.bz2
+*.tar.xz
+*.zip
+*.rar
+*.7z
+
+# Security and secrets (extra safety)
+*.key
+*.pem
+*.crt
+*.p12
+secrets/
+.secrets/
+
+flash_fpga.py
+.github/
+.pytest_cache/
+.benchmarks/
+
+# Include VFIO constants build files
+!vfio_helper.c
+!patch_vfio_constants.py
+!build_vfio_constants.sh
+!VFIO_CONSTANTS_README.md

pcileechfwgenerator-0.5.7/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+*Please no uuids in this*
+
+## 📦 Environment
+
+Host OS:
+e.g., Ubuntu 22.04 / Windows 11 WSL / Arch Linux
+Python Version:
+e.g., 3.11.8
+Vivado Version:
+e.g., 2022.2
+Board Target:
+e.g., pcileech_35t325_x4 or pcileech_75t
+Device type
+Audio Network etc
+
+## 🚨Problem or Feature Description
+
+Describe what’s happening or what you need. Include exact error messages, crash logs, or feature descriptions.
+Please use backticks or attach txt for logs
+
+## 🧠 Expected Behavior
+
+What did you expect to happen?
+e.g., “Expected synthesized firmware to build successfully with correct BAR size and MSI-X table emulated”
+
+## 📎 Attachments (optional)
+
+config.json
+Synth log or crash dump (*.log)
+Screenshot of GUI or waveform
+Custom .tcl or .sv file
+
+## ✅ Checklist
+
+I’m using the latest main branch
+I’ve checked for similar issues
+I’ve read the relevant modules (device_emulator, cap_parser, svgen, etc

pcileechfwgenerator-0.5.7/.github/ISSUE_TEMPLATE/device_report.md

@@ -0,0 +1,71 @@
+---
+name: Device Report
+about: Submit information about a tested device
+title: '[DEVICE] '
+labels: device-report
+assignees: ''
+---
+
+*Please no sensitive device identifiers in this*
+
+## 📱 Device Information
+
+**Device Name/Model:**
+e.g., ACME USB3380 PCIe Adapter
+
+**Device ID (VID:PID):**
+e.g., 1234:5678
+
+**Device Type:**
+e.g., USB3380, FT601, FT2232H, etc.
+
+**Form Factor:**
+e.g., PCIe card, USB dongle, embedded device, etc.
+
+## 💾 Firmware Information
+
+**Firmware Version Tested:**
+e.g., v2.1.0
+
+**Firmware Generated Using:**
+e.g., PCILeechFWGenerator v1.2.3
+
+**Generation Command Used:**
+```
+# Paste the exact command you used to generate the firmware
+```
+
+## ⚡ Performance Metrics
+
+**Read Speed (approx.):**
+e.g., 150 MB/s
+
+**Write Speed (approx.):**
+e.g., 120 MB/s
+
+**Max Tested DMA Size:**
+e.g., 16 MB
+
+## 🔄 Compatibility
+
+**Works with PCILeech/MemProcFS:** Yes/No/Partial
+
+**Host OS Tested:**
+e.g., Windows 10 21H2, Ubuntu 22.04, macOS 13.1
+
+**Target OS Tested:**
+e.g., Windows 11, Linux kernel 6.1, etc.
+
+## ⚠️ Issues or Limitations
+
+Describe any issues, limitations, or special considerations for this device
+
+## 📎 Attachments (optional)
+
+Performance test results
+Configuration details
+Screenshots of device in action
+
+## 📝 Additional Notes
+
+Any other relevant information about this device

pcileechfwgenerator-0.5.7/.github/dependabot.yml

@@ -0,0 +1,62 @@
+version: 2
+updates:
+  # Python dependencies
+  - package-ecosystem: "pip"
+    directory: "/src"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"
+      - "python"
+    versioning-strategy: auto
+    ignore:
+      # Ignore patch updates for black, as formatting changes might be disruptive
+      - dependency-name: "black"
+        update-types: ["version-update:semver-patch"]
+    commit-message:
+      prefix: "pip"
+      include: "scope"
+
+  # Docker dependencies in Containerfile
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+    open-pull-requests-limit: 5
+    labels:
+      - "dependencies"
+      - "docker"
+    commit-message:
+      prefix: "docker"
+      include: "scope"
+
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "wednesday"
+    open-pull-requests-limit: 5
+    labels:
+      - "dependencies"
+      - "github-actions"
+    commit-message:
+      prefix: "github-actions"
+      include: "scope"
+
+  # Test requirements
+  - package-ecosystem: "pip"
+    directory: "/tests"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 5
+    labels:
+      - "dependencies"
+      - "testing"
+    versioning-strategy: auto
+    commit-message:
+      prefix: "test-deps"
+      include: "scope"

pcileechfwgenerator-0.5.7/.github/workflows/ci.yml

@@ -0,0 +1,95 @@
+name: CI
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Cache pip dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+        pip install types-setuptools types-psutil
+        pip install pytest-asyncio
+      
+    - name: Check code formatting with black
+      run: |
+        black --check src/ tests/
+    
+    - name: Check import sorting with isort
+      run: |
+        isort --check-only src/ tests/
+    
+    - name: Type check with mypy
+      run: |
+        mypy --config-file mypy_dev.ini src/ --exclude 'tests/'
+      continue-on-error: true
+    
+    - name: Security check with bandit
+      run: |
+        bandit -r src/ -f json -o bandit-report.json || true
+      continue-on-error: true
+    
+    - name: Test with pytest
+      env:
+        CI: true
+        PYTEST_CURRENT_TEST: true
+      run: |
+        pytest tests/ -k "not tui" -m "not hardware" --cov=src --cov-report=xml --cov-report=term-missing
+      continue-on-error: true
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: ramseymcgrath/PCILeechFWGenerator
+        files: ./coverage.xml  
+        flags: unittests
+        fail_ci_if_error: false
+
+  docs:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install documentation dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install sphinx sphinx-rtd-theme
+        pip install -r requirements.txt
+    
+    - name: Check documentation build
+      run: |
+        # Create basic Sphinx documentation structure if it doesn't exist
+        if [ ! -f "docs/conf.py" ]; then
+          mkdir -p docs
+          sphinx-quickstart -q -p "PCILeech Firmware Generator" -a "Ramsey McGrath" -v "0.5.0" --ext-autodoc --ext-viewcode --makefile --no-batchfile docs
+        fi
+        # Build documentation
+        cd docs && make html || echo "Documentation build test completed"

pcileechfwgenerator-0.5.7/.github/workflows/datadog.yml

@@ -0,0 +1,36 @@
+on: [push]
+
+name: Datadog Software Composition Analysis
+
+jobs:
+  software-composition-analysis:
+    runs-on: ubuntu-latest
+    name: Datadog SBOM Generation and Upload
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Check imported libraries are secure and compliant
+      id: datadog-software-composition-analysis
+      uses: DataDog/datadog-sca-github-action@main
+      with:
+        dd_api_key: "${{ secrets.DD_API_KEY }}"
+        dd_app_key: "${{ secrets.DD_APP_KEY }}"
+        dd_site: datadoghq.com
+    continue-on-error: true
+  static-analysis:
+    runs-on: ubuntu-latest
+    name: Datadog Static Analyzer
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Check code meets quality and security standards
+      id: datadog-static-analysis
+      uses: DataDog/datadog-static-analyzer-github-action@v1
+      with:
+        dd_api_key: ${{ secrets.DD_API_KEY }}
+        dd_app_key: ${{ secrets.DD_APP_KEY }}
+        dd_site: datadoghq.com
+        secrets_enabled: false
+        static_analysis_enabled: true
+        cpu_count: 2
+    continue-on-error: true

pcileechfwgenerator-0.5.7/.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,49 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pcileechfwgenerator-0.5.7/.github/workflows/release.yml

@@ -0,0 +1,133 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build package
+      run: |
+        python -m build
+    
+    - name: Check package
+      run: |
+        twine check dist/*
+    
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/
+
+  pypi-publish:
+    needs: build
+    name: upload release to PyPI
+    if: github.event_name == 'release' && github.event.action == 'published'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-github:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Download build artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: dist
+        path: dist/
+    
+    - name: Extract tag name
+      id: tag
+      run: echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+    
+    - name: Extract changelog
+      id: changelog
+      run: |
+        # Extract changelog section for this version
+        VERSION=$(echo ${{ steps.tag.outputs.tag }} | sed 's/^v//')
+        awk "/^## \[$VERSION\]/{flag=1; next} /^## \[/{flag=0} flag" CHANGELOG.md > release_notes.md
+    
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v2
+      with:
+        tag_name: ${{ steps.tag.outputs.tag }}
+        name: Release ${{ steps.tag.outputs.tag }}
+        body_path: release_notes.md
+        files: |
+          dist/*.whl
+          dist/*.tar.gz
+        draft: false
+        prerelease: false
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  container:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+    
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v3
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    
+    - name: Extract metadata
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: ghcr.io/${{ github.repository }}
+        tags: |
+          type=ref,event=tag
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=semver,pattern={{major}}
+    
+    - name: Build and push container
+      uses: docker/build-push-action@v6
+      with:
+        context: .
+        file: ./Containerfile
+        push: true
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}
+        cache-from: type=gha
+        cache-to: type=gha,mode=max

pcileechfwgenerator-0.5.7/.gitignore

@@ -0,0 +1,54 @@
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+tags
+
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.coverage.*
+.tox
+junit*.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_rst/*
+docs/_build/*
+cover/*
+MANIFEST
+
+# Per-project virtualenvs
+.venv*/
+.conda*/
+.python-version