ChipFlow Library Documentation

chipflow is a Python library and tools for working with the ChipFlow Platform

It is developed at https://github.com/chipFlow/chipflow-lib/ and licensed BSD 2-Clause

User Guide

• Getting Started with ChipFlow
  • What is ChipFlow?
  • Prerequisites
  • Clone chipflow-examples
  • Install the dependencies
  • Set up the environment
  • Running a chip build
• ChipFlow Architecture Overview
  • High-Level Overview
  • Core Components
  • Design Flow in Detail
  • Annotation System Architecture
  • Package System Architecture
  • Configuration System
  • Extending ChipFlow
  • See Also
• Simulation Guide
  • Overview
  • Basic Workflow
  • What Happens During Simulation
  • SimPlatform Internals
  • Configuration
  • Simulation Commands
  • Debugging with RTL Debugger
  • Event Logging for Testing
  • Customizing Simulation
  • Performance Tips
  • Common Issues
  • Example: Complete Simulation Setup
  • See Also
• Intro to chipflow.toml
  • [chipflow] table
• project_name
• clock_domains
  • [chipflow.top] table
  • [chipflow.steps] table
  • [chipflow.silicon]
• process
• package
  • Power connections
• The chipflow command
  • chipflow pin lock
  • chipflow silicon
  • chipflow sim
  • chipflow software
• Using Pin Signatures and Software Drivers
  • Overview
  • Pin Signatures
  • Software Driver Signatures
  • Using Peripherals in Your SoC
  • Attaching Software Binaries
  • Complete Example
  • See Also
• Platform API Reference
  • Platforms
  • Build Steps
  • IO Signatures
  • IO Configuration
  • Utility Functions
  • Constants

Contributor Guide

• Pin Signature Architecture (Contributor Guide)
  • Overview
  • Annotation Infrastructure
  • I/O Signature Base Classes
  • Concrete Pin Signatures
  • Platform Consumption
  • Complete Flow Example
  • Adding New Pin Signatures
  • Adding Custom Platform Backends
  • JSON Schema Integration
  • Key Files
  • See Also