chipflow.platform.io.annotate

Amaranth annotation utilities for ChipFlow.

Functions

submodule_metadata(fragment, component_name[, recursive])

Generator that finds component_name in fragment and yields metadata.

Module Contents

chipflow.platform.io.annotate.submodule_metadata(fragment, component_name, recursive=False)

Generator that finds component_name in fragment and yields metadata.

Yields the wiring.Component instances of that component’s submodule, along with their names and metadata.

Can only be run once for a given component (or its children).

Parameters:

  • fragment (amaranth.Fragment) – The fragment to search in.

  • component_name (str) – The name of the component to find.

  • recursive – If True, name is a tuple of the hierarchy of names. Otherwise, name is the string name of the first level component.

Yields:

Tuple of (component, name, metadata) for each submodule.

Return type:

collections.abc.Generator[Tuple[amaranth.lib.wiring.Component, str | tuple, dict]]