Skip to content

Commit

Permalink
Add comments with more context to the wishbone interface description …
Browse files Browse the repository at this point in the history
…YAML

Internal-tag: [#63755]
Signed-off-by: Krzysztof Obłonczek <[email protected]>
  • Loading branch information
koblonczek committed Aug 7, 2024
1 parent 41bb9ff commit 0f42770
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions topwrap/interfaces/wishbone.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# SPDX-License-Identifier: Apache-2.0

# Signals specification:
# - https://cdn.opencores.org/downloads/wbspec_b3.pdf#page=32
# - https://cdn.opencores.org/downloads/wbspec_b3.pdf#page=73
# - https://cdn.opencores.org/downloads/wbspec_b4.pdf#page=27
# - https://cdn.opencores.org/downloads/wbspec_b4.pdf#page=69
name: wishbone
port_prefix: wishbone
signals:
Expand All @@ -15,6 +15,15 @@ signals:
ack: ack
optional:
out:
# mosi/miso is a naming convention that is currently unsupported
# in Topwrap since it's semantically the same signal but it has
# a different name depending on the peripheral being a master or
# a slave, so if the RTL source uses this convention grouping ports
# under interfaces might not be performed correctly.
#
# Many implementations use saner dat_w/dat_r convention that does
# not depend on whether the peripheral is a master or a slave. This
# is reflected in an additional regex pattern below and in dat_r.
dat_w: dat_w|mosi
adr: adr
tgd_w: tgd_w
Expand All @@ -23,6 +32,7 @@ signals:
tga: tga
tgc: tgc
we: we
# Wishbone Registered Feedback extension signals
cti: cti
bte: bte
in:
Expand Down

0 comments on commit 0f42770

Please sign in to comment.