Skip to content

Commit

Permalink
Add documentation for new write acknowledge behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenzschmid committed Jul 5, 2024
1 parent 91278f9 commit 6ea2f5e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ Code generated by Cheby is under your license (the one of the source file).

## Version 1.6 (dev)

Add generation of field widths in constant files (github PR #50)

Remove sampling of internal write acknowledge to allow consecutive single cycle
access (github PR #49)

Add documented 'all' value for pipeline (issue#127)

Handle address-space in --pretty-print and --print-simple (issue#124)
Expand Down
9 changes: 6 additions & 3 deletions doc/cheby-ug.txt
Original file line number Diff line number Diff line change
Expand Up @@ -267,9 +267,12 @@ There are also aliases: "wr" is for "wr-in,wr-out", "rd" for "rd-in,rd-out",
Finally it is possible to use "none" not to use any pipelining.
The pipelining is a single barrier of registers inserted on an internal bus,
which is created from the external bus.
Please note, that without any pipelinging the `apb-32` interface might
complete its write and read request without the access phase and hence, in a
single clock cycle only (contrary to the standard's specifications).
Please note, that without correct pipelining of the write request and read
response ("wr-in,rd-out"), the `apb-32` interface might complete its write and
read request without the access phase and hence, in a single clock cycle only
(contrary to the standard's specifications). Also in case of a write request,
the updated data might be applied earlier than at the end of the access phase
(contrary to the standard's specifications).

`name-suffix`:: The name of the hdl entity or module is by default the name of
the memory map. This attribute adds a suffix to those names.
Expand Down

0 comments on commit 6ea2f5e

Please sign in to comment.