Platform API Reference

This page documents the complete public API of the chipflow.platform module.

All symbols listed here are re-exported from submodules for convenience and can be imported directly from chipflow.platform.

Platforms

Build Steps

IO Signatures

Base IO Signatures

Protocol-Specific Signatures

Software Integration

IO Configuration

Utility Functions

chipflow.utils.top_components(config)

Return the top level components for the design, as configured in chipflow.toml.

Args:

config: The parsed chipflow configuration

Returns:

Dictionary mapping component names to instantiated Component objects

Raises:

ChipFlowError: If component references are invalid or instantiation fails

Parameters:

config (Config)

Return type:

Dict[str, wiring.Component]

chipflow.utils.get_software_builds(m, component)

Extract software build information from a component’s interfaces.

Args:

m: Module containing the component component: Name of the component

Returns:

Dictionary of interface names to SoftwareBuild objects

Parameters:

component (str)

Constants