dv-flow-libfusesoc

User Guide:

  • Getting Started
    • Prerequisites
      • System Requirements
      • Required Knowledge
    • Installation
      • Install from PyPI
      • Install from Source
      • Verify Installation
      • Install Simulation Tools
    • Quick Start Tutorial
      • Step 1: Set Up FuseSoC Workspace
      • Step 2: Create a Simple Core
      • Step 3: Run Your First Simulation
    • Next Steps
    • Common Issues
      • Core Not Found
      • Build Failures
      • Tool Not Found
    • Further Reading
  • Usage Examples
    • Basic Examples
      • Example 1: Simple Core Resolution
      • Example 2: Icarus Verilog Simulation
      • Example 3: Verilator Simulation
    • Advanced Examples
      • Example 4: Using Multiple Libraries
      • Example 5: Parameterized Simulation
      • Example 6: Error Handling
    • Integration Examples
      • Example 7: Integration with DV Flow
      • Example 8: Custom Task Integration
    • Real-World Examples
      • Example 9: UART Simulation
      • Example 10: SoC Subsystem Simulation
    • Tips and Best Practices
      • Performance Optimization
      • Debugging Tips
      • Workspace Management
  • DV Flow Task Reference
    • Task Overview
    • fusesoc Package
      • CoreResolve Task
      • CoreFetch Task
    • fusesoc.edalize.sim Package
      • SimConfigure Task
      • SimBuild Task
      • SimRun Task
      • Complete Simulation Flow Example
    • fusesoc.edalize.fpga Package
    • fusesoc.edalize.lint Package
    • Task Development Guide
      • Creating Custom Tasks
      • Best Practices
  • Quick Reference
    • Common Commands
      • Core Resolution
      • Simulation Flow
    • Parameter Reference
      • CoreResolve Parameters
      • SimConfigure Parameters
    • Supported Tools
      • Simulators
    • Tool-Specific Options
      • Icarus Verilog
      • Verilator
      • ModelSim/Questa
      • VCS
    • Common Patterns
      • Pattern: Multiple Test Cases
      • Pattern: Parameterized Configurations
      • Pattern: Error Handling
    • File Type Mappings
      • FuseSoC to DV Flow
    • Environment Variables
      • FuseSoC Variables
    • Troubleshooting
      • Common Errors
      • Debug Commands
    • Performance Tips
    • Additional Resources
      • External Links

API Documentation:

  • FuseSoC Integration
    • fusesoc_manager
      • FuseSoCManager
        • FuseSoCManager.__init__()
        • FuseSoCManager.get_core_manager()
        • FuseSoCManager.add_library()
        • FuseSoCManager.resolve_core()
        • FuseSoCManager.get_core_files()
        • FuseSoCManager.get_dependencies()
        • FuseSoCManager.resolve_dependencies()
      • Key Features
    • fusesoc_fileset
      • FilesetConverter
        • FilesetConverter.FILE_TYPE_MAP
        • FilesetConverter.__init__()
        • FilesetConverter.convert_files()
        • FilesetConverter.extract_include_dirs()
        • FilesetConverter.filter_by_type()
        • FilesetConverter.get_source_files()
      • Conversion Features
      • File Type Mapping
    • fusesoc_core_resolve
      • CoreResolveParams
        • CoreResolveParams.core
        • CoreResolveParams.target
        • CoreResolveParams.tool
        • CoreResolveParams.libraries
        • CoreResolveParams.workspace
        • CoreResolveParams.model_config
      • CoreResolveOutput
        • CoreResolveOutput.core_name
        • CoreResolveOutput.core_root
        • CoreResolveOutput.files_root
        • CoreResolveOutput.files
        • CoreResolveOutput.dependencies
        • CoreResolveOutput.parameters
        • CoreResolveOutput.include_dirs
        • CoreResolveOutput.model_config
      • CoreResolveMemento
        • CoreResolveMemento.core
        • CoreResolveMemento.target
        • CoreResolveMemento.tool
        • CoreResolveMemento.core_name
        • CoreResolveMemento.last_resolution
        • CoreResolveMemento.model_config
      • CoreResolve()
      • Task Parameters
      • Task Outputs
      • Usage Example
  • Edalize Integration
    • edam_builder
      • EdamBuilder
        • EdamBuilder.__init__()
        • EdamBuilder.add_files()
        • EdamBuilder.set_toplevel()
        • EdamBuilder.add_parameters()
        • EdamBuilder.add_plusargs()
        • EdamBuilder.set_tool_options()
        • EdamBuilder.set_flow_options()
        • EdamBuilder.add_include_dirs()
        • EdamBuilder.build()
      • build_edam_from_core()
      • EDAM Structure
      • Builder Pattern
      • Convenience Functions
    • edalize_backend
      • EdalizeBackend
        • EdalizeBackend.__init__()
        • EdalizeBackend.configure()
        • EdalizeBackend.build()
        • EdalizeBackend.run()
        • EdalizeBackend.get_tool()
        • EdalizeBackend.get_work_root()
        • EdalizeBackend.get_log_files()
        • EdalizeBackend.cleanup()
      • create_sim_backend()
      • create_fpga_backend()
      • Backend Lifecycle
      • Error Handling
      • Convenience Functions
    • edalize_sim
      • SimConfigureParams
        • SimConfigureParams.core_name
        • SimConfigureParams.files
        • SimConfigureParams.include_dirs
        • SimConfigureParams.toplevel
        • SimConfigureParams.tool
        • SimConfigureParams.parameters
        • SimConfigureParams.plusargs
        • SimConfigureParams.tool_options
        • SimConfigureParams.model_config
      • SimConfigureOutput
        • SimConfigureOutput.work_root
        • SimConfigureOutput.tool
        • SimConfigureOutput.configured
        • SimConfigureOutput.model_config
      • SimBuildParams
        • SimBuildParams.work_root
        • SimBuildParams.tool
        • SimBuildParams.model_config
      • SimBuildOutput
        • SimBuildOutput.work_root
        • SimBuildOutput.build_success
        • SimBuildOutput.executable
        • SimBuildOutput.model_config
      • SimRunParams
        • SimRunParams.work_root
        • SimRunParams.tool
        • SimRunParams.runtime_plusargs
        • SimRunParams.model_config
      • SimRunOutput
        • SimRunOutput.work_root
        • SimRunOutput.run_success
        • SimRunOutput.log_file
        • SimRunOutput.model_config
      • SimConfigure()
      • SimBuild()
      • SimRun()
      • SimConfigure Task
      • SimBuild Task
      • SimRun Task
      • Task Chaining
  • API Reference
    • Core Modules
      • FuseSoC Integration
        • fusesoc_manager
        • fusesoc_fileset
        • fusesoc_core_resolve
      • Edalize Integration
        • edam_builder
        • edalize_backend
        • edalize_sim
      • DV Flow Task Reference
        • Task Overview
        • fusesoc Package
        • fusesoc.edalize.sim Package
        • fusesoc.edalize.fpga Package
        • fusesoc.edalize.lint Package
        • Task Development Guide

Additional:

  • Changelog
    • Version 0.0.1 (2026-02-03)
      • Initial Release
        • Features
        • Implementation Details
        • Known Limitations
        • Breaking Changes
        • Migration Guide
        • Future Plans
        • Contributors
        • Acknowledgments
        • License
    • Version 0.0.0 (Development)
dv-flow-libfusesoc
  • Search

© Copyright 2026, Matthew Ballance.

Built with Sphinx using a theme provided by Read the Docs.