Seminar OpenTitan – Entwicklungsumgebung, Repository und Buildsystem

OpenTitan wird als gemeinsames Hardware-, Software- und Tool-Repository entwickelt. Ein reproduzierbarer Arbeitsplatz muss deshalb Compiler, Python-Werkzeuge, Buildregeln, Simulator- oder FPGA-Ziel und Git-Workflow konsistent verbinden.

Das Seminar richtet eine funktionsfähige Umgebung ein und führt typische Aufgaben vom Repository-Orientieren über Bazel-Abfragen bis zum Build und Test auf einem ausgewählten Ziel durch. Generierte Artefakte und manuell gepflegte Quellen werden klar getrennt.

Inhaltsübersicht

• Seminarziel
• Zielgruppe
• Voraussetzungen
• Lernziele
• Seminarinhalte
  • Arbeitsplatz und Abhängigkeiten
  • Repository und Verzeichnisstruktur
  • Bazel-Grundlagen
  • Top- und Zielauswahl
  • Generatoren und abgeleitete Dateien
  • Git-, Format- und Testworkflow
• Praxisübungen

Seminarziel

Ein OpenTitan-Arbeitsplatz soll reproduzierbar eingerichtet, das Monorepo sicher navigiert und Hardware- sowie Softwareziele mit Bazel, Generatoren und Testwerkzeugen gebaut und geprüft werden können.

Zielgruppe

Neue OpenTitan-Entwickler, Build- und CI-Verantwortliche, Firmware- und RTL-Entwickler, Verifikationsingenieure, Integratoren und technische Administratoren.

Voraussetzungen

Sicherer Umgang mit Linux, Shell, Git und grundlegenden Buildwerkzeugen. Kenntnisse in C, Python oder SystemVerilog sind je nach späterem Schwerpunkt hilfreich.

Lernziele

• Repositorystruktur und Zuständigkeiten der Verzeichnisse verstehen
• Abhängigkeiten und Python-Umgebung reproduzierbar einrichten
• Bazel-Targets abfragen, bauen und testen
• Top-Level-, Simulator- und FPGA-Ziele korrekt auswählen
• Änderungen mit Generatoren, Formatierung und Git-Checks vorbereiten

Seminarinhalte

Schritt 1: Arbeitsplatz und Abhängigkeiten

1. Hardware-, Software- und Toolanforderungen des Arbeitsplatzes erfassen
2. Linux-Pakete, Python-Virtual-Environment und projektgebundene Abhängigkeiten einrichten
3. Umgebungsvariablen, Speicherbedarf und Scratch-Bereiche nachvollziehbar konfigurieren
4. Installations- und Versionsabweichungen mit einem reproduzierbaren Prüfschritt erkennen

Schritt 2: Repository und Verzeichnisstruktur

1. doc, hw, sw, util und rules nach Verantwortungsbereich unterscheiden
2. IP-, Top-Level-, DV- und Firmwarequellen gezielt auffinden
3. Generierte Dateien, Upstream-Komponenten und lokale Patches erkennen
4. Änderungsumfang und Abhängigkeiten vor der Bearbeitung mit Git analysieren

Schritt 3: Bazel-Grundlagen

1. Targets, Packages, Konfigurationen und Abhängigkeiten mit Query-Befehlen untersuchen
2. Host- und Device-Software sowie Hardwareartefakte bauen
3. On-host- und on-device-Tests unterscheiden und gezielt ausführen
4. Buildausgaben, Caches und reproduzierbare Fehlerberichte verwalten

Schritt 4: Top- und Zielauswahl

1. OpenTitan-Top-Level für Build und Softwareheader auswählen
2. Verilator-, FPGA- und weitere Zielkonfigurationen unterscheiden
3. Artefakte einem konkreten Top und einer konkreten Plattform zuordnen
4. Fehlkonfigurationen durch kontrollierte Query- und Buildprüfungen erkennen

Schritt 5: Generatoren und abgeleitete Dateien

1. RegGen, TopGen, TLGen und IPGen nach Eingaben und Ausgaben zuordnen
2. HJSON-Änderungen kontrolliert in generierte Artefakte überführen
3. Abweichungen zwischen Quelle und Generat erkennen
4. Generatorversionen und Reviewumfang nachvollziehbar dokumentieren

Schritt 6: Git-, Format- und Testworkflow

1. Branch, Commitstruktur und kleine prüfbare Änderungen planen
2. Formatierer, Linter und zielgerichtete Tests vor dem Review ausführen
3. Fehler mit Logs, exakten Befehlen und Zielkonfiguration reproduzierbar melden
4. Änderungen gegen Aktualisierungen des Hauptzweigs sauber nachführen

Praxisübungen

1. OpenTitan-Arbeitsumgebung einschließlich Python-Virtual-Environment prüfen
2. Repositorystruktur für eine vorgegebene Hardware- und Firmwareaufgabe analysieren
3. Bazel-Targets abfragen, bauen und einen On-host- sowie On-device-Test starten
4. Eine kleine HJSON- oder Dokumentationsänderung mit Generator- und Qualitätschecks vorbereiten