chipflow.platform.io.annotate
=============================

.. py:module:: chipflow.platform.io.annotate

.. autoapi-nested-parse::

   Amaranth annotation utilities for ChipFlow.



Functions
---------

.. autoapisummary::

   chipflow.platform.io.annotate.submodule_metadata


Module Contents
---------------

.. py:function:: 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).

   Args:
       fragment: The fragment to search in.
       component_name: 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.