Kratos: a hardware design language written in C++/Python

The basics

• First steps
  • Installing kratos
    • Linux/macOS/Windows
    • Other OS/ Compiling from source
    • Development setup
  • Create a simple pass-through module
    • Put everything together
• Generator of Generators
  • Port and Variables
    • Variable Proxies
    • Expressions
    • Constants
    • Arrays
    • Enums
  • Child generators
  • External Modules
    • External module
    • Stub module
  • Free-Style Code Block
    • Combinational and Sequential Code Block
    • Examples
  • Procedural code generation
    • Syntax sugars
    • Examples
• Generate SystemVerilog

Advanced Topics

• How to debug in Kratos
  • Debug hardware as software
  • Which line generates this SystemVerilog?
  • Commenting SystemVerilog
• Passes in Kratos
  • Application specific Passes
  • Symbol-Level Passes
  • Built-in Passes
  • Write your own Pass
  • A note on parallelism
  • Helper functions for your passes
• Efficient Generator Clones
  • Design Philosophy on CoW
  • Implement Generator Clones with create
  • A more efficient yet shallow clone using clone
• Generator Parameters
  • Examples
    • Parameterize constant values
    • Parameterize variable width
• Packed Struct and Bundles
  • Packed Struct
  • Port Bundles
  • When to use packed sturct and when to use port bundles
• Attributes in Kratos’s IR
  • Attributes in Python
  • Attributes in C++
• Procedural Code Generation in Depth
  • Expressions
    • Expression Stacking
  • Statements
    • AssignStmt
    • SequentialCodeBlock
    • CombinationalCodeBlock
    • SwitchStmt
    • IfStmt
    • Syntax sugars
    • Comments
• Finite State Machine
  • Create a FSM
  • How to debug FSM
  • Access State Variables
  • Moore machine to Mealy
  • Coming Soon
• Kratos Functions
  • Usage
  • Debug
  • Type Deduction and limitations
• DPI in Kratos
  • C/C++ Interface
  • Python Interface
  • SystemVerilog Types
  • Work in Progress
• Use Kratos as a Backend
  • How to specify source mapping
  • How to specify context/scope variables
  • How to store the debug information
• Interfacce
  • Create an interface

API Reference

• Kratos API Reference