Skip to content

Commit 6ca7fc4

Browse files
committed
lib.io: document platform.get_io_buffer() override.
1 parent 08fd7b3 commit 6ca7fc4

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

amaranth/lib/io.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -518,6 +518,11 @@ class Buffer(wiring.Component):
518518
----------
519519
signature : :class:`Buffer.Signature`
520520
:py:`Signature(direction, len(port)).flip()`.
521+
522+
Platform overrides
523+
------------------
524+
Define the :py:`get_io_buffer()` platform method to override the implementation of
525+
:class:`Buffer`, e.g. to instantiate library cells directly.
521526
"""
522527
class Signature(wiring.Signature):
523528
"""Signature of a combinational I/O buffer.
@@ -690,6 +695,11 @@ class FFBuffer(wiring.Component):
690695
----------
691696
signature : :class:`FFBuffer.Signature`
692697
:py:`Signature(direction, len(port)).flip()`.
698+
699+
Platform overrides
700+
------------------
701+
Define the :py:`get_io_buffer()` platform method to override the implementation of
702+
:class:`FFBuffer`, e.g. to instantiate library cells directly.
693703
"""
694704
class Signature(wiring.Signature):
695705
"""Signature of a registered I/O buffer.
@@ -898,6 +908,11 @@ class DDRBuffer(wiring.Component):
898908
----------
899909
signature : :class:`DDRBuffer.Signature`
900910
:py:`Signature(direction, len(port)).flip()`.
911+
912+
Platform overrides
913+
------------------
914+
Define the :py:`get_io_buffer()` platform method to override the implementation of
915+
:class:`DDRBuffer`, e.g. to instantiate library cells directly.
901916
"""
902917
class Signature(wiring.Signature):
903918
"""Signature of a double data rate I/O buffer.

0 commit comments

Comments
 (0)