Skip to content

Library/Utils: Adding documentation for associated addition to Counte… #280

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Library/Utils: Adding documentation for associated addition to Counte… #280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion source/SpinalHDL/Libraries/utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,13 +123,15 @@ The Counter tool can be used to easily instantiate a hardware counter.
* - Instantiation syntax
- Notes
* - ``Counter(start: BigInt, end: BigInt[, inc : Bool])``
-
-
* - ``Counter(range : Range[, inc : Bool])``
- Compatible with the ``x to y`` ``x until y`` syntaxes
* - ``Counter(stateCount: BigInt[, inc : Bool])``
- Starts at zero and ends at ``stateCount - 1``
* - ``Counter(bitCount: BitCount[, inc : Bool])``
- Starts at zero and ends at ``(1 << bitCount) - 1``
* - ``Counter(time: TimeNumber[, inc : Bool])``
- Starts at zero and ends after ``time`` clocks

A counter can be controlled by methods, and signals can be read:

Expand Down
Loading