Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Add reference-level documentation #82

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

[WIP] Add reference-level documentation #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9a809d5
docs: add reference-level documentation.
jfng Apr 9, 2024
294a61b
docs/memory: add guide-level documentation.
jfng May 14, 2024
dbcbb5e
csr.bus: fix incorrect flow of element members of register signatures.
jfng May 21, 2024
67c33c5
docs/csr/bus: add guide-level documentation.
jfng May 21, 2024
4b4824d
docs/_static/custom.css: sync with amaranth upstream.
jfng May 28, 2024
0b0644e
docs/csr/reg: add guide-level documentation.
jfng Aug 27, 2024
cfdd0ab
docs/gpio: add documentation.
jfng Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 73 additions & 53 deletions amaranth_soc/csr/action.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@


class R(FieldAction):
"""A read-only field action.
"""A read-only :class:`~.csr.reg.FieldAction`.

Parameters
----------
Arguments
---------
shape : :ref:`shape-like object <lang-shapelike>`
Shape of the field.

Interface attributes
--------------------
port : :class:`FieldPort`
Members
-------
port : :py:`In(csr.reg.FieldPort.Signature(shape, "r"))`
Field port.
r_data : Signal(shape)
Read data. Drives ``port.r_data``. See :class:`FieldPort`.
r_stb : Signal()
Read strobe. Driven by ``port.r_stb``. See :class:`FieldPort`.
r_data : :py:`In(shape)`
Read data. Drives ``port.r_data``.
r_stb : :py:`Out(1)`
Read strobe. Driven by ``port.r_stb``.
"""
def __init__(self, shape):
super().__init__(shape, access="r", members={
Expand All @@ -40,21 +40,21 @@ def elaborate(self, platform):


class W(FieldAction):
"""A write-only field action.
"""A write-only :class:`~.csr.reg.FieldAction`.

Parameters
----------
Arguments
---------
shape : :ref:`shape-like object <lang-shapelike>`
Shape of the field.

Interface attributes
--------------------
port : :class:`FieldPort`
Members
-------
port : :py:`In(csr.reg.FieldPort.Signature(shape, "w"))`
Field port.
w_data : Signal(shape)
Write data. Driven by ``port.w_data``. See :class:`FieldPort`.
w_stb : Signal()
Write strobe. Driven by ``port.w_stb``. See :class:`FieldPort`.
w_data : :py:`Out(shape)`
Write data. Driven by ``port.w_data``.
w_stb : :py:`Out(1)`
Write strobe. Driven by ``port.w_stb``.
"""
def __init__(self, shape):
super().__init__(shape, access="w", members={
Expand All @@ -72,23 +72,23 @@ def elaborate(self, platform):


class RW(FieldAction):
"""A read/write field action, with built-in storage.
"""A read/write :class:`~.csr.reg.FieldAction`, with built-in storage.

Storage is updated with the value of ``port.w_data`` one clock cycle after ``port.w_stb`` is
asserted.

Parameters
----------
Arguments
---------
shape : :ref:`shape-like object <lang-shapelike>`
Shape of the field.
init : :class:`int`
Storage initial value.

Interface attributes
--------------------
port : :class:`FieldPort`
Members
-------
port : :py:`In(csr.reg.FieldPort.Signature(shape, "rw"))`
Field port.
data : Signal(shape)
data : :py:`Out(shape)`
Storage output.
"""
def __init__(self, shape, *, init=0):
Expand All @@ -100,6 +100,12 @@ def __init__(self, shape, *, init=0):

@property
def init(self):
"""Storage initial value.

Returns
-------
:class:`int`
"""
return self._init

def elaborate(self, platform):
Expand All @@ -117,28 +123,29 @@ def elaborate(self, platform):


class RW1C(FieldAction):
"""A read/write-one-to-clear field action, with built-in storage.
"""A read/write-one-to-clear :class:`~.csr.reg.FieldAction`, with built-in storage.

Storage bits are:

* cleared by high bits in ``port.w_data``, one clock cycle after ``port.w_stb`` is asserted;
* set by high bits in ``set``, one clock cycle after they are asserted.

If a storage bit is set and cleared on the same clock cycle, setting it has precedence.

Parameters
----------
Arguments
---------
shape : :ref:`shape-like object <lang-shapelike>`
Shape of the field.
init : :class:`int`
Storage initial value.

Interface attributes
--------------------
port : :class:`FieldPort`
Members
-------
port : :py:`In(csr.reg.FieldPort.Signature(shape, "rw"))`
Field port.
data : Signal(shape)
data : :py:`Out(shape)`
Storage output.
set : Signal(shape)
set : :py:`In(shape)`
Mask to set storage bits.
"""
def __init__(self, shape, *, init=0):
Expand All @@ -151,6 +158,12 @@ def __init__(self, shape, *, init=0):

@property
def init(self):
"""Storage initial value.

Returns
-------
:class:`int`
"""
return self._init

def elaborate(self, platform):
Expand All @@ -171,40 +184,47 @@ def elaborate(self, platform):


class RW1S(FieldAction):
"""A read/write-one-to-set field action, with built-in storage.
"""A read/write-one-to-set :class:`~.csr.reg.FieldAction`, with built-in storage.

Storage bits are:

* set by high bits in ``port.w_data``, one clock cycle after ``port.w_stb`` is asserted;
* cleared by high bits in ``clear``, one clock cycle after they are asserted.

If a storage bit is set and cleared on the same clock cycle, setting it has precedence.

Parameters
----------
Arguments
---------
shape : :ref:`shape-like object <lang-shapelike>`
Shape of the field.
init : :class:`int`
Storage initial value.

Interface attributes
--------------------
port : :class:`FieldPort`
Members
-------
port : :py:`In(csr.reg.FieldPort.Signature(shape, "rw"))`
Field port.
data : Signal(shape)
data : :py:`Out(shape)`
Storage output.
clear : Signal(shape)
clear : :py:`In(shape)`
Mask to clear storage bits.
"""
def __init__(self, shape, *, init=0):
super().__init__(shape, access="rw", members={
"clear": In(shape),
"data": Out(shape),
"clear": In(shape),
})
self._storage = Signal(shape, init=init)
self._init = init

@property
def init(self):
"""Storage initial value.

Returns
-------
:class:`int`
"""
return self._init

def elaborate(self, platform):
Expand All @@ -228,14 +248,14 @@ class _Reserved(FieldAction):
_doc_template = """
{description}

Parameters
----------
Arguments
---------
shape : :ref:`shape-like object <lang-shapelike>`
Shape of the field.

Interface attributes
--------------------
port : :class:`FieldPort`
Members
-------
port : :py:`In(csr.reg.FieldPort.Signature(shape, "nc"))`
Field port.
"""
def __init__(self, shape):
Expand All @@ -247,23 +267,23 @@ def elaborate(self, platform):

class ResRAW0(_Reserved):
__doc__ = _Reserved._doc_template.format(description="""
A reserved read-any/write-zero field action.
A reserved read-any/write-zero :class:`~.csr.reg.FieldAction`.
""")


class ResRAWL(_Reserved):
__doc__ = _Reserved._doc_template.format(description="""
A reserved read-any/write-last field action.
A reserved read-any/write-last :class:`~.csr.reg.FieldAction`.
""")


class ResR0WA(_Reserved):
__doc__ = _Reserved._doc_template.format(description="""
A reserved read-zero/write-any field action.
A reserved read-zero/write-any :class:`~.csr.reg.FieldAction`.
""")


class ResR0W0(_Reserved):
__doc__ = _Reserved._doc_template.format(description="""
A reserved read-zero/write-zero field action.
A reserved read-zero/write-zero :class:`~.csr.reg.FieldAction`.
""")
Loading